Package version:

Interface Cluster

Cluster details.

interface Cluster {
    aadApplicationObjectId?: string;
    aadClientId?: string;
    aadServicePrincipalObjectId?: string;
    aadTenantId?: string;
    billingModel?: string;
    cloudId?: string;
    cloudManagementEndpoint?: string;
    clusterPattern?: string;
    connectivityStatus?: string;
    desiredProperties?: ClusterDesiredProperties;
    id?: string;
    identityProvider?: string;
    isManagementCluster?: boolean;
    isolatedVmAttestationConfiguration?: IsolatedVmAttestationConfiguration;
    lastBillingTimestamp?: any;
    lastSyncTimestamp?: any;
    localAvailabilityZones?: {};
    location: string;
    logCollectionProperties?: LogCollectionProperties;
    name?: string;
    principalId?: string;
    provisioningState?: string;
    registrationTimestamp?: any;
    remoteSupportProperties?: RemoteSupportProperties;
    reportedProperties?: ClusterReportedProperties;
    resourceProviderObjectId?: string;
    secretsLocations?: {};
    serviceEndpoint?: string;
    softwareAssuranceProperties?: SoftwareAssuranceProperties;
    status?: string;
    systemData?: SystemData;
    tags?: any;
    tenantId?: string;
    trialDaysRemaining?: number;
    type?: string;
    typeIdentityType?: string;
    userAssignedIdentities?: any;
}

Hierarchy (view full)

Properties

aadApplicationObjectId? aadClientId? aadServicePrincipalObjectId? aadTenantId? billingModel? cloudId? cloudManagementEndpoint? clusterPattern? connectivityStatus? desiredProperties? id? identityProvider? isManagementCluster? isolatedVmAttestationConfiguration? lastBillingTimestamp? lastSyncTimestamp? localAvailabilityZones? location logCollectionProperties? name? principalId? provisioningState? registrationTimestamp? remoteSupportProperties? reportedProperties? resourceProviderObjectId? secretsLocations? serviceEndpoint? softwareAssuranceProperties? status? systemData? tags? tenantId? trialDaysRemaining? type? typeIdentityType? userAssignedIdentities?

Properties

OptionalaadApplicationObjectId

aadApplicationObjectId?: string

Object id of cluster AAD identity.

OptionalaadClientId

aadClientId?: string

App id of cluster AAD identity.

OptionalaadServicePrincipalObjectId

aadServicePrincipalObjectId?: string

Id of cluster identity service principal.

OptionalaadTenantId

aadTenantId?: string

Tenant id of cluster AAD identity.

Optional ReadonlybillingModel

billingModel?: string

Type of billing applied to the resource.

Optional ReadonlycloudId

cloudId?: string

Unique, immutable resource id.

OptionalcloudManagementEndpoint

cloudManagementEndpoint?: string

Endpoint configured for management from the Azure portal.

Optional ReadonlyclusterPattern

clusterPattern?: string

Supported Storage Type for HCI Cluster

Optional ReadonlyconnectivityStatus

connectivityStatus?: string

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

OptionaldesiredProperties

desiredProperties?: ClusterDesiredProperties

Desired properties of the cluster.

Optional Readonlyid

id?: string

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

Optional ReadonlyidentityProvider

identityProvider?: string

Identity Provider for the cluster

Optional ReadonlyisManagementCluster

isManagementCluster?: boolean

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

Optional ReadonlyisolatedVmAttestationConfiguration

isolatedVmAttestationConfiguration?: IsolatedVmAttestationConfiguration

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

Optional ReadonlylastBillingTimestamp

lastBillingTimestamp?: any

Most recent billing meter timestamp.

Optional ReadonlylastSyncTimestamp

lastSyncTimestamp?: any

Most recent cluster sync timestamp.

OptionallocalAvailabilityZones

localAvailabilityZones?: {}

Local Availability Zone information for HCI cluster

location

location: string

The geo-location where the resource lives

OptionallogCollectionProperties

logCollectionProperties?: LogCollectionProperties

Log Collection properties of the cluster.

Optional Readonlyname

name?: string

The name of the resource

Optional ReadonlyprincipalId

principalId?: string

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

Optional ReadonlyprovisioningState

provisioningState?: string

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

Optional ReadonlyregistrationTimestamp

registrationTimestamp?: any

First cluster sync timestamp.

OptionalremoteSupportProperties

remoteSupportProperties?: RemoteSupportProperties

RemoteSupport properties of the cluster.

Optional ReadonlyreportedProperties

reportedProperties?: ClusterReportedProperties

Properties reported by cluster agent.

Optional ReadonlyresourceProviderObjectId

resourceProviderObjectId?: string

Object id of RP Service Principal

OptionalsecretsLocations

secretsLocations?: {}

List of secret locations.

Optional ReadonlyserviceEndpoint

serviceEndpoint?: string

Region specific DataPath Endpoint of the cluster.

OptionalsoftwareAssuranceProperties

softwareAssuranceProperties?: SoftwareAssuranceProperties

Software Assurance properties of the cluster.

Optional Readonlystatus

status?: string

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

Optional ReadonlysystemData

systemData?: SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

Optionaltags

tags?: any

Resource tags.

Optional ReadonlytenantId

tenantId?: string

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

Optional ReadonlytrialDaysRemaining

trialDaysRemaining?: number

Number of days remaining in the trial period.

Optional Readonlytype

type?: string

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

OptionaltypeIdentityType

typeIdentityType?: string

The type of managed identity assigned to this resource.

OptionaluserAssignedIdentities

userAssignedIdentities?: any

The identities assigned to this resource by the user.

Settings

Member Visibility