Clusters - List By Resource Group

Service:

Azure Stack HCI

API Version:

2024-04-01

List all HCI clusters in a resource group.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters?api-version=2024-04-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ClusterList	OK
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List clusters in a given resource group

Sample request

HTTP

GET https://management.azure.com/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters?api-version=2024-04-01

Java

/**
 * Samples for Clusters ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/
     * ListClustersByResourceGroup.json
     */
    /**
     * Sample code: List clusters in a given resource group.
     * 
     * @param manager Entry point to AzureStackHciManager.
     */
    public static void
        listClustersInAGivenResourceGroup(com.azure.resourcemanager.azurestackhci.AzureStackHciManager manager) {
        manager.clusters().listByResourceGroup("test-rg", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.azurestackhci import AzureStackHCIClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-azurestackhci
# USAGE
    python list_clusters_by_resource_group.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AzureStackHCIClient(
        credential=DefaultAzureCredential(),
        subscription_id="fd3c3665-1729-4b7b-9a38-238e83b0f98b",
    )

    response = client.clusters.list_by_resource_group(
        resource_group_name="test-rg",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListClustersByResourceGroup.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armazurestackhci_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/azurestackhci/armazurestackhci/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListClustersByResourceGroup.json
func ExampleClustersClient_NewListByResourceGroupPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewClustersClient().NewListByResourceGroupPager("test-rg", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ClusterList = armazurestackhci.ClusterList{
		// 	Value: []*armazurestackhci.Cluster{
		// 		{
		// 			Name: to.Ptr("myCluster1"),
		// 			Type: to.Ptr("Microsoft.AzureStackHCI/clusters"),
		// 			ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster1"),
		// 			SystemData: &armazurestackhci.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
		// 				CreatedBy: to.Ptr("user1"),
		// 				CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("user2"),
		// 				LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
		// 			},
		// 			Location: to.Ptr("East US"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armazurestackhci.ClusterProperties{
		// 				AADClientID: to.Ptr("515da1c2-379e-49b4-9975-09e3e40c86be"),
		// 				AADTenantID: to.Ptr("7e589cc1-a8b6-4dff-91bd-5ec0fa18db94"),
		// 				BillingModel: to.Ptr("Trial"),
		// 				CloudID: to.Ptr("91c2b355-4826-4e96-9164-e3f26dcf1cdd"),
		// 				CloudManagementEndpoint: to.Ptr("https://98294836-31be-4668-aeae-698667faf99b.waconazure.com"),
		// 				ConnectivityStatus: to.Ptr(armazurestackhci.ConnectivityStatusNotYetRegistered),
		// 				DesiredProperties: &armazurestackhci.ClusterDesiredProperties{
		// 					DiagnosticLevel: to.Ptr(armazurestackhci.DiagnosticLevelBasic),
		// 					WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
		// 				},
		// 				ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
		// 				ReportedProperties: &armazurestackhci.ClusterReportedProperties{
		// 				},
		// 				Status: to.Ptr(armazurestackhci.StatusNotYetRegistered),
		// 				TrialDaysRemaining: to.Ptr[float32](29),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("myCluster2"),
		// 			Type: to.Ptr("Microsoft.AzureStackHCI/clusters"),
		// 			ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster2"),
		// 			SystemData: &armazurestackhci.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
		// 				CreatedBy: to.Ptr("user1"),
		// 				CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("user2"),
		// 				LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
		// 			},
		// 			Location: to.Ptr("East US"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armazurestackhci.ClusterProperties{
		// 				AADClientID: to.Ptr("24a6e53d-04e5-44d2-b7cc-1b732a847dfc"),
		// 				AADTenantID: to.Ptr("7e589cc1-a8b6-4dff-91bd-5ec0fa18db94"),
		// 				BillingModel: to.Ptr("Trial"),
		// 				CloudID: to.Ptr("a3c0468f-e38e-4dda-ac48-817f620536f0"),
		// 				CloudManagementEndpoint: to.Ptr("https://98294836-31be-4668-aeae-698667faf99b.waconazure.com"),
		// 				ConnectivityStatus: to.Ptr(armazurestackhci.ConnectivityStatusPartiallyConnected),
		// 				DesiredProperties: &armazurestackhci.ClusterDesiredProperties{
		// 					DiagnosticLevel: to.Ptr(armazurestackhci.DiagnosticLevelBasic),
		// 					WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
		// 				},
		// 				LastBillingTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-12T08:12:55.231Z"); return t}()),
		// 				LastSyncTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T20:44:32.562Z"); return t}()),
		// 				ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
		// 				RegistrationTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T20:44:32.562Z"); return t}()),
		// 				ReportedProperties: &armazurestackhci.ClusterReportedProperties{
		// 					ClusterID: to.Ptr("a76ac23a-1819-4e82-9410-e3e4ec3d1425"),
		// 					ClusterName: to.Ptr("cluster1"),
		// 					ClusterType: to.Ptr(armazurestackhci.ClusterNodeTypeThirdParty),
		// 					ClusterVersion: to.Ptr("10.0.17777"),
		// 					DiagnosticLevel: to.Ptr(armazurestackhci.DiagnosticLevelBasic),
		// 					ImdsAttestation: to.Ptr(armazurestackhci.ImdsAttestationDisabled),
		// 					LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T19:24:42.194Z"); return t}()),
		// 					Manufacturer: to.Ptr("Dell Inc."),
		// 					Nodes: []*armazurestackhci.ClusterNode{
		// 						{
		// 							Name: to.Ptr("Node1"),
		// 							CoreCount: to.Ptr[float32](8),
		// 							ID: to.Ptr[float32](0),
		// 							Manufacturer: to.Ptr("Dell Inc."),
		// 							MemoryInGiB: to.Ptr[float32](128),
		// 							Model: to.Ptr("EMC AX740"),
		// 							OemActivation: to.Ptr(armazurestackhci.OemActivationEnabled),
		// 							OSName: to.Ptr("Azure Stack HCI"),
		// 							OSVersion: to.Ptr("10.0.17777.1061"),
		// 							SerialNumber: to.Ptr("Q45CZC3"),
		// 							WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
		// 						},
		// 						{
		// 							Name: to.Ptr("Node2"),
		// 							CoreCount: to.Ptr[float32](8),
		// 							ID: to.Ptr[float32](1),
		// 							Manufacturer: to.Ptr("Dell Inc."),
		// 							MemoryInGiB: to.Ptr[float32](128),
		// 							Model: to.Ptr("EMC AX740"),
		// 							OemActivation: to.Ptr(armazurestackhci.OemActivationEnabled),
		// 							OSName: to.Ptr("Azure Stack HCI"),
		// 							OSVersion: to.Ptr("10.0.17777.1061"),
		// 							SerialNumber: to.Ptr("Q44BSC3"),
		// 							WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
		// 						},
		// 						{
		// 							Name: to.Ptr("Node3"),
		// 							CoreCount: to.Ptr[float32](16),
		// 							ID: to.Ptr[float32](2),
		// 							Manufacturer: to.Ptr("Dell Inc."),
		// 							MemoryInGiB: to.Ptr[float32](256),
		// 							Model: to.Ptr("EMC AX740"),
		// 							OemActivation: to.Ptr(armazurestackhci.OemActivationDisabled),
		// 							OSName: to.Ptr("Azure Stack HCI"),
		// 							OSVersion: to.Ptr("10.0.17777.1061"),
		// 							SerialNumber: to.Ptr("Q44RFC3"),
		// 							WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
		// 					}},
		// 					OemActivation: to.Ptr(armazurestackhci.OemActivationDisabled),
		// 				},
		// 				Status: to.Ptr(armazurestackhci.StatusConnectedRecently),
		// 				TrialDaysRemaining: to.Ptr[float32](30),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AzureStackHCIClient } = require("@azure/arm-azurestackhci");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List all HCI clusters in a resource group.
 *
 * @summary List all HCI clusters in a resource group.
 * x-ms-original-file: specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListClustersByResourceGroup.json
 */
async function listClustersInAGivenResourceGroup() {
  const subscriptionId =
    process.env["AZURESTACKHCI_SUBSCRIPTION_ID"] || "fd3c3665-1729-4b7b-9a38-238e83b0f98b";
  const resourceGroupName = process.env["AZURESTACKHCI_RESOURCE_GROUP"] || "test-rg";
  const credential = new DefaultAzureCredential();
  const client = new AzureStackHCIClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.clusters.listByResourceGroup(resourceGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Hci.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Hci;

// Generated from example definition: specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListClustersByResourceGroup.json
// this example is just showing the usage of "Clusters_ListByResourceGroup" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "fd3c3665-1729-4b7b-9a38-238e83b0f98b";
string resourceGroupName = "test-rg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this HciClusterResource
HciClusterCollection collection = resourceGroupResource.GetHciClusters();

// invoke the operation and iterate over the result
await foreach (HciClusterResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    HciClusterData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster1",
      "name": "myCluster1",
      "type": "Microsoft.AzureStackHCI/clusters",
      "location": "East US",
      "tags": {},
      "systemData": {
        "createdBy": "user1",
        "createdByType": "User",
        "createdAt": "2020-01-01T17:18:19.1234567Z",
        "lastModifiedBy": "user2",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "status": "NotYetRegistered",
        "connectivityStatus": "NotYetRegistered",
        "cloudId": "91c2b355-4826-4e96-9164-e3f26dcf1cdd",
        "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com",
        "aadClientId": "515da1c2-379e-49b4-9975-09e3e40c86be",
        "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94",
        "desiredProperties": {
          "windowsServerSubscription": "Enabled",
          "diagnosticLevel": "Basic"
        },
        "reportedProperties": {},
        "trialDaysRemaining": 29,
        "billingModel": "Trial"
      }
    },
    {
      "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster2",
      "name": "myCluster2",
      "type": "Microsoft.AzureStackHCI/clusters",
      "location": "East US",
      "tags": {},
      "systemData": {
        "createdBy": "user1",
        "createdByType": "User",
        "createdAt": "2020-01-01T17:18:19.1234567Z",
        "lastModifiedBy": "user2",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "status": "ConnectedRecently",
        "connectivityStatus": "PartiallyConnected",
        "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0",
        "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com",
        "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc",
        "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94",
        "desiredProperties": {
          "windowsServerSubscription": "Enabled",
          "diagnosticLevel": "Basic"
        },
        "reportedProperties": {
          "clusterName": "cluster1",
          "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425",
          "clusterVersion": "10.0.17777",
          "clusterType": "ThirdParty",
          "manufacturer": "Dell Inc.",
          "oemActivation": "Disabled",
          "nodes": [
            {
              "name": "Node1",
              "id": 0,
              "windowsServerSubscription": "Enabled",
              "manufacturer": "Dell Inc.",
              "model": "EMC AX740",
              "osName": "Azure Stack HCI",
              "osVersion": "10.0.17777.1061",
              "serialNumber": "Q45CZC3",
              "coreCount": 8,
              "memoryInGiB": 128,
              "oemActivation": "Enabled"
            },
            {
              "name": "Node2",
              "id": 1,
              "windowsServerSubscription": "Enabled",
              "manufacturer": "Dell Inc.",
              "model": "EMC AX740",
              "osName": "Azure Stack HCI",
              "osVersion": "10.0.17777.1061",
              "serialNumber": "Q44BSC3",
              "coreCount": 8,
              "memoryInGiB": 128,
              "oemActivation": "Enabled"
            },
            {
              "name": "Node3",
              "id": 2,
              "windowsServerSubscription": "Enabled",
              "manufacturer": "Dell Inc.",
              "model": "EMC AX740",
              "osName": "Azure Stack HCI",
              "osVersion": "10.0.17777.1061",
              "serialNumber": "Q44RFC3",
              "coreCount": 16,
              "memoryInGiB": 256,
              "oemActivation": "Disabled"
            }
          ],
          "lastUpdated": "2020-03-11T19:24:42.1946017Z",
          "imdsAttestation": "Disabled",
          "diagnosticLevel": "Basic"
        },
        "trialDaysRemaining": 30,
        "billingModel": "Trial",
        "registrationTimestamp": "2020-03-11T20:44:32.5625121Z",
        "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z",
        "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z"
      }
    }
  ]
}

Definitions

Name	Description
AccessLevel	Remote Support Access Level
Cluster	Cluster details.
ClusterDesiredProperties	Desired properties of the cluster.
ClusterList	List of clusters.
ClusterNode	Cluster node details.
ClusterNodeType	Type of the cluster node hardware.
ClusterReportedProperties	Properties reported by cluster agent.
ConnectivityStatus	Overall connectivity status for the cluster resource.
createdByType	The type of identity that created the resource.
DiagnosticLevel	Desired level of diagnostic data emitted by the cluster.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ImdsAttestation	IMDS attestation status of the cluster.
IsolatedVmAttestationConfiguration	Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster.
LogCollectionError	Log Collection Error details of the cluster.
LogCollectionJobType	LogCollection job type
LogCollectionProperties	Log Collection properties of the cluster.
LogCollectionSession	Log Collection Session details of the cluster.
LogCollectionStatus	LogCollection status
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
OemActivation	OEM activation status of the node.
PerNodeRemoteSupportSession	Remote Support Node Session Details on the Node.
ProvisioningState	Provisioning state.
RemoteSupportNodeSettings	Remote Support Node Settings of the cluster.
RemoteSupportProperties	Remote Support properties of the cluster.
RemoteSupportType	Remote Support Type for cluster
SoftwareAssuranceIntent	Customer Intent for Software Assurance Benefit.
SoftwareAssuranceProperties	Software Assurance properties of the cluster.
SoftwareAssuranceStatus	Status of the Software Assurance for the cluster.
Status	Status of the cluster agent.
systemData	Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentity	User assigned identity properties
WindowsServerSubscription	Desired state of Windows Server Subscription.

AccessLevel

Enumeration

Remote Support Access Level

Value	Description
Diagnostics
DiagnosticsAndRepair

Cluster

Object

Cluster details.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity.principalId	string (uuid)	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
identity.tenantId	string (uuid)	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
identity.type	ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
identity.userAssignedIdentities	<string,  UserAssignedIdentity>	User-Assigned Identities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.aadApplicationObjectId	string	Object id of cluster AAD identity.
properties.aadClientId	string	App id of cluster AAD identity.
properties.aadServicePrincipalObjectId	string	Id of cluster identity service principal.
properties.aadTenantId	string	Tenant id of cluster AAD identity.
properties.billingModel	string	Type of billing applied to the resource.
properties.cloudId	string	Unique, immutable resource id.
properties.cloudManagementEndpoint	string	Endpoint configured for management from the Azure portal.
properties.connectivityStatus	ConnectivityStatus	Overall connectivity status for the cluster resource.
properties.desiredProperties	ClusterDesiredProperties	Desired properties of the cluster.
properties.isolatedVmAttestationConfiguration	IsolatedVmAttestationConfiguration	Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster.
properties.lastBillingTimestamp	string (date-time)	Most recent billing meter timestamp.
properties.lastSyncTimestamp	string (date-time)	Most recent cluster sync timestamp.
properties.logCollectionProperties	LogCollectionProperties	Log Collection properties of the cluster.
properties.provisioningState	ProvisioningState	Provisioning state.
properties.registrationTimestamp	string (date-time)	First cluster sync timestamp.
properties.remoteSupportProperties	RemoteSupportProperties	RemoteSupport properties of the cluster.
properties.reportedProperties	ClusterReportedProperties	Properties reported by cluster agent.
properties.resourceProviderObjectId	string	Object id of RP Service Principal
properties.serviceEndpoint	string	Region specific DataPath Endpoint of the cluster.
properties.softwareAssuranceProperties	SoftwareAssuranceProperties	Software Assurance properties of the cluster.
properties.status	Status	Status of the cluster agent.
properties.trialDaysRemaining	number	Number of days remaining in the trial period.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ClusterDesiredProperties

Object

Desired properties of the cluster.

Name	Type	Description
diagnosticLevel	DiagnosticLevel	Desired level of diagnostic data emitted by the cluster.
windowsServerSubscription	WindowsServerSubscription	Desired state of Windows Server Subscription.

ClusterList

Object

List of clusters.

Name	Type	Description
nextLink	string	Link to the next set of results.
value	Cluster[]	List of clusters.

ClusterNode

Object

Cluster node details.

Name	Type	Description
coreCount	number	Number of physical cores on the cluster node.
ehcResourceId	string	Edge Hardware Center Resource Id
id	number	Id of the node in the cluster.
lastLicensingTimestamp	string (date-time)	Most recent licensing timestamp.
manufacturer	string	Manufacturer of the cluster node hardware.
memoryInGiB	number	Total available memory on the cluster node (in GiB).
model	string	Model name of the cluster node hardware.
name	string	Name of the cluster node.
nodeType	ClusterNodeType	Type of the cluster node hardware.
oemActivation	OemActivation	OEM activation status of the node.
osDisplayVersion	string	Display version of the operating system running on the cluster node.
osName	string	Operating system running on the cluster node.
osVersion	string	Version of the operating system running on the cluster node.
serialNumber	string	Immutable id of the cluster node.
windowsServerSubscription	WindowsServerSubscription	State of Windows Server Subscription.

ClusterNodeType

Enumeration

Type of the cluster node hardware.

Value	Description
FirstParty
ThirdParty

ClusterReportedProperties

Object

Properties reported by cluster agent.

Name	Type	Description
clusterId	string	Unique id generated by the on-prem cluster.
clusterName	string	Name of the on-prem cluster connected to this resource.
clusterType	ClusterNodeType	The node type of all the nodes of the cluster.
clusterVersion	string	Version of the cluster software.
diagnosticLevel	DiagnosticLevel	Level of diagnostic data emitted by the cluster.
imdsAttestation	ImdsAttestation	IMDS attestation status of the cluster.
lastUpdated	string (date-time)	Last time the cluster reported the data.
manufacturer	string	The manufacturer of all the nodes of the cluster.
nodes	ClusterNode[]	List of nodes reported by the cluster.
oemActivation	OemActivation	OEM activation status of the cluster.
supportedCapabilities	string[]	Capabilities supported by the cluster.

ConnectivityStatus

Enumeration

Overall connectivity status for the cluster resource.

Value	Description
NotYetRegistered
Connected
NotConnectedRecently
PartiallyConnected
Disconnected
NotSpecified

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DiagnosticLevel

Enumeration

Desired level of diagnostic data emitted by the cluster.

Value	Description
Off
Basic
Enhanced

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ImdsAttestation

Enumeration

IMDS attestation status of the cluster.

Value	Description
Disabled
Enabled

IsolatedVmAttestationConfiguration

Object

Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster.

Name	Type	Description
attestationResourceId	string (arm-id)	Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster.
attestationServiceEndpoint	string	Region specific endpoint for Microsoft Azure Attestation service for the cluster
relyingPartyServiceEndpoint	string	Region specific endpoint for relying party service.

LogCollectionError

Object

Log Collection Error details of the cluster.

Name	Type	Description
errorCode	string	Error Code of the log collection
errorMessage	string	Error Message of the log collection

LogCollectionJobType

Enumeration

LogCollection job type

Value	Description
OnDemand
Scheduled

LogCollectionProperties

Object

Log Collection properties of the cluster.

Name	Type	Description
fromDate	string (date-time)	From DateTimeStamp from when logs need to be connected
lastLogGenerated	string (date-time)	Recent DateTimeStamp where logs are successfully generated
logCollectionSessionDetails	LogCollectionSession[]	Log Collection Session details of the cluster.
toDate	string (date-time)	To DateTimeStamp till when logs need to be connected

LogCollectionSession

Object

Log Collection Session details of the cluster.

Name	Type	Description
correlationId	string	CorrelationId of the log collection
endTimeCollected	string (date-time)	End Time of the logs when it was collected
logCollectionError	LogCollectionError	Log Collection Error details of the cluster.
logCollectionJobType	LogCollectionJobType	LogCollection job type
logCollectionStatus	LogCollectionStatus	LogCollection status
logEndTime	string (date-time)	End Time of the logs when it was collected
logSize	integer (int64)	Size of the logs collected
logStartTime	string (date-time)	Start Time of the logs when it was collected
timeCollected	string (date-time)	Duration of logs collected

LogCollectionStatus

Enumeration

LogCollection status

Value	Description
None
InProgress
Failed
Succeeded

ManagedServiceIdentityType

Enumeration

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Value	Description
None
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned

OemActivation

Enumeration

OEM activation status of the node.

Value	Description
Disabled
Enabled

PerNodeRemoteSupportSession

Object

Remote Support Node Session Details on the Node.

Name	Type	Description
accessLevel	AccessLevel	Remote Support Access Level
duration	integer (int64)	Duration of Remote Support Enablement
nodeName	string	Name of the node
sessionEndTime	string (date-time)	Remote Support Session EndTime on the Node
sessionStartTime	string (date-time)	Remote Support Session StartTime on the Node

ProvisioningState

Enumeration

Provisioning state.

Value	Description
Succeeded
Failed
Canceled
Accepted
Provisioning
NotSpecified
Creating
Updating
Deleting
Moving
Deleted
PartiallySucceeded
InProgress
DisableInProgress
Connected
PartiallyConnected
Disconnected

RemoteSupportNodeSettings

Object

Remote Support Node Settings of the cluster.

Name	Type	Description
arcResourceId	string	Arc ResourceId of the Node
connectionErrorMessage	string	Remote Support Access Connection Error Message on the Node
connectionStatus	string	Remote Support Access Connection Status on the Node
createdAt	string (date-time)	Remote Support Enablement Request Created TimeStamp on the Node
state	string	Remote Support Access Connection State on the Node
transcriptLocation	string	Remote Support Transcript location on the node
updatedAt	string (date-time)	Remote Support Enablement Request Updated TimeStamp on the Node

RemoteSupportProperties

Object

Remote Support properties of the cluster.

Name	Type	Description
accessLevel	AccessLevel	Remote Support Access Level
expirationTimeStamp	string (date-time)	Expiration DateTimeStamp when Remote Support Access will be expired
remoteSupportNodeSettings	RemoteSupportNodeSettings[]	Remote Support Node Settings of the cluster.
remoteSupportSessionDetails	PerNodeRemoteSupportSession[]	Remote Support Node Session Details on the Node.
remoteSupportType	RemoteSupportType	Remote Support Type for cluster

RemoteSupportType

Enumeration

Remote Support Type for cluster

Value	Description
Enable
Revoke

SoftwareAssuranceIntent

Enumeration

Customer Intent for Software Assurance Benefit.

Value	Description
Enable
Disable

SoftwareAssuranceProperties

Object

Software Assurance properties of the cluster.

Name	Type	Description
lastUpdated	string (date-time)	TimeStamp denoting the latest SA benefit applicability is validated.
softwareAssuranceIntent	SoftwareAssuranceIntent	Customer Intent for Software Assurance Benefit.
softwareAssuranceStatus	SoftwareAssuranceStatus	Status of the Software Assurance for the cluster.

SoftwareAssuranceStatus

Enumeration

Status of the Software Assurance for the cluster.

Value	Description
Enabled
Disabled

Status

Enumeration

Status of the cluster agent.

Value	Description
NotYetRegistered
ConnectedRecently
NotConnectedRecently
Disconnected
Error
NotSpecified
ValidationInProgress
ValidationSuccess
ValidationFailed
DeploymentInProgress
DeploymentFailed
DeploymentSuccess

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UserAssignedIdentity

Object

User assigned identity properties

Name	Type	Description
clientId	string (uuid)	The client ID of the assigned identity.
principalId	string (uuid)	The principal ID of the assigned identity.

WindowsServerSubscription

Enumeration

Desired state of Windows Server Subscription.

Value	Description
Disabled
Enabled