Share via


Cluster Class

Definition

Cluster details.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.Api20240401.ClusterTypeConverter))]
public class Cluster : Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.Api20240401.ICluster, Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.Api20240401.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

AadApplicationObjectId

Object id of cluster AAD identity.

AadClientId

App id of cluster AAD identity.

AadServicePrincipalObjectId

Id of cluster identity service principal.

AadTenantId

Tenant id of cluster AAD identity.

BillingModel

Type of billing applied to the resource.

CloudId

Unique, immutable resource id.

CloudManagementEndpoint

Endpoint configured for management from the Azure portal.

ConnectivityStatus

Overall connectivity status for the cluster resource.

DesiredPropertyDiagnosticLevel

Desired level of diagnostic data emitted by the cluster.

DesiredPropertyWindowsServerSubscription

Desired state of Windows Server Subscription.

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.

IsolatedVMAttestationConfigurationAttestationResourceId

Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster.

IsolatedVMAttestationConfigurationAttestationServiceEndpoint

Region specific endpoint for Microsoft Azure Attestation service for the cluster

IsolatedVMAttestationConfigurationRelyingPartyServiceEndpoint

Region specific endpoint for relying party service.

LastBillingTimestamp

Most recent billing meter timestamp.

LastSyncTimestamp

Most recent cluster sync timestamp.

Location

The geo-location where the resource lives

LogCollectionPropertyFromDate

From DateTimeStamp from when logs need to be connected

LogCollectionPropertyLastLogGenerated

Recent DateTimeStamp where logs are successfully generated

LogCollectionPropertyLogCollectionSessionDetail
LogCollectionPropertyToDate

To DateTimeStamp till when logs need to be connected

Name

The name of the resource

ProvisioningState

Provisioning state.

RegistrationTimestamp

First cluster sync timestamp.

RemoteSupportPropertyAccessLevel

Remote Support Access Level

RemoteSupportPropertyExpirationTimeStamp

Expiration DateTimeStamp when Remote Support Access will be expired

RemoteSupportPropertyRemoteSupportNodeSetting
RemoteSupportPropertyRemoteSupportSessionDetail
RemoteSupportPropertyRemoteSupportType

Remote Support Type for cluster

ReportedPropertyClusterId

Unique id generated by the on-prem cluster.

ReportedPropertyClusterName

Name of the on-prem cluster connected to this resource.

ReportedPropertyClusterType

The node type of all the nodes of the cluster.

ReportedPropertyClusterVersion

Version of the cluster software.

ReportedPropertyDiagnosticLevel

Level of diagnostic data emitted by the cluster.

ReportedPropertyImdsAttestation

IMDS attestation status of the cluster.

ReportedPropertyLastUpdated

Last time the cluster reported the data.

ReportedPropertyManufacturer

The manufacturer of all the nodes of the cluster.

ReportedPropertyNode

List of nodes reported by the cluster.

ReportedPropertyOemActivation

OEM activation status of the cluster.

ReportedPropertySupportedCapability

Capabilities supported by the cluster.

ResourceGroupName

Gets the resource group name

ResourceProviderObjectId

Object id of RP Service Principal

ServiceEndpoint

Region specific DataPath Endpoint of the cluster.

SoftwareAssurancePropertyLastUpdated

TimeStamp denoting the latest SA benefit applicability is validated.

SoftwareAssurancePropertySoftwareAssuranceIntent

Customer Intent for Software Assurance Benefit.

SoftwareAssurancePropertySoftwareAssuranceStatus

Status of the Software Assurance for the cluster.

Status

Status of the cluster agent.

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.

TrialDaysRemaining

Number of days remaining in the trial period.

Type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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.StackHCI.Models.Api20240401.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.

Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to