ClusterPropertiesUpdateParameters
Describes the cluster resource properties that can be updated during PATCH operation.
Properties
| Name | Type | Required |
|---|---|---|
| addOnFeatures | array of AddOnFeatures | No |
| certificate | CertificateDescription | No |
| certificateCommonNames | ServerCertificateCommonNames | No |
| clientCertificateCommonNames | array of ClientCertificateCommonName | No |
| clientCertificateThumbprints | array of ClientCertificateThumbprint | No |
| clusterCodeVersion | string | No |
| fabricSettings | array of SettingsSectionDescription | No |
| nodeTypes | array of NodeTypeDescription | No |
| reliabilityLevel | string (enum) | No |
| reverseProxyCertificate | CertificateDescription | No |
| upgradeDescription | ClusterUpgradePolicy | No |
| upgradeMode | string (enum) | No |
addOnFeatures
Type: array of AddOnFeatures
Required: No
The list of add-on features to enable in 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. This will overwrite the existing list.
clientCertificateThumbprints
Type: array of ClientCertificateThumbprint
Required: No
The list of client certificates referenced by thumbprint that are allowed to manage the cluster. This will overwrite the existing list.
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.
fabricSettings
Type: array of SettingsSectionDescription
Required: No
The list of custom fabric settings to configure the cluster. This will overwrite the existing list.
nodeTypes
Type: array of NodeTypeDescription
Required: No
The list of node types in the cluster. This will overwrite the existing list.
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.
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.