ClusterProperties interface

ClusterProperties represents the properties of a cluster.

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

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

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

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[]

ClusterProperties interface

Properties

Property Details

actionStates

Property Value

aggregatorOrSingleRackDefinition

Property Value

analyticsOutputSettings

Property Value

analyticsWorkspaceId

Property Value

availableUpgradeVersions

Property Value

clusterCapacity

Property Value

clusterConnectionStatus

Property Value

clusterExtendedLocation

Property Value

clusterLocation

Property Value

clusterManagerConnectionStatus

Property Value

clusterManagerId

Property Value

clusterServicePrincipal

Property Value

clusterType

Property Value

clusterVersion

Property Value

commandOutputSettings

Property Value

computeDeploymentThreshold

Property Value

computeRackDefinitions

Property Value

detailedStatus

Property Value

detailedStatusMessage

Property Value

hybridAksExtendedLocation

Property Value

lastSuccessfulVersionUpdateTime

Property Value

managedCredentials

Property Value

managedResourceGroupConfiguration

Property Value

manualActionCount

Property Value

networkFabricId

Property Value

provisioningState

Property Value

runtimeProtectionConfiguration

Property Value

secretArchive

Property Value

secretArchiveSettings

Property Value

supportExpiryDate

Property Value

updateStrategy

Property Value

vulnerabilityScanningSettings

Property Value

workloadResourceIds

Property Value