Share via


ServiceFabricClusterPatch Class

Definition

Cluster update request.

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

Constructors

ServiceFabricClusterPatch()

Initializes a new instance of ServiceFabricClusterPatch.

Properties

AddOnFeatures

The list of add-on features to enable in 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. This will overwrite the existing list.

ClientCertificateThumbprints

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

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.

FabricSettings

The list of custom fabric settings to configure the cluster. This will overwrite the existing list.

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.

MaxUnusedVersionsToKeep

Number of unused versions per application type to keep.

NodeTypes

The list of node types in the cluster. This will overwrite the existing list.

Notifications

Indicates a list of notification channels for cluster events.

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

The server certificate used by reverse proxy.

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.

Tags

Cluster update parameters.

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

The end timestamp of pause runtime version upgrades on the cluster (UTC).

UpgradePauseStartOn

The start timestamp to pause runtime version upgrades 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'.

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.

Explicit Interface Implementations

IJsonModel<ServiceFabricClusterPatch>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<ServiceFabricClusterPatch>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ServiceFabricClusterPatch>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ServiceFabricClusterPatch>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<ServiceFabricClusterPatch>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to