Cluster Constructors

  • Reference

Definition

Namespace:
Microsoft.Azure.Management.ServiceFabric.Models
Assembly:
Microsoft.Azure.Management.ServiceFabric.dll
Package:
Microsoft.Azure.Management.ServiceFabric v1.3.0

Overloads

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.

Cluster()

Initializes a new instance of the Cluster class.

public Cluster ();
Public Sub New ()

Applies to

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.

public Cluster (string location, string managementEndpoint, System.Collections.Generic.IList<Microsoft.Azure.Management.ServiceFabric.Models.NodeTypeDescription> nodeTypes, string id = default, string name = default, string type = default, System.Collections.Generic.IDictionary<string,string> tags = default, string etag = default, System.Collections.Generic.IList<string> addOnFeatures = default, System.Collections.Generic.IList<Microsoft.Azure.Management.ServiceFabric.Models.ClusterVersionDetails> availableClusterVersions = default, Microsoft.Azure.Management.ServiceFabric.Models.AzureActiveDirectory azureActiveDirectory = default, Microsoft.Azure.Management.ServiceFabric.Models.CertificateDescription certificate = default, Microsoft.Azure.Management.ServiceFabric.Models.ServerCertificateCommonNames certificateCommonNames = default, System.Collections.Generic.IList<Microsoft.Azure.Management.ServiceFabric.Models.ClientCertificateCommonName> clientCertificateCommonNames = default, System.Collections.Generic.IList<Microsoft.Azure.Management.ServiceFabric.Models.ClientCertificateThumbprint> clientCertificateThumbprints = default, string clusterCodeVersion = default, string clusterEndpoint = default, string clusterId = default, string clusterState = default, Microsoft.Azure.Management.ServiceFabric.Models.DiagnosticsStorageAccountConfig diagnosticsStorageAccountConfig = default, bool? eventStoreServiceEnabled = default, System.Collections.Generic.IList<Microsoft.Azure.Management.ServiceFabric.Models.SettingsSectionDescription> fabricSettings = default, string provisioningState = default, string reliabilityLevel = default, Microsoft.Azure.Management.ServiceFabric.Models.CertificateDescription reverseProxyCertificate = default, Microsoft.Azure.Management.ServiceFabric.Models.ServerCertificateCommonNames reverseProxyCertificateCommonNames = default, Microsoft.Azure.Management.ServiceFabric.Models.ClusterUpgradePolicy upgradeDescription = default, string upgradeMode = default, Microsoft.Azure.Management.ServiceFabric.Models.ApplicationTypeVersionsCleanupPolicy applicationTypeVersionsCleanupPolicy = default, string vmImage = default);
new Microsoft.Azure.Management.ServiceFabric.Models.Cluster : string * string * System.Collections.Generic.IList<Microsoft.Azure.Management.ServiceFabric.Models.NodeTypeDescription> * string * string * string * System.Collections.Generic.IDictionary<string, string> * string * System.Collections.Generic.IList<string> * System.Collections.Generic.IList<Microsoft.Azure.Management.ServiceFabric.Models.ClusterVersionDetails> * Microsoft.Azure.Management.ServiceFabric.Models.AzureActiveDirectory * Microsoft.Azure.Management.ServiceFabric.Models.CertificateDescription * Microsoft.Azure.Management.ServiceFabric.Models.ServerCertificateCommonNames * System.Collections.Generic.IList<Microsoft.Azure.Management.ServiceFabric.Models.ClientCertificateCommonName> * System.Collections.Generic.IList<Microsoft.Azure.Management.ServiceFabric.Models.ClientCertificateThumbprint> * string * string * string * string * Microsoft.Azure.Management.ServiceFabric.Models.DiagnosticsStorageAccountConfig * Nullable<bool> * System.Collections.Generic.IList<Microsoft.Azure.Management.ServiceFabric.Models.SettingsSectionDescription> * string * string * Microsoft.Azure.Management.ServiceFabric.Models.CertificateDescription * Microsoft.Azure.Management.ServiceFabric.Models.ServerCertificateCommonNames * Microsoft.Azure.Management.ServiceFabric.Models.ClusterUpgradePolicy * string * Microsoft.Azure.Management.ServiceFabric.Models.ApplicationTypeVersionsCleanupPolicy * string -> Microsoft.Azure.Management.ServiceFabric.Models.Cluster
Public Sub New (location As String, managementEndpoint As String, nodeTypes As IList(Of NodeTypeDescription), Optional id As String = Nothing, Optional name As String = Nothing, Optional type As String = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional etag As String = Nothing, Optional addOnFeatures As IList(Of String) = Nothing, Optional availableClusterVersions As IList(Of ClusterVersionDetails) = Nothing, Optional azureActiveDirectory As AzureActiveDirectory = Nothing, Optional certificate As CertificateDescription = Nothing, Optional certificateCommonNames As ServerCertificateCommonNames = Nothing, Optional clientCertificateCommonNames As IList(Of ClientCertificateCommonName) = Nothing, Optional clientCertificateThumbprints As IList(Of ClientCertificateThumbprint) = Nothing, Optional clusterCodeVersion As String = Nothing, Optional clusterEndpoint As String = Nothing, Optional clusterId As String = Nothing, Optional clusterState As String = Nothing, Optional diagnosticsStorageAccountConfig As DiagnosticsStorageAccountConfig = Nothing, Optional eventStoreServiceEnabled As Nullable(Of Boolean) = Nothing, Optional fabricSettings As IList(Of SettingsSectionDescription) = Nothing, Optional provisioningState As String = Nothing, Optional reliabilityLevel As String = Nothing, Optional reverseProxyCertificate As CertificateDescription = Nothing, Optional reverseProxyCertificateCommonNames As ServerCertificateCommonNames = Nothing, Optional upgradeDescription As ClusterUpgradePolicy = Nothing, Optional upgradeMode As String = Nothing, Optional applicationTypeVersionsCleanupPolicy As ApplicationTypeVersionsCleanupPolicy = Nothing, Optional vmImage As String = Nothing)

Parameters

location
String

Azure resource location.

managementEndpoint
String

The http management endpoint of the cluster.

nodeTypes
IList<NodeTypeDescription>

The list of node types in the cluster.

id
String

Azure resource identifier.

name
String

Azure resource name.

type
String

Azure resource type.

tags
IDictionary<String,String>

Azure resource tags.

etag
String

Azure resource etag.

addOnFeatures
IList<String>

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

availableClusterVersions
IList<ClusterVersionDetails>

The Service Fabric runtime versions available for this cluster.

azureActiveDirectory
AzureActiveDirectory

The AAD authentication settings of the cluster.

certificate
CertificateDescription

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
ServerCertificateCommonNames

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

clientCertificateCommonNames
IList<ClientCertificateCommonName>

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

clientCertificateThumbprints
IList<ClientCertificateThumbprint>

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

clusterCodeVersion
String

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
String

The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint.

clusterId
String

A service generated unique identifier for the cluster resource.

clusterState
String

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
DiagnosticsStorageAccountConfig

The storage account information for storing Service Fabric diagnostic logs.

eventStoreServiceEnabled
Nullable<Boolean>

Indicates if the event store service is enabled.

fabricSettings
IList<SettingsSectionDescription>

The list of custom fabric settings to configure the cluster.

provisioningState
String

The provisioning state of the cluster resource. Possible values include: 'Updating', 'Succeeded', 'Failed', 'Canceled'

reliabilityLevel
String

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.
         . Possible values include: 'None', 'Bronze', 'Silver', 'Gold',
         'Platinum'
reverseProxyCertificate
CertificateDescription

The server certificate used by reverse proxy.

reverseProxyCertificateCommonNames
ServerCertificateCommonNames

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

upgradeDescription
ClusterUpgradePolicy

The policy to use when upgrading the cluster.

upgradeMode
String

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'
applicationTypeVersionsCleanupPolicy
ApplicationTypeVersionsCleanupPolicy

The policy used to clean up unused versions.

vmImage
String

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

Applies to