ClusterManager interface

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

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.
detailedStatus

The detailed status that provides additional information about the cluster manager.
detailedStatusMessage

The descriptive message about the current detailed status.
etag

"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")
fabricControllerId

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

The managed service identities assigned to this resource.
kind

The kind of 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.
provisioningState

The provisioning state of the cluster manager.
relayConfiguration

The relay configuration for the cluster manager.
vmSize

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. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

The geo-location where the resource lives
name

The name of the resource
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags

Resource tags.
type

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

Property Details

analyticsWorkspaceId

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

analyticsWorkspaceId?: string

Property Value

string

availabilityZones

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.

clusterVersions?: ClusterAvailableVersion[]

Property Value

ClusterAvailableVersion[]

detailedStatus

The detailed status that provides additional information about the cluster manager.

detailedStatus?: string

Property Value

string

detailedStatusMessage

The descriptive message about the current detailed status.

detailedStatusMessage?: string

Property Value

string

etag

"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")

etag?: 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

identity

The managed service identities assigned to this resource.

identity?: ManagedServiceIdentity

Property Value

ManagedServiceIdentity

kind

The kind of the cluster manager.

kind?: 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.

managerExtendedLocation?: ExtendedLocation

Property Value

ExtendedLocation

provisioningState

The provisioning state of the cluster manager.

provisioningState?: string

Property Value

string

relayConfiguration

The relay configuration for the cluster manager.

relayConfiguration?: ClusterManagerRelayConfiguration

Property Value

ClusterManagerRelayConfiguration

vmSize

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. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

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

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

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

type?: string

Property Value

string

Inherited From TrackedResource.type