ServiceFabricManagedClusterData Class

Definition

A class representing the ServiceFabricManagedCluster data model. The managed cluster resource

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

Constructors

ServiceFabricManagedClusterData(AzureLocation, ServiceFabricManagedClustersSku)

Initializes a new instance of ServiceFabricManagedClusterData.

ServiceFabricManagedClusterData(AzureLocation)

Initializes a new instance of ServiceFabricManagedClusterData.

Properties

AddOnFeatures

List of add-on features to enable on the cluster.

AdminPassword

VM admin user password.

AdminUserName

VM admin user name.

AllocatedOutboundPorts

The number of outbound ports allocated for SNAT for each node in the backend pool of the default load balancer. The default value is 0 which provides dynamic port allocation based on pool size.

AutoGeneratedDomainNameLabelScope

This property is the entry point to using a public CA cert for your cluster cert. It specifies the level of reuse allowed for the custom FQDN created, matching the subject of the public CA cert.

AuxiliarySubnets

Auxiliary subnets for the cluster.

AzureActiveDirectory

The AAD authentication settings of the cluster.

ClientConnectionPort

The port used for client connections to the cluster.

Clients

Client certificates that are allowed to manage the cluster.

ClusterCertificateThumbprints

List of thumbprints of the cluster certificates.

To assign an object to the element of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

ClusterCodeVersion

The Service Fabric runtime version of the cluster. This property is required when clusterUpgradeMode 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.

ClusterId

A service generated unique identifier for the cluster resource.

ClusterState

The current state of the cluster.

ClusterUpgradeCadence

Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when clusterUpgradeMode is set to 'Automatic'.

ClusterUpgradeMode

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

DdosProtectionPlanId

Specify the resource id of a DDoS network protection plan that will be associated with the virtual network of the cluster.

DnsName

The cluster dns name.

ETag

Azure resource etag.

FabricSettings

The list of custom fabric settings to configure the cluster.

Fqdn

The fully qualified domain name associated with the public load balancer of the cluster.

HasZoneResiliency

Indicates if the cluster has zone resiliency.

HttpGatewayConnectionPort

The port used for HTTP connections to the cluster.

HttpGatewayTokenAuthConnectionPort

The port used for token-auth based HTTPS connections to the cluster. Cannot be set to the same port as HttpGatewayEndpoint.

Id

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

(Inherited from ResourceData)
IPTags

The list of IP tags associated with the default public IP address of the cluster.

IPv4Address

The IPv4 address associated with the public load balancer of the cluster.

IPv6Address

IPv6 address for the cluster if IPv6 is enabled.

IsAutoOSUpgradeEnabled

Enables automatic OS upgrade for node types created using OS images with version 'latest'. The default value for this setting is false.

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, HttpGatewayTokenAuthConnectionPort must be defined.

IsIPv6Enabled

Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false.

IsRdpAccessAllowed

Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false.

IsServicePublicIPEnabled

Setting this to true will link the IPv4 address as the ServicePublicIP of the IPv6 address. It can only be set to True if IPv6 is enabled on the cluster.

LoadBalancingRules

Load balancing rules that are applied to the public load balancer of the cluster.

Location

The geo-location where the resource lives.

(Inherited from TrackedResourceData)
MaxUnusedVersionsToKeep

Number of unused versions per application type to keep.

Name

The name of the resource.

(Inherited from ResourceData)
NetworkSecurityRules

Custom Network Security Rules that are applied to the Virtual Network of the cluster.

ProvisioningState

The provisioning state of the managed cluster resource.

PublicIPPrefixId

Specify the resource id of a public IPv4 prefix that the load balancer will allocate a public IPv4 address from. This setting cannot be changed once the cluster is created.

PublicIPv6PrefixId

Specify the resource id of a public IPv6 prefix that the load balancer will allocate a public IPv6 address from. This setting cannot be changed once the cluster is created.

ResourceType

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

(Inherited from ResourceData)
ServiceEndpoints

Service endpoints for subnets in the cluster.

SkuName

Sku Name.

SubnetId

If specified, the node types for the cluster are created in this subnet instead of the default VNet. The networkSecurityRules specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created.

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.

UseCustomVnet

For new clusters, this parameter indicates that it uses Bring your own VNet, but the subnet is specified at node type level; and for such clusters, the subnetId property is required for node types.

ZonalUpdateMode

Indicates the update mode for Cross Az clusters.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from TrackedResourceData)

Explicit Interface Implementations

IJsonModel<ServiceFabricManagedClusterData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<ServiceFabricManagedClusterData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ServiceFabricManagedClusterData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ServiceFabricManagedClusterData>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<ServiceFabricManagedClusterData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to