Cluster Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Cluster represents the on-premises Network Cloud cluster.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20230701.ClusterTypeConverter))]
public class Cluster : Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20230701.ICluster, Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20230701.ClusterTypeConverter))>]
type Cluster = class
interface ICluster
interface IJsonSerializable
interface ITrackedResource
interface IResource
interface IValidates
Public Class Cluster
Implements ICluster, IValidates
- Inheritance
-
Cluster
- Attributes
- Implements
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. |
AvailableUpgradeVersion |
The list of cluster runtime version upgrades available for this cluster. |
CapacityAvailableApplianceStorageGb |
The remaining appliance-based storage in GB available for workload use. |
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. |
CapacityAvailableMemoryGb |
The remaining memory in GB that are available in this cluster for workload use. |
CapacityTotalApplianceStorageGb |
The total appliance-based storage in GB supported by this cluster for workload use. |
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. |
CapacityTotalMemoryGb |
The total memory supported by this cluster for workload use. |
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. |
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}" |
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 |
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" |
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) | |
FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20230701.ICluster. |
FromJsonString(String) |
Creates a new instance of Cluster, deserializing the content from a json string. |
ToJson(JsonObject, SerializationMode) | |
ToJsonString() |
Serializes this instance to a json string. |
ToString() | |
Validate(IEventListener) |
Validates that this object meets the validation criteria. |