Cluster Class

Definition

Namespace:

Microsoft.Azure.Management.ServiceFabric.Models

Assembly:

Microsoft.Azure.Management.ServiceFabric.dll

Package:

Microsoft.Azure.Management.ServiceFabric v1.3.0

The cluster resource

[Microsoft.Rest.Serialization.JsonTransformation]
public class Cluster : Microsoft.Azure.Management.ServiceFabric.Models.Resource

[<Microsoft.Rest.Serialization.JsonTransformation>]
type Cluster = class
    inherit Resource

Public Class Cluster
Inherits Resource

Inheritance

Object

Resource

Cluster

Attributes

JsonTransformationAttribute

Constructors

Cluster()

Initializes a new instance of the Cluster class.

Cluster(String, String, IList<NodeTypeDescription>, String, String, String, IDictionary<String,String>, String, IList<String>, IList<ClusterVersionDetails>, AzureActiveDirectory, CertificateDescription, ServerCertificateCommonNames, IList<ClientCertificateCommonName>, IList<ClientCertificateThumbprint>, String, String, String, String, DiagnosticsStorageAccountConfig, Nullable<Boolean>, IList<SettingsSectionDescription>, String, String, CertificateDescription, ServerCertificateCommonNames, ClusterUpgradePolicy, String, ApplicationTypeVersionsCleanupPolicy, String)

Initializes a new instance of the Cluster 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.
AvailableClusterVersions	Gets the Service Fabric runtime versions available for this cluster.
AzureActiveDirectory	Gets or sets the AAD authentication settings of the cluster.
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.
ClientCertificateThumbprints	Gets or sets the list of client certificates referenced by thumbprint that are allowed to manage the cluster.
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.
ClusterEndpoint	Gets the Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint.
ClusterId	Gets a service generated unique identifier for the cluster resource.
ClusterState	Gets 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. . Possible values include: 'WaitingForNodes', 'Deploying', 'BaselineUpgrade', 'UpdatingUserConfiguration', 'UpdatingUserCertificate', 'UpdatingInfrastructure', 'EnforcingClusterVersion', 'UpgradeServiceUnreachable', 'AutoScale', 'Ready'
DiagnosticsStorageAccountConfig	Gets or sets the storage account information for storing Service Fabric diagnostic logs.
Etag	Gets azure resource etag. (Inherited from Resource)
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.
Id	Gets azure resource identifier. (Inherited from Resource)
Location	Gets or sets azure resource location. (Inherited from Resource)
ManagementEndpoint	Gets or sets the http management endpoint of the cluster.
Name	Gets azure resource name. (Inherited from Resource)
NodeTypes	Gets or sets the list of node types in the cluster.
ProvisioningState	Gets the provisioning state of the cluster resource. Possible values include: 'Updating', 'Succeeded', 'Failed', 'Canceled'
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 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.
ReverseProxyCertificateCommonNames	Gets or sets describes a list of server certificates referenced by common name that are used to secure the cluster.
Tags	Gets or sets azure resource tags. (Inherited from Resource)
Type	Gets azure resource type. (Inherited from Resource)
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'
VmImage	Gets or sets the VM image VMSS has been configured with. Generic names such as Windows or Linux can be used.

Methods

Validate()

Validate the object.