Share via

ClusterUpdateParameters interface

  • Reference
Package:
@azure/arm-servicefabric

Cluster update request

Properties

addOnFeatures

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

The policy used to clean up unused versions.
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. This will overwrite the existing list.
clientCertificateThumbprints

The list of client certificates referenced by thumbprint that are allowed to manage the cluster. This will overwrite the existing list.
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.
eventStoreServiceEnabled

Indicates if the event store service is enabled.
fabricSettings

The list of custom fabric settings to configure the cluster. This will overwrite the existing list.
infrastructureServiceManager

Indicates if infrastructure service manager is enabled.
nodeTypes

The list of node types in the cluster. This will overwrite the existing list.
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.
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.
tags

Cluster update parameters
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

The end timestamp of pause runtime version upgrades on the cluster (UTC).
upgradePauseStartTimestampUtc

The start timestamp to pause runtime version upgrades 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'.
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?: string[]

Property Value

string[]

applicationTypeVersionsCleanupPolicy

The policy used to clean up unused versions.

applicationTypeVersionsCleanupPolicy?: ApplicationTypeVersionsCleanupPolicy

Property Value

ApplicationTypeVersionsCleanupPolicy

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. This will overwrite the existing list.

clientCertificateCommonNames?: ClientCertificateCommonName[]

Property Value

ClientCertificateCommonName[]

clientCertificateThumbprints

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

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

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. This will overwrite the existing list.

fabricSettings?: SettingsSectionDescription[]

Property Value

SettingsSectionDescription[]

infrastructureServiceManager

Indicates if infrastructure service manager is enabled.

infrastructureServiceManager?: boolean

Property Value

boolean

nodeTypes

The list of node types in the cluster. This will overwrite the existing list.

nodeTypes?: NodeTypeDescription[]

Property Value

NodeTypeDescription[]

notifications

Indicates a list of notification channels for cluster events.

notifications?: Notification_2[]

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

Property Value

string

reverseProxyCertificate

The server certificate used by reverse proxy.

reverseProxyCertificate?: CertificateDescription

Property Value

CertificateDescription

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

Property Value

string

tags

Cluster update parameters

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

Property Value

{[propertyName: string]: string}

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

Property Value

string

upgradePauseEndTimestampUtc

The end timestamp of pause runtime version upgrades on the cluster (UTC).

upgradePauseEndTimestampUtc?: Date

Property Value

Date

upgradePauseStartTimestampUtc

The start timestamp to pause runtime version upgrades on the cluster (UTC).

upgradePauseStartTimestampUtc?: Date

Property Value

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

Property Value

string

waveUpgradePaused

Boolean to pause automatic runtime version upgrades to the cluster.

waveUpgradePaused?: boolean

Property Value

boolean