Cluster interface

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

addOnFeatures?: string[]

Property Value

The policy used to clean up unused versions.

applicationTypeVersionsCleanupPolicy?: ApplicationTypeVersionsCleanupPolicy

Property Value

The Service Fabric runtime versions available for this cluster. NOTE: This property will not be serialized. It can only be populated by the server.

availableClusterVersions?: ClusterVersionDetails[]

Property Value

The AAD authentication settings of the cluster.

azureActiveDirectory?: AzureActiveDirectory

Property Value

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.

certificate?: CertificateDescription

Property Value

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

certificateCommonNames?: ServerCertificateCommonNames

Property Value

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

clientCertificateCommonNames?: ClientCertificateCommonName[]

Property Value

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

clientCertificateThumbprints?: ClientCertificateThumbprint[]

Property Value

The Service Fabric runtime version of the cluster. This property can only by set the user when upgradeMode 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

The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint. NOTE: This property will not be serialized. It can only be populated by the server.

clusterEndpoint?: 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.

• 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.

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

clusterState?: string

Property Value

The storage account information for storing Service Fabric diagnostic logs.

diagnosticsStorageAccountConfig?: DiagnosticsStorageAccountConfig

Property Value

Indicates if the event store service is enabled.

eventStoreServiceEnabled?: boolean

Property Value

The list of custom fabric settings to configure the cluster.

fabricSettings?: SettingsSectionDescription[]

Property Value

Indicates if infrastructure service manager is enabled.

infrastructureServiceManager?: boolean

Property Value

The http management endpoint of the cluster.

managementEndpoint?: string

Property Value

The list of node types in the cluster.

nodeTypes?: NodeTypeDescription[]

Property Value

Indicates a list of notification channels for cluster events.

notifications?: Notification_2[]

Property Value

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

provisioningState?: string

Property Value

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.

reliabilityLevel?: string

Property Value

The server certificate used by reverse proxy.

reverseProxyCertificate?: CertificateDescription

Property Value

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

reverseProxyCertificateCommonNames?: ServerCertificateCommonNames

Property Value

This property controls the logical grouping of VMs in upgrade domains (UDs). This property can't be modified if a node type with multiple Availability Zones is already present in the cluster.

sfZonalUpgradeMode?: string

Property Value

The policy to use when upgrading the cluster.

upgradeDescription?: ClusterUpgradePolicy

Property Value

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

upgradeMode?: string

Property Value

Indicates the end date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC).

upgradePauseEndTimestampUtc?: Date

Property Value

Indicates the start date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC).

upgradePauseStartTimestampUtc?: Date

Property Value

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

upgradeWave?: string

Property Value

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

vmImage?: string

Property Value

This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added.

vmssZonalUpgradeMode?: string

Property Value

Boolean to pause automatic runtime version upgrades to the cluster.

waveUpgradePaused?: boolean

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