Deployment Settings - Get

Service:

Azure Stack HCI

API Version:

2024-04-01

Get a DeploymentSetting

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

URI Parameters

Name	In	Required	Type	Description
clusterName	path	True	string	The name of the cluster.
deploymentSettingsName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Name of Deployment Setting
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	DeploymentSetting	ARM operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

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 Deployment Settings

Sample request

HTTP

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

Java

/**
 * Samples for DeploymentSettings Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/
     * GetDeploymentSettings.json
     */
    /**
     * Sample code: Get Deployment Settings.
     * 
     * @param manager Entry point to AzureStackHciManager.
     */
    public static void getDeploymentSettings(com.azure.resourcemanager.azurestackhci.AzureStackHciManager manager) {
        manager.deploymentSettings().getWithResponse("test-rg", "myCluster", "default",
            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 get_deployment_settings.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.deployment_settings.get(
        resource_group_name="test-rg",
        cluster_name="myCluster",
    )
    print(response)


# x-ms-original-file: specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetDeploymentSettings.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/GetDeploymentSettings.json
func ExampleDeploymentSettingsClient_Get() {
	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)
	}
	res, err := clientFactory.NewDeploymentSettingsClient().Get(ctx, "test-rg", "myCluster", "default", 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.DeploymentSetting = armazurestackhci.DeploymentSetting{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.AzureStackHCI/clusters/deploymentSettings"),
	// 	ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/deploymentSettings/default"),
	// 	SystemData: &armazurestackhci.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-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, "2021-01-02T17:18:19.123Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("user2"),
	// 		LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 	},
	// 	Properties: &armazurestackhci.DeploymentSettingsProperties{
	// 		ArcNodeResourceIDs: []*string{
	// 			to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1"),
	// 			to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2")},
	// 			DeploymentConfiguration: &armazurestackhci.DeploymentConfiguration{
	// 				ScaleUnits: []*armazurestackhci.ScaleUnits{
	// 					{
	// 						DeploymentData: &armazurestackhci.DeploymentData{
	// 							AdouPath: to.Ptr("OU=ms169,DC=ASZ1PLab8,DC=nttest,DC=microsoft,DC=com"),
	// 							Cluster: &armazurestackhci.DeploymentCluster{
	// 								Name: to.Ptr("testHCICluster"),
	// 								AzureServiceEndpoint: to.Ptr("core.windows.net"),
	// 								CloudAccountName: to.Ptr("myasestoragacct"),
	// 								WitnessPath: to.Ptr("Cloud"),
	// 								WitnessType: to.Ptr("Cloud"),
	// 							},
	// 							DomainFqdn: to.Ptr("ASZ1PLab8.nttest.microsoft.com"),
	// 							HostNetwork: &armazurestackhci.DeploymentSettingHostNetwork{
	// 								EnableStorageAutoIP: to.Ptr(false),
	// 								Intents: []*armazurestackhci.DeploymentSettingIntents{
	// 									{
	// 										Name: to.Ptr("Compute_Management"),
	// 										Adapter: []*string{
	// 											to.Ptr("Port2")},
	// 											AdapterPropertyOverrides: &armazurestackhci.DeploymentSettingAdapterPropertyOverrides{
	// 												JumboPacket: to.Ptr("1514"),
	// 												NetworkDirect: to.Ptr("Enabled"),
	// 												NetworkDirectTechnology: to.Ptr("iWARP"),
	// 											},
	// 											OverrideAdapterProperty: to.Ptr(false),
	// 											OverrideQosPolicy: to.Ptr(false),
	// 											OverrideVirtualSwitchConfiguration: to.Ptr(false),
	// 											QosPolicyOverrides: &armazurestackhci.QosPolicyOverrides{
	// 												BandwidthPercentageSMB: to.Ptr("50"),
	// 												PriorityValue8021ActionCluster: to.Ptr("7"),
	// 												PriorityValue8021ActionSMB: to.Ptr("3"),
	// 											},
	// 											TrafficType: []*string{
	// 												to.Ptr("Compute"),
	// 												to.Ptr("Management")},
	// 												VirtualSwitchConfigurationOverrides: &armazurestackhci.DeploymentSettingVirtualSwitchConfigurationOverrides{
	// 													EnableIov: to.Ptr("True"),
	// 													LoadBalancingAlgorithm: to.Ptr("HyperVPort"),
	// 												},
	// 										}},
	// 										StorageConnectivitySwitchless: to.Ptr(true),
	// 										StorageNetworks: []*armazurestackhci.DeploymentSettingStorageNetworks{
	// 											{
	// 												Name: to.Ptr("Storage1Network"),
	// 												NetworkAdapterName: to.Ptr("Port3"),
	// 												StorageAdapterIPInfo: []*armazurestackhci.DeploymentSettingStorageAdapterIPInfo{
	// 													{
	// 														IPv4Address: to.Ptr("10.57.48.60"),
	// 														PhysicalNode: to.Ptr("string"),
	// 														SubnetMask: to.Ptr("255.255.248.0"),
	// 												}},
	// 												VlanID: to.Ptr("5"),
	// 										}},
	// 									},
	// 									InfrastructureNetwork: []*armazurestackhci.InfrastructureNetwork{
	// 										{
	// 											DNSServers: []*string{
	// 												to.Ptr("10.57.50.90")},
	// 												Gateway: to.Ptr("255.255.248.0"),
	// 												IPPools: []*armazurestackhci.IPPools{
	// 													{
	// 														EndingAddress: to.Ptr("10.57.48.66"),
	// 														StartingAddress: to.Ptr("10.57.48.60"),
	// 												}},
	// 												SubnetMask: to.Ptr("255.255.248.0"),
	// 										}},
	// 										NamingPrefix: to.Ptr("ms169"),
	// 										Observability: &armazurestackhci.Observability{
	// 											EpisodicDataUpload: to.Ptr(true),
	// 											EuLocation: to.Ptr(false),
	// 											StreamingDataClient: to.Ptr(true),
	// 										},
	// 										OptionalServices: &armazurestackhci.OptionalServices{
	// 											CustomLocation: to.Ptr("customLocationName"),
	// 										},
	// 										PhysicalNodes: []*armazurestackhci.PhysicalNodes{
	// 											{
	// 												Name: to.Ptr("ms169host"),
	// 												IPv4Address: to.Ptr("10.57.51.224"),
	// 											},
	// 											{
	// 												Name: to.Ptr("ms154host"),
	// 												IPv4Address: to.Ptr("10.57.53.236"),
	// 										}},
	// 										SdnIntegration: &armazurestackhci.SdnIntegration{
	// 											NetworkController: &armazurestackhci.NetworkController{
	// 												MacAddressPoolStart: to.Ptr("00-0D-3A-1B-C7-21"),
	// 												MacAddressPoolStop: to.Ptr("00-0D-3A-1B-C7-29"),
	// 												NetworkVirtualizationEnabled: to.Ptr(true),
	// 											},
	// 										},
	// 										Secrets: []*armazurestackhci.EceDeploymentSecrets{
	// 											{
	// 												EceSecretName: to.Ptr(armazurestackhci.EceSecrets("BMCAdminUserCred")),
	// 												SecretLocation: to.Ptr("https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b"),
	// 												SecretName: to.Ptr("cluster1-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63"),
	// 											},
	// 											{
	// 												EceSecretName: to.Ptr(armazurestackhci.EceSecretsAzureStackLCMUserCredential),
	// 												SecretLocation: to.Ptr("https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4c"),
	// 												SecretName: to.Ptr("cluster2-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63"),
	// 										}},
	// 										SecretsLocation: to.Ptr("/subscriptions/db4e2fdb-6d80-4e6e-b7cd-xxxxxxx/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/abcd123"),
	// 										SecuritySettings: &armazurestackhci.DeploymentSecuritySettings{
	// 											BitlockerBootVolume: to.Ptr(true),
	// 											BitlockerDataVolumes: to.Ptr(true),
	// 											CredentialGuardEnforced: to.Ptr(false),
	// 											DriftControlEnforced: to.Ptr(true),
	// 											DrtmProtection: to.Ptr(true),
	// 											HvciProtection: to.Ptr(true),
	// 											SideChannelMitigationEnforced: to.Ptr(true),
	// 											SmbClusterEncryption: to.Ptr(false),
	// 											SmbSigningEnforced: to.Ptr(true),
	// 											WdacEnforced: to.Ptr(true),
	// 										},
	// 										Storage: &armazurestackhci.Storage{
	// 											ConfigurationMode: to.Ptr("Express"),
	// 										},
	// 									},
	// 									SbePartnerInfo: &armazurestackhci.SbePartnerInfo{
	// 										CredentialList: []*armazurestackhci.SbeCredentials{
	// 											{
	// 												EceSecretName: to.Ptr("DownloadConnectorCred"),
	// 												SecretLocation: to.Ptr("https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b"),
	// 												SecretName: to.Ptr("cluster1-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63"),
	// 										}},
	// 										PartnerProperties: []*armazurestackhci.SbePartnerProperties{
	// 											{
	// 												Name: to.Ptr("EnableBMCIpV6"),
	// 												Value: to.Ptr("false"),
	// 											},
	// 											{
	// 												Name: to.Ptr("PhoneHomePort"),
	// 												Value: to.Ptr("1653"),
	// 											},
	// 											{
	// 												Name: to.Ptr("BMCSecurityState"),
	// 												Value: to.Ptr("HighSecurity"),
	// 										}},
	// 										SbeDeploymentInfo: &armazurestackhci.SbeDeploymentInfo{
	// 											Family: to.Ptr("Gen5"),
	// 											Publisher: to.Ptr("Contoso"),
	// 											SbeManifestCreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-07-25T02:40:33.000Z"); return t}()),
	// 											SbeManifestSource: to.Ptr("default"),
	// 											Version: to.Ptr("4.0.2309.13"),
	// 										},
	// 									},
	// 							}},
	// 							Version: to.Ptr("string"),
	// 						},
	// 						DeploymentMode: to.Ptr(armazurestackhci.DeploymentModeDeploy),
	// 						OperationType: to.Ptr(armazurestackhci.OperationTypeClusterProvisioning),
	// 						ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
	// 						ReportedProperties: &armazurestackhci.EceReportedProperties{
	// 							DeploymentStatus: &armazurestackhci.EceActionStatus{
	// 								Status: to.Ptr("Error"),
	// 								Steps: []*armazurestackhci.DeploymentStep{
	// 									{
	// 										Name: to.Ptr("Cloud Deployment"),
	// 										Description: to.Ptr("Deploy Cloud."),
	// 										EndTimeUTC: to.Ptr("2023-06-09T04:01:47"),
	// 										FullStepIndex: to.Ptr("0"),
	// 										StartTimeUTC: to.Ptr("2023-06-09T00:08:19"),
	// 										Status: to.Ptr("Error"),
	// 										Steps: []*armazurestackhci.DeploymentStep{
	// 											{
	// 												Name: to.Ptr("Before Cloud Deployment"),
	// 												Description: to.Ptr("Before Cloud Deployment"),
	// 												EndTimeUTC: to.Ptr("2023-06-09T01:10:10"),
	// 												FullStepIndex: to.Ptr("0.1"),
	// 												StartTimeUTC: to.Ptr("2023-06-09T00:08:23"),
	// 											},
	// 											{
	// 												Name: to.Ptr("Clean up temporary content"),
	// 												Description: to.Ptr("Clean up temporary content"),
	// 												EndTimeUTC: to.Ptr("2023-06-09T04:01:47"),
	// 												Exception: []*string{
	// 													to.Ptr("exception1"),
	// 													to.Ptr("exception2")},
	// 													FullStepIndex: to.Ptr("0.36"),
	// 													StartTimeUTC: to.Ptr("2023-06-09T03:58:37"),
	// 													Status: to.Ptr("Error"),
	// 											}},
	// 									}},
	// 								},
	// 								ValidationStatus: &armazurestackhci.EceActionStatus{
	// 									Status: to.Ptr("Error"),
	// 									Steps: []*armazurestackhci.DeploymentStep{
	// 										{
	// 											Name: to.Ptr("Cloud Deployment"),
	// 											Description: to.Ptr("Deploy Cloud."),
	// 											EndTimeUTC: to.Ptr("2023-06-09T04:01:47"),
	// 											FullStepIndex: to.Ptr("0"),
	// 											StartTimeUTC: to.Ptr("2023-06-09T00:08:19"),
	// 											Status: to.Ptr("Error"),
	// 											Steps: []*armazurestackhci.DeploymentStep{
	// 												{
	// 													Name: to.Ptr("Before Cloud Deployment"),
	// 													Description: to.Ptr("Before Cloud Deployment"),
	// 													EndTimeUTC: to.Ptr("2023-06-09T01:10:10"),
	// 													FullStepIndex: to.Ptr("0.1"),
	// 													StartTimeUTC: to.Ptr("2023-06-09T00:08:23"),
	// 												},
	// 												{
	// 													Name: to.Ptr("Clean up temporary content"),
	// 													Description: to.Ptr("Clean up temporary content"),
	// 													EndTimeUTC: to.Ptr("2023-06-09T04:01:47"),
	// 													Exception: []*string{
	// 														to.Ptr("exception1"),
	// 														to.Ptr("exception2")},
	// 														FullStepIndex: to.Ptr("0.36"),
	// 														StartTimeUTC: to.Ptr("2023-06-09T03:58:37"),
	// 														Status: to.Ptr("Error"),
	// 												}},
	// 										}},
	// 									},
	// 								},
	// 							},
	// 						}
}

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 Get a DeploymentSetting
 *
 * @summary Get a DeploymentSetting
 * x-ms-original-file: specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetDeploymentSettings.json
 */
async function getDeploymentSettings() {
  const subscriptionId =
    process.env["AZURESTACKHCI_SUBSCRIPTION_ID"] || "fd3c3665-1729-4b7b-9a38-238e83b0f98b";
  const resourceGroupName = process.env["AZURESTACKHCI_RESOURCE_GROUP"] || "test-rg";
  const clusterName = "myCluster";
  const deploymentSettingsName = "default";
  const credential = new DefaultAzureCredential();
  const client = new AzureStackHCIClient(credential, subscriptionId);
  const result = await client.deploymentSettings.get(
    resourceGroupName,
    clusterName,
    deploymentSettingsName,
  );
  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

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.Hci;

// Generated from example definition: specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetDeploymentSettings.json
// this example is just showing the usage of "DeploymentSettings_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 HciClusterResource created on azure
// for more information of creating HciClusterResource, please refer to the document of HciClusterResource
string subscriptionId = "fd3c3665-1729-4b7b-9a38-238e83b0f98b";
string resourceGroupName = "test-rg";
string clusterName = "myCluster";
ResourceIdentifier hciClusterResourceId = HciClusterResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, clusterName);
HciClusterResource hciCluster = client.GetHciClusterResource(hciClusterResourceId);

// get the collection of this HciClusterDeploymentSettingResource
HciClusterDeploymentSettingCollection collection = hciCluster.GetHciClusterDeploymentSettings();

// invoke the operation
string deploymentSettingsName = "default";
NullableResponse<HciClusterDeploymentSettingResource> response = await collection.GetIfExistsAsync(deploymentSettingsName);
HciClusterDeploymentSettingResource 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
    HciClusterDeploymentSettingData 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/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/deploymentSettings/default",
  "name": "default",
  "type": "Microsoft.AzureStackHCI/clusters/deploymentSettings",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "operationType": "ClusterProvisioning",
    "deploymentMode": "Deploy",
    "arcNodeResourceIds": [
      "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1",
      "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2"
    ],
    "deploymentConfiguration": {
      "version": "string",
      "scaleUnits": [
        {
          "deploymentData": {
            "securitySettings": {
              "hvciProtection": true,
              "drtmProtection": true,
              "driftControlEnforced": true,
              "credentialGuardEnforced": false,
              "smbSigningEnforced": true,
              "smbClusterEncryption": false,
              "sideChannelMitigationEnforced": true,
              "bitlockerBootVolume": true,
              "bitlockerDataVolumes": true,
              "wdacEnforced": true
            },
            "observability": {
              "streamingDataClient": true,
              "euLocation": false,
              "episodicDataUpload": true
            },
            "cluster": {
              "name": "testHCICluster",
              "witnessType": "Cloud",
              "witnessPath": "Cloud",
              "cloudAccountName": "myasestoragacct",
              "azureServiceEndpoint": "core.windows.net"
            },
            "storage": {
              "configurationMode": "Express"
            },
            "namingPrefix": "ms169",
            "domainFqdn": "ASZ1PLab8.nttest.microsoft.com",
            "infrastructureNetwork": [
              {
                "subnetMask": "255.255.248.0",
                "gateway": "255.255.248.0",
                "ipPools": [
                  {
                    "startingAddress": "10.57.48.60",
                    "endingAddress": "10.57.48.66"
                  }
                ],
                "dnsServers": [
                  "10.57.50.90"
                ]
              }
            ],
            "physicalNodes": [
              {
                "name": "ms169host",
                "ipv4Address": "10.57.51.224"
              },
              {
                "name": "ms154host",
                "ipv4Address": "10.57.53.236"
              }
            ],
            "hostNetwork": {
              "intents": [
                {
                  "name": "Compute_Management",
                  "trafficType": [
                    "Compute",
                    "Management"
                  ],
                  "adapter": [
                    "Port2"
                  ],
                  "overrideVirtualSwitchConfiguration": false,
                  "virtualSwitchConfigurationOverrides": {
                    "enableIov": "True",
                    "loadBalancingAlgorithm": "HyperVPort"
                  },
                  "overrideQosPolicy": false,
                  "qosPolicyOverrides": {
                    "priorityValue8021Action_Cluster": "7",
                    "priorityValue8021Action_SMB": "3",
                    "bandwidthPercentage_SMB": "50"
                  },
                  "overrideAdapterProperty": false,
                  "adapterPropertyOverrides": {
                    "jumboPacket": "1514",
                    "networkDirect": "Enabled",
                    "networkDirectTechnology": "iWARP"
                  }
                }
              ],
              "storageNetworks": [
                {
                  "name": "Storage1Network",
                  "networkAdapterName": "Port3",
                  "vlanId": "5",
                  "storageAdapterIPInfo": [
                    {
                      "physicalNode": "string",
                      "ipv4Address": "10.57.48.60",
                      "subnetMask": "255.255.248.0"
                    }
                  ]
                }
              ],
              "storageConnectivitySwitchless": true,
              "enableStorageAutoIp": false
            },
            "sdnIntegration": {
              "networkController": {
                "macAddressPoolStart": "00-0D-3A-1B-C7-21",
                "macAddressPoolStop": "00-0D-3A-1B-C7-29",
                "networkVirtualizationEnabled": true
              }
            },
            "adouPath": "OU=ms169,DC=ASZ1PLab8,DC=nttest,DC=microsoft,DC=com",
            "secretsLocation": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-xxxxxxx/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/abcd123",
            "secrets": [
              {
                "secretName": "cluster1-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63",
                "eceSecretName": "BMCAdminUserCred",
                "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b"
              },
              {
                "secretName": "cluster2-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63",
                "eceSecretName": "AzureStackLCMUserCredential",
                "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4c"
              }
            ],
            "optionalServices": {
              "customLocation": "customLocationName"
            }
          },
          "sbePartnerInfo": {
            "sbeDeploymentInfo": {
              "version": "4.0.2309.13",
              "family": "Gen5",
              "publisher": "Contoso",
              "sbeManifestSource": "default",
              "sbeManifestCreationDate": "2023-07-25T02:40:33Z"
            },
            "partnerProperties": [
              {
                "name": "EnableBMCIpV6",
                "value": "false"
              },
              {
                "name": "PhoneHomePort",
                "value": "1653"
              },
              {
                "name": "BMCSecurityState",
                "value": "HighSecurity"
              }
            ],
            "credentialList": [
              {
                "secretName": "cluster1-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63",
                "eceSecretName": "DownloadConnectorCred",
                "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b"
              }
            ]
          }
        }
      ]
    },
    "reportedProperties": {
      "validationStatus": {
        "status": "Error",
        "steps": [
          {
            "fullStepIndex": "0",
            "name": "Cloud Deployment",
            "description": "Deploy Cloud.",
            "startTimeUtc": "2023-06-09T00:08:19",
            "endTimeUtc": "2023-06-09T04:01:47",
            "status": "Error",
            "steps": [
              {
                "fullStepIndex": "0.1",
                "name": "Before Cloud Deployment",
                "description": "Before Cloud Deployment",
                "startTimeUtc": "2023-06-09T00:08:23",
                "endTimeUtc": "2023-06-09T01:10:10"
              },
              {
                "fullStepIndex": "0.36",
                "name": "Clean up temporary content",
                "description": "Clean up temporary content",
                "startTimeUtc": "2023-06-09T03:58:37",
                "endTimeUtc": "2023-06-09T04:01:47",
                "status": "Error",
                "exception": [
                  "exception1",
                  "exception2"
                ]
              }
            ]
          }
        ]
      },
      "deploymentStatus": {
        "status": "Error",
        "steps": [
          {
            "fullStepIndex": "0",
            "name": "Cloud Deployment",
            "description": "Deploy Cloud.",
            "startTimeUtc": "2023-06-09T00:08:19",
            "endTimeUtc": "2023-06-09T04:01:47",
            "status": "Error",
            "steps": [
              {
                "fullStepIndex": "0.1",
                "name": "Before Cloud Deployment",
                "description": "Before Cloud Deployment",
                "startTimeUtc": "2023-06-09T00:08:23",
                "endTimeUtc": "2023-06-09T01:10:10"
              },
              {
                "fullStepIndex": "0.36",
                "name": "Clean up temporary content",
                "description": "Clean up temporary content",
                "startTimeUtc": "2023-06-09T03:58:37",
                "endTimeUtc": "2023-06-09T04:01:47",
                "status": "Error",
                "exception": [
                  "exception1",
                  "exception2"
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

Definitions

Name	Description
AdapterPropertyOverrides	The AdapterPropertyOverrides of a cluster.
createdByType	The type of identity that created the resource.
DeploymentCluster	AzureStackHCI Cluster deployment properties.
DeploymentConfiguration	Deployment Configuration
DeploymentData	The Deployment data of AzureStackHCI Cluster.
DeploymentMode	The deployment mode of EnterpriseCloudEngine(ECE) action for a cluster.
DeploymentSecuritySettings	The SecuritySettings of AzureStackHCI Cluster.
DeploymentSetting	Edge device resource
DeploymentStep	The Step of AzureStackHCI Cluster.
EceActionStatus	The ECE action plan deployment status for AzureStackHCI Cluster.
EceDeploymentSecrets	Protected parameters list stored in keyvault.
EceReportedProperties	The DeploymentStatus of AzureStackHCI Cluster.
EceSecrets	Secret names allowed for Enterprise Cloud Engine (ECE) deployment.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
HostNetwork	The HostNetwork of a cluster.
InfrastructureNetwork	The InfrastructureNetwork of a AzureStackHCI Cluster.
Intents	The Intents of a cluster.
IpPools	The dnsServers of a device.
NetworkController	network controller config for SDN Integration to deploy AzureStackHCI Cluster.
Observability	The Observability of AzureStackHCI Cluster.
OperationType	The intended operation for a cluster.
OptionalServices	The OptionalServices of AzureStackHCI Cluster.
PhysicalNodes	The PhysicalNodes of a cluster.
ProvisioningState	The provisioning state of a resource.
QosPolicyOverrides	The QoSPolicyOverrides of a cluster.
SbeCredentials	secrets used for solution builder extension (SBE) partner extensibility.
SbeDeploymentInfo	Solution builder extension (SBE) package and manifest information for the solution builder extension staged for AzureStackHCI cluster deployment.
SbePartnerInfo	The solution builder extension (SBE) partner deployment info for cluster.
SbePartnerProperties	Solution builder extension (SBE) partner properties object.
ScaleUnits	Scale units will contains list of deployment data
SdnIntegration	SDN Integration config to deploy AzureStackHCI Cluster.
Storage	The Storage config of AzureStackHCI Cluster.
StorageAdapterIPInfo	The StorageAdapter physical nodes of a cluster.
StorageNetworks	The StorageNetworks of a cluster.
systemData	Metadata pertaining to creation and last modification of the resource.
VirtualSwitchConfigurationOverrides	The VirtualSwitchConfigurationOverrides of a cluster.

AdapterPropertyOverrides

Object

The AdapterPropertyOverrides of a cluster.

Name	Type	Description
jumboPacket	string	This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.
networkDirect	string	This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.
networkDirectTechnology	string	This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. Expected values are 'iWARP', 'RoCEv2', 'RoCE'

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DeploymentCluster

Object

AzureStackHCI Cluster deployment properties.

Name	Type	Description
azureServiceEndpoint	string	For Azure blob service endpoint type, select either Default or Custom domain. If you selected **Custom domain, enter the domain for the blob service in this format core.windows.net.
cloudAccountName	string	Specify the Azure Storage account name for cloud witness for your Azure Stack HCI cluster.
name	string	The cluster name provided when preparing Active Directory.
witnessPath	string	Specify the fileshare path for the local witness for your Azure Stack HCI cluster.
witnessType	string	Use a cloud witness if you have internet access and if you use an Azure Storage account to provide a vote on cluster quorum. A cloud witness uses Azure Blob Storage to read or write a blob file and then uses it to arbitrate in split-brain resolution. Only allowed values are 'Cloud', 'FileShare'.

DeploymentConfiguration

Object

Deployment Configuration

Name	Type	Description
scaleUnits	ScaleUnits[]	Scale units will contains list of deployment data
version	string	deployment template version

DeploymentData

Object

The Deployment data of AzureStackHCI Cluster.

Name	Type	Description
adouPath	string	The path to the Active Directory Organizational Unit container object prepared for the deployment.
cluster	DeploymentCluster	Observability config to deploy AzureStackHCI Cluster.
domainFqdn	string	FQDN to deploy cluster
hostNetwork	HostNetwork	HostNetwork config to deploy AzureStackHCI Cluster.
infrastructureNetwork	InfrastructureNetwork[]	InfrastructureNetwork config to deploy AzureStackHCI Cluster.
namingPrefix	string pattern: ^[a-zA-Z0-9-]{1,8}$	naming prefix to deploy cluster.
observability	Observability	Observability config to deploy AzureStackHCI Cluster.
optionalServices	OptionalServices	OptionalServices config to deploy AzureStackHCI Cluster.
physicalNodes	PhysicalNodes[]	list of physical nodes config to deploy AzureStackHCI Cluster.
sdnIntegration	SdnIntegration	SDN Integration config to deploy AzureStackHCI Cluster.
secrets	EceDeploymentSecrets[]	secrets used for cloud deployment.
secretsLocation	string	Azure keyvault endpoint. This property is deprecated from 2023-12-01-preview. Please use secrets property instead.
securitySettings	DeploymentSecuritySettings	SecuritySettings to deploy AzureStackHCI Cluster.
storage	Storage	Storage config to deploy AzureStackHCI Cluster.

DeploymentMode

Enumeration

The deployment mode of EnterpriseCloudEngine(ECE) action for a cluster.

Value	Description
Validate	Validate ECE action deployment for a cluster.
Deploy	Deploy ECE action deployment for a cluster.

DeploymentSecuritySettings

Object

The SecuritySettings of AzureStackHCI Cluster.

Name	Type	Default value	Description
bitlockerBootVolume	boolean	True	When set to true, BitLocker XTS_AES 256-bit encryption is enabled for all data-at-rest on the OS volume of your Azure Stack HCI cluster. This setting is TPM-hardware dependent.
bitlockerDataVolumes	boolean	True	When set to true, BitLocker XTS-AES 256-bit encryption is enabled for all data-at-rest on your Azure Stack HCI cluster shared volumes.
credentialGuardEnforced	boolean	False	When set to true, Credential Guard is enabled.
driftControlEnforced	boolean	True	When set to true, the security baseline is re-applied regularly.
drtmProtection	boolean	True	By default, Secure Boot is enabled on your Azure HCI cluster. This setting is hardware dependent.
hvciProtection	boolean	True	By default, Hypervisor-protected Code Integrity is enabled on your Azure HCI cluster.
sideChannelMitigationEnforced	boolean	True	When set to true, all the side channel mitigations are enabled
smbClusterEncryption	boolean	False	When set to true, cluster east-west traffic is encrypted.
smbSigningEnforced	boolean	True	When set to true, the SMB default instance requires sign in for the client and server services.
wdacEnforced	boolean	True	WDAC is enabled by default and limits the applications and the code that you can run on your Azure Stack HCI cluster.

DeploymentSetting

Object

Edge device resource

Name	Type	Default value	Description
id	string (arm-id)		Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string		The name of the resource
properties.arcNodeResourceIds	string[]		Azure resource ids of Arc machines to be part of cluster.
properties.deploymentConfiguration	DeploymentConfiguration		Scale units will contains list of deployment data
properties.deploymentMode	DeploymentMode	Deploy	The deployment mode for cluster deployment.
properties.operationType	OperationType	ClusterProvisioning	The intended operation for a cluster.
properties.provisioningState	ProvisioningState		DeploymentSetting provisioning state
properties.reportedProperties	EceReportedProperties		Deployment Status reported from cluster.
systemData	systemData		Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string		The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

DeploymentStep

Object

The Step of AzureStackHCI Cluster.

Name	Type	Description
description	string	Description of step.
endTimeUtc	string	End time of step.
exception	string[]	List of exceptions in AzureStackHCI Cluster Deployment.
fullStepIndex	string	FullStepIndex of step.
name	string	Name of step.
startTimeUtc	string	Start time of step.
status	string	Status of step. Allowed values are 'Error', 'Success', 'InProgress'
steps	DeploymentStep[]	List of nested steps of AzureStackHCI Cluster Deployment.

EceActionStatus

Object

The ECE action plan deployment status for AzureStackHCI Cluster.

Name	Type	Description
status	string	Status of ECE action AzureStackHCI Cluster Deployment.
steps	DeploymentStep[]	List of steps of AzureStackHCI Cluster Deployment.

EceDeploymentSecrets

Object

Protected parameters list stored in keyvault.

Name	Type	Description
eceSecretName	EceSecrets	Secret name expected for Enterprise Cloud Engine (ECE) deployment.
secretLocation	string (uri)	Secret URI stored in keyvault.
secretName	string	Secret name stored in keyvault.

EceReportedProperties

Object

The DeploymentStatus of AzureStackHCI Cluster.

Name	Type	Description
deploymentStatus	EceActionStatus	Deployment status of AzureStackHCI Cluster Deployment.
validationStatus	EceActionStatus	validation status of AzureStackHCI Cluster Deployment.

EceSecrets

Enumeration

Secret names allowed for Enterprise Cloud Engine (ECE) deployment.

Value	Description
AzureStackLCMUserCredential	AzureStackLCMUserCredential used for LCM operations for AzureStackHCI cluster.
DefaultARBApplication	DefaultARBApplication used to manage Azure Arc resource bridge (ARB) for AzureStackHCI cluster.
LocalAdminCredential	LocalAdminCredential used for admin operations for AzureStackHCI cluster.
WitnessStorageKey	WitnessStorageKey used for setting up a cloud witness for AzureStackHCI cluster.

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.

HostNetwork

Object

The HostNetwork of a cluster.

Name	Type	Default value	Description
enableStorageAutoIp	boolean	False	Optional parameter required only for 3 Nodes Switchless deployments. This allows users to specify IPs and Mask for Storage NICs when Network ATC is not assigning the IPs for storage automatically.
intents	Intents[]		The network intents assigned to the network reference pattern used for the deployment. Each intent will define its own name, traffic type, adapter names, and overrides as recommended by your OEM.
storageConnectivitySwitchless	boolean	False	Defines how the storage adapters between nodes are connected either switch or switch less..
storageNetworks	StorageNetworks[]		List of StorageNetworks config to deploy AzureStackHCI Cluster.

InfrastructureNetwork

Object

The InfrastructureNetwork of a AzureStackHCI Cluster.

Name	Type	Description
dnsServers	string[]	IPv4 address of the DNS servers in your environment.
gateway	string	Default gateway that should be used for the provided IP address space.
ipPools	IpPools[]	Range of IP addresses from which addresses are allocated for nodes within a subnet.
subnetMask	string	Subnet mask that matches the provided IP address space.
useDhcp	boolean	Allows customers to use DHCP for Hosts and Cluster IPs. If not declared, the deployment will default to static IPs. When true, GW and DNS servers are not required

Intents

Object

The Intents of a cluster.

Name	Type	Default value	Description
adapter	string[]		Array of network interfaces used for the network intent.
adapterPropertyOverrides	AdapterPropertyOverrides		Set Adapter PropertyOverrides for cluster.
name	string		Name of the network intent you wish to create.
overrideAdapterProperty	boolean	False	This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.
overrideQosPolicy	boolean	False	This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.
overrideVirtualSwitchConfiguration	boolean	False	This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.
qosPolicyOverrides	QosPolicyOverrides		Set QoS PolicyOverrides for cluster.
trafficType	string[]		List of network traffic types. Only allowed values are 'Compute', 'Storage', 'Management'.
virtualSwitchConfigurationOverrides	VirtualSwitchConfigurationOverrides		Set virtualSwitch ConfigurationOverrides for cluster.

IpPools

Object

The dnsServers of a device.

Name	Type	Description
endingAddress	string	Ending IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering.
startingAddress	string	Starting IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering.

NetworkController

Object

network controller config for SDN Integration to deploy AzureStackHCI Cluster.

Name	Type	Description
macAddressPoolStart	string	macAddressPoolStart of network controller used for SDN Integration.
macAddressPoolStop	string	macAddressPoolStop of network controller used for SDN Integration.
networkVirtualizationEnabled	boolean	NetworkVirtualizationEnabled of network controller used for SDN Integration.

Observability

Object

The Observability of AzureStackHCI Cluster.

Name	Type	Default value	Description
episodicDataUpload	boolean	True	When set to true, collects log data to facilitate quicker issue resolution.
euLocation	boolean	False	Location of your cluster. The log and diagnostic data is sent to the appropriate diagnostics servers depending upon where your cluster resides. Setting this to false results in all data sent to Microsoft to be stored outside of the EU.
streamingDataClient	boolean	True	Enables telemetry data to be sent to Microsoft

OperationType

Enumeration

The intended operation for a cluster.

Value	Description
ClusterProvisioning	Cluster provisioning operation.
ClusterUpgrade	Cluster upgrade operation.

OptionalServices

Object

The OptionalServices of AzureStackHCI Cluster.

Name	Type	Description
customLocation	string	The name of custom location.

PhysicalNodes

Object

The PhysicalNodes of a cluster.

Name	Type	Description
ipv4Address	string	The IPv4 address assigned to each physical server on your Azure Stack HCI cluster.
name	string	NETBIOS name of each physical server on your Azure Stack HCI cluster.

ProvisioningState

Enumeration

The provisioning state of a resource.

Value	Description
Succeeded	Resource has been created.
Failed	Resource creation failed.
Canceled	Resource creation was canceled.
NotSpecified	The resource provision state is not specified
Provisioning	The resource is being provisioned
Updating	The resource is updating
Deleting	The resource is being deleted
Accepted	The resource create request has been accepted

QosPolicyOverrides

Object

The QoSPolicyOverrides of a cluster.

Name	Type	Description
bandwidthPercentage_SMB	string	This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.
priorityValue8021Action_Cluster	string	This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.
priorityValue8021Action_SMB	string	This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.

SbeCredentials

Object

secrets used for solution builder extension (SBE) partner extensibility.

Name	Type	Description
eceSecretName	string	secret name expected for Enterprise Cloud Engine (ECE).
secretLocation	string (uri)	secret URI stored in keyvault.
secretName	string	secret name stored in keyvault.

SbeDeploymentInfo

Object

Solution builder extension (SBE) package and manifest information for the solution builder extension staged for AzureStackHCI cluster deployment.

Name	Type	Description
family	string	SBE family name.
publisher	string	SBE manifest publisher.
sbeManifestCreationDate	string (date-time)	SBE Manifest Creation Date.
sbeManifestSource	string	SBE Manifest Source.
version	string	SBE package version.

SbePartnerInfo

Object

The solution builder extension (SBE) partner deployment info for cluster.

Name	Type	Description
credentialList	SbeCredentials[]	SBE credentials list for AzureStackHCI cluster deployment.
partnerProperties	SbePartnerProperties[]	List of SBE partner properties for AzureStackHCI cluster deployment.
sbeDeploymentInfo	SbeDeploymentInfo	SBE package and manifest information for the solution Builder Extension staged for AzureStackHCI cluster deployment.

SbePartnerProperties

Object

Solution builder extension (SBE) partner properties object.

Name	Type	Description
name	string	SBE partner property name.
value	string	SBE partner property value.

ScaleUnits

Object

Scale units will contains list of deployment data

Name	Type	Description
deploymentData	DeploymentData	Deployment Data to deploy AzureStackHCI Cluster.
sbePartnerInfo	SbePartnerInfo	Solution builder extension (SBE) partner properties

SdnIntegration

Object

SDN Integration config to deploy AzureStackHCI Cluster.

Name	Type	Description
networkController	NetworkController	network controller config for SDN Integration to deploy AzureStackHCI Cluster.

Storage

Object

The Storage config of AzureStackHCI Cluster.

Name	Type	Default value	Description
configurationMode	string	Express	By default, this mode is set to Express and your storage is configured as per best practices based on the number of nodes in the cluster. Allowed values are 'Express','InfraOnly', 'KeepStorage'

StorageAdapterIPInfo

Object

The StorageAdapter physical nodes of a cluster.

Name	Type	Description
ipv4Address	string	The IPv4 address assigned to each storage adapter physical node on your Azure Stack HCI cluster.
physicalNode	string	storage adapter physical node name.
subnetMask	string	The SubnetMask address assigned to each storage adapter physical node on your Azure Stack HCI cluster.

StorageNetworks

Object

The StorageNetworks of a cluster.

Name	Type	Description
name	string	Name of the storage network.
networkAdapterName	string	Name of the storage network adapter.
storageAdapterIPInfo	StorageAdapterIPInfo[]	List of Storage adapter physical nodes config to deploy AzureStackHCI Cluster.
vlanId	string	ID specified for the VLAN storage network. This setting is applied to the network interfaces that route the storage and VM migration traffic.

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.

VirtualSwitchConfigurationOverrides

Object

The VirtualSwitchConfigurationOverrides of a cluster.

Name	Type	Description
enableIov	string	Enable IoV for Virtual Switch
loadBalancingAlgorithm	string	Load Balancing Algorithm for Virtual Switch