Share via

Cluster interface

  • Reference
Package:
@azure/arm-connectedvmware

Define the cluster.

Properties

customResourceName

Gets the name of the corresponding resource in Kubernetes. NOTE: This property will not be serialized. It can only be populated by the server.
datastoreIds

Gets the datastore ARM ids. NOTE: This property will not be serialized. It can only be populated by the server.
extendedLocation

Gets or sets the extended location.
id

Gets or sets the Id. NOTE: This property will not be serialized. It can only be populated by the server.
inventoryItemId

Gets or sets the inventory Item ID for the cluster.
kind

Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
location

Gets or sets the location.
moName

Gets or sets the vCenter Managed Object name for the cluster. NOTE: This property will not be serialized. It can only be populated by the server.
moRefId

Gets or sets the vCenter MoRef (Managed Object Reference) ID for the cluster.
name

Gets or sets the name. NOTE: This property will not be serialized. It can only be populated by the server.
networkIds

Gets the network ARM ids. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

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

The resource status information. NOTE: This property will not be serialized. It can only be populated by the server.
systemData

The system data. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Gets or sets the Resource tags.
totalCpuMHz

Gets the max CPU usage across all cores on the cluster in MHz. NOTE: This property will not be serialized. It can only be populated by the server.
totalMemoryGB

Gets the total amount of physical memory on the cluster in GB. NOTE: This property will not be serialized. It can only be populated by the server.
type

Gets or sets the type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
usedCpuMHz

Gets the used CPU usage across all cores on the cluster in MHz. NOTE: This property will not be serialized. It can only be populated by the server.
usedMemoryGB

Gets the used physical memory on the cluster in GB. NOTE: This property will not be serialized. It can only be populated by the server.
uuid

Gets or sets a unique identifier for this resource. NOTE: This property will not be serialized. It can only be populated by the server.
vCenterId

Gets or sets the ARM Id of the vCenter resource in which this cluster resides.

Property Details

customResourceName

Gets the name of the corresponding resource in Kubernetes. NOTE: This property will not be serialized. It can only be populated by the server.

customResourceName?: string

Property Value

string

datastoreIds

Gets the datastore ARM ids. NOTE: This property will not be serialized. It can only be populated by the server.

datastoreIds?: string[]

Property Value

string[]

extendedLocation

Gets or sets the extended location.

extendedLocation?: ExtendedLocation

Property Value

ExtendedLocation

id

Gets or sets the Id. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

inventoryItemId

Gets or sets the inventory Item ID for the cluster.

inventoryItemId?: string

Property Value

string

kind

Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

kind?: string

Property Value

string

location

Gets or sets the location.

location: string

Property Value

string

moName

Gets or sets the vCenter Managed Object name for the cluster. NOTE: This property will not be serialized. It can only be populated by the server.

moName?: string

Property Value

string

moRefId

Gets or sets the vCenter MoRef (Managed Object Reference) ID for the cluster.

moRefId?: string

Property Value

string

name

Gets or sets the name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

networkIds

Gets the network ARM ids. NOTE: This property will not be serialized. It can only be populated by the server.

networkIds?: string[]

Property Value

string[]

provisioningState

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

provisioningState?: string

Property Value

string

statuses

The resource status information. NOTE: This property will not be serialized. It can only be populated by the server.

statuses?: ResourceStatus[]

Property Value

ResourceStatus[]

systemData

The system data. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

tags

Gets or sets the Resource tags.

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

Property Value

{[propertyName: string]: string}

totalCpuMHz

Gets the max CPU usage across all cores on the cluster in MHz. NOTE: This property will not be serialized. It can only be populated by the server.

totalCpuMHz?: number

Property Value

number

totalMemoryGB

Gets the total amount of physical memory on the cluster in GB. NOTE: This property will not be serialized. It can only be populated by the server.

totalMemoryGB?: number

Property Value

number

type

Gets or sets the type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

usedCpuMHz

Gets the used CPU usage across all cores on the cluster in MHz. NOTE: This property will not be serialized. It can only be populated by the server.

usedCpuMHz?: number

Property Value

number

usedMemoryGB

Gets the used physical memory on the cluster in GB. NOTE: This property will not be serialized. It can only be populated by the server.

usedMemoryGB?: number

Property Value

number

uuid

Gets or sets a unique identifier for this resource. NOTE: This property will not be serialized. It can only be populated by the server.

uuid?: string

Property Value

string

vCenterId

Gets or sets the ARM Id of the vCenter resource in which this cluster resides.

vCenterId?: string

Property Value

string