你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Clusters - Get

Service:: Operator Nexus - Network Cloud

API Version:: 2025-02-01

Retrieve the cluster.
Get properties of the provided cluster.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}?api-version=2025-02-01

URI Parameters

Name	In	Required	Type	Description
clusterName	path	True	string pattern: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$	The name of the cluster.
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	Cluster	The resource has been successfully retrieved.
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

Get cluster

Sample request

GET https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName?api-version=2025-02-01


/**
 * Samples for Clusters GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2025-02-01/examples/Clusters_Get.json
     */
    /**
     * Sample code: Get cluster.
     * 
     * @param manager Entry point to NetworkCloudManager.
     */
    public static void getCluster(com.azure.resourcemanager.networkcloud.NetworkCloudManager manager) {
        manager.clusters().getByResourceGroupWithResponse("resourceGroupName", "clusterName",
            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

from azure.identity import DefaultAzureCredential

from azure.mgmt.networkcloud import NetworkCloudMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-networkcloud
# USAGE
    python clusters_get.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 = NetworkCloudMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="123e4567-e89b-12d3-a456-426655440000",
    )

    response = client.clusters.get(
        resource_group_name="resourceGroupName",
        cluster_name="clusterName",
    )
    print(response)


# x-ms-original-file: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2025-02-01/examples/Clusters_Get.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

package armnetworkcloud_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/networkcloud/armnetworkcloud"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d0d3a9b4fe0fce880fded7a617e71f84406bacbd/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2025-02-01/examples/Clusters_Get.json
func ExampleClustersClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetworkcloud.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewClustersClient().Get(ctx, "resourceGroupName", "clusterName", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Cluster = armnetworkcloud.Cluster{
	// 	Name: to.Ptr("clusterName"),
	// 	Type: to.Ptr("Microsoft.NetworkCloud/clusters"),
	// 	ID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName"),
	// 	SystemData: &armnetworkcloud.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-22T13:27:03.008Z"); return t}()),
	// 		CreatedBy: to.Ptr("identityA"),
	// 		CreatedByType: to.Ptr(armnetworkcloud.CreatedByTypeApplication),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-22T13:29:03.001Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("identityB"),
	// 		LastModifiedByType: to.Ptr(armnetworkcloud.CreatedByTypeUser),
	// 	},
	// 	Location: to.Ptr("location"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("myvalue1"),
	// 		"key2": to.Ptr("myvalue2"),
	// 	},
	// 	ExtendedLocation: &armnetworkcloud.ExtendedLocation{
	// 		Name: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName"),
	// 		Type: to.Ptr("CustomLocation"),
	// 	},
	// 	Identity: &armnetworkcloud.ManagedServiceIdentity{
	// 		Type: to.Ptr(armnetworkcloud.ManagedServiceIdentityTypeUserAssigned),
	// 		UserAssignedIdentities: map[string]*armnetworkcloud.UserAssignedIdentity{
	// 			"/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": &armnetworkcloud.UserAssignedIdentity{
	// 			},
	// 		},
	// 	},
	// 	Properties: &armnetworkcloud.ClusterProperties{
	// 		AggregatorOrSingleRackDefinition: &armnetworkcloud.RackDefinition{
	// 			BareMetalMachineConfigurationData: []*armnetworkcloud.BareMetalMachineConfigurationData{
	// 				{
	// 					BmcConnectionString: to.Ptr("bmcConnectionString"),
	// 					BmcCredentials: &armnetworkcloud.AdministrativeCredentials{
	// 						Username: to.Ptr("username"),
	// 					},
	// 					BmcMacAddress: to.Ptr("AA:BB:CC:DD:EE:FF"),
	// 					BootMacAddress: to.Ptr("00:BB:CC:DD:EE:FF"),
	// 					MachineDetails: to.Ptr("extraDetails"),
	// 					MachineName: to.Ptr("bmmName1"),
	// 					RackSlot: to.Ptr[int64](1),
	// 					SerialNumber: to.Ptr("BM1219XXX"),
	// 				},
	// 				{
	// 					BmcConnectionString: to.Ptr("bmcConnectionString"),
	// 					BmcCredentials: &armnetworkcloud.AdministrativeCredentials{
	// 						Username: to.Ptr("username"),
	// 					},
	// 					BmcMacAddress: to.Ptr("AA:BB:CC:DD:EE:00"),
	// 					BootMacAddress: to.Ptr("00:BB:CC:DD:EE:00"),
	// 					MachineDetails: to.Ptr("extraDetails"),
	// 					MachineName: to.Ptr("bmmName2"),
	// 					RackSlot: to.Ptr[int64](2),
	// 					SerialNumber: to.Ptr("BM1219YYY"),
	// 			}},
	// 			NetworkRackID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName"),
	// 			RackLocation: to.Ptr("Foo Datacenter, Floor 3, Aisle 9, Rack 2"),
	// 			RackSerialNumber: to.Ptr("AA1234"),
	// 			RackSKUID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName"),
	// 			StorageApplianceConfigurationData: []*armnetworkcloud.StorageApplianceConfigurationData{
	// 				{
	// 					AdminCredentials: &armnetworkcloud.AdministrativeCredentials{
	// 						Username: to.Ptr("username"),
	// 					},
	// 					RackSlot: to.Ptr[int64](1),
	// 					SerialNumber: to.Ptr("BM1219XXX"),
	// 					StorageApplianceName: to.Ptr("vmName"),
	// 			}},
	// 		},
	// 		AnalyticsOutputSettings: &armnetworkcloud.AnalyticsOutputSettings{
	// 			AnalyticsWorkspaceID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName"),
	// 			AssociatedIdentity: &armnetworkcloud.IdentitySelector{
	// 				IdentityType: to.Ptr(armnetworkcloud.ManagedServiceIdentitySelectorTypeUserAssignedIdentity),
	// 				UserAssignedIdentityResourceID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1"),
	// 			},
	// 		},
	// 		AvailableUpgradeVersions: []*armnetworkcloud.ClusterAvailableUpgradeVersion{
	// 			{
	// 				ControlImpact: to.Ptr(armnetworkcloud.ControlImpactFalse),
	// 				ExpectedDuration: to.Ptr("0:0:30"),
	// 				ImpactDescription: to.Ptr("can be done in place"),
	// 				SupportExpiryDate: to.Ptr("2025-01-01"),
	// 				TargetClusterVersion: to.Ptr("1.0.2"),
	// 				WorkloadImpact: to.Ptr(armnetworkcloud.WorkloadImpactFalse),
	// 		}},
	// 		ClusterCapacity: &armnetworkcloud.ClusterCapacity{
	// 			AvailableApplianceStorageGB: to.Ptr[int64](3),
	// 			AvailableCoreCount: to.Ptr[int64](10),
	// 			AvailableHostStorageGB: to.Ptr[int64](20),
	// 			AvailableMemoryGB: to.Ptr[int64](20),
	// 			TotalApplianceStorageGB: to.Ptr[int64](10),
	// 			TotalCoreCount: to.Ptr[int64](10),
	// 			TotalHostStorageGB: to.Ptr[int64](10),
	// 			TotalMemoryGB: to.Ptr[int64](10),
	// 		},
	// 		ClusterConnectionStatus: to.Ptr(armnetworkcloud.ClusterConnectionStatusConnected),
	// 		ClusterExtendedLocation: &armnetworkcloud.ExtendedLocation{
	// 			Name: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"),
	// 			Type: to.Ptr("CustomLocation"),
	// 		},
	// 		ClusterLocation: to.Ptr("Foo Street, 3rd Floor, row 9"),
	// 		ClusterManagerConnectionStatus: to.Ptr(armnetworkcloud.ClusterManagerConnectionStatusConnected),
	// 		ClusterManagerID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName"),
	// 		ClusterServicePrincipal: &armnetworkcloud.ServicePrincipalInformation{
	// 			ApplicationID: to.Ptr("12345678-1234-1234-1234-123456789012"),
	// 			PrincipalID: to.Ptr("00000008-0004-0004-0004-000000000012"),
	// 			TenantID: to.Ptr("80000000-4000-4000-4000-120000000000"),
	// 		},
	// 		ClusterType: to.Ptr(armnetworkcloud.ClusterTypeSingleRack),
	// 		ClusterVersion: to.Ptr("1.0.0"),
	// 		CommandOutputSettings: &armnetworkcloud.CommandOutputSettings{
	// 			AssociatedIdentity: &armnetworkcloud.IdentitySelector{
	// 				IdentityType: to.Ptr(armnetworkcloud.ManagedServiceIdentitySelectorTypeUserAssignedIdentity),
	// 				UserAssignedIdentityResourceID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1"),
	// 			},
	// 			ContainerURL: to.Ptr("https://myaccount.blob.core.windows.net/mycontainer?restype=container"),
	// 		},
	// 		ComputeDeploymentThreshold: &armnetworkcloud.ValidationThreshold{
	// 			Type: to.Ptr(armnetworkcloud.ValidationThresholdTypePercentSuccess),
	// 			Grouping: to.Ptr(armnetworkcloud.ValidationThresholdGroupingPerCluster),
	// 			Value: to.Ptr[int64](90),
	// 		},
	// 		ComputeRackDefinitions: []*armnetworkcloud.RackDefinition{
	// 			{
	// 				BareMetalMachineConfigurationData: []*armnetworkcloud.BareMetalMachineConfigurationData{
	// 					{
	// 						BmcConnectionString: to.Ptr("bmcConnectionString"),
	// 						BmcCredentials: &armnetworkcloud.AdministrativeCredentials{
	// 							Username: to.Ptr("username"),
	// 						},
	// 						BmcMacAddress: to.Ptr("AA:BB:CC:DD:EE:FF"),
	// 						BootMacAddress: to.Ptr("00:BB:CC:DD:EE:FF"),
	// 						MachineDetails: to.Ptr("extraDetails"),
	// 						MachineName: to.Ptr("bmmName1"),
	// 						RackSlot: to.Ptr[int64](1),
	// 						SerialNumber: to.Ptr("BM1219XXX"),
	// 					},
	// 					{
	// 						BmcConnectionString: to.Ptr("bmcConnectionString"),
	// 						BmcCredentials: &armnetworkcloud.AdministrativeCredentials{
	// 							Username: to.Ptr("username"),
	// 						},
	// 						BmcMacAddress: to.Ptr("AA:BB:CC:DD:EE:00"),
	// 						BootMacAddress: to.Ptr("00:BB:CC:DD:EE:00"),
	// 						MachineDetails: to.Ptr("extraDetails"),
	// 						MachineName: to.Ptr("bmmName2"),
	// 						RackSlot: to.Ptr[int64](2),
	// 						SerialNumber: to.Ptr("BM1219YYY"),
	// 				}},
	// 				NetworkRackID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName"),
	// 				RackLocation: to.Ptr("Foo Datacenter, Floor 3, Aisle 9, Rack 2"),
	// 				RackSerialNumber: to.Ptr("AA1234"),
	// 				RackSKUID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName"),
	// 				StorageApplianceConfigurationData: []*armnetworkcloud.StorageApplianceConfigurationData{
	// 					{
	// 						AdminCredentials: &armnetworkcloud.AdministrativeCredentials{
	// 							Username: to.Ptr("username"),
	// 						},
	// 						RackSlot: to.Ptr[int64](1),
	// 						SerialNumber: to.Ptr("BM1219XXX"),
	// 						StorageApplianceName: to.Ptr("vmName"),
	// 				}},
	// 		}},
	// 		DetailedStatus: to.Ptr(armnetworkcloud.ClusterDetailedStatusRunning),
	// 		DetailedStatusMessage: to.Ptr("Cluster is running and healthy"),
	// 		ManagedResourceGroupConfiguration: &armnetworkcloud.ManagedResourceGroupConfiguration{
	// 			Name: to.Ptr("my-managed-rg"),
	// 			Location: to.Ptr("East US"),
	// 		},
	// 		ManualActionCount: to.Ptr[int64](0),
	// 		NetworkFabricID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName"),
	// 		ProvisioningState: to.Ptr(armnetworkcloud.ClusterProvisioningStateSucceeded),
	// 		RuntimeProtectionConfiguration: &armnetworkcloud.RuntimeProtectionConfiguration{
	// 			EnforcementLevel: to.Ptr(armnetworkcloud.RuntimeProtectionEnforcementLevelOnDemand),
	// 		},
	// 		SecretArchiveSettings: &armnetworkcloud.SecretArchiveSettings{
	// 			AssociatedIdentity: &armnetworkcloud.IdentitySelector{
	// 				IdentityType: to.Ptr(armnetworkcloud.ManagedServiceIdentitySelectorTypeUserAssignedIdentity),
	// 				UserAssignedIdentityResourceID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1"),
	// 			},
	// 			VaultURI: to.Ptr("https://keyvaultname.vault.azure.net/"),
	// 		},
	// 		SupportExpiryDate: to.Ptr("2023-04-29"),
	// 		UpdateStrategy: &armnetworkcloud.ClusterUpdateStrategy{
	// 			MaxUnavailable: to.Ptr[int64](4),
	// 			StrategyType: to.Ptr(armnetworkcloud.ClusterUpdateStrategyTypeRack),
	// 			ThresholdType: to.Ptr(armnetworkcloud.ValidationThresholdTypeCountSuccess),
	// 			ThresholdValue: to.Ptr[int64](4),
	// 			WaitTimeMinutes: to.Ptr[int64](10),
	// 		},
	// 		VulnerabilityScanningSettings: &armnetworkcloud.VulnerabilityScanningSettings{
	// 			ContainerScan: to.Ptr(armnetworkcloud.VulnerabilityScanningSettingsContainerScanEnabled),
	// 		},
	// 		WorkloadResourceIDs: []*string{
	// 			to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName")},
	// 		},
	// 	}
}

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

const { NetworkCloud } = require("@azure/arm-networkcloud");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Get properties of the provided cluster.
 *
 * @summary Get properties of the provided cluster.
 * x-ms-original-file: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2025-02-01/examples/Clusters_Get.json
 */
async function getCluster() {
  const subscriptionId =
    process.env["NETWORKCLOUD_SUBSCRIPTION_ID"] || "123e4567-e89b-12d3-a456-426655440000";
  const resourceGroupName = process.env["NETWORKCLOUD_RESOURCE_GROUP"] || "resourceGroupName";
  const clusterName = "clusterName";
  const credential = new DefaultAzureCredential();
  const client = new NetworkCloud(credential, subscriptionId);
  const result = await client.clusters.get(resourceGroupName, clusterName);
  console.log(result);
}

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

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

// Generated from example definition: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2025-02-01/examples/Clusters_Get.json
// this example is just showing the usage of "Clusters_Get" 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 = "123e4567-e89b-12d3-a456-426655440000";
string resourceGroupName = "resourceGroupName";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this NetworkCloudClusterResource
NetworkCloudClusterCollection collection = resourceGroupResource.GetNetworkCloudClusters();

// invoke the operation
string clusterName = "clusterName";
NullableResponse<NetworkCloudClusterResource> response = await collection.GetIfExistsAsync(clusterName);
NetworkCloudClusterResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result 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
    NetworkCloudClusterData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

{
  "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName",
  "name": "clusterName",
  "systemData": {
    "createdAt": "2021-01-22T13:27:03.008Z",
    "createdBy": "identityA",
    "createdByType": "Application",
    "lastModifiedAt": "2021-01-22T13:29:03.001Z",
    "lastModifiedBy": "identityB",
    "lastModifiedByType": "User"
  },
  "type": "Microsoft.NetworkCloud/clusters",
  "location": "location",
  "tags": {
    "key1": "myvalue1",
    "key2": "myvalue2"
  },
  "extendedLocation": {
    "type": "CustomLocation",
    "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {}
    }
  },
  "properties": {
    "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName",
    "clusterType": "SingleRack",
    "analyticsOutputSettings": {
      "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName",
      "associatedIdentity": {
        "identityType": "UserAssignedIdentity",
        "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1"
      }
    },
    "clusterLocation": "Foo Street, 3rd Floor, row 9",
    "clusterVersion": "1.0.0",
    "aggregatorOrSingleRackDefinition": {
      "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName",
      "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName",
      "rackSerialNumber": "AA1234",
      "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2",
      "storageApplianceConfigurationData": [
        {
          "rackSlot": 1,
          "adminCredentials": {
            "username": "username"
          },
          "storageApplianceName": "vmName",
          "serialNumber": "BM1219XXX"
        }
      ],
      "bareMetalMachineConfigurationData": [
        {
          "rackSlot": 1,
          "bootMacAddress": "00:BB:CC:DD:EE:FF",
          "bmcCredentials": {
            "username": "username"
          },
          "bmcConnectionString": "bmcConnectionString",
          "machineName": "bmmName1",
          "machineDetails": "extraDetails",
          "bmcMacAddress": "AA:BB:CC:DD:EE:FF",
          "serialNumber": "BM1219XXX"
        },
        {
          "rackSlot": 2,
          "bootMacAddress": "00:BB:CC:DD:EE:00",
          "bmcCredentials": {
            "username": "username"
          },
          "bmcConnectionString": "bmcConnectionString",
          "machineName": "bmmName2",
          "machineDetails": "extraDetails",
          "bmcMacAddress": "AA:BB:CC:DD:EE:00",
          "serialNumber": "BM1219YYY"
        }
      ]
    },
    "computeRackDefinitions": [
      {
        "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName",
        "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName",
        "rackSerialNumber": "AA1234",
        "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2",
        "storageApplianceConfigurationData": [
          {
            "rackSlot": 1,
            "adminCredentials": {
              "username": "username"
            },
            "storageApplianceName": "vmName",
            "serialNumber": "BM1219XXX"
          }
        ],
        "bareMetalMachineConfigurationData": [
          {
            "rackSlot": 1,
            "bootMacAddress": "00:BB:CC:DD:EE:FF",
            "bmcCredentials": {
              "username": "username"
            },
            "bmcConnectionString": "bmcConnectionString",
            "machineName": "bmmName1",
            "machineDetails": "extraDetails",
            "bmcMacAddress": "AA:BB:CC:DD:EE:FF",
            "serialNumber": "BM1219XXX"
          },
          {
            "rackSlot": 2,
            "bootMacAddress": "00:BB:CC:DD:EE:00",
            "bmcCredentials": {
              "username": "username"
            },
            "bmcConnectionString": "bmcConnectionString",
            "machineName": "bmmName2",
            "machineDetails": "extraDetails",
            "bmcMacAddress": "AA:BB:CC:DD:EE:00",
            "serialNumber": "BM1219YYY"
          }
        ]
      }
    ],
    "managedResourceGroupConfiguration": {
      "name": "my-managed-rg",
      "location": "East US"
    },
    "clusterServicePrincipal": {
      "tenantId": "80000000-4000-4000-4000-120000000000",
      "principalId": "00000008-0004-0004-0004-000000000012",
      "applicationId": "12345678-1234-1234-1234-123456789012"
    },
    "commandOutputSettings": {
      "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container",
      "associatedIdentity": {
        "identityType": "UserAssignedIdentity",
        "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1"
      }
    },
    "computeDeploymentThreshold": {
      "type": "PercentSuccess",
      "grouping": "PerCluster",
      "value": 90
    },
    "secretArchiveSettings": {
      "vaultUri": "https://keyvaultname.vault.azure.net/",
      "associatedIdentity": {
        "identityType": "UserAssignedIdentity",
        "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1"
      }
    },
    "updateStrategy": {
      "strategyType": "Rack",
      "waitTimeMinutes": 10,
      "thresholdType": "CountSuccess",
      "thresholdValue": 4,
      "maxUnavailable": 4
    },
    "runtimeProtectionConfiguration": {
      "enforcementLevel": "OnDemand"
    },
    "vulnerabilityScanningSettings": {
      "containerScan": "Enabled"
    },
    "provisioningState": "Succeeded",
    "clusterExtendedLocation": {
      "type": "CustomLocation",
      "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"
    },
    "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName",
    "availableUpgradeVersions": [
      {
        "targetClusterVersion": "1.0.2",
        "expectedDuration": "0:0:30",
        "controlImpact": "False",
        "workloadImpact": "False",
        "impactDescription": "can be done in place",
        "supportExpiryDate": "2025-01-01"
      }
    ],
    "supportExpiryDate": "2023-04-29",
    "detailedStatus": "Running",
    "detailedStatusMessage": "Cluster is running and healthy",
    "clusterManagerConnectionStatus": "Connected",
    "clusterConnectionStatus": "Connected",
    "workloadResourceIds": [
      "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName"
    ],
    "clusterCapacity": {
      "totalCoreCount": 10,
      "availableCoreCount": 10,
      "totalMemoryGB": 10,
      "availableMemoryGB": 20,
      "totalHostStorageGB": 10,
      "availableHostStorageGB": 20,
      "totalApplianceStorageGB": 10,
      "availableApplianceStorageGB": 3
    },
    "manualActionCount": 0
  }
}

Definitions

Name	Description
AdministrativeCredentials	AdministrativeCredentials represents the admin credentials for the device requiring password-based authentication.
AnalyticsOutputSettings	AnalyticsOutputSettings represents the settings for the log analytics workspace used for output of logs from this cluster.
BareMetalMachineConfigurationData	BareMetalMachineConfigurationData represents configuration for the bare metal machine.
Cluster	Cluster represents the on-premises Network Cloud cluster.
ClusterAvailableUpgradeVersion	ClusterAvailableUpgradeVersion represents the various cluster upgrade parameters.
ClusterCapacity	ClusterCapacity represents various details regarding compute capacity.
ClusterConnectionStatus	The latest heartbeat status between the cluster manager and the cluster.
ClusterDetailedStatus	The current detailed status of the cluster.
ClusterManagerConnectionStatus	The latest connectivity status between cluster manager and the cluster.
ClusterProvisioningState	The provisioning state of the cluster.
ClusterSecretArchive	ClusterSecretArchive configures the key vault to archive the secrets of the cluster for later retrieval.
ClusterSecretArchiveEnabled	The indicator if the specified key vault should be used to archive the secrets of the cluster.
ClusterType	The type of rack configuration for the cluster.
ClusterUpdateStrategy	ClusterUpdateStrategy represents the strategy for updating the cluster.
ClusterUpdateStrategyType	The mode of operation for runtime protection.
CommandOutputSettings	CommandOutputSettings represents the settings for commands run within the cluster such as bare metal machine run read-only commands.
ControlImpact	The indicator of whether the control plane will be impacted during the upgrade.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ExtendedLocation	ExtendedLocation represents the Azure custom location where the resource will be created.
IdentitySelector	IdentitySelector represents the selection of a managed identity for use.
ManagedResourceGroupConfiguration	ManagedResourceGroupConfiguration represents the configuration of the resource group managed by Azure.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
ManagedServiceIdentitySelectorType	The type of managed identity that is being selected.
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
RackDefinition	RackDefinition represents details regarding the rack.
RuntimeProtectionConfiguration	RuntimeProtectionConfiguration represents the runtime protection configuration for the cluster.
RuntimeProtectionEnforcementLevel	The mode of operation for runtime protection.
SecretArchiveSettings	SecretArchiveSettings represents the settings for the secret archive used to hold credentials for the cluster.
ServicePrincipalInformation	ServicePrincipalInformation represents the details of the service principal to be used by the cluster during Arc Appliance installation.
StorageApplianceConfigurationData	StorageApplianceConfigurationData represents configuration for the storage application.
systemData	Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentity	User assigned identity properties
ValidationThreshold	ValidationThreshold indicates allowed machine and node hardware and deployment failures.
ValidationThresholdGrouping	Selection of how the type evaluation is applied to the cluster calculation.
ValidationThresholdType	Selection of how the threshold should be evaluated.
VulnerabilityScanningSettings	VulnerabilityScanningSettings represents the settings for how security vulnerability scanning is applied to the cluster.
VulnerabilityScanningSettingsContainerScan	The mode selection for container vulnerability scanning.
WorkloadImpact	The indicator of whether the workload will be impacted during the upgrade.

AdministrativeCredentials

Object

AdministrativeCredentials represents the admin credentials for the device requiring password-based authentication.

Name	Type	Description
password	string minLength: 1	The password of the administrator of the device used during initialization.
username	string minLength: 1	The username of the administrator of the device used during initialization.

AnalyticsOutputSettings

Object

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

Name	Type	Description
analyticsWorkspaceId	string (arm-id)	The resource ID of the analytics workspace that is to be used by the specified identity.
associatedIdentity	IdentitySelector	IdentitySelector represents the selection of a managed identity for use. The selection of the managed identity to use with this analytics workspace. The identity type must be either system assigned or user assigned.

BareMetalMachineConfigurationData

Object

BareMetalMachineConfigurationData represents configuration for the bare metal machine.

Name	Type	Description
bmcConnectionString	string	The connection string for the baseboard management controller including IP address and protocol.
bmcCredentials	AdministrativeCredentials	AdministrativeCredentials represents the admin credentials for the device requiring password-based authentication. The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead.
bmcMacAddress	string pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$	The MAC address of the BMC for this machine.
bootMacAddress	string pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$	The MAC address associated with the PXE NIC card.
machineDetails	string maxLength: 256	The free-form additional information about the machine, e.g. an asset tag.
machineName	string pattern: ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$	The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically.
rackSlot	integer (int64) minimum: 1 maximum: 256	The slot the physical machine is in the rack based on the BOM configuration.
serialNumber	string maxLength: 64	The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag.

Cluster

Object

Cluster represents the on-premises Network Cloud cluster.

Name	Type	Description
etag	string	Resource ETag.
extendedLocation	ExtendedLocation	ExtendedLocation represents the Azure custom location where the resource will be created. The extended location of the cluster manager associated with the cluster.
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity	The identity for the resource.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.aggregatorOrSingleRackDefinition	RackDefinition	RackDefinition represents details regarding the rack. 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.
properties.analyticsOutputSettings	AnalyticsOutputSettings	AnalyticsOutputSettings represents the settings for the log analytics workspace used for output of logs from this cluster. The settings for the log analytics workspace used for output of logs from this cluster.
properties.analyticsWorkspaceId	string (arm-id)	Field Deprecated. The resource ID of the Log Analytics Workspace that will be used for storing relevant logs.
properties.availableUpgradeVersions	ClusterAvailableUpgradeVersion[]	The list of cluster runtime version upgrades available for this cluster.
properties.clusterCapacity	ClusterCapacity	ClusterCapacity represents various details regarding compute capacity. The capacity supported by this cluster.
properties.clusterConnectionStatus	ClusterConnectionStatus	The latest heartbeat status between the cluster manager and the cluster.
properties.clusterExtendedLocation	ExtendedLocation	ExtendedLocation represents the Azure custom location where the resource will be created. 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.
properties.clusterLocation	string maxLength: 256	The customer-provided location information to identify where the cluster resides.
properties.clusterManagerConnectionStatus	ClusterManagerConnectionStatus	The latest connectivity status between cluster manager and the cluster.
properties.clusterManagerId	string (arm-id)	The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created.
properties.clusterServicePrincipal	ServicePrincipalInformation	ServicePrincipalInformation represents the details of the service principal to be used by the cluster during Arc Appliance installation. The service principal to be used by the cluster during Arc Appliance installation.
properties.clusterType	ClusterType	The type of rack configuration for the cluster.
properties.clusterVersion	string	The current runtime version of the cluster.
properties.commandOutputSettings	CommandOutputSettings	CommandOutputSettings represents the settings for commands run within the cluster such as bare metal machine run read-only commands. The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts.
properties.computeDeploymentThreshold	ValidationThreshold	ValidationThreshold indicates allowed machine and node hardware and deployment failures. The validation threshold indicating the allowable failures of compute machines during environment validation and deployment.
properties.computeRackDefinitions	RackDefinition[]	The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster.
properties.detailedStatus	ClusterDetailedStatus	The current detailed status of the cluster.
properties.detailedStatusMessage	string	The descriptive message about the detailed status.
properties.hybridAksExtendedLocation	ExtendedLocation	ExtendedLocation represents the Azure custom location where the resource will be created. 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).
properties.managedResourceGroupConfiguration	ManagedResourceGroupConfiguration	ManagedResourceGroupConfiguration represents the configuration of the resource group managed by Azure. The configuration of the managed resource group associated with the resource.
properties.manualActionCount	integer (int64)	The count of Manual Action Taken (MAT) events that have not been validated.
properties.networkFabricId	string (arm-id)	The resource ID of the Network Fabric associated with the cluster.
properties.provisioningState	ClusterProvisioningState	The provisioning state of the cluster.
properties.runtimeProtectionConfiguration	RuntimeProtectionConfiguration	RuntimeProtectionConfiguration represents the runtime protection configuration for the cluster. The settings for cluster runtime protection.
properties.secretArchive	ClusterSecretArchive	ClusterSecretArchive configures the key vault to archive the secrets of the cluster for later retrieval. The configuration for use of a key vault to store secrets for later retrieval by the operator.
properties.secretArchiveSettings	SecretArchiveSettings	SecretArchiveSettings represents the settings for the secret archive used to hold credentials for the cluster. The settings for the secret archive used to hold credentials for the cluster.
properties.supportExpiryDate	string	The support end date of the runtime version of the cluster.
properties.updateStrategy	ClusterUpdateStrategy	ClusterUpdateStrategy represents the strategy for updating the cluster. The strategy for updating the cluster.
properties.vulnerabilityScanningSettings	VulnerabilityScanningSettings	VulnerabilityScanningSettings represents the settings for how security vulnerability scanning is applied to the cluster. The settings for how security vulnerability scanning is applied to the cluster.
properties.workloadResourceIds	string[]	The list of workload resource IDs that are hosted within this cluster.
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"

ClusterAvailableUpgradeVersion

Object

ClusterAvailableUpgradeVersion represents the various cluster upgrade parameters.

Name	Type	Description
controlImpact	ControlImpact	The indicator of whether the control plane will be impacted during the upgrade.
expectedDuration	string	The expected duration needed for this upgrade.
impactDescription	string	The impact description including the specific details and release notes.
supportExpiryDate	string	The last date the version of the platform is supported.
targetClusterVersion	string	The target version this cluster will be upgraded to.
workloadImpact	WorkloadImpact	The indicator of whether the workload will be impacted during the upgrade.

ClusterCapacity

Object

ClusterCapacity represents various details regarding compute capacity.

Name	Type	Description
availableApplianceStorageGB	integer (int64)	The remaining appliance-based storage in GB available for workload use. Measured in gibibytes.
availableCoreCount	integer (int64)	The remaining number of cores that are available in this cluster for workload use.
availableHostStorageGB	integer (int64)	The remaining machine or host-based storage in GB available for workload use. Measured in gibibytes.
availableMemoryGB	integer (int64)	The remaining memory in GB that are available in this cluster for workload use. Measured in gibibytes.
totalApplianceStorageGB	integer (int64)	The total appliance-based storage in GB supported by this cluster for workload use. Measured in gibibytes.
totalCoreCount	integer (int64)	The total number of cores that are supported by this cluster for workload use.
totalHostStorageGB	integer (int64)	The total machine or host-based storage in GB supported by this cluster for workload use. Measured in gibibytes.
totalMemoryGB	integer (int64)	The total memory supported by this cluster for workload use. Measured in gibibytes.

ClusterConnectionStatus

Enumeration

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

Value	Description
Connected
Disconnected
Timeout
Undefined

ClusterDetailedStatus

Enumeration

The current detailed status of the cluster.

Value	Description
PendingDeployment
Deploying
Running
Updating
UpdatePaused
Degraded
Deleting
Disconnected
Failed

ClusterManagerConnectionStatus

Enumeration

The latest connectivity status between cluster manager and the cluster.

Value	Description
Connected
Unreachable

ClusterProvisioningState

Enumeration

The provisioning state of the cluster.

Value	Description
Succeeded
Failed
Canceled
Accepted
Validating
Updating

ClusterSecretArchive

Object

ClusterSecretArchive configures the key vault to archive the secrets of the cluster for later retrieval.

Name	Type	Default value	Description
keyVaultId	string (arm-id)		The resource ID of the key vault to archive the secrets of the cluster.
useKeyVault	ClusterSecretArchiveEnabled	False	The indicator if the specified key vault should be used to archive the secrets of the cluster.

ClusterSecretArchiveEnabled

Enumeration

The indicator if the specified key vault should be used to archive the secrets of the cluster.

Value	Description
True
False

ClusterType

Enumeration

The type of rack configuration for the cluster.

Value	Description
SingleRack
MultiRack

ClusterUpdateStrategy

Object

ClusterUpdateStrategy represents the strategy for updating the cluster.

Name	Type	Default value	Description
maxUnavailable	integer (int64) minimum: 1		The maximum number of worker nodes that can be offline within the increment of update, e.g., rack-by-rack. Limited by the maximum number of machines in the increment. Defaults to the whole increment size.
strategyType	ClusterUpdateStrategyType		The mode of operation for runtime protection.
thresholdType	ValidationThresholdType		Selection of how the threshold should be evaluated.
thresholdValue	integer (int64) minimum: 0		The numeric threshold value.
waitTimeMinutes	integer (int64) minimum: 0 maximum: 60	15	The time to wait between the increments of update defined by the strategy.

ClusterUpdateStrategyType

Enumeration

The mode of operation for runtime protection.

Value	Description
Rack
PauseAfterRack

CommandOutputSettings

Object

CommandOutputSettings represents the settings for commands run within the cluster such as bare metal machine run read-only commands.

Name	Type	Description
associatedIdentity	IdentitySelector	IdentitySelector represents the selection of a managed identity for use. The selection of the managed identity to use with this storage account container. The identity type must be either system assigned or user assigned.
containerUrl	string (uri)	The URL of the storage account container that is to be used by the specified identities.

ControlImpact

Enumeration

The indicator of whether the control plane will be impacted during the upgrade.

Value	Description
True
False

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

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.

ExtendedLocation

Object

ExtendedLocation represents the Azure custom location where the resource will be created.

Name	Type	Description
name	string	The resource ID of the extended location on which the resource will be created.
type	string	The extended location type, for example, CustomLocation.

IdentitySelector

Object

IdentitySelector represents the selection of a managed identity for use.

Name	Type	Description
identityType	ManagedServiceIdentitySelectorType	The type of managed identity that is being selected.
userAssignedIdentityResourceId	string (arm-id)	The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type.

ManagedResourceGroupConfiguration

Object

ManagedResourceGroupConfiguration represents the configuration of the resource group managed by Azure.

Name	Type	Description
location	string	The location of the managed resource group. If not specified, the location of the parent resource is chosen.
name	string maxLength: 75	The name for the managed resource group. If not specified, the unique name is automatically generated.

ManagedServiceIdentity

Object

Managed service identity (system assigned and/or user assigned identities)

Name	Type	Description
principalId	string (uuid)	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string (uuid)	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type	ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
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.

ManagedServiceIdentitySelectorType

Enumeration

The type of managed identity that is being selected.

Value	Description
SystemAssignedIdentity
UserAssignedIdentity

ManagedServiceIdentityType

Enumeration

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

Value	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

RackDefinition

Object

RackDefinition represents details regarding the rack.

Name	Type	Description
availabilityZone	string pattern: ^[a-zA-Z0-9]{1,10}$	The zone name used for this rack when created. Availability zones are used for workload placement.
bareMetalMachineConfigurationData	BareMetalMachineConfigurationData[]	The unordered list of bare metal machine configuration.
networkRackId	string (arm-id)	The resource ID of the network rack that matches this rack definition.
rackLocation	string maxLength: 256	The free-form description of the rack's location.
rackSerialNumber	string minLength: 1 maxLength: 64	The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired.
rackSkuId	string (arm-id)	The resource ID of the sku for the rack being added.
storageApplianceConfigurationData	StorageApplianceConfigurationData[]	The list of storage appliance configuration data for this rack.

RuntimeProtectionConfiguration

Object

RuntimeProtectionConfiguration represents the runtime protection configuration for the cluster.

Name	Type	Default value	Description
enforcementLevel	RuntimeProtectionEnforcementLevel	Disabled	The mode of operation for runtime protection.

RuntimeProtectionEnforcementLevel

Enumeration

The mode of operation for runtime protection.

Value	Description
Audit
Disabled
OnDemand
Passive
RealTime

SecretArchiveSettings

Object

SecretArchiveSettings represents the settings for the secret archive used to hold credentials for the cluster.

Name	Type	Description
associatedIdentity	IdentitySelector	IdentitySelector represents the selection of a managed identity for use. The selection of the managed identity to use with this vault URI. The identity type must be either system assigned or user assigned.
vaultUri	string (uri)	The URI for the key vault used as the secret archive.

ServicePrincipalInformation

Object

ServicePrincipalInformation represents the details of the service principal to be used by the cluster during Arc Appliance installation.

Name	Type	Description
applicationId	string	The application ID, also known as client ID, of the service principal.
password	string	The password of the service principal.
principalId	string	The principal ID, also known as the object ID, of the service principal.
tenantId	string	The tenant ID, also known as the directory ID, of the tenant in which the service principal is created.

StorageApplianceConfigurationData

Object

StorageApplianceConfigurationData represents configuration for the storage application.

Name	Type	Description
adminCredentials	AdministrativeCredentials	AdministrativeCredentials represents the admin credentials for the device requiring password-based authentication. The credentials of the administrative interface on this storage appliance. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead.
rackSlot	integer (int64) minimum: 1 maximum: 256	The slot that storage appliance is in the rack based on the BOM configuration.
serialNumber	string	The serial number of the appliance.
storageApplianceName	string pattern: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$	The user-provided name for the storage appliance that will be created from this specification.

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.

ValidationThreshold

Object

ValidationThreshold indicates allowed machine and node hardware and deployment failures.

Name	Type	Description
grouping	ValidationThresholdGrouping	Selection of how the type evaluation is applied to the cluster calculation.
type	ValidationThresholdType	Selection of how the threshold should be evaluated.
value	integer (int64) minimum: 0	The numeric threshold value.

ValidationThresholdGrouping

Enumeration

Selection of how the type evaluation is applied to the cluster calculation.

Value	Description
PerCluster
PerRack

ValidationThresholdType

Enumeration

Selection of how the threshold should be evaluated.

Value	Description
CountSuccess
PercentSuccess

VulnerabilityScanningSettings

Object

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

Name	Type	Default value	Description
containerScan	VulnerabilityScanningSettingsContainerScan	Enabled	The mode selection for container vulnerability scanning.

VulnerabilityScanningSettingsContainerScan

Enumeration

The mode selection for container vulnerability scanning.

Value	Description
Disabled
Enabled

WorkloadImpact

Enumeration

The indicator of whether the workload will be impacted during the upgrade.

Value	Description
True
False