ClusterInner Class

Package:: com.azure.resourcemanager.servicefabric.fluent.models

Maven Artifact:: com.azure.resourcemanager:azure-resourcemanager-servicefabric:1.0.0

java.lang.Object
- com.azure.core.management.ProxyResource
- - com.azure.core.management.Resource
  - - com.azure.resourcemanager.servicefabric.fluent.models.ClusterInner

public final class ClusterInner
extends Resource

The cluster resource.

Constructor Summary

Constructor	Description
ClusterInner()	Creates an instance of ClusterInner class.

Method Summary

Modifier and Type	Method and Description
List<AddOnFeatures>	addOnFeatures() Get the addOnFeatures property: The list of add-on features to enable in the cluster.
ApplicationTypeVersionsCleanupPolicy	applicationTypeVersionsCleanupPolicy() Get the applicationTypeVersionsCleanupPolicy property: The policy used to clean up unused versions.
List<ClusterVersionDetails>	availableClusterVersions() Get the availableClusterVersions property: The Service Fabric runtime versions available for this cluster.
AzureActiveDirectory	azureActiveDirectory() Get the azureActiveDirectory property: The AAD authentication settings of the cluster.
CertificateDescription	certificate() Get the certificate property: The certificate to use for securing the cluster.
ServerCertificateCommonNames	certificateCommonNames() Get the certificateCommonNames property: Describes a list of server certificates referenced by common name that are used to secure the cluster.
List<ClientCertificateCommonName>	clientCertificateCommonNames() Get the clientCertificateCommonNames property: The list of client certificates referenced by common name that are allowed to manage the cluster.
List<ClientCertificateThumbprint>	clientCertificateThumbprints() Get the clientCertificateThumbprints property: The list of client certificates referenced by thumbprint that are allowed to manage the cluster.
String	clusterCodeVersion() Get the clusterCodeVersion property: The Service Fabric runtime version of the cluster.
String	clusterEndpoint() Get the clusterEndpoint property: The Azure Resource Provider endpoint.
String	clusterId() Get the clusterId property: A service generated unique identifier for the cluster resource.
ClusterState	clusterState() Get the clusterState property: The current state of the cluster.
DiagnosticsStorageAccountConfig	diagnosticsStorageAccountConfig() Get the diagnosticsStorageAccountConfig property: The storage account information for storing Service Fabric diagnostic logs.
String	etag() Get the etag property: Azure resource etag.
Boolean	eventStoreServiceEnabled() Get the eventStoreServiceEnabled property: Indicates if the event store service is enabled.
List<SettingsSectionDescription>	fabricSettings() Get the fabricSettings property: The list of custom fabric settings to configure the cluster.
static ClusterInner	fromJson(JsonReader jsonReader) Reads an instance of ClusterInner from the JsonReader.
String	id() Get the id property: Fully qualified resource Id for the resource.
Boolean	infrastructureServiceManager() Get the infrastructureServiceManager property: Indicates if infrastructure service manager is enabled.
String	managementEndpoint() Get the managementEndpoint property: The http management endpoint of the cluster.
String	name() Get the name property: The name of the resource.
List<NodeTypeDescription>	nodeTypes() Get the nodeTypes property: The list of node types in the cluster.
List<Notification>	notifications() Get the notifications property: Indicates a list of notification channels for cluster events.
ProvisioningState	provisioningState() Get the provisioningState property: The provisioning state of the cluster resource.
ReliabilityLevel	reliabilityLevel() Get the reliabilityLevel property: The reliability level sets the replica set size of system services.
CertificateDescription	reverseProxyCertificate() Get the reverseProxyCertificate property: The server certificate used by reverse proxy.
ServerCertificateCommonNames	reverseProxyCertificateCommonNames() Get the reverseProxyCertificateCommonNames property: Describes a list of server certificates referenced by common name that are used to secure the cluster.
SfZonalUpgradeMode	sfZonalUpgradeMode() Get the sfZonalUpgradeMode property: This property controls the logical grouping of VMs in upgrade domains (UDs).
SystemData	systemData() Get the systemData property: Metadata pertaining to creation and last modification of the resource.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: The type of the resource.
ClusterUpgradePolicy	upgradeDescription() Get the upgradeDescription property: The policy to use when upgrading the cluster.
UpgradeMode	upgradeMode() Get the upgradeMode property: The upgrade mode of the cluster when new Service Fabric runtime version is available.
OffsetDateTime	upgradePauseEndTimestampUtc() Get the upgradePauseEndTimestampUtc property: 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).
OffsetDateTime	upgradePauseStartTimestampUtc() Get the upgradePauseStartTimestampUtc property: 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).
ClusterUpgradeCadence	upgradeWave() Get the upgradeWave property: Indicates when new cluster runtime version upgrades will be applied after they are released.
void	validate() Validates the instance.
String	vmImage() Get the vmImage property: The VM image VMSS has been configured with.
VmssZonalUpgradeMode	vmssZonalUpgradeMode() Get the vmssZonalUpgradeMode property: 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.
Boolean	waveUpgradePaused() Get the waveUpgradePaused property: Boolean to pause automatic runtime version upgrades to the cluster.
ClusterInner	withAddOnFeatures(List<AddOnFeatures> addOnFeatures) Set the addOnFeatures property: The list of add-on features to enable in the cluster.
ClusterInner	withApplicationTypeVersionsCleanupPolicy(ApplicationTypeVersionsCleanupPolicy applicationTypeVersionsCleanupPolicy) Set the applicationTypeVersionsCleanupPolicy property: The policy used to clean up unused versions.
ClusterInner	withAzureActiveDirectory(AzureActiveDirectory azureActiveDirectory) Set the azureActiveDirectory property: The AAD authentication settings of the cluster.
ClusterInner	withCertificate(CertificateDescription certificate) Set the certificate property: The certificate to use for securing the cluster.
ClusterInner	withCertificateCommonNames(ServerCertificateCommonNames certificateCommonNames) Set the certificateCommonNames property: Describes a list of server certificates referenced by common name that are used to secure the cluster.
ClusterInner	withClientCertificateCommonNames(List<ClientCertificateCommonName> clientCertificateCommonNames) Set the clientCertificateCommonNames property: The list of client certificates referenced by common name that are allowed to manage the cluster.
ClusterInner	withClientCertificateThumbprints(List<ClientCertificateThumbprint> clientCertificateThumbprints) Set the clientCertificateThumbprints property: The list of client certificates referenced by thumbprint that are allowed to manage the cluster.
ClusterInner	withClusterCodeVersion(String clusterCodeVersion) Set the clusterCodeVersion property: The Service Fabric runtime version of the cluster.
ClusterInner	withDiagnosticsStorageAccountConfig(DiagnosticsStorageAccountConfig diagnosticsStorageAccountConfig) Set the diagnosticsStorageAccountConfig property: The storage account information for storing Service Fabric diagnostic logs.
ClusterInner	withEventStoreServiceEnabled(Boolean eventStoreServiceEnabled) Set the eventStoreServiceEnabled property: Indicates if the event store service is enabled.
ClusterInner	withFabricSettings(List<SettingsSectionDescription> fabricSettings) Set the fabricSettings property: The list of custom fabric settings to configure the cluster.
ClusterInner	withInfrastructureServiceManager(Boolean infrastructureServiceManager) Set the infrastructureServiceManager property: Indicates if infrastructure service manager is enabled.
ClusterInner	withLocation(String location)
ClusterInner	withManagementEndpoint(String managementEndpoint) Set the managementEndpoint property: The http management endpoint of the cluster.
ClusterInner	withNodeTypes(List<NodeTypeDescription> nodeTypes) Set the nodeTypes property: The list of node types in the cluster.
ClusterInner	withNotifications(List<Notification> notifications) Set the notifications property: Indicates a list of notification channels for cluster events.
ClusterInner	withReliabilityLevel(ReliabilityLevel reliabilityLevel) Set the reliabilityLevel property: The reliability level sets the replica set size of system services.
ClusterInner	withReverseProxyCertificate(CertificateDescription reverseProxyCertificate) Set the reverseProxyCertificate property: The server certificate used by reverse proxy.
ClusterInner	withReverseProxyCertificateCommonNames(ServerCertificateCommonNames reverseProxyCertificateCommonNames) Set the reverseProxyCertificateCommonNames property: Describes a list of server certificates referenced by common name that are used to secure the cluster.
ClusterInner	withSfZonalUpgradeMode(SfZonalUpgradeMode sfZonalUpgradeMode) Set the sfZonalUpgradeMode property: This property controls the logical grouping of VMs in upgrade domains (UDs).
ClusterInner	withTags(Map<String,String> tags)
ClusterInner	withUpgradeDescription(ClusterUpgradePolicy upgradeDescription) Set the upgradeDescription property: The policy to use when upgrading the cluster.
ClusterInner	withUpgradeMode(UpgradeMode upgradeMode) Set the upgradeMode property: The upgrade mode of the cluster when new Service Fabric runtime version is available.
ClusterInner	withUpgradePauseEndTimestampUtc(OffsetDateTime upgradePauseEndTimestampUtc) Set the upgradePauseEndTimestampUtc property: 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).
ClusterInner	withUpgradePauseStartTimestampUtc(OffsetDateTime upgradePauseStartTimestampUtc) Set the upgradePauseStartTimestampUtc property: 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).
ClusterInner	withUpgradeWave(ClusterUpgradeCadence upgradeWave) Set the upgradeWave property: Indicates when new cluster runtime version upgrades will be applied after they are released.
ClusterInner	withVmImage(String vmImage) Set the vmImage property: The VM image VMSS has been configured with.
ClusterInner	withVmssZonalUpgradeMode(VmssZonalUpgradeMode vmssZonalUpgradeMode) Set the vmssZonalUpgradeMode property: 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.
ClusterInner	withWaveUpgradePaused(Boolean waveUpgradePaused) Set the waveUpgradePaused property: Boolean to pause automatic runtime version upgrades to the cluster.

Methods inherited from ProxyResource

id name type

Methods inherited from Resource

fromJson location tags toJson withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ClusterInner

public ClusterInner()

Creates an instance of ClusterInner class.

Method Details

addOnFeatures

public List<AddOnFeatures> addOnFeatures()

Get the addOnFeatures property: The list of add-on features to enable in the cluster.

Returns:

the addOnFeatures value.

applicationTypeVersionsCleanupPolicy

public ApplicationTypeVersionsCleanupPolicy applicationTypeVersionsCleanupPolicy()

Get the applicationTypeVersionsCleanupPolicy property: The policy used to clean up unused versions.

Returns:

the applicationTypeVersionsCleanupPolicy value.

availableClusterVersions

public List<ClusterVersionDetails> availableClusterVersions()

Get the availableClusterVersions property: The Service Fabric runtime versions available for this cluster.

Returns:

the availableClusterVersions value.

azureActiveDirectory

public AzureActiveDirectory azureActiveDirectory()

Get the azureActiveDirectory property: The AAD authentication settings of the cluster.

Returns:

the azureActiveDirectory value.

certificate

public CertificateDescription certificate()

Get the certificate property: 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.

Returns:

the certificate value.

certificateCommonNames

public ServerCertificateCommonNames certificateCommonNames()

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

Returns:

the certificateCommonNames value.

clientCertificateCommonNames

public List<ClientCertificateCommonName> clientCertificateCommonNames()

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

Returns:

the clientCertificateCommonNames value.

clientCertificateThumbprints

public List<ClientCertificateThumbprint> clientCertificateThumbprints()

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

Returns:

the clientCertificateThumbprints value.

clusterCodeVersion

public String clusterCodeVersion()

Get the clusterCodeVersion property: 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](https://learn.microsoft.com/rest/api/servicefabric/cluster-versions/list). To get the list of available version for existing clusters use **availableClusterVersions**.

Returns:

the clusterCodeVersion value.

clusterEndpoint

public String clusterEndpoint()

Get the clusterEndpoint property: The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint.

Returns:

the clusterEndpoint value.

clusterId

public String clusterId()

Get the clusterId property: A service generated unique identifier for the cluster resource.

Returns:

the clusterId value.

clusterState

public ClusterState clusterState()

Get the clusterState property: 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.

Returns:

the clusterState value.

diagnosticsStorageAccountConfig

public DiagnosticsStorageAccountConfig diagnosticsStorageAccountConfig()

Get the diagnosticsStorageAccountConfig property: The storage account information for storing Service Fabric diagnostic logs.

Returns:

the diagnosticsStorageAccountConfig value.

etag

public String etag()

Get the etag property: Azure resource etag.

Returns:

the etag value.

eventStoreServiceEnabled

public Boolean eventStoreServiceEnabled()

Get the eventStoreServiceEnabled property: Indicates if the event store service is enabled.

Returns:

the eventStoreServiceEnabled value.

fabricSettings

public List<SettingsSectionDescription> fabricSettings()

Get the fabricSettings property: The list of custom fabric settings to configure the cluster.

Returns:

the fabricSettings value.

fromJson

public static ClusterInner fromJson(JsonReader jsonReader)

Reads an instance of ClusterInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ClusterInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

ClusterInner.id()

Returns:

the id value.

infrastructureServiceManager

public Boolean infrastructureServiceManager()

Get the infrastructureServiceManager property: Indicates if infrastructure service manager is enabled.

Returns:

the infrastructureServiceManager value.

managementEndpoint

public String managementEndpoint()

Get the managementEndpoint property: The http management endpoint of the cluster.

Returns:

the managementEndpoint value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

ClusterInner.name()

Returns:

the name value.

nodeTypes

public List<NodeTypeDescription> nodeTypes()

Get the nodeTypes property: The list of node types in the cluster.

Returns:

the nodeTypes value.

notifications

public List<Notification> notifications()

Get the notifications property: Indicates a list of notification channels for cluster events.

Returns:

the notifications value.

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the cluster resource.

Returns:

the provisioningState value.

reliabilityLevel

public ReliabilityLevel reliabilityLevel()

Get the reliabilityLevel property: The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - 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.

Returns:

the reliabilityLevel value.

reverseProxyCertificate

public CertificateDescription reverseProxyCertificate()

Get the reverseProxyCertificate property: The server certificate used by reverse proxy.

Returns:

the reverseProxyCertificate value.

reverseProxyCertificateCommonNames

public ServerCertificateCommonNames reverseProxyCertificateCommonNames()

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

Returns:

the reverseProxyCertificateCommonNames value.

sfZonalUpgradeMode

public SfZonalUpgradeMode sfZonalUpgradeMode()

Get the sfZonalUpgradeMode property: 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.

Returns:

the sfZonalUpgradeMode value.

systemData

public SystemData systemData()

Get the systemData property: Metadata pertaining to creation and last modification of the resource.

Returns:

the systemData value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ClusterInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: The type of the resource.

Overrides:

ClusterInner.type()

Returns:

the type value.

upgradeDescription

public ClusterUpgradePolicy upgradeDescription()

Get the upgradeDescription property: The policy to use when upgrading the cluster.

Returns:

the upgradeDescription value.

upgradeMode

public UpgradeMode upgradeMode()

Get the upgradeMode property: The upgrade mode of the cluster when new Service Fabric runtime version is available.

Returns:

the upgradeMode value.

upgradePauseEndTimestampUtc

public OffsetDateTime upgradePauseEndTimestampUtc()

Get the upgradePauseEndTimestampUtc property: 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).

Returns:

the upgradePauseEndTimestampUtc value.

upgradePauseStartTimestampUtc

public OffsetDateTime upgradePauseStartTimestampUtc()

Get the upgradePauseStartTimestampUtc property: 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).

Returns:

the upgradePauseStartTimestampUtc value.

upgradeWave

public ClusterUpgradeCadence upgradeWave()

Get the upgradeWave property: 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'.

Returns:

the upgradeWave value.

validate

public void validate()

Validates the instance.

vmImage

public String vmImage()

Get the vmImage property: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used.

Returns:

the vmImage value.

vmssZonalUpgradeMode

public VmssZonalUpgradeMode vmssZonalUpgradeMode()

Get the vmssZonalUpgradeMode property: 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.

Returns:

the vmssZonalUpgradeMode value.

waveUpgradePaused

public Boolean waveUpgradePaused()

Get the waveUpgradePaused property: Boolean to pause automatic runtime version upgrades to the cluster.

Returns:

the waveUpgradePaused value.

withAddOnFeatures

public ClusterInner withAddOnFeatures(List<AddOnFeatures> addOnFeatures)

Set the addOnFeatures property: The list of add-on features to enable in the cluster.

Parameters:

addOnFeatures - the addOnFeatures value to set.

Returns:

the ClusterInner object itself.

withApplicationTypeVersionsCleanupPolicy

public ClusterInner withApplicationTypeVersionsCleanupPolicy(ApplicationTypeVersionsCleanupPolicy applicationTypeVersionsCleanupPolicy)

Set the applicationTypeVersionsCleanupPolicy property: The policy used to clean up unused versions.

Parameters:

applicationTypeVersionsCleanupPolicy - the applicationTypeVersionsCleanupPolicy value to set.

Returns:

the ClusterInner object itself.

withAzureActiveDirectory

public ClusterInner withAzureActiveDirectory(AzureActiveDirectory azureActiveDirectory)

Set the azureActiveDirectory property: The AAD authentication settings of the cluster.

Parameters:

azureActiveDirectory - the azureActiveDirectory value to set.

Returns:

the ClusterInner object itself.

withCertificate

public ClusterInner withCertificate(CertificateDescription certificate)

Set the certificate property: 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.

Parameters:

certificate - the certificate value to set.

Returns:

the ClusterInner object itself.

withCertificateCommonNames

public ClusterInner withCertificateCommonNames(ServerCertificateCommonNames certificateCommonNames)

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

Parameters:

certificateCommonNames - the certificateCommonNames value to set.

Returns:

the ClusterInner object itself.

withClientCertificateCommonNames

public ClusterInner withClientCertificateCommonNames(List<ClientCertificateCommonName> clientCertificateCommonNames)

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

Parameters:

clientCertificateCommonNames - the clientCertificateCommonNames value to set.

Returns:

the ClusterInner object itself.

withClientCertificateThumbprints

public ClusterInner withClientCertificateThumbprints(List<ClientCertificateThumbprint> clientCertificateThumbprints)

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

Parameters:

clientCertificateThumbprints - the clientCertificateThumbprints value to set.

Returns:

the ClusterInner object itself.

withClusterCodeVersion

public ClusterInner withClusterCodeVersion(String clusterCodeVersion)

Set the clusterCodeVersion property: 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](https://learn.microsoft.com/rest/api/servicefabric/cluster-versions/list). To get the list of available version for existing clusters use **availableClusterVersions**.

Parameters:

clusterCodeVersion - the clusterCodeVersion value to set.

Returns:

the ClusterInner object itself.

withDiagnosticsStorageAccountConfig

public ClusterInner withDiagnosticsStorageAccountConfig(DiagnosticsStorageAccountConfig diagnosticsStorageAccountConfig)

Set the diagnosticsStorageAccountConfig property: The storage account information for storing Service Fabric diagnostic logs.

Parameters:

diagnosticsStorageAccountConfig - the diagnosticsStorageAccountConfig value to set.

Returns:

the ClusterInner object itself.

withEventStoreServiceEnabled

public ClusterInner withEventStoreServiceEnabled(Boolean eventStoreServiceEnabled)

Set the eventStoreServiceEnabled property: Indicates if the event store service is enabled.

Parameters:

eventStoreServiceEnabled - the eventStoreServiceEnabled value to set.

Returns:

the ClusterInner object itself.

withFabricSettings

public ClusterInner withFabricSettings(List<SettingsSectionDescription> fabricSettings)

Set the fabricSettings property: The list of custom fabric settings to configure the cluster.

Parameters:

fabricSettings - the fabricSettings value to set.

Returns:

the ClusterInner object itself.

withInfrastructureServiceManager

public ClusterInner withInfrastructureServiceManager(Boolean infrastructureServiceManager)

Set the infrastructureServiceManager property: Indicates if infrastructure service manager is enabled.

Parameters:

infrastructureServiceManager - the infrastructureServiceManager value to set.

Returns:

the ClusterInner object itself.

withLocation

public ClusterInner withLocation(String location)

Overrides:

ClusterInner.withLocation(String location)

Parameters:

location

withManagementEndpoint

public ClusterInner withManagementEndpoint(String managementEndpoint)

Set the managementEndpoint property: The http management endpoint of the cluster.

Parameters:

managementEndpoint - the managementEndpoint value to set.

Returns:

the ClusterInner object itself.

withNodeTypes

public ClusterInner withNodeTypes(List<NodeTypeDescription> nodeTypes)

Set the nodeTypes property: The list of node types in the cluster.

Parameters:

nodeTypes - the nodeTypes value to set.

Returns:

the ClusterInner object itself.

withNotifications

public ClusterInner withNotifications(List<Notification> notifications)

Set the notifications property: Indicates a list of notification channels for cluster events.

Parameters:

notifications - the notifications value to set.

Returns:

the ClusterInner object itself.

withReliabilityLevel

public ClusterInner withReliabilityLevel(ReliabilityLevel reliabilityLevel)

Set the reliabilityLevel property: The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - 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.

Parameters:

reliabilityLevel - the reliabilityLevel value to set.

Returns:

the ClusterInner object itself.

withReverseProxyCertificate

public ClusterInner withReverseProxyCertificate(CertificateDescription reverseProxyCertificate)

Set the reverseProxyCertificate property: The server certificate used by reverse proxy.

Parameters:

reverseProxyCertificate - the reverseProxyCertificate value to set.

Returns:

the ClusterInner object itself.

withReverseProxyCertificateCommonNames

public ClusterInner withReverseProxyCertificateCommonNames(ServerCertificateCommonNames reverseProxyCertificateCommonNames)

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

Parameters:

reverseProxyCertificateCommonNames - the reverseProxyCertificateCommonNames value to set.

Returns:

the ClusterInner object itself.

withSfZonalUpgradeMode

public ClusterInner withSfZonalUpgradeMode(SfZonalUpgradeMode sfZonalUpgradeMode)

Set the sfZonalUpgradeMode property: 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.

Parameters:

sfZonalUpgradeMode - the sfZonalUpgradeMode value to set.

Returns:

the ClusterInner object itself.

withTags

public ClusterInner withTags(Map<String,String> tags)

Overrides:

ClusterInner.withTags(Map<String,String> tags)

Parameters:

withUpgradeDescription

public ClusterInner withUpgradeDescription(ClusterUpgradePolicy upgradeDescription)

Set the upgradeDescription property: The policy to use when upgrading the cluster.

Parameters:

upgradeDescription - the upgradeDescription value to set.

Returns:

the ClusterInner object itself.

withUpgradeMode

public ClusterInner withUpgradeMode(UpgradeMode upgradeMode)

Set the upgradeMode property: The upgrade mode of the cluster when new Service Fabric runtime version is available.

Parameters:

upgradeMode - the upgradeMode value to set.

Returns:

the ClusterInner object itself.

withUpgradePauseEndTimestampUtc

public ClusterInner withUpgradePauseEndTimestampUtc(OffsetDateTime upgradePauseEndTimestampUtc)

Set the upgradePauseEndTimestampUtc property: 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).

Parameters:

upgradePauseEndTimestampUtc - the upgradePauseEndTimestampUtc value to set.

Returns:

the ClusterInner object itself.

withUpgradePauseStartTimestampUtc

public ClusterInner withUpgradePauseStartTimestampUtc(OffsetDateTime upgradePauseStartTimestampUtc)

Set the upgradePauseStartTimestampUtc property: 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).

Parameters:

upgradePauseStartTimestampUtc - the upgradePauseStartTimestampUtc value to set.

Returns:

the ClusterInner object itself.

withUpgradeWave

public ClusterInner withUpgradeWave(ClusterUpgradeCadence upgradeWave)

Set the upgradeWave property: 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'.

Parameters:

upgradeWave - the upgradeWave value to set.

Returns:

the ClusterInner object itself.

withVmImage

public ClusterInner withVmImage(String vmImage)

Set the vmImage property: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used.

Parameters:

vmImage - the vmImage value to set.

Returns:

the ClusterInner object itself.

withVmssZonalUpgradeMode

public ClusterInner withVmssZonalUpgradeMode(VmssZonalUpgradeMode vmssZonalUpgradeMode)

Set the vmssZonalUpgradeMode property: 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.

Parameters:

vmssZonalUpgradeMode - the vmssZonalUpgradeMode value to set.

Returns:

the ClusterInner object itself.

withWaveUpgradePaused

public ClusterInner withWaveUpgradePaused(Boolean waveUpgradePaused)

Set the waveUpgradePaused property: Boolean to pause automatic runtime version upgrades to the cluster.

Parameters:

waveUpgradePaused - the waveUpgradePaused value to set.

Returns:

the ClusterInner object itself.

Applies to

Feedback

Was this page helpful?