Cluster interface

Cluster details.

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.
clusterPattern	Supported Storage Type for HCI Cluster
connectivityStatus	Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated.
desiredProperties	Desired properties of the cluster.
identityProvider	Identity Provider for the cluster
isManagementCluster	Is Management Cluster, when true indicates that the cluster is used for managing other clusters
isolatedVmAttestationConfiguration	Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster.
lastBillingTimestamp	Most recent billing meter timestamp.
lastSyncTimestamp	Most recent cluster sync timestamp.
localAvailabilityZones	Local Availability Zone information for HCI cluster
logCollectionProperties	Log Collection properties of the cluster.
principalId	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
provisioningState	Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states.
registrationTimestamp	First cluster sync timestamp.
remoteSupportProperties	RemoteSupport properties of the cluster.
reportedProperties	Properties reported by cluster agent.
resourceProviderObjectId	Object id of RP Service Principal
secretsLocations	List of secret locations.
serviceEndpoint	Region specific DataPath Endpoint of the cluster.
softwareAssuranceProperties	Software Assurance properties of the cluster.
status	Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster.
tenantId	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
trialDaysRemaining	Number of days remaining in the trial period.
typeIdentityType	The type of managed identity assigned to this resource.
userAssignedIdentities	The identities assigned to this resource by the user.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	The geo-location where the resource lives
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	Resource tags.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

aadApplicationObjectId

Object id of cluster AAD identity.

aadApplicationObjectId?: string

Property Value

string

aadClientId

App id of cluster AAD identity.

aadClientId?: string

Property Value

string

aadServicePrincipalObjectId

Id of cluster identity service principal.

aadServicePrincipalObjectId?: string

Property Value

string

aadTenantId

Tenant id of cluster AAD identity.

aadTenantId?: string

Property Value

string

billingModel

Type of billing applied to the resource.

billingModel?: string

Property Value

string

cloudId

Unique, immutable resource id.

cloudId?: string

Property Value

string

cloudManagementEndpoint

Endpoint configured for management from the Azure portal.

cloudManagementEndpoint?: string

Property Value

string

clusterPattern

Supported Storage Type for HCI Cluster

clusterPattern?: string

Property Value

string

connectivityStatus

Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated.

connectivityStatus?: string

Property Value

string

desiredProperties

Desired properties of the cluster.

desiredProperties?: ClusterDesiredProperties

Property Value

ClusterDesiredProperties

identityProvider

Identity Provider for the cluster

identityProvider?: string

Property Value

string

isManagementCluster

Is Management Cluster, when true indicates that the cluster is used for managing other clusters

isManagementCluster?: boolean

Property Value

boolean

isolatedVmAttestationConfiguration

Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster.

isolatedVmAttestationConfiguration?: IsolatedVmAttestationConfiguration

Property Value

IsolatedVmAttestationConfiguration

lastBillingTimestamp

Most recent billing meter timestamp.

lastBillingTimestamp?: Date

Property Value

Date

lastSyncTimestamp

Most recent cluster sync timestamp.

lastSyncTimestamp?: Date

Property Value

Date

localAvailabilityZones

Local Availability Zone information for HCI cluster

localAvailabilityZones?: LocalAvailabilityZones[]

Property Value

LocalAvailabilityZones[]

logCollectionProperties

Log Collection properties of the cluster.

logCollectionProperties?: LogCollectionProperties

Property Value

LogCollectionProperties

principalId

The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.

principalId?: string

Property Value

string

provisioningState

Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states.

provisioningState?: string

Property Value

string

registrationTimestamp

First cluster sync timestamp.

registrationTimestamp?: Date

Property Value

Date

remoteSupportProperties

RemoteSupport properties of the cluster.

remoteSupportProperties?: RemoteSupportProperties

Property Value

RemoteSupportProperties

reportedProperties

Properties reported by cluster agent.

reportedProperties?: ClusterReportedProperties

Property Value

ClusterReportedProperties

resourceProviderObjectId

Object id of RP Service Principal

resourceProviderObjectId?: string

Property Value

string

secretsLocations

List of secret locations.

secretsLocations?: SecretsLocationDetails[]

Property Value

SecretsLocationDetails[]

serviceEndpoint

Region specific DataPath Endpoint of the cluster.

serviceEndpoint?: string

Property Value

string

softwareAssuranceProperties

Software Assurance properties of the cluster.

softwareAssuranceProperties?: SoftwareAssuranceProperties

Property Value

SoftwareAssuranceProperties

status

Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster.

status?: string

Property Value

string

tenantId

The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.

tenantId?: string

Property Value

string

trialDaysRemaining

Number of days remaining in the trial period.

trialDaysRemaining?: number

Property Value

number

typeIdentityType

The type of managed identity assigned to this resource.

typeIdentityType?: string

Property Value

string

userAssignedIdentities

The identities assigned to this resource by the user.

userAssignedIdentities?: Record<string, UserAssignedIdentity>

Property Value

Record<string, UserAssignedIdentity>

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

type

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

type?: string

Property Value

string

Inherited From TrackedResource.type

Share via

Cluster interface

Properties

Inherited Properties

Property Details

aadApplicationObjectId

Property Value

aadClientId

Property Value

aadServicePrincipalObjectId

Property Value

aadTenantId

Property Value

billingModel

Property Value

cloudId

Property Value

cloudManagementEndpoint

Property Value

clusterPattern

Property Value

connectivityStatus

Property Value

desiredProperties

Property Value

identityProvider

Property Value

isManagementCluster

Property Value

isolatedVmAttestationConfiguration

Property Value

lastBillingTimestamp

Property Value

lastSyncTimestamp

Property Value

localAvailabilityZones

Property Value

logCollectionProperties

Property Value

principalId

Property Value

provisioningState

Property Value

registrationTimestamp

Property Value

remoteSupportProperties

Property Value

reportedProperties

Property Value

resourceProviderObjectId

Property Value

secretsLocations

Property Value

serviceEndpoint

Property Value

softwareAssuranceProperties

Property Value

status

Property Value

tenantId

Property Value

trialDaysRemaining

Property Value

typeIdentityType

Property Value

userAssignedIdentities

Property Value

Inherited Property Details

id

Property Value

location

Property Value

name

Property Value

systemData

Property Value

tags

Property Value

type

Property Value