Cluster Class

Definition

Namespace:

Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20240701

Assembly:

Az.NetworkCloud.private.dll

Cluster represents the on-premises Network Cloud cluster.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20240701.ClusterTypeConverter))]
public class Cluster : Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20240701.ICluster, Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Runtime.IValidates

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20240701.ClusterTypeConverter))>]
type Cluster = class
    interface ICluster
    interface IJsonSerializable
    interface ITrackedResource
    interface IResource
    interface IValidates

Public Class Cluster
Implements ICluster, IValidates

Inheritance

Object

Cluster

Attributes

TypeConverterAttribute

Implements

ICluster IResource ITrackedResource IJsonSerializable IValidates

Constructors

Cluster()

Creates an new Cluster instance.

Properties

AggregatorOrSingleRackDefinitionAvailabilityZone	The zone name used for this rack when created. Availability zones are used for workload placement.
AggregatorOrSingleRackDefinitionBareMetalMachineConfigurationData	The unordered list of bare metal machine configuration.
AggregatorOrSingleRackDefinitionNetworkRackId	The resource ID of the network rack that matches this rack definition.
AggregatorOrSingleRackDefinitionRackLocation	The free-form description of the rack's location.
AggregatorOrSingleRackDefinitionRackSerialNumber	The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired.
AggregatorOrSingleRackDefinitionRackSkuId	The resource ID of the sku for the rack being added.
AggregatorOrSingleRackDefinitionStorageApplianceConfigurationData	The list of storage appliance configuration data for this rack.
AnalyticsWorkspaceId	The resource ID of the Log Analytics Workspace that will be used for storing relevant logs.
AssociatedIdentityType	The type of managed identity that is being selected.
AssociatedIdentityUserAssignedIdentityResourceId	The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type.
AvailableUpgradeVersion	The list of cluster runtime version upgrades available for this cluster.
CapacityAvailableApplianceStorageGb	The remaining appliance-based storage in GB available for workload use. Measured in gibibytes.
CapacityAvailableCoreCount	The remaining number of cores that are available in this cluster for workload use.
CapacityAvailableHostStorageGb	The remaining machine or host-based storage in GB available for workload use. Measured in gibibytes.
CapacityAvailableMemoryGb	The remaining memory in GB that are available in this cluster for workload use. Measured in gibibytes.
CapacityTotalApplianceStorageGb	The total appliance-based storage in GB supported by this cluster for workload use. Measured in gibibytes.
CapacityTotalCoreCount	The total number of cores that are supported by this cluster for workload use.
CapacityTotalHostStorageGb	The total machine or host-based storage in GB supported by this cluster for workload use. Measured in gibibytes.
CapacityTotalMemoryGb	The total memory supported by this cluster for workload use. Measured in gibibytes.
ClusterExtendedLocationName	The resource ID of the extended location on which the resource will be created.
ClusterExtendedLocationType	The extended location type, for example, CustomLocation.
ClusterLocation	The customer-provided location information to identify where the cluster resides.
ClusterType	The type of rack configuration for the cluster.
CommandOutputSettingContainerUrl	The URL of the storage account container that is to be used by the specified identities.
ComputeDeploymentThresholdGrouping	Selection of how the type evaluation is applied to the cluster calculation.
ComputeDeploymentThresholdType	Selection of how the threshold should be evaluated.
ComputeDeploymentThresholdValue	The numeric threshold value.
ComputeRackDefinition	The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster.
ConnectionStatus	The latest heartbeat status between the cluster manager and the cluster.
DetailedStatus	The current detailed status of the cluster.
DetailedStatusMessage	The descriptive message about the detailed status.
ExtendedLocationName	The resource ID of the extended location on which the resource will be created.
ExtendedLocationType	The extended location type, for example, CustomLocation.
HybridAkExtendedLocationName	The resource ID of the extended location on which the resource will be created.
HybridAkExtendedLocationType	The extended location type, for example, CustomLocation.
Id	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
IdentityPrincipalId	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
IdentityTenantId	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
IdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
IdentityUserAssignedIdentity	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
Location	The geo-location where the resource lives
ManagedResourceGroupConfigurationLocation	The location of the managed resource group. If not specified, the location of the parent resource is chosen.
ManagedResourceGroupConfigurationName	The name for the managed resource group. If not specified, the unique name is automatically generated.
ManagerConnectionStatus	The latest connectivity status between cluster manager and the cluster.
ManagerId	The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created.
ManualActionCount	The count of Manual Action Taken (MAT) events that have not been validated.
Name	The name of the resource
NetworkFabricId	The resource ID of the Network Fabric associated with the cluster.
ProvisioningState	The provisioning state of the cluster.
ResourceGroupName	Gets the resource group name
RuntimeProtectionConfigurationEnforcementLevel	The mode of operation for runtime protection.
SecretArchiveKeyVaultId	The resource ID of the key vault to archive the secrets of the cluster.
SecretArchiveUseKeyVault	The indicator if the specified key vault should be used to archive the secrets of the cluster.
ServicePrincipalApplicationId	The application ID, also known as client ID, of the service principal.
ServicePrincipalId	The principal ID, also known as the object ID, of the service principal.
ServicePrincipalPassword	The password of the service principal.
ServicePrincipalTenantId	The tenant ID, also known as the directory ID, of the tenant in which the service principal is created.
SupportExpiryDate	The support end date of the runtime version of the cluster.
SystemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
SystemDataCreatedAt	The timestamp of resource creation (UTC).
SystemDataCreatedBy	The identity that created the resource.
SystemDataCreatedByType	The type of identity that created the resource.
SystemDataLastModifiedAt	The timestamp of resource last modification (UTC)
SystemDataLastModifiedBy	The identity that last modified the resource.
SystemDataLastModifiedByType	The type of identity that last modified the resource.
Tag	Resource tags.
Type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
UpdateStrategyMaxUnavailable	The maximum number of worker nodes that can be offline within the increment of update, e.g., rack-by-rack. Limited by the maximum number of machines in the increment. Defaults to the whole increment size.
UpdateStrategyThresholdType	Selection of how the threshold should be evaluated.
UpdateStrategyThresholdValue	The numeric threshold value.
UpdateStrategyType	The mode of operation for runtime protection.
UpdateStrategyWaitTimeMinute	The time to wait between the increments of update defined by the strategy.
Version	The current runtime version of the cluster.
WorkloadResourceId	The list of workload resource IDs that are hosted within this cluster.

Methods

DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of Cluster.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of Cluster.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20240701.ICluster.
FromJsonString(String)	Creates a new instance of Cluster, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of Cluster into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()
Validate(IEventListener)	Validates that this object meets the validation criteria.