다음을 통해 공유


ArmServiceFabricModelFactory.ServiceFabricClusterData Method

Definition

Initializes a new instance of ServiceFabricClusterData.

public static Azure.ResourceManager.ServiceFabric.ServiceFabricClusterData ServiceFabricClusterData (Azure.Core.ResourceIdentifier id = default, string name = default, Azure.Core.ResourceType resourceType = default, Azure.ResourceManager.Models.SystemData systemData = default, System.Collections.Generic.IDictionary<string,string> tags = default, Azure.Core.AzureLocation location = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ServiceFabric.Models.ClusterAddOnFeature> addOnFeatures = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ServiceFabric.Models.ClusterVersionDetails> availableClusterVersions = default, Azure.ResourceManager.ServiceFabric.Models.ClusterAadSetting azureActiveDirectory = default, Azure.ResourceManager.ServiceFabric.Models.ClusterCertificateDescription certificate = default, Azure.ResourceManager.ServiceFabric.Models.ClusterServerCertificateCommonNames certificateCommonNames = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ServiceFabric.Models.ClusterClientCertificateCommonName> clientCertificateCommonNames = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ServiceFabric.Models.ClusterClientCertificateThumbprint> clientCertificateThumbprints = default, string clusterCodeVersion = default, Uri clusterEndpoint = default, Guid? clusterId = default, Azure.ResourceManager.ServiceFabric.Models.ServiceFabricClusterState? clusterState = default, Azure.ResourceManager.ServiceFabric.Models.DiagnosticsStorageAccountConfig diagnosticsStorageAccountConfig = default, bool? isEventStoreServiceEnabled = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ServiceFabric.Models.SettingsSectionDescription> fabricSettings = default, Uri managementEndpoint = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ServiceFabric.Models.ClusterNodeTypeDescription> nodeTypes = default, Azure.ResourceManager.ServiceFabric.Models.ServiceFabricProvisioningState? provisioningState = default, Azure.ResourceManager.ServiceFabric.Models.ClusterReliabilityLevel? reliabilityLevel = default, Azure.ResourceManager.ServiceFabric.Models.ClusterCertificateDescription reverseProxyCertificate = default, Azure.ResourceManager.ServiceFabric.Models.ClusterServerCertificateCommonNames reverseProxyCertificateCommonNames = default, Azure.ResourceManager.ServiceFabric.Models.ClusterUpgradePolicy upgradeDescription = default, Azure.ResourceManager.ServiceFabric.Models.ClusterUpgradeMode? upgradeMode = default, long? maxUnusedVersionsToKeep = default, string vmImage = default, Azure.ResourceManager.ServiceFabric.Models.SfZonalUpgradeMode? serviceFabricZonalUpgradeMode = default, Azure.ResourceManager.ServiceFabric.Models.VmssZonalUpgradeMode? vmssZonalUpgradeMode = default, bool? isInfrastructureServiceManagerEnabled = default, Azure.ResourceManager.ServiceFabric.Models.ClusterUpgradeCadence? upgradeWave = default, DateTimeOffset? upgradePauseStartOn = default, DateTimeOffset? upgradePauseEndOn = default, bool? isWaveUpgradePaused = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ServiceFabric.Models.ClusterNotification> notifications = default, bool? isHttpGatewayExclusiveAuthModeEnabled = default, Azure.ETag? etag = default);
static member ServiceFabricClusterData : Azure.Core.ResourceIdentifier * string * Azure.Core.ResourceType * Azure.ResourceManager.Models.SystemData * System.Collections.Generic.IDictionary<string, string> * Azure.Core.AzureLocation * seq<Azure.ResourceManager.ServiceFabric.Models.ClusterAddOnFeature> * seq<Azure.ResourceManager.ServiceFabric.Models.ClusterVersionDetails> * Azure.ResourceManager.ServiceFabric.Models.ClusterAadSetting * Azure.ResourceManager.ServiceFabric.Models.ClusterCertificateDescription * Azure.ResourceManager.ServiceFabric.Models.ClusterServerCertificateCommonNames * seq<Azure.ResourceManager.ServiceFabric.Models.ClusterClientCertificateCommonName> * seq<Azure.ResourceManager.ServiceFabric.Models.ClusterClientCertificateThumbprint> * string * Uri * Nullable<Guid> * Nullable<Azure.ResourceManager.ServiceFabric.Models.ServiceFabricClusterState> * Azure.ResourceManager.ServiceFabric.Models.DiagnosticsStorageAccountConfig * Nullable<bool> * seq<Azure.ResourceManager.ServiceFabric.Models.SettingsSectionDescription> * Uri * seq<Azure.ResourceManager.ServiceFabric.Models.ClusterNodeTypeDescription> * Nullable<Azure.ResourceManager.ServiceFabric.Models.ServiceFabricProvisioningState> * Nullable<Azure.ResourceManager.ServiceFabric.Models.ClusterReliabilityLevel> * Azure.ResourceManager.ServiceFabric.Models.ClusterCertificateDescription * Azure.ResourceManager.ServiceFabric.Models.ClusterServerCertificateCommonNames * Azure.ResourceManager.ServiceFabric.Models.ClusterUpgradePolicy * Nullable<Azure.ResourceManager.ServiceFabric.Models.ClusterUpgradeMode> * Nullable<int64> * string * Nullable<Azure.ResourceManager.ServiceFabric.Models.SfZonalUpgradeMode> * Nullable<Azure.ResourceManager.ServiceFabric.Models.VmssZonalUpgradeMode> * Nullable<bool> * Nullable<Azure.ResourceManager.ServiceFabric.Models.ClusterUpgradeCadence> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<bool> * seq<Azure.ResourceManager.ServiceFabric.Models.ClusterNotification> * Nullable<bool> * Nullable<Azure.ETag> -> Azure.ResourceManager.ServiceFabric.ServiceFabricClusterData
Public Shared Function ServiceFabricClusterData (Optional id As ResourceIdentifier = Nothing, Optional name As String = Nothing, Optional resourceType As ResourceType = Nothing, Optional systemData As SystemData = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional location As AzureLocation = Nothing, Optional addOnFeatures As IEnumerable(Of ClusterAddOnFeature) = Nothing, Optional availableClusterVersions As IEnumerable(Of ClusterVersionDetails) = Nothing, Optional azureActiveDirectory As ClusterAadSetting = Nothing, Optional certificate As ClusterCertificateDescription = Nothing, Optional certificateCommonNames As ClusterServerCertificateCommonNames = Nothing, Optional clientCertificateCommonNames As IEnumerable(Of ClusterClientCertificateCommonName) = Nothing, Optional clientCertificateThumbprints As IEnumerable(Of ClusterClientCertificateThumbprint) = Nothing, Optional clusterCodeVersion As String = Nothing, Optional clusterEndpoint As Uri = Nothing, Optional clusterId As Nullable(Of Guid) = Nothing, Optional clusterState As Nullable(Of ServiceFabricClusterState) = Nothing, Optional diagnosticsStorageAccountConfig As DiagnosticsStorageAccountConfig = Nothing, Optional isEventStoreServiceEnabled As Nullable(Of Boolean) = Nothing, Optional fabricSettings As IEnumerable(Of SettingsSectionDescription) = Nothing, Optional managementEndpoint As Uri = Nothing, Optional nodeTypes As IEnumerable(Of ClusterNodeTypeDescription) = Nothing, Optional provisioningState As Nullable(Of ServiceFabricProvisioningState) = Nothing, Optional reliabilityLevel As Nullable(Of ClusterReliabilityLevel) = Nothing, Optional reverseProxyCertificate As ClusterCertificateDescription = Nothing, Optional reverseProxyCertificateCommonNames As ClusterServerCertificateCommonNames = Nothing, Optional upgradeDescription As ClusterUpgradePolicy = Nothing, Optional upgradeMode As Nullable(Of ClusterUpgradeMode) = Nothing, Optional maxUnusedVersionsToKeep As Nullable(Of Long) = Nothing, Optional vmImage As String = Nothing, Optional serviceFabricZonalUpgradeMode As Nullable(Of SfZonalUpgradeMode) = Nothing, Optional vmssZonalUpgradeMode As Nullable(Of VmssZonalUpgradeMode) = Nothing, Optional isInfrastructureServiceManagerEnabled As Nullable(Of Boolean) = Nothing, Optional upgradeWave As Nullable(Of ClusterUpgradeCadence) = Nothing, Optional upgradePauseStartOn As Nullable(Of DateTimeOffset) = Nothing, Optional upgradePauseEndOn As Nullable(Of DateTimeOffset) = Nothing, Optional isWaveUpgradePaused As Nullable(Of Boolean) = Nothing, Optional notifications As IEnumerable(Of ClusterNotification) = Nothing, Optional isHttpGatewayExclusiveAuthModeEnabled As Nullable(Of Boolean) = Nothing, Optional etag As Nullable(Of ETag) = Nothing) As ServiceFabricClusterData

Parameters

id
ResourceIdentifier

The id.

name
String

The name.

resourceType
ResourceType

The resourceType.

systemData
SystemData

The systemData.

tags
IDictionary<String,String>

The tags.

location
AzureLocation

The location.

addOnFeatures
IEnumerable<ClusterAddOnFeature>

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

availableClusterVersions
IEnumerable<ClusterVersionDetails>

The Service Fabric runtime versions available for this cluster.

azureActiveDirectory
ClusterAadSetting

The AAD authentication settings of the cluster.

certificate
ClusterCertificateDescription

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
ClusterServerCertificateCommonNames

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

clientCertificateCommonNames
IEnumerable<ClusterClientCertificateCommonName>

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

clientCertificateThumbprints
IEnumerable<ClusterClientCertificateThumbprint>

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
Uri

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

clusterId
Nullable<Guid>

A service generated unique identifier for the cluster resource.

clusterState
Nullable<ServiceFabricClusterState>

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.
diagnosticsStorageAccountConfig
DiagnosticsStorageAccountConfig

The storage account information for storing Service Fabric diagnostic logs.

isEventStoreServiceEnabled
Nullable<Boolean>

Indicates if the event store service is enabled.

fabricSettings
IEnumerable<SettingsSectionDescription>

The list of custom fabric settings to configure the cluster.

managementEndpoint
Uri

The http management endpoint of the cluster.

nodeTypes
IEnumerable<ClusterNodeTypeDescription>

The list of node types in the cluster.

provisioningState
Nullable<ServiceFabricProvisioningState>

The provisioning state of the cluster resource.

reliabilityLevel
Nullable<ClusterReliabilityLevel>

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
ClusterCertificateDescription

The server certificate used by reverse proxy.

reverseProxyCertificateCommonNames
ClusterServerCertificateCommonNames

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
Nullable<ClusterUpgradeMode>

The upgrade mode of the cluster when new Service Fabric runtime version is available.

maxUnusedVersionsToKeep
Nullable<Int64>

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.

serviceFabricZonalUpgradeMode
Nullable<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.

vmssZonalUpgradeMode
Nullable<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.

isInfrastructureServiceManagerEnabled
Nullable<Boolean>

Indicates if infrastructure service manager is enabled.

upgradeWave
Nullable<ClusterUpgradeCadence>

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'.

upgradePauseStartOn
Nullable<DateTimeOffset>

Indicates the start date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC).

upgradePauseEndOn
Nullable<DateTimeOffset>

Indicates the end date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC).

isWaveUpgradePaused
Nullable<Boolean>

Boolean to pause automatic runtime version upgrades to the cluster.

notifications
IEnumerable<ClusterNotification>

Indicates a list of notification channels for cluster events.

isHttpGatewayExclusiveAuthModeEnabled
Nullable<Boolean>

If true, token-based authentication is not allowed on the HttpGatewayEndpoint. This is required to support TLS versions 1.3 and above. If token-based authentication is used, HttpGatewayTokenAuthEndpointPort must be defined.

etag
Nullable<ETag>

Azure resource etag.

Returns

A new ServiceFabricClusterData instance for mocking.

Applies to