Share via

ClusterManager interface

  • Reference
Package:
@azure/arm-networkcloud

ClusterManager represents a control-plane to manage one or more on-premises clusters.

Extends
TrackedResource

Properties

analyticsWorkspaceId

The resource ID of the Log Analytics workspace that is used for the logs collection.
availabilityZones

Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The Azure availability zones within the region that will be used to support the cluster manager resource.
clusterVersions

The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource. NOTE: This property will not be serialized. It can only be populated by the server.
detailedStatus

The detailed status that provides additional information about the cluster manager. NOTE: This property will not be serialized. It can only be populated by the server.
detailedStatusMessage

The descriptive message about the current detailed status. NOTE: This property will not be serialized. It can only be populated by the server.
fabricControllerId

The resource ID of the fabric controller that has one to one mapping with the cluster manager.
managedResourceGroupConfiguration

The configuration of the managed resource group associated with the resource.
managerExtendedLocation

The extended location (custom location) that represents the cluster manager's control plane location. This extended location is used when creating cluster and rack manifest resources. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

The provisioning state of the cluster manager. NOTE: This property will not be serialized. It can only be populated by the server.
vmSize

Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The size of the Azure virtual machines to use for hosting the cluster manager resource.

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

analyticsWorkspaceId

The resource ID of the Log Analytics workspace that is used for the logs collection.

analyticsWorkspaceId?: string

Property Value

string

availabilityZones

Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The Azure availability zones within the region that will be used to support the cluster manager resource.

availabilityZones?: string[]

Property Value

string[]

clusterVersions

The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource. NOTE: This property will not be serialized. It can only be populated by the server.

clusterVersions?: ClusterAvailableVersion[]

Property Value

ClusterAvailableVersion[]

detailedStatus

The detailed status that provides additional information about the cluster manager. NOTE: This property will not be serialized. It can only be populated by the server.

detailedStatus?: string

Property Value

string

detailedStatusMessage

The descriptive message about the current detailed status. NOTE: This property will not be serialized. It can only be populated by the server.

detailedStatusMessage?: string

Property Value

string

fabricControllerId

The resource ID of the fabric controller that has one to one mapping with the cluster manager.

fabricControllerId: string

Property Value

string

managedResourceGroupConfiguration

The configuration of the managed resource group associated with the resource.

managedResourceGroupConfiguration?: ManagedResourceGroupConfiguration

Property Value

ManagedResourceGroupConfiguration

managerExtendedLocation

The extended location (custom location) that represents the cluster manager's control plane location. This extended location is used when creating cluster and rack manifest resources. NOTE: This property will not be serialized. It can only be populated by the server.

managerExtendedLocation?: ExtendedLocation

Property Value

ExtendedLocation

provisioningState

The provisioning state of the cluster manager. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

vmSize

Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The size of the Azure virtual machines to use for hosting the cluster manager resource.

vmSize?: string

Property Value

string

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