Private Clouds - Get

Service:

AVS

API Version:

2023-09-01

Get a PrivateCloud

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}?api-version=2023-09-01

URI Parameters

Name	In	Required	Type	Description
privateCloudName	path	True	string pattern: ^[-\w\._]+$	Name of the private cloud
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	PrivateCloud	Azure 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

PrivateClouds_Get

PrivateClouds_Get_Stretched

PrivateClouds_Get

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1?api-version=2023-09-01

Java

/**
 * Samples for PrivateClouds GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/examples/PrivateClouds_Get.json
     */
    /**
     * Sample code: PrivateClouds_Get.
     * 
     * @param manager Entry point to AvsManager.
     */
    public static void privateCloudsGet(com.azure.resourcemanager.avs.AvsManager manager) {
        manager.privateClouds().getByResourceGroupWithResponse("group1", "cloud1", 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.avs import AVSClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-avs
# USAGE
    python private_clouds_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 = AVSClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.private_clouds.get(
        resource_group_name="group1",
        private_cloud_name="cloud1",
    )
    print(response)


# x-ms-original-file: specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/examples/PrivateClouds_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

Go

package armavs_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/avs/armavs/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e7678455846b1000fd31db27596e4ca3d299a872/specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/examples/PrivateClouds_Get.json
func ExamplePrivateCloudsClient_Get_privateCloudsGet() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armavs.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPrivateCloudsClient().Get(ctx, "group1", "cloud1", 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.PrivateCloud = armavs.PrivateCloud{
	// 	Name: to.Ptr("cloud1"),
	// 	Type: to.Ptr("Microsoft.AVS/privateClouds"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1"),
	// 	Location: to.Ptr("eastus2"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Identity: &armavs.PrivateCloudIdentity{
	// 		Type: to.Ptr(armavs.ResourceIdentityTypeSystemAssigned),
	// 		PrincipalID: to.Ptr("881e5573-063f-49e4-8c08-79d7df0169d8"),
	// 		TenantID: to.Ptr("881e5573-063f-49e4-8c08-79d7df0169d8"),
	// 	},
	// 	Properties: &armavs.PrivateCloudProperties{
	// 		Availability: &armavs.AvailabilityProperties{
	// 			Strategy: to.Ptr(armavs.AvailabilityStrategySingleZone),
	// 			Zone: to.Ptr[int32](1),
	// 		},
	// 		Circuit: &armavs.Circuit{
	// 			ExpressRouteID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2/providers/Microsoft.Network/expressroutecircuits/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2-xconnect"),
	// 			ExpressRoutePrivatePeeringID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/tnt42-cust-p01-dmo01/providers/Microsoft.Network/expressroutecircuits/tnt42-cust-p01-dmo01-er/peerings/AzurePrivatePeering"),
	// 			PrimarySubnet: to.Ptr("192.168.53.0/30"),
	// 			SecondarySubnet: to.Ptr("192.168.53.4/30"),
	// 		},
	// 		Encryption: &armavs.Encryption{
	// 			KeyVaultProperties: &armavs.EncryptionKeyVaultProperties{
	// 				KeyName: to.Ptr("keyname1"),
	// 				KeyState: to.Ptr(armavs.EncryptionKeyStatusConnected),
	// 				KeyVaultURL: to.Ptr("https://keyvault1-kmip-kvault.vault.azure.net/"),
	// 				KeyVersion: to.Ptr("ver1.0"),
	// 				VersionType: to.Ptr(armavs.EncryptionVersionTypeFixed),
	// 			},
	// 			Status: to.Ptr(armavs.EncryptionStateEnabled),
	// 		},
	// 		Endpoints: &armavs.Endpoints{
	// 			HcxCloudManager: to.Ptr("https://hcx.290351365f5b41a19b77af.eastus.avslab.azure.com/"),
	// 			HcxCloudManagerIP: to.Ptr("192.168.50.4"),
	// 			NsxtManager: to.Ptr("https://nsx.290351365f5b41a19b77af.eastus.avslab.azure.com/"),
	// 			NsxtManagerIP: to.Ptr("192.168.50.3"),
	// 			VcenterIP: to.Ptr("192.168.50.2"),
	// 			Vcsa: to.Ptr("https://vc.290351365f5b41a19b77af.eastus.avslab.azure.com/"),
	// 		},
	// 		ExternalCloudLinks: []*string{
	// 			to.Ptr("/subscriptions/12341234-1234-1234-1234-123412341234/resourceGroups/mygroup/providers/Microsoft.AVS/privateClouds/cloud2")},
	// 			IdentitySources: []*armavs.IdentitySource{
	// 				{
	// 					Name: to.Ptr("group1"),
	// 					Alias: to.Ptr("groupAlias"),
	// 					BaseGroupDN: to.Ptr("ou=baseGroup"),
	// 					BaseUserDN: to.Ptr("ou=baseUser"),
	// 					Domain: to.Ptr("domain1"),
	// 					PrimaryServer: to.Ptr("ldaps://1.1.1.1:636/"),
	// 					SecondaryServer: to.Ptr("ldaps://1.1.1.2:636/"),
	// 					SSL: to.Ptr(armavs.SSLEnumEnabled),
	// 			}},
	// 			Internet: to.Ptr(armavs.InternetEnumDisabled),
	// 			ManagementCluster: &armavs.ManagementCluster{
	// 				ClusterID: to.Ptr[int32](1),
	// 				ClusterSize: to.Ptr[int32](4),
	// 				Hosts: []*string{
	// 					to.Ptr("fakehost18.nyc1.kubernetes.center"),
	// 					to.Ptr("fakehost19.nyc1.kubernetes.center"),
	// 					to.Ptr("fakehost20.nyc1.kubernetes.center"),
	// 					to.Ptr("fakehost21.nyc1.kubernetes.center")},
	// 				},
	// 				NetworkBlock: to.Ptr("192.168.48.0/22"),
	// 				ProvisioningState: to.Ptr(armavs.PrivateCloudProvisioningStateSucceeded),
	// 			},
	// 			SKU: &armavs.SKU{
	// 				Name: to.Ptr("AV36"),
	// 			},
	// 		}
}

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 { AzureVMwareSolutionAPI } = require("@azure/arm-avs");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get a PrivateCloud
 *
 * @summary Get a PrivateCloud
 * x-ms-original-file: specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/examples/PrivateClouds_Get.json
 */
async function privateCloudsGet() {
  const subscriptionId =
    process.env["AVS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["AVS_RESOURCE_GROUP"] || "group1";
  const privateCloudName = "cloud1";
  const credential = new DefaultAzureCredential();
  const client = new AzureVMwareSolutionAPI(credential, subscriptionId);
  const result = await client.privateClouds.get(resourceGroupName, privateCloudName);
  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.Avs.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Avs;

// Generated from example definition: specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/examples/PrivateClouds_Get.json
// this example is just showing the usage of "PrivateClouds_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 AvsPrivateCloudResource created on azure
// for more information of creating AvsPrivateCloudResource, please refer to the document of AvsPrivateCloudResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "group1";
string privateCloudName = "cloud1";
ResourceIdentifier avsPrivateCloudResourceId = AvsPrivateCloudResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, privateCloudName);
AvsPrivateCloudResource avsPrivateCloud = client.GetAvsPrivateCloudResource(avsPrivateCloudResourceId);

// invoke the operation
AvsPrivateCloudResource result = await avsPrivateCloud.GetAsync();

// 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
AvsPrivateCloudData 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/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1",
  "identity": {
    "principalId": "881e5573-063f-49e4-8c08-79d7df0169d8",
    "tenantId": "881e5573-063f-49e4-8c08-79d7df0169d8",
    "type": "SystemAssigned"
  },
  "location": "eastus2",
  "name": "cloud1",
  "sku": {
    "name": "AV36"
  },
  "properties": {
    "availability": {
      "strategy": "SingleZone",
      "zone": 1
    },
    "networkBlock": "192.168.48.0/22",
    "circuit": {
      "expressRouteID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2/providers/Microsoft.Network/expressroutecircuits/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2-xconnect",
      "primarySubnet": "192.168.53.0/30",
      "secondarySubnet": "192.168.53.4/30",
      "expressRoutePrivatePeeringID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/tnt42-cust-p01-dmo01/providers/Microsoft.Network/expressroutecircuits/tnt42-cust-p01-dmo01-er/peerings/AzurePrivatePeering"
    },
    "managementCluster": {
      "clusterId": 1,
      "clusterSize": 4,
      "hosts": [
        "fakehost18.nyc1.kubernetes.center",
        "fakehost19.nyc1.kubernetes.center",
        "fakehost20.nyc1.kubernetes.center",
        "fakehost21.nyc1.kubernetes.center"
      ]
    },
    "encryption": {
      "status": "Enabled",
      "keyVaultProperties": {
        "keyName": "keyname1",
        "keyVersion": "ver1.0",
        "keyVaultUrl": "https://keyvault1-kmip-kvault.vault.azure.net/",
        "keyState": "Connected",
        "versionType": "Fixed"
      }
    },
    "endpoints": {
      "nsxtManager": "https://nsx.290351365f5b41a19b77af.eastus.avslab.azure.com/",
      "vcsa": "https://vc.290351365f5b41a19b77af.eastus.avslab.azure.com/",
      "hcxCloudManager": "https://hcx.290351365f5b41a19b77af.eastus.avslab.azure.com/",
      "nsxtManagerIp": "192.168.50.3",
      "vcenterIp": "192.168.50.2",
      "hcxCloudManagerIp": "192.168.50.4"
    },
    "externalCloudLinks": [
      "/subscriptions/12341234-1234-1234-1234-123412341234/resourceGroups/mygroup/providers/Microsoft.AVS/privateClouds/cloud2"
    ],
    "identitySources": [
      {
        "alias": "groupAlias",
        "baseGroupDN": "ou=baseGroup",
        "baseUserDN": "ou=baseUser",
        "domain": "domain1",
        "name": "group1",
        "primaryServer": "ldaps://1.1.1.1:636/",
        "secondaryServer": "ldaps://1.1.1.2:636/",
        "ssl": "Enabled"
      }
    ],
    "internet": "Disabled",
    "provisioningState": "Succeeded"
  },
  "tags": {},
  "type": "Microsoft.AVS/privateClouds"
}

PrivateClouds_Get_Stretched

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1?api-version=2023-09-01

Java

/**
 * Samples for PrivateClouds GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/examples/PrivateClouds_Get_Stretched.json
     */
    /**
     * Sample code: PrivateClouds_Get_Stretched.
     * 
     * @param manager Entry point to AvsManager.
     */
    public static void privateCloudsGetStretched(com.azure.resourcemanager.avs.AvsManager manager) {
        manager.privateClouds().getByResourceGroupWithResponse("group1", "cloud1", 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.avs import AVSClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-avs
# USAGE
    python private_clouds_get_stretched.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 = AVSClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.private_clouds.get(
        resource_group_name="group1",
        private_cloud_name="cloud1",
    )
    print(response)


# x-ms-original-file: specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/examples/PrivateClouds_Get_Stretched.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 armavs_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/avs/armavs/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e7678455846b1000fd31db27596e4ca3d299a872/specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/examples/PrivateClouds_Get_Stretched.json
func ExamplePrivateCloudsClient_Get_privateCloudsGetStretched() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armavs.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPrivateCloudsClient().Get(ctx, "group1", "cloud1", 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.PrivateCloud = armavs.PrivateCloud{
	// 	Name: to.Ptr("cloud1"),
	// 	Type: to.Ptr("Microsoft.AVS/privateClouds"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1"),
	// 	Location: to.Ptr("eastus2"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armavs.PrivateCloudProperties{
	// 		Availability: &armavs.AvailabilityProperties{
	// 			SecondaryZone: to.Ptr[int32](2),
	// 			Strategy: to.Ptr(armavs.AvailabilityStrategyDualZone),
	// 			Zone: to.Ptr[int32](1),
	// 		},
	// 		Circuit: &armavs.Circuit{
	// 			ExpressRouteID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2/providers/Microsoft.Network/expressroutecircuits/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2-xconnect"),
	// 			ExpressRoutePrivatePeeringID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/tnt42-cust-p01-dmo01/providers/Microsoft.Network/expressroutecircuits/tnt42-cust-p01-dmo01-er/peerings/AzurePrivatePeering"),
	// 			PrimarySubnet: to.Ptr("192.168.53.0/30"),
	// 			SecondarySubnet: to.Ptr("192.168.53.4/30"),
	// 		},
	// 		Endpoints: &armavs.Endpoints{
	// 			HcxCloudManager: to.Ptr("https://hcx.290351365f5b41a19b77af.eastus.avslab.azure.com/"),
	// 			HcxCloudManagerIP: to.Ptr("192.168.50.4"),
	// 			NsxtManager: to.Ptr("https://nsx.290351365f5b41a19b77af.eastus.avslab.azure.com/"),
	// 			NsxtManagerIP: to.Ptr("192.168.50.3"),
	// 			VcenterIP: to.Ptr("192.168.50.2"),
	// 			Vcsa: to.Ptr("https://vc.290351365f5b41a19b77af.eastus.avslab.azure.com/"),
	// 		},
	// 		ExternalCloudLinks: []*string{
	// 			to.Ptr("/subscriptions/12341234-1234-1234-1234-123412341234/resourceGroups/mygroup/providers/Microsoft.AVS/privateClouds/cloud2")},
	// 			IdentitySources: []*armavs.IdentitySource{
	// 				{
	// 					Name: to.Ptr("group1"),
	// 					Alias: to.Ptr("groupAlias"),
	// 					BaseGroupDN: to.Ptr("ou=baseGroup"),
	// 					BaseUserDN: to.Ptr("ou=baseUser"),
	// 					Domain: to.Ptr("domain1"),
	// 					PrimaryServer: to.Ptr("ldaps://1.1.1.1:636/"),
	// 					SecondaryServer: to.Ptr("ldaps://1.1.1.2:636/"),
	// 					SSL: to.Ptr(armavs.SSLEnumEnabled),
	// 			}},
	// 			Internet: to.Ptr(armavs.InternetEnumDisabled),
	// 			ManagementCluster: &armavs.ManagementCluster{
	// 				ClusterID: to.Ptr[int32](1),
	// 				ClusterSize: to.Ptr[int32](4),
	// 				Hosts: []*string{
	// 					to.Ptr("fakehost18.nyc1.kubernetes.center"),
	// 					to.Ptr("fakehost19.nyc1.kubernetes.center"),
	// 					to.Ptr("fakehost20.nyc1.kubernetes.center"),
	// 					to.Ptr("fakehost21.nyc1.kubernetes.center")},
	// 				},
	// 				NetworkBlock: to.Ptr("192.168.48.0/22"),
	// 				ProvisioningState: to.Ptr(armavs.PrivateCloudProvisioningStateSucceeded),
	// 				SecondaryCircuit: &armavs.Circuit{
	// 					ExpressRouteID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2/providers/Microsoft.Network/expressroutecircuits/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2-xconnect"),
	// 					ExpressRoutePrivatePeeringID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/tnt42-cust-p01-dmo01/providers/Microsoft.Network/expressroutecircuits/tnt42-cust-p01-dmo01-er2/peerings/AzurePrivatePeering"),
	// 					PrimarySubnet: to.Ptr("192.168.53.0/30"),
	// 					SecondarySubnet: to.Ptr("192.168.53.4/30"),
	// 				},
	// 			},
	// 			SKU: &armavs.SKU{
	// 				Name: to.Ptr("AV36"),
	// 			},
	// 		}
}

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 { AzureVMwareSolutionAPI } = require("@azure/arm-avs");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get a PrivateCloud
 *
 * @summary Get a PrivateCloud
 * x-ms-original-file: specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/examples/PrivateClouds_Get_Stretched.json
 */
async function privateCloudsGetStretched() {
  const subscriptionId =
    process.env["AVS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["AVS_RESOURCE_GROUP"] || "group1";
  const privateCloudName = "cloud1";
  const credential = new DefaultAzureCredential();
  const client = new AzureVMwareSolutionAPI(credential, subscriptionId);
  const result = await client.privateClouds.get(resourceGroupName, privateCloudName);
  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.Avs.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Avs;

// Generated from example definition: specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/examples/PrivateClouds_Get_Stretched.json
// this example is just showing the usage of "PrivateClouds_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 AvsPrivateCloudResource created on azure
// for more information of creating AvsPrivateCloudResource, please refer to the document of AvsPrivateCloudResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "group1";
string privateCloudName = "cloud1";
ResourceIdentifier avsPrivateCloudResourceId = AvsPrivateCloudResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, privateCloudName);
AvsPrivateCloudResource avsPrivateCloud = client.GetAvsPrivateCloudResource(avsPrivateCloudResourceId);

// invoke the operation
AvsPrivateCloudResource result = await avsPrivateCloud.GetAsync();

// 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
AvsPrivateCloudData 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/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1",
  "location": "eastus2",
  "name": "cloud1",
  "sku": {
    "name": "AV36"
  },
  "properties": {
    "availability": {
      "strategy": "DualZone",
      "zone": 1,
      "secondaryZone": 2
    },
    "networkBlock": "192.168.48.0/22",
    "circuit": {
      "expressRouteID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2/providers/Microsoft.Network/expressroutecircuits/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2-xconnect",
      "primarySubnet": "192.168.53.0/30",
      "secondarySubnet": "192.168.53.4/30",
      "expressRoutePrivatePeeringID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/tnt42-cust-p01-dmo01/providers/Microsoft.Network/expressroutecircuits/tnt42-cust-p01-dmo01-er/peerings/AzurePrivatePeering"
    },
    "secondaryCircuit": {
      "expressRouteID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2/providers/Microsoft.Network/expressroutecircuits/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2-xconnect",
      "primarySubnet": "192.168.53.0/30",
      "secondarySubnet": "192.168.53.4/30",
      "expressRoutePrivatePeeringID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/tnt42-cust-p01-dmo01/providers/Microsoft.Network/expressroutecircuits/tnt42-cust-p01-dmo01-er2/peerings/AzurePrivatePeering"
    },
    "managementCluster": {
      "clusterId": 1,
      "clusterSize": 4,
      "hosts": [
        "fakehost18.nyc1.kubernetes.center",
        "fakehost19.nyc1.kubernetes.center",
        "fakehost20.nyc1.kubernetes.center",
        "fakehost21.nyc1.kubernetes.center"
      ]
    },
    "endpoints": {
      "nsxtManager": "https://nsx.290351365f5b41a19b77af.eastus.avslab.azure.com/",
      "vcsa": "https://vc.290351365f5b41a19b77af.eastus.avslab.azure.com/",
      "hcxCloudManager": "https://hcx.290351365f5b41a19b77af.eastus.avslab.azure.com/",
      "nsxtManagerIp": "192.168.50.3",
      "vcenterIp": "192.168.50.2",
      "hcxCloudManagerIp": "192.168.50.4"
    },
    "externalCloudLinks": [
      "/subscriptions/12341234-1234-1234-1234-123412341234/resourceGroups/mygroup/providers/Microsoft.AVS/privateClouds/cloud2"
    ],
    "identitySources": [
      {
        "alias": "groupAlias",
        "baseGroupDN": "ou=baseGroup",
        "baseUserDN": "ou=baseUser",
        "domain": "domain1",
        "name": "group1",
        "primaryServer": "ldaps://1.1.1.1:636/",
        "secondaryServer": "ldaps://1.1.1.2:636/",
        "ssl": "Enabled"
      }
    ],
    "internet": "Disabled",
    "provisioningState": "Succeeded"
  },
  "tags": {},
  "type": "Microsoft.AVS/privateClouds"
}

Definitions

Name	Description
AvailabilityProperties	The properties describing private cloud availability zone distribution
AvailabilityStrategy	Whether the private clouds is available in a single zone or two zones
Circuit	An ExpressRoute Circuit
ClusterProvisioningState	Cluster provisioning state
createdByType	The type of identity that created the resource.
DnsZoneType	The type of DNS zone.
Encryption	The properties of customer managed encryption key
EncryptionKeyStatus	Whether the the encryption key is connected or access denied
EncryptionKeyVaultProperties	An Encryption Key
EncryptionState	Whether encryption is enabled or disabled
EncryptionVersionType	Whether the encryption version is fixed or auto-detected
Endpoints	Endpoint addresses
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
IdentitySource	vCenter Single Sign On Identity Source
InternetEnum	Whether internet is enabled or disabled
ManagementCluster	The properties of a management cluster
NsxPublicIpQuotaRaisedEnum	NSX public IP quota raised
PrivateCloud	A private cloud resource
PrivateCloudProvisioningState	private cloud provisioning state
Sku	The resource model definition representing SKU
SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
SslEnum	Whether SSL is enabled or disabled
SystemAssignedServiceIdentity	Managed service identity (either system assigned, or none)
SystemAssignedServiceIdentityType	Type of managed service identity (either system assigned, or none).
systemData	Metadata pertaining to creation and last modification of the resource.

AvailabilityProperties

Object

The properties describing private cloud availability zone distribution

Name	Type	Description
secondaryZone	integer (int32)	The secondary availability zone for the private cloud
strategy	AvailabilityStrategy	The availability strategy for the private cloud
zone	integer (int32)	The primary availability zone for the private cloud

AvailabilityStrategy

Enumeration

Whether the private clouds is available in a single zone or two zones

Value	Description
DualZone	in two zones
SingleZone	in single zone

Circuit

Object

An ExpressRoute Circuit

Name	Type	Description
expressRouteID	string	Identifier of the ExpressRoute Circuit (Microsoft Colo only)
expressRoutePrivatePeeringID	string	ExpressRoute Circuit private peering identifier
primarySubnet	string	CIDR of primary subnet
secondarySubnet	string	CIDR of secondary subnet

ClusterProvisioningState

Enumeration

Cluster provisioning state

Value	Description
Canceled	Resource creation was canceled.
Cancelled	is cancelled
Deleting	is deleting
Failed	Resource creation failed.
Succeeded	Resource has been created.
Updating	is updating

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
Application
Key
ManagedIdentity
User

DnsZoneType

Enumeration

The type of DNS zone.

Value	Description
Private	Private DNS zone.
Public	Primary DNS zone.

Encryption

Object

The properties of customer managed encryption key

Name	Type	Description
keyVaultProperties	EncryptionKeyVaultProperties	The key vault where the encryption key is stored
status	EncryptionState	Status of customer managed encryption key

EncryptionKeyStatus

Enumeration

Whether the the encryption key is connected or access denied

Value	Description
AccessDenied	is access denied
Connected	is connected

EncryptionKeyVaultProperties

Object

An Encryption Key

Name	Type	Description
autoDetectedKeyVersion	string	The auto-detected version of the key if versionType is auto-detected.
keyName	string	The name of the key.
keyState	EncryptionKeyStatus	The state of key provided
keyVaultUrl	string	The URL of the vault.
keyVersion	string	The version of the key.
versionType	EncryptionVersionType	Property of the key if user provided or auto detected

EncryptionState

Enumeration

Whether encryption is enabled or disabled

Value	Description
Disabled	is disabled
Enabled	is enabled

EncryptionVersionType

Enumeration

Whether the encryption version is fixed or auto-detected

Value	Description
AutoDetected	is auto-detected
Fixed	is fixed

Endpoints

Object

Endpoint addresses

Name	Type	Description
hcxCloudManager	string	Endpoint FQDN for the HCX Cloud Manager
hcxCloudManagerIp	string	Endpoint IP for the HCX Cloud Manager
nsxtManager	string	Endpoint FQDN for the NSX-T Data Center manager
nsxtManagerIp	string	Endpoint IP for the NSX-T Data Center manager
vcenterIp	string	Endpoint IP for Virtual Center Server Appliance
vcsa	string	Endpoint FQDN for Virtual Center Server Appliance

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.

IdentitySource

Object

vCenter Single Sign On Identity Source

Name	Type	Description
alias	string	The domain's NetBIOS name
baseGroupDN	string	The base distinguished name for groups
baseUserDN	string	The base distinguished name for users
domain	string	The domain's dns name
name	string	The name of the identity source
password	string (password)	The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups.
primaryServer	string	Primary server URL
secondaryServer	string	Secondary server URL
ssl	SslEnum	Protect LDAP communication using SSL certificate (LDAPS)
username	string	The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group

InternetEnum

Enumeration

Whether internet is enabled or disabled

Value	Description
Disabled	is disabled
Enabled	is enabled

ManagementCluster

Object

The properties of a management cluster

Name	Type	Description
clusterId	integer (int32)	The identity
clusterSize	integer (int32)	The cluster size
hosts	string[]	The hosts
provisioningState	ClusterProvisioningState	The state of the cluster provisioning
vsanDatastoreName	string	Name of the vsan datastore associated with the cluster

NsxPublicIpQuotaRaisedEnum

Enumeration

NSX public IP quota raised

Value	Description
Disabled	is disabled
Enabled	is enabled

PrivateCloud

Object

A private cloud 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}"
identity	SystemAssignedServiceIdentity		The managed service identities assigned to this resource.
location	string		The geo-location where the resource lives
name	string		The name of the resource
properties.availability	AvailabilityProperties		Properties describing how the cloud is distributed across availability zones
properties.circuit	Circuit		An ExpressRoute Circuit
properties.dnsZoneType	DnsZoneType		The type of DNS zone to use.
properties.encryption	Encryption		Customer managed key encryption, can be enabled or disabled
properties.endpoints	Endpoints		The endpoints
properties.extendedNetworkBlocks	string[]		Array of additional networks noncontiguous with networkBlock. Networks must be unique and non-overlapping across VNet in your subscription, on-premise, and this privateCloud networkBlock attribute. Make sure the CIDR format conforms to (A.B.C.D/X).
properties.externalCloudLinks	string[]		Array of cloud link IDs from other clouds that connect to this one
properties.identitySources	IdentitySource[]		vCenter Single Sign On Identity Sources
properties.internet	InternetEnum	Disabled	Connectivity to internet is enabled or disabled
properties.managementCluster	ManagementCluster		The default cluster used for management
properties.managementNetwork	string		Network used to access vCenter Server and NSX-T Manager
properties.networkBlock	string		The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22
properties.nsxPublicIpQuotaRaised	NsxPublicIpQuotaRaisedEnum		Flag to indicate whether the private cloud has the quota for provisioned NSX Public IP count raised from 64 to 1024
properties.nsxtCertificateThumbprint	string		Thumbprint of the NSX-T Manager SSL certificate
properties.nsxtPassword	string (password)		Optionally, set the NSX-T Manager password when the private cloud is created
properties.provisioningNetwork	string		Used for virtual machine cold migration, cloning, and snapshot migration
properties.provisioningState	PrivateCloudProvisioningState		The provisioning state
properties.secondaryCircuit	Circuit		A secondary expressRoute circuit from a separate AZ. Only present in a stretched private cloud
properties.vcenterCertificateThumbprint	string		Thumbprint of the vCenter Server SSL certificate
properties.vcenterPassword	string (password)		Optionally, set the vCenter admin password when the private cloud is created
properties.virtualNetworkId	string (arm-id)		Azure resource ID of the virtual network
properties.vmotionNetwork	string		Used for live migration of virtual machines
sku	Sku		The SKU (Stock Keeping Unit) assigned to this resource.
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"

PrivateCloudProvisioningState

Enumeration

private cloud provisioning state

Value	Description
Building	is building
Canceled	Resource creation was canceled.
Cancelled	is cancelled
Deleting	is deleting
Failed	Resource creation failed.
Pending	is pending
Succeeded	Resource has been created.
Updating	is updating

Sku

Object

The resource model definition representing SKU

Name	Type	Description
capacity	integer (int32)	If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
family	string	If the service has different generations of hardware, for the same SKU, then that can be captured here.
name	string	The name of the SKU. E.g. P3. It is typically a letter+number code
size	string	The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier	SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

SkuTier

Enumeration

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

Value	Description
Basic
Free
Premium
Standard

SslEnum

Enumeration

Whether SSL is enabled or disabled

Value	Description
Disabled	is disabled
Enabled	is enabled

SystemAssignedServiceIdentity

Object

Managed service identity (either system assigned, or none)

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	SystemAssignedServiceIdentityType	Type of managed service identity (either system assigned, or none).

SystemAssignedServiceIdentityType

Enumeration

Type of managed service identity (either system assigned, or none).

Value	Description
None
SystemAssigned

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.