ManagedCluster interface

  • Reference
Package:
@azure/arm-servicefabricmanagedclusters

The managed cluster resource

Extends
Resource

Properties

addonFeatures

List of add-on features to enable on the cluster.
adminPassword

VM admin user password. This value contains a credential. Consider obscuring before showing to users
adminUserName

VM admin user name.
allowRdpAccess

Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false.
applicationTypeVersionsCleanupPolicy

The policy used to clean up unused versions.
auxiliarySubnets

Auxiliary subnets for the cluster.
azureActiveDirectory

The AAD authentication settings of the cluster.
clientConnectionPort

The port used for client connections to the cluster.
clients

Client certificates that are allowed to manage the cluster.
clusterCertificateThumbprints

List of thumbprints of the cluster certificates. NOTE: This property will not be serialized. It can only be populated by the server.
clusterCodeVersion

The Service Fabric runtime version of the cluster. This property is required when clusterUpgradeMode is set to 'Manual'. To get list of available Service Fabric versions for new clusters use ClusterVersion API. To get the list of available version for existing clusters use availableClusterVersions.
clusterId

A service generated unique identifier for the cluster resource. NOTE: This property will not be serialized. It can only be populated by the server.
clusterState

The current state of the cluster. NOTE: This property will not be serialized. It can only be populated by the server.
clusterUpgradeCadence

Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when clusterUpgradeMode is set to 'Automatic'.
clusterUpgradeMode

The upgrade mode of the cluster when new Service Fabric runtime version is available.
ddosProtectionPlanId

Specify the resource id of a DDoS network protection plan that will be associated with the virtual network of the cluster.
dnsName

The cluster dns name.
enableAutoOSUpgrade

Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false.
enableHttpGatewayExclusiveAuthMode

If true, token-based authentication is not allowed on the HttpGatewayEndpoint. This is required to support TLS versions 1.3 and above. If token-based authentication is used, HttpGatewayTokenAuthConnectionPort must be defined.
enableIpv6

Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false.
enableServicePublicIP

Setting this to true will link the IPv4 address as the ServicePublicIP of the IPv6 address. It can only be set to True if IPv6 is enabled on the cluster.
fabricSettings

The list of custom fabric settings to configure the cluster.
fqdn

The fully qualified domain name associated with the public load balancer of the cluster. NOTE: This property will not be serialized. It can only be populated by the server.
httpGatewayConnectionPort

The port used for HTTP connections to the cluster.
httpGatewayTokenAuthConnectionPort

The port used for token-auth based HTTPS connections to the cluster. Cannot be set to the same port as HttpGatewayEndpoint.
ipTags

The list of IP tags associated with the default public IP address of the cluster.
ipv4Address

The IPv4 address associated with the public load balancer of the cluster. NOTE: This property will not be serialized. It can only be populated by the server.
ipv6Address

IPv6 address for the cluster if IPv6 is enabled. NOTE: This property will not be serialized. It can only be populated by the server.
loadBalancingRules

Load balancing rules that are applied to the public load balancer of the cluster.
networkSecurityRules

Custom Network Security Rules that are applied to the Virtual Network of the cluster.
provisioningState

The provisioning state of the managed cluster resource. NOTE: This property will not be serialized. It can only be populated by the server.
publicIPPrefixId

Specify the resource id of a public IPv4 prefix that the load balancer will allocate a public IPv4 address from. This setting cannot be changed once the cluster is created.
publicIPv6PrefixId

Specify the resource id of a public IPv6 prefix that the load balancer will allocate a public IPv6 address from. This setting cannot be changed once the cluster is created.
serviceEndpoints

Service endpoints for subnets in the cluster.
sku

The sku of the managed cluster
subnetId

If specified, the node types for the cluster are created in this subnet instead of the default VNet. The networkSecurityRules specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created.
upgradeDescription

The policy to use when upgrading the cluster.
useCustomVnet

For new clusters, this parameter indicates that it uses Bring your own VNet, but the subnet is specified at node type level; and for such clusters, the subnetId property is required for node types.
zonalResiliency

Indicates if the cluster has zone resiliency.
zonalUpdateMode

Indicates the update mode for Cross Az clusters.

Inherited Properties

etag

Azure resource etag. NOTE: This property will not be serialized. It can only be populated by the server.
id

Azure resource identifier. NOTE: This property will not be serialized. It can only be populated by the server.
location

Azure resource location.
name

Azure resource name. NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Azure resource tags.
type

Azure resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

addonFeatures

List of add-on features to enable on the cluster.

addonFeatures?: string[]

Property Value

string[]

adminPassword

VM admin user password. This value contains a credential. Consider obscuring before showing to users

adminPassword?: string

Property Value

string

adminUserName

VM admin user name.

adminUserName?: string

Property Value

string

allowRdpAccess

Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false.

allowRdpAccess?: boolean

Property Value

boolean

applicationTypeVersionsCleanupPolicy

The policy used to clean up unused versions.

applicationTypeVersionsCleanupPolicy?: ApplicationTypeVersionsCleanupPolicy

Property Value

ApplicationTypeVersionsCleanupPolicy

auxiliarySubnets

Auxiliary subnets for the cluster.

auxiliarySubnets?: Subnet[]

Property Value

Subnet[]

azureActiveDirectory

The AAD authentication settings of the cluster.

azureActiveDirectory?: AzureActiveDirectory

Property Value

AzureActiveDirectory

clientConnectionPort

The port used for client connections to the cluster.

clientConnectionPort?: number

Property Value

number

clients

Client certificates that are allowed to manage the cluster.

clients?: ClientCertificate[]

Property Value

ClientCertificate[]

clusterCertificateThumbprints

List of thumbprints of the cluster certificates. NOTE: This property will not be serialized. It can only be populated by the server.

clusterCertificateThumbprints?: string[]

Property Value

string[]

clusterCodeVersion

The Service Fabric runtime version of the cluster. This property is required when clusterUpgradeMode is set to 'Manual'. To get list of available Service Fabric versions for new clusters use ClusterVersion API. To get the list of available version for existing clusters use availableClusterVersions.

clusterCodeVersion?: string

Property Value

string

clusterId

A service generated unique identifier for the cluster resource. NOTE: This property will not be serialized. It can only be populated by the server.

clusterId?: string

Property Value

string

clusterState

The current state of the cluster. NOTE: This property will not be serialized. It can only be populated by the server.

clusterState?: string

Property Value

string

clusterUpgradeCadence

Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when clusterUpgradeMode is set to 'Automatic'.

clusterUpgradeCadence?: string

Property Value

string

clusterUpgradeMode

The upgrade mode of the cluster when new Service Fabric runtime version is available.

clusterUpgradeMode?: string

Property Value

string

ddosProtectionPlanId

Specify the resource id of a DDoS network protection plan that will be associated with the virtual network of the cluster.

ddosProtectionPlanId?: string

Property Value

string

dnsName

The cluster dns name.

dnsName?: string

Property Value

string

enableAutoOSUpgrade

Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false.

enableAutoOSUpgrade?: boolean

Property Value

boolean

enableHttpGatewayExclusiveAuthMode

If true, token-based authentication is not allowed on the HttpGatewayEndpoint. This is required to support TLS versions 1.3 and above. If token-based authentication is used, HttpGatewayTokenAuthConnectionPort must be defined.

enableHttpGatewayExclusiveAuthMode?: boolean

Property Value

boolean

enableIpv6

Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false.

enableIpv6?: boolean

Property Value

boolean

enableServicePublicIP

Setting this to true will link the IPv4 address as the ServicePublicIP of the IPv6 address. It can only be set to True if IPv6 is enabled on the cluster.

enableServicePublicIP?: boolean

Property Value

boolean

fabricSettings

The list of custom fabric settings to configure the cluster.

fabricSettings?: SettingsSectionDescription[]

Property Value

SettingsSectionDescription[]

fqdn

The fully qualified domain name associated with the public load balancer of the cluster. NOTE: This property will not be serialized. It can only be populated by the server.

fqdn?: string

Property Value

string

httpGatewayConnectionPort

The port used for HTTP connections to the cluster.

httpGatewayConnectionPort?: number

Property Value

number

httpGatewayTokenAuthConnectionPort

The port used for token-auth based HTTPS connections to the cluster. Cannot be set to the same port as HttpGatewayEndpoint.

httpGatewayTokenAuthConnectionPort?: number

Property Value

number

ipTags

The list of IP tags associated with the default public IP address of the cluster.

ipTags?: IpTag[]

Property Value

IpTag[]

ipv4Address

The IPv4 address associated with the public load balancer of the cluster. NOTE: This property will not be serialized. It can only be populated by the server.

ipv4Address?: string

Property Value

string

ipv6Address

IPv6 address for the cluster if IPv6 is enabled. NOTE: This property will not be serialized. It can only be populated by the server.

ipv6Address?: string

Property Value

string

loadBalancingRules

Load balancing rules that are applied to the public load balancer of the cluster.

loadBalancingRules?: LoadBalancingRule[]

Property Value

LoadBalancingRule[]

networkSecurityRules

Custom Network Security Rules that are applied to the Virtual Network of the cluster.

networkSecurityRules?: NetworkSecurityRule[]

Property Value

NetworkSecurityRule[]

provisioningState

The provisioning state of the managed cluster resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

publicIPPrefixId

Specify the resource id of a public IPv4 prefix that the load balancer will allocate a public IPv4 address from. This setting cannot be changed once the cluster is created.

publicIPPrefixId?: string

Property Value

string

publicIPv6PrefixId

Specify the resource id of a public IPv6 prefix that the load balancer will allocate a public IPv6 address from. This setting cannot be changed once the cluster is created.

publicIPv6PrefixId?: string

Property Value

string

serviceEndpoints

Service endpoints for subnets in the cluster.

serviceEndpoints?: ServiceEndpoint[]

Property Value

ServiceEndpoint[]

sku

The sku of the managed cluster

sku: Sku

Property Value

Sku

subnetId

If specified, the node types for the cluster are created in this subnet instead of the default VNet. The networkSecurityRules specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created.

subnetId?: string

Property Value

string

upgradeDescription

The policy to use when upgrading the cluster.

upgradeDescription?: ClusterUpgradePolicy

Property Value

ClusterUpgradePolicy

useCustomVnet

For new clusters, this parameter indicates that it uses Bring your own VNet, but the subnet is specified at node type level; and for such clusters, the subnetId property is required for node types.

useCustomVnet?: boolean

Property Value

boolean

zonalResiliency

Indicates if the cluster has zone resiliency.

zonalResiliency?: boolean

Property Value

boolean

zonalUpdateMode

Indicates the update mode for Cross Az clusters.

zonalUpdateMode?: string

Property Value

string

Inherited Property Details

etag

Azure resource etag. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

Inherited From Resource.etag

id

Azure resource identifier. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

location

Azure resource location.

location: string

Property Value

string

Inherited From Resource.location

name

Azure resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

systemData

Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From Resource.systemData

tags

Azure resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

Azure resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type