Cluster interface

Package:

@azure/arm-azurestackhci

Cluster details.

Extends

TrackedResource

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. NOTE: This property will not be serialized. It can only be populated by the server.
cloudId	Unique, immutable resource id. NOTE: This property will not be serialized. It can only be populated by the server.
cloudManagementEndpoint	Endpoint configured for management from the Azure portal.
connectivityStatus	Overall connectivity status for the cluster resource. NOTE: This property will not be serialized. It can only be populated by the server.
desiredProperties	Desired properties of the cluster.
isolatedVmAttestationConfiguration	Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. NOTE: This property will not be serialized. It can only be populated by the server.
lastBillingTimestamp	Most recent billing meter timestamp. NOTE: This property will not be serialized. It can only be populated by the server.
lastSyncTimestamp	Most recent cluster sync timestamp. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState	Provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.
registrationTimestamp	First cluster sync timestamp. NOTE: This property will not be serialized. It can only be populated by the server.
remoteSupportProperties	RemoteSupport properties of the cluster.
reportedProperties	Properties reported by cluster agent. NOTE: This property will not be serialized. It can only be populated by the server.
resourceProviderObjectId	Object id of RP Service Principal NOTE: This property will not be serialized. It can only be populated by the server.
serviceEndpoint	Region specific DataPath Endpoint of the cluster. NOTE: This property will not be serialized. It can only be populated by the server.
softwareAssuranceProperties	Software Assurance properties of the cluster.
status	Status of the cluster agent. NOTE: This property will not be serialized. It can only be populated by the server.
tenantId	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. NOTE: This property will not be serialized. It can only be populated by the server.
trialDaysRemaining	Number of days remaining in the trial period. NOTE: This property will not be serialized. It can only be populated by the server.
typeIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities	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.

Inherited Properties

id	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
location	The geo-location where the resource lives
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

billingModel?: string

Property Value

string

cloudId

Unique, immutable resource id. NOTE: This property will not be serialized. It can only be populated by the server.

cloudId?: string

Property Value

string

cloudManagementEndpoint

Endpoint configured for management from the Azure portal.

cloudManagementEndpoint?: string

Property Value

string

connectivityStatus

Overall connectivity status for the cluster resource. NOTE: This property will not be serialized. It can only be populated by the server.

connectivityStatus?: string

Property Value

string

desiredProperties

Desired properties of the cluster.

desiredProperties?: ClusterDesiredProperties

Property Value

ClusterDesiredProperties

isolatedVmAttestationConfiguration

Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. NOTE: This property will not be serialized. It can only be populated by the server.

isolatedVmAttestationConfiguration?: IsolatedVmAttestationConfiguration

Property Value

IsolatedVmAttestationConfiguration

lastBillingTimestamp

Most recent billing meter timestamp. NOTE: This property will not be serialized. It can only be populated by the server.

lastBillingTimestamp?: Date

Property Value

Date

lastSyncTimestamp

Most recent cluster sync timestamp. NOTE: This property will not be serialized. It can only be populated by the server.

lastSyncTimestamp?: Date

Property Value

Date

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. NOTE: This property will not be serialized. It can only be populated by the server.

principalId?: string

Property Value

string

provisioningState

Provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

registrationTimestamp

First cluster sync timestamp. NOTE: This property will not be serialized. It can only be populated by the server.

registrationTimestamp?: Date

Property Value

Date

remoteSupportProperties

RemoteSupport properties of the cluster.

remoteSupportProperties?: RemoteSupportProperties

Property Value

RemoteSupportProperties

reportedProperties

Properties reported by cluster agent. NOTE: This property will not be serialized. It can only be populated by the server.

reportedProperties?: ClusterReportedProperties

Property Value

ClusterReportedProperties

resourceProviderObjectId

Object id of RP Service Principal NOTE: This property will not be serialized. It can only be populated by the server.

resourceProviderObjectId?: string

Property Value

string

serviceEndpoint

Region specific DataPath Endpoint of the cluster. NOTE: This property will not be serialized. It can only be populated by the server.

serviceEndpoint?: string

Property Value

string

softwareAssuranceProperties

Software Assurance properties of the cluster.

softwareAssuranceProperties?: SoftwareAssuranceProperties

Property Value

SoftwareAssuranceProperties

status

Status of the cluster agent. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

tenantId?: string

Property Value

string

trialDaysRemaining

Number of days remaining in the trial period. NOTE: This property will not be serialized. It can only be populated by the server.

trialDaysRemaining?: number

Property Value

number

typeIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

typeIdentityType?: string

Property Value

string

userAssignedIdentities

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.

userAssignedIdentities?: {[propertyName: string]: UserAssignedIdentity}

Property Value

{[propertyName: string]: UserAssignedIdentity}

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

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 NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type