Share via

ClusterProperties

  • Article

Describes the cluster resource properties.

Properties

Name Type Required
addOnFeatures array of AddOnFeatures No
availableClusterVersions array of ClusterVersionDetails No
azureActiveDirectory AzureActiveDirectory No
certificate CertificateDescription No
certificateCommonNames ServerCertificateCommonNames No
clientCertificateCommonNames array of ClientCertificateCommonName No
clientCertificateThumbprints array of ClientCertificateThumbprint No
clusterCodeVersion string No
clusterEndpoint string No
clusterId string No
clusterState string (enum) No
diagnosticsStorageAccountConfig DiagnosticsStorageAccountConfig No
fabricSettings array of SettingsSectionDescription No
managementEndpoint string Yes
nodeTypes array of NodeTypeDescription Yes
provisioningState string (enum) No
reliabilityLevel string (enum) No
reverseProxyCertificate CertificateDescription No
reverseProxyCertificateCommonNames ServerCertificateCommonNames No
upgradeDescription ClusterUpgradePolicy No
upgradeMode string (enum) No
vmImage string No

addOnFeatures

Type: array of AddOnFeatures
Required: No

The list of add-on features to enable in the cluster.

availableClusterVersions

Type: array of ClusterVersionDetails
Required: No

The Service Fabric runtime versions available for this cluster.

azureActiveDirectory

Type: AzureActiveDirectory
Required: No

The AAD authentication settings of the cluster.

certificate

Type: CertificateDescription
Required: No

The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client.

certificateCommonNames

Type: ServerCertificateCommonNames
Required: No

Describes a list of server certificates referenced by common name that are used to secure the cluster.

clientCertificateCommonNames

Type: array of ClientCertificateCommonName
Required: No

The list of client certificates referenced by common name that are allowed to manage the cluster.

clientCertificateThumbprints

Type: array of ClientCertificateThumbprint
Required: No

The list of client certificates referenced by thumbprint that are allowed to manage the cluster.

clusterCodeVersion

Type: string
Required: No

The Service Fabric runtime version of the cluster. This property can only be set by the user when upgradeMode is set to Manual. To get the list of available Service Fabric versions for new clusters use ClusterVersion API. To get the list of available versions for existing clusters use availableClusterVersions.

clusterEndpoint

Type: string
Required: No

The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint.

clusterId

Type: string
Required: No

A service generated unique identifier for the cluster resource.

clusterState

Type: string (enum)
Required: No

The current state of the cluster.

  • WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it.
  • Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up.
  • BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time.
  • UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration.
  • UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate.
  • UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the upgradeMode is set to 'Automatic'.
  • EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version.
  • UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider.
  • AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted.
  • Ready - Indicates that the cluster is in a stable state.

diagnosticsStorageAccountConfig

Type: DiagnosticsStorageAccountConfig
Required: No

The storage account information for storing Service Fabric diagnostic logs.

fabricSettings

Type: array of SettingsSectionDescription
Required: No

The list of custom fabric settings to configure the cluster.

managementEndpoint

Type: string
Required: Yes

The http management endpoint of the cluster.

nodeTypes

Type: array of NodeTypeDescription
Required: Yes

The list of node types in the cluster.

provisioningState

Type: string (enum)
Required: No

The provisioning state of the cluster resource.

reliabilityLevel

Type: string (enum)
Required: No

The reliability level sets the replica set size of system services. Learn about ReliabilityLevel.

  • None - Run the System services with a target replica set count of 1. This should only be used for test clusters.
  • Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters.
  • Silver - Run the System services with a target replica set count of 5.
  • Gold - Run the System services with a target replica set count of 7.
  • Platinum - Run the System services with a target replica set count of 9.

reverseProxyCertificate

Type: CertificateDescription
Required: No

The server certificate used by reverse proxy.

reverseProxyCertificateCommonNames

Type: ServerCertificateCommonNames
Required: No

Describes a list of server certificates referenced by common name that are used to secure the cluster.

upgradeDescription

Type: ClusterUpgradePolicy
Required: No

The policy to use when upgrading the cluster.

upgradeMode

Type: string (enum)
Required: No

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

  • Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available.
  • Manual - The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the clusterCodeVersion property in the cluster resource.

vmImage

Type: string
Required: No

The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used.