Share via

Cluster interface

  • Reference
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.
createdAt

The timestamp of resource creation (UTC).
createdBy

The identity that created the resource.
createdByType

The type of identity that created the resource.
desiredProperties

Desired properties of the cluster.
lastBillingTimestamp

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

The timestamp of resource last modification (UTC)
lastModifiedBy

The identity that last modified the resource.
lastModifiedByType

The type of identity that last modified the resource.
lastSyncTimestamp

Most recent cluster sync timestamp. 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.
reportedProperties

Properties reported by cluster agent. 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.
status

Status of the cluster agent. 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.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /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.
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

createdAt

The timestamp of resource creation (UTC).

createdAt?: Date

Property Value

Date

createdBy

The identity that created the resource.

createdBy?: string

Property Value

string

createdByType

The type of identity that created the resource.

createdByType?: string

Property Value

string

desiredProperties

Desired properties of the cluster.

desiredProperties?: ClusterDesiredProperties

Property Value

ClusterDesiredProperties

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

lastModifiedAt

The timestamp of resource last modification (UTC)

lastModifiedAt?: Date

Property Value

Date

lastModifiedBy

The identity that last modified the resource.

lastModifiedBy?: string

Property Value

string

lastModifiedByType

The type of identity that last modified the resource.

lastModifiedByType?: string

Property Value

string

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

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

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

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

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

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

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /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

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