Share via

ClusterProperties interface

Package:
@azure/arm-azurestackhci

Cluster properties.

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.
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.
trialDaysRemaining

Number of days remaining in the trial period.

Property Details

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

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

trialDaysRemaining

Number of days remaining in the trial period.

trialDaysRemaining?: number

Property Value

number