ManagedCluster interface

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

addonFeatures?: string[]

Property Value

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

adminPassword?: string

Property Value

VM admin user name.

adminUserName?: string

Property Value

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

The policy used to clean up unused versions.

applicationTypeVersionsCleanupPolicy?: ApplicationTypeVersionsCleanupPolicy

Property Value

This property is the entry point to using a public CA cert for your cluster cert. It specifies the level of reuse allowed for the custom FQDN created, matching the subject of the public CA cert.

autoGeneratedDomainNameLabelScope?: string

Property Value

Auxiliary subnets for the cluster.

auxiliarySubnets?: Subnet[]

Property Value

The AAD authentication settings of the cluster.

azureActiveDirectory?: AzureActiveDirectory

Property Value

The port used for client connections to the cluster.

clientConnectionPort?: number

Property Value

Client certificates that are allowed to manage the cluster.

clients?: ClientCertificate[]

Property Value

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

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

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

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

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

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

clusterUpgradeMode?: string

Property Value

If using autoGeneratedDomainNameLabelScope, this is the fully qualified domain name using SFMC's domain, pointing to the public load balancer of the cluster.

customFqdn?: string

Property Value

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

The cluster dns name.

dnsName?: string

Property Value

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

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

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

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

The list of custom fabric settings to configure the cluster.

fabricSettings?: SettingsSectionDescription[]

Property Value

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

The port used for HTTP connections to the cluster.

httpGatewayConnectionPort?: number

Property Value

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

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

ipTags?: IpTag[]

Property Value

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

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

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

loadBalancingRules?: LoadBalancingRule[]

Property Value

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

networkSecurityRules?: NetworkSecurityRule[]

Property Value

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

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

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

Service endpoints for subnets in the cluster.

serviceEndpoints?: ServiceEndpoint[]

Property Value

The sku of the managed cluster

sku: Sku

Property Value

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

The policy to use when upgrading the cluster.

upgradeDescription?: ClusterUpgradePolicy

Property Value

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

Indicates if the cluster has zone resiliency.

zonalResiliency?: boolean

Property Value

Indicates the update mode for Cross Az clusters.

zonalUpdateMode?: string

Property Value

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

etag?: string

Property Value

Inherited From Resource.etag

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

id?: string

Property Value

Inherited From Resource.id

Azure resource location.

location: string

Property Value

Inherited From Resource.location

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

name?: string

Property Value

Inherited From Resource.name

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

Inherited From Resource.systemData

Azure resource tags.

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

Property Value

Inherited From Resource.tags

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

type?: string

Property Value

Inherited From Resource.type