ClusterUpdateParameters Class

Definition

Cluster update request

[Microsoft.Rest.Serialization.JsonTransformation]
public class ClusterUpdateParameters
[<Microsoft.Rest.Serialization.JsonTransformation>]
type ClusterUpdateParameters = class
Public Class ClusterUpdateParameters
Inheritance
ClusterUpdateParameters
Attributes

Constructors

ClusterUpdateParameters()

Initializes a new instance of the ClusterUpdateParameters class.

ClusterUpdateParameters(IList<String>, CertificateDescription, ServerCertificateCommonNames, IList<ClientCertificateCommonName>, IList<ClientCertificateThumbprint>, String, Nullable<Boolean>, IList<SettingsSectionDescription>, IList<NodeTypeDescription>, String, CertificateDescription, ClusterUpgradePolicy, String, ApplicationTypeVersionsCleanupPolicy, IDictionary<String,String>)

Initializes a new instance of the ClusterUpdateParameters class.

Properties

AddOnFeatures

Gets or sets the list of add-on features to enable in the cluster.

ApplicationTypeVersionsCleanupPolicy

Gets or sets the policy used to clean up unused versions.

Certificate

Gets or sets 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

Gets or sets describes a list of server certificates referenced by common name that are used to secure the cluster.

ClientCertificateCommonNames

Gets or sets the list of client certificates referenced by common name that are allowed to manage the cluster. This will overwrite the existing list.

ClientCertificateThumbprints

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

ClusterCodeVersion

Gets or sets 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

Gets or sets indicates if the event store service is enabled.

FabricSettings

Gets or sets the list of custom fabric settings to configure the cluster. This will overwrite the existing list.

NodeTypes

Gets or sets the list of node types in the cluster. This will overwrite the existing list.

ReliabilityLevel

Gets or sets 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
  • Platinum - Run the System services with a target replica set count of 9. . Possible values include: 'None', 'Bronze', 'Silver', 'Gold', 'Platinum'
ReverseProxyCertificate

Gets or sets the server certificate used by reverse proxy.

Tags

Gets or sets cluster update parameters

UpgradeDescription

Gets or sets the policy to use when upgrading the cluster.

UpgradeMode

Gets or sets 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. . Possible values include: 'Automatic', 'Manual'

Methods

Validate()

Validate the object.

Applies to