Private Clouds - Get

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

Name of the private cloud

Regex pattern: ^[-\w\._]+$

resourceGroupName
path True

string

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

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

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

Sample Response

{
  "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

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

Sample Response

{
  "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

The properties describing private cloud availability zone distribution

Name Type Description
secondaryZone

integer

The secondary availability zone for the private cloud

strategy

AvailabilityStrategy

The availability strategy for the private cloud

zone

integer

The primary availability zone for the private cloud

AvailabilityStrategy

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

Name Type Description
DualZone

string

in two zones

SingleZone

string

in single zone

Circuit

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

Cluster provisioning state

Name Type Description
Canceled

string

Resource creation was canceled.

Cancelled

string

is cancelled

Deleting

string

is deleting

Failed

string

Resource creation failed.

Succeeded

string

Resource has been created.

Updating

string

is updating

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

DnsZoneType

The type of DNS zone.

Name Type Description
Private

string

Private DNS zone.

Public

string

Primary DNS zone.

Encryption

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

Whether the the encryption key is connected or access denied

Name Type Description
AccessDenied

string

is access denied

Connected

string

is connected

EncryptionKeyVaultProperties

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

Whether encryption is enabled or disabled

Name Type Description
Disabled

string

is disabled

Enabled

string

is enabled

EncryptionVersionType

Whether the encryption version is fixed or auto-detected

Name Type Description
AutoDetected

string

is auto-detected

Fixed

string

is fixed

Endpoints

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

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

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

Error response

Name Type Description
error

ErrorDetail

The error object.

IdentitySource

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

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

Whether internet is enabled or disabled

Name Type Description
Disabled

string

is disabled

Enabled

string

is enabled

ManagementCluster

The properties of a management cluster

Name Type Description
clusterId

integer

The identity

clusterSize

integer

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

NSX public IP quota raised

Name Type Description
Disabled

string

is disabled

Enabled

string

is enabled

PrivateCloud

A private cloud resource

Name Type Default Value Description
id

string

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

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

Optionally, set the vCenter admin password when the private cloud is created

properties.virtualNetworkId

string

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

private cloud provisioning state

Name Type Description
Building

string

is building

Canceled

string

Resource creation was canceled.

Cancelled

string

is cancelled

Deleting

string

is deleting

Failed

string

Resource creation failed.

Pending

string

is pending

Succeeded

string

Resource has been created.

Updating

string

is updating

Sku

The resource model definition representing SKU

Name Type Description
capacity

integer

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

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.

Name Type Description
Basic

string

Free

string

Premium

string

Standard

string

SslEnum

Whether SSL is enabled or disabled

Name Type Description
Disabled

string

is disabled

Enabled

string

is enabled

SystemAssignedServiceIdentity

Managed service identity (either system assigned, or none)

Name Type Description
principalId

string

The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.

tenantId

string

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

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

Name Type Description
None

string

SystemAssigned

string

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

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

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.