Share via


ServiceFabricClusterData Class

Definition

A class representing the ServiceFabricCluster data model. The cluster resource

public class ServiceFabricClusterData : Azure.ResourceManager.Models.TrackedResourceData
public class ServiceFabricClusterData : Azure.ResourceManager.Models.TrackedResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ServiceFabric.ServiceFabricClusterData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ServiceFabric.ServiceFabricClusterData>
type ServiceFabricClusterData = class
    inherit TrackedResourceData
type ServiceFabricClusterData = class
    inherit TrackedResourceData
    interface IJsonModel<ServiceFabricClusterData>
    interface IPersistableModel<ServiceFabricClusterData>
Public Class ServiceFabricClusterData
Inherits TrackedResourceData
Public Class ServiceFabricClusterData
Inherits TrackedResourceData
Implements IJsonModel(Of ServiceFabricClusterData), IPersistableModel(Of ServiceFabricClusterData)
Inheritance
ServiceFabricClusterData
Implements

Constructors

ServiceFabricClusterData(AzureLocation)

Initializes a new instance of ServiceFabricClusterData.

Properties

AddOnFeatures

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

AvailableClusterVersions

The Service Fabric runtime versions available for this cluster.

AzureActiveDirectory

The AAD authentication settings of the cluster.

Certificate

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

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

ClientCertificateCommonNames

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

ClientCertificateThumbprints

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

ClusterCodeVersion

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

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

ClusterId

A service generated unique identifier for the cluster resource.

ClusterState

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

The storage account information for storing Service Fabric diagnostic logs.

ETag

Azure resource etag.

FabricSettings

The list of custom fabric settings to configure the cluster.

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
IsEventStoreServiceEnabled

Indicates if the event store service is enabled.

IsHttpGatewayExclusiveAuthModeEnabled

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.

IsInfrastructureServiceManagerEnabled

Indicates if infrastructure service manager is enabled.

IsWaveUpgradePaused

Boolean to pause automatic runtime version upgrades to the cluster.

Location

The geo-location where the resource lives.

(Inherited from TrackedResourceData)
ManagementEndpoint

The http management endpoint of the cluster.

MaxUnusedVersionsToKeep

Number of unused versions per application type to keep.

Name

The name of the resource.

(Inherited from ResourceData)
NodeTypes

The list of node types in the cluster.

Notifications

Indicates a list of notification channels for cluster events.

ProvisioningState

The provisioning state of the cluster resource.

ReliabilityLevel

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

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
ReverseProxyCertificate

The server certificate used by reverse proxy.

ReverseProxyCertificateCommonNames

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

ServiceFabricZonalUpgradeMode

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.

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
Tags

Resource tags.

(Inherited from TrackedResourceData)
UpgradeDescription

The policy to use when upgrading the cluster.

UpgradeMode

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

UpgradePauseEndOn

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

UpgradePauseStartOn

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

UpgradeWave

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

VmImage

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

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.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from TrackedResourceData)

Explicit Interface Implementations

IJsonModel<ServiceFabricClusterData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<ServiceFabricClusterData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ServiceFabricClusterData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ServiceFabricClusterData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<ServiceFabricClusterData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to