Cluster interface

Package:
@azure/arm-networkcloud

Cluster represents the on-premises Network Cloud cluster.

Extends
TrackedResource

Properties

actionStates

The current state of any in progress or completed actions. The most recent known instance of each action type is shown.
aggregatorOrSingleRackDefinition

The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster.
analyticsOutputSettings

The settings for the log analytics workspace used for output of logs from this cluster.
analyticsWorkspaceId

Field Deprecated. The resource ID of the Log Analytics Workspace that will be used for storing relevant logs.
availableUpgradeVersions

The list of cluster runtime version upgrades available for this cluster.
clusterCapacity

The capacity supported by this cluster.
clusterConnectionStatus

The latest heartbeat status between the cluster manager and the cluster.
clusterExtendedLocation

The extended location (custom location) that represents the cluster's control plane location. This extended location is used to route the requests of child objects of the cluster that are handled by the platform operator.
clusterLocation

The customer-provided location information to identify where the cluster resides.
clusterManagerConnectionStatus

The latest connectivity status between cluster manager and the cluster.
clusterManagerId

The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created.
clusterServicePrincipal

Field Deprecated: Use managed identity to provide cluster privileges. The service principal to be used by the cluster during Arc Appliance installation.
clusterType

The type of rack configuration for the cluster.
clusterVersion

The current runtime version of the cluster.
commandOutputSettings

The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts.
computeDeploymentThreshold

The validation threshold indicating the allowable failures of compute machines during environment validation and deployment.
computeRackDefinitions

The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster.
detailedStatus

The current detailed status of the cluster.
detailedStatusMessage

The descriptive message about the 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.")
extendedLocation

The extended location of the resource. This property is required when creating the resource.
hybridAksExtendedLocation

Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters).
identity

The managed service identities assigned to this resource.
kind

The type (kind) of the cluster. When specified, the value must exactly match the kind configured on the cluster manager that manages the cluster. If omitted, the service will default the value to the kind value of the cluster manager.
lastSuccessfulVersionUpdateTime

The date and time of the end of the last successful version update for the cluster.
managedCredentials

The list of credentials that are managed for the cluster and can be rotated on-demand.
managedResourceGroupConfiguration

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

The count of Manual Action Taken (MAT) events that have not been validated.
networkFabricId

The resource ID of the Network Fabric associated with the cluster.
provisioningState

The provisioning state of the cluster.
runtimeProtectionConfiguration

The settings for cluster runtime protection.
secretArchive

The configuration for use of a key vault to store secrets for later retrieval by the operator.
secretArchiveSettings

The settings for the secret archive used to hold credentials for the cluster.
supportExpiryDate

The support end date of the runtime version of the cluster.
updateStrategy

The strategy for updating the cluster.
vulnerabilityScanningSettings

The settings for how security vulnerability scanning is applied to the cluster.
workloadResourceIds

The list of workload resource IDs that are hosted within this cluster.

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

actionStates

The current state of any in progress or completed actions. The most recent known instance of each action type is shown.

actionStates?: ActionState[]

Property Value

ActionState[]

aggregatorOrSingleRackDefinition

The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster.

aggregatorOrSingleRackDefinition: RackDefinition

Property Value

RackDefinition

analyticsOutputSettings

The settings for the log analytics workspace used for output of logs from this cluster.

analyticsOutputSettings?: AnalyticsOutputSettings

Property Value

AnalyticsOutputSettings

analyticsWorkspaceId

Field Deprecated. The resource ID of the Log Analytics Workspace that will be used for storing relevant logs.

analyticsWorkspaceId?: string

Property Value

string

availableUpgradeVersions

The list of cluster runtime version upgrades available for this cluster.

availableUpgradeVersions?: ClusterAvailableUpgradeVersion[]

Property Value

ClusterAvailableUpgradeVersion[]

clusterCapacity

The capacity supported by this cluster.

clusterCapacity?: ClusterCapacity

Property Value

ClusterCapacity

clusterConnectionStatus

The latest heartbeat status between the cluster manager and the cluster.

clusterConnectionStatus?: string

Property Value

string

clusterExtendedLocation

The extended location (custom location) that represents the cluster's control plane location. This extended location is used to route the requests of child objects of the cluster that are handled by the platform operator.

clusterExtendedLocation?: ExtendedLocation

Property Value

ExtendedLocation

clusterLocation

The customer-provided location information to identify where the cluster resides.

clusterLocation?: string

Property Value

string

clusterManagerConnectionStatus

The latest connectivity status between cluster manager and the cluster.

clusterManagerConnectionStatus?: string

Property Value

string

clusterManagerId

The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created.

clusterManagerId?: string

Property Value

string

clusterServicePrincipal

Field Deprecated: Use managed identity to provide cluster privileges. The service principal to be used by the cluster during Arc Appliance installation.

clusterServicePrincipal?: ServicePrincipalInformation

Property Value

ServicePrincipalInformation

clusterType

The type of rack configuration for the cluster.

clusterType: string

Property Value

string

clusterVersion

The current runtime version of the cluster.

clusterVersion: string

Property Value

string

commandOutputSettings

The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts.

commandOutputSettings?: CommandOutputSettings

Property Value

CommandOutputSettings

computeDeploymentThreshold

The validation threshold indicating the allowable failures of compute machines during environment validation and deployment.

computeDeploymentThreshold?: ValidationThreshold

Property Value

ValidationThreshold

computeRackDefinitions

The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster.

computeRackDefinitions?: RackDefinition[]

Property Value

RackDefinition[]

detailedStatus

The current detailed status of the cluster.

detailedStatus?: string

Property Value

string

detailedStatusMessage

The descriptive message about the 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

extendedLocation

The extended location of the resource. This property is required when creating the resource.

extendedLocation: ExtendedLocation

Property Value

ExtendedLocation

hybridAksExtendedLocation

Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters).

hybridAksExtendedLocation?: ExtendedLocation

Property Value

ExtendedLocation

identity

The managed service identities assigned to this resource.

identity?: ManagedServiceIdentity

Property Value

ManagedServiceIdentity

kind

The type (kind) of the cluster. When specified, the value must exactly match the kind configured on the cluster manager that manages the cluster. If omitted, the service will default the value to the kind value of the cluster manager.

kind?: string

Property Value

string

lastSuccessfulVersionUpdateTime

The date and time of the end of the last successful version update for the cluster.

lastSuccessfulVersionUpdateTime?: Date

Property Value

Date

managedCredentials

The list of credentials that are managed for the cluster and can be rotated on-demand.

managedCredentials?: string[]

Property Value

string[]

managedResourceGroupConfiguration

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

managedResourceGroupConfiguration?: ManagedResourceGroupConfiguration

Property Value

ManagedResourceGroupConfiguration

manualActionCount

The count of Manual Action Taken (MAT) events that have not been validated.

manualActionCount?: number

Property Value

number

networkFabricId

The resource ID of the Network Fabric associated with the cluster.

networkFabricId: string

Property Value

string

provisioningState

The provisioning state of the cluster.

provisioningState?: string

Property Value

string

runtimeProtectionConfiguration

The settings for cluster runtime protection.

runtimeProtectionConfiguration?: RuntimeProtectionConfiguration

Property Value

RuntimeProtectionConfiguration

secretArchive

The configuration for use of a key vault to store secrets for later retrieval by the operator.

secretArchive?: ClusterSecretArchive

Property Value

ClusterSecretArchive

secretArchiveSettings

The settings for the secret archive used to hold credentials for the cluster.

secretArchiveSettings?: SecretArchiveSettings

Property Value

SecretArchiveSettings

supportExpiryDate

The support end date of the runtime version of the cluster.

supportExpiryDate?: string

Property Value

string

updateStrategy

The strategy for updating the cluster.

updateStrategy?: ClusterUpdateStrategy

Property Value

ClusterUpdateStrategy

vulnerabilityScanningSettings

The settings for how security vulnerability scanning is applied to the cluster.

vulnerabilityScanningSettings?: VulnerabilityScanningSettings

Property Value

VulnerabilityScanningSettings

workloadResourceIds

The list of workload resource IDs that are hosted within this cluster.

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