ClusterProperties interface

Package:

@azure-rest/arm-servicefabric

Describes the cluster resource properties.

Properties

addOnFeatures	The list of add-on features to enable in the cluster.
applicationTypeVersionsCleanupPolicy	The policy used to clean up unused versions.
azureActiveDirectory	The AAD authentication settings of the cluster.
certificate	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	Describes a list of server certificates referenced by common name that are used to secure the cluster.
clientCertificateCommonNames	The list of client certificates referenced by common name that are allowed to manage the cluster.
clientCertificateThumbprints	The list of client certificates referenced by thumbprint that are allowed to manage the cluster.
clusterCodeVersion	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.
diagnosticsStorageAccountConfig	The storage account information for storing Service Fabric diagnostic logs.
eventStoreServiceEnabled	Indicates if the event store service is enabled.
fabricSettings	The list of custom fabric settings to configure the cluster.
infrastructureServiceManager	Indicates if infrastructure service manager is enabled.
managementEndpoint	The http management endpoint of the cluster.
nodeTypes	The list of node types in the cluster.
notifications	Indicates a list of notification channels for cluster events.
reliabilityLevel	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	The server certificate used by reverse proxy.
reverseProxyCertificateCommonNames	Describes a list of server certificates referenced by common name that are used to secure the cluster.
sfZonalUpgradeMode	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.
upgradeDescription	The policy to use when upgrading the cluster.
upgradeMode	The upgrade mode of the cluster when new Service Fabric runtime version is available.
upgradePauseEndTimestampUtc	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).
upgradePauseStartTimestampUtc	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).
upgradeWave	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'.
vmImage	The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used.
vmssZonalUpgradeMode	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.
waveUpgradePaused	Boolean to pause automatic runtime version upgrades to the cluster.

Property Details

addOnFeatures

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

addOnFeatures?: ("RepairManager" | "DnsService" | "BackupRestoreService" | "ResourceMonitorService")[]

Property Value

("RepairManager" | "DnsService" | "BackupRestoreService" | "ResourceMonitorService")[]

applicationTypeVersionsCleanupPolicy

The policy used to clean up unused versions.

applicationTypeVersionsCleanupPolicy?: ApplicationTypeVersionsCleanupPolicy

Property Value

ApplicationTypeVersionsCleanupPolicy

azureActiveDirectory

The AAD authentication settings of the cluster.

azureActiveDirectory?: AzureActiveDirectory

Property Value

AzureActiveDirectory

certificate

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

CertificateDescription

certificateCommonNames

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

certificateCommonNames?: ServerCertificateCommonNames

Property Value

ServerCertificateCommonNames

clientCertificateCommonNames

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

clientCertificateCommonNames?: ClientCertificateCommonName[]

Property Value

ClientCertificateCommonName[]

clientCertificateThumbprints

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

clientCertificateThumbprints?: ClientCertificateThumbprint[]

Property Value

ClientCertificateThumbprint[]

clusterCodeVersion

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

string

diagnosticsStorageAccountConfig

The storage account information for storing Service Fabric diagnostic logs.

diagnosticsStorageAccountConfig?: DiagnosticsStorageAccountConfig

Property Value

DiagnosticsStorageAccountConfig

eventStoreServiceEnabled

Indicates if the event store service is enabled.

eventStoreServiceEnabled?: boolean

Property Value

boolean

fabricSettings

The list of custom fabric settings to configure the cluster.

fabricSettings?: SettingsSectionDescription[]

Property Value

SettingsSectionDescription[]

infrastructureServiceManager

Indicates if infrastructure service manager is enabled.

infrastructureServiceManager?: boolean

Property Value

boolean

managementEndpoint

The http management endpoint of the cluster.

managementEndpoint: string

Property Value

string

nodeTypes

The list of node types in the cluster.

nodeTypes: NodeTypeDescription[]

Property Value

NodeTypeDescription[]

notifications

Indicates a list of notification channels for cluster events.

notifications?: Notification[]

Property Value

Notification[]

reliabilityLevel

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?: "None" | "Bronze" | "Silver" | "Gold" | "Platinum"

Property Value

"None" | "Bronze" | "Silver" | "Gold" | "Platinum"

reverseProxyCertificate

The server certificate used by reverse proxy.

reverseProxyCertificate?: CertificateDescription

Property Value

CertificateDescription

reverseProxyCertificateCommonNames

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

reverseProxyCertificateCommonNames?: ServerCertificateCommonNames

Property Value

ServerCertificateCommonNames

sfZonalUpgradeMode

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?: "Parallel" | "Hierarchical"

Property Value

"Parallel" | "Hierarchical"

upgradeDescription

The policy to use when upgrading the cluster.

upgradeDescription?: ClusterUpgradePolicy

Property Value

ClusterUpgradePolicy

upgradeMode

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

upgradeMode?: "Automatic" | "Manual"

Property Value

"Automatic" | "Manual"

upgradePauseEndTimestampUtc

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?: string | Date

Property Value

string | Date

upgradePauseStartTimestampUtc

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?: string | Date

Property Value

string | Date

upgradeWave

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?: "Wave0" | "Wave1" | "Wave2"

Property Value

"Wave0" | "Wave1" | "Wave2"

vmImage

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

vmImage?: string

Property Value

string

vmssZonalUpgradeMode

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?: "Parallel" | "Hierarchical"

Property Value

"Parallel" | "Hierarchical"

waveUpgradePaused

Boolean to pause automatic runtime version upgrades to the cluster.

waveUpgradePaused?: boolean

Property Value

boolean