PSCluster Class

Definition

Namespace:

Microsoft.Azure.Commands.ServiceFabric.Models

Assembly:

Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll

public class PSCluster : Microsoft.Azure.Management.ServiceFabric.Models.Cluster

type PSCluster = class
    inherit Cluster

Public Class PSCluster
Inherits Cluster

Inheritance

Object

Resource

Cluster

PSCluster

Constructors

PSCluster(Cluster)

Properties

AddOnFeatures	Gets or sets the list of add-on features to enable in the cluster. (Inherited from Cluster)
ApplicationTypeVersionsCleanupPolicy	Gets or sets the policy used to clean up unused versions. (Inherited from Cluster)
AvailableClusterVersions	Gets the Service Fabric runtime versions available for this cluster. (Inherited from Cluster)
AzureActiveDirectory	Gets or sets the AAD authentication settings of the cluster. (Inherited from Cluster)
Certificate	Gets or sets 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. (Inherited from Cluster)
CertificateCommonNames	Gets or sets describes a list of server certificates referenced by common name that are used to secure the cluster. (Inherited from Cluster)
ClientCertificateCommonNames	Gets or sets the list of client certificates referenced by common name that are allowed to manage the cluster. (Inherited from Cluster)
ClientCertificateThumbprints	Gets or sets the list of client certificates referenced by thumbprint that are allowed to manage the cluster. (Inherited from Cluster)
ClusterCodeVersion	Gets or sets 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. (Inherited from Cluster)
ClusterEndpoint	Gets the Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint. (Inherited from Cluster)
ClusterId	Gets a service generated unique identifier for the cluster resource. (Inherited from Cluster)
ClusterState	Gets 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. Possible values include: 'WaitingForNodes', 'Deploying', 'BaselineUpgrade', 'UpdatingUserConfiguration', 'UpdatingUserCertificate', 'UpdatingInfrastructure', 'EnforcingClusterVersion', 'UpgradeServiceUnreachable', 'AutoScale', 'Ready' (Inherited from Cluster)
DiagnosticsStorageAccountConfig	Gets or sets the storage account information for storing Service Fabric diagnostic logs. (Inherited from Cluster)
Etag	Gets azure resource etag. (Inherited from Resource)
EventStoreServiceEnabled	Gets or sets indicates if the event store service is enabled. (Inherited from Cluster)
FabricSettings	Gets or sets the list of custom fabric settings to configure the cluster. (Inherited from Cluster)
Id	Gets azure resource identifier. (Inherited from Resource)
InfrastructureServiceManager	Gets or sets indicates if infrastructure service manager is enabled. (Inherited from Cluster)
Location	Gets or sets azure resource location. (Inherited from Resource)
ManagementEndpoint	Gets or sets the http management endpoint of the cluster. (Inherited from Cluster)
Name	Gets azure resource name. (Inherited from Resource)
NodeTypes	Gets or sets the list of node types in the cluster. (Inherited from Cluster)
Notifications	Gets or sets indicates a list of notification channels for cluster events. (Inherited from Cluster)
ProvisioningState	Gets the provisioning state of the cluster resource. Possible values include: 'Updating', 'Succeeded', 'Failed', 'Canceled' (Inherited from Cluster)
PSClusterString
ReliabilityLevel	Gets or sets 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. Possible values include: 'None', 'Bronze', 'Silver', 'Gold', 'Platinum' (Inherited from Cluster)
ReverseProxyCertificate	Gets or sets the server certificate used by reverse proxy. (Inherited from Cluster)
ReverseProxyCertificateCommonNames	Gets or sets describes a list of server certificates referenced by common name that are used to secure the cluster. (Inherited from Cluster)
SfZonalUpgradeMode	Gets or sets 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. Possible values include: 'Parallel', 'Hierarchical' (Inherited from Cluster)
SystemData	Gets metadata pertaining to creation and last modification of the resource. (Inherited from Resource)
Tags	Gets or sets azure resource tags. (Inherited from Resource)
Type	Gets azure resource type. (Inherited from Resource)
UpgradeDescription	Gets or sets the policy to use when upgrading the cluster. (Inherited from Cluster)
UpgradeMode	Gets or sets the upgrade mode of the cluster when new Service Fabric runtime version is available. Possible values include: 'Automatic', 'Manual' (Inherited from Cluster)
UpgradePauseEndTimestampUtc	Gets or sets 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). (Inherited from Cluster)
UpgradePauseStartTimestampUtc	Gets or sets 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). (Inherited from Cluster)
UpgradeWave	Gets or sets 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'. Possible values include: 'Wave0', 'Wave1', 'Wave2' (Inherited from Cluster)
VmImage	Gets or sets the VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. (Inherited from Cluster)
VmssZonalUpgradeMode	Gets or sets 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. Possible values include: 'Parallel', 'Hierarchical' (Inherited from Cluster)
WaveUpgradePaused	Gets or sets boolean to pause automatic runtime version upgrades to the cluster. (Inherited from Cluster)

Methods

ToString()
Validate()	Validate the object. (Inherited from Cluster)