Private Clouds - Get

Get a private cloud

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

URI Parameters

Name In Required Type Description
privateCloudName
path True
  • string

Name of the private cloud

resourceGroupName
path True
  • string

The name of the resource group. The name is case insensitive.

subscriptionId
path True
  • string

The ID of the target subscription.

api-version
query True
  • string

The API version to use for this operation.

Responses

Name Type Description
200 OK

successful operation

Other Status Codes

Error response describing why the operation failed

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation impersonate your user account

Examples

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=2022-05-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://192.168.50.3/",
      "vcsa": "https://192.168.50.2/",
      "hcxCloudManager": "https://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=2022-05-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://192.168.50.3/",
      "vcsa": "https://192.168.50.2/",
      "hcxCloudManager": "https://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

AvailabilityProperties

The properties describing private cloud availability zone distribution

AvailabilityStrategy

The availability strategy for the private cloud

Circuit

An ExpressRoute Circuit

CloudError

API error response

ClusterProvisioningState

The state of the cluster provisioning

Encryption

The properties of customer managed encryption key

EncryptionKeyStatus

The state of key provided

EncryptionKeyVaultProperties

An Encryption Key

EncryptionState

Status of customer managed encryption key

EncryptionVersionType

Property of the key if user provided or auto detected

Endpoints

Endpoint addresses

ErrorAdditionalInfo

The resource management error additional info.

ErrorResponse

Error Response

IdentitySource

vCenter Single Sign On Identity Source

InternetEnum

Connectivity to internet is enabled or disabled

ManagementCluster

The properties of a management cluster

nsxPublicIpQuotaRaisedEnum

Flag to indicate whether the private cloud has the quota for provisioned NSX Public IP count raised from 64 to 1024

PrivateCloud

A private cloud resource

PrivateCloudIdentity

Identity for the virtual machine.

PrivateCloudProvisioningState

The provisioning state

ResourceIdentityType

The type of identity used for the private cloud. The type 'SystemAssigned' refers to an implicitly created identity. The type 'None' will remove any identities from the Private Cloud.

Sku

The resource model definition representing SKU

SslEnum

Protect LDAP communication using SSL certificate (LDAPS)

AvailabilityProperties

The properties describing private cloud availability zone distribution

Name Type Description
secondaryZone
  • integer

The secondary availability zone for the private cloud

strategy

The availability strategy for the private cloud

zone
  • integer

The primary availability zone for the private cloud

AvailabilityStrategy

The availability strategy for the private cloud

Name Type Description
DualZone
  • string
SingleZone
  • string

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

CloudError

API error response

Name Type Description
error

Error Response
An error returned by the API

ClusterProvisioningState

The state of the cluster provisioning

Name Type Description
Canceled
  • string
Cancelled
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

Encryption

The properties of customer managed encryption key

Name Type Description
keyVaultProperties

The key vault where the encryption key is stored

status

Status of customer managed encryption key

EncryptionKeyStatus

The state of key provided

Name Type Description
AccessDenied
  • string
Connected
  • string

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

The state of key provided

keyVaultUrl
  • string

The URL of the vault.

keyVersion
  • string

The version of the key.

versionType

Property of the key if user provided or auto detected

EncryptionState

Status of customer managed encryption key

Name Type Description
Disabled
  • string
Enabled
  • string

EncryptionVersionType

Property of the key if user provided or auto detected

Name Type Description
AutoDetected
  • string
Fixed
  • string

Endpoints

Endpoint addresses

Name Type Description
hcxCloudManager
  • string

Endpoint for the HCX Cloud Manager

nsxtManager
  • string

Endpoint for the NSX-T Data Center manager

vcsa
  • string

Endpoint 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.

ErrorResponse

Error Response

Name Type Description
additionalInfo

The error additional info.

code
  • string

The error code.

details

The error details.

message
  • string

The error message.

target
  • string

The error target.

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

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

Connectivity to internet is enabled or disabled

Name Type Description
Disabled
  • string
Enabled
  • string

ManagementCluster

The properties of a management cluster

Name Type Description
clusterId
  • integer

The identity

clusterSize
  • integer

The cluster size

hosts
  • string[]

The hosts

provisioningState

The state of the cluster provisioning

nsxPublicIpQuotaRaisedEnum

Flag to indicate whether the private cloud has the quota for provisioned NSX Public IP count raised from 64 to 1024

Name Type Description
Disabled
  • string
Enabled
  • string

PrivateCloud

A private cloud resource

Name Type Default Value Description
id
  • string

Resource ID.

identity

The identity of the private cloud, if configured.

location
  • string

Resource location

name
  • string

Resource name.

properties.availability

Properties describing how the cloud is distributed across availability zones

properties.circuit

An ExpressRoute Circuit

properties.encryption

Customer managed key encryption, can be enabled or disabled

properties.endpoints

The endpoints

properties.externalCloudLinks
  • string[]

Array of cloud link IDs from other clouds that connect to this one

properties.identitySources

vCenter Single Sign On Identity Sources

properties.internet Disabled

Connectivity to internet is enabled or disabled

properties.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

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

The provisioning state

properties.secondaryCircuit

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.vmotionNetwork
  • string

Used for live migration of virtual machines

sku

The private cloud SKU

tags
  • object

Resource tags

type
  • string

Resource type.

PrivateCloudIdentity

Identity for the virtual machine.

Name Type Description
principalId
  • string

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

tenantId
  • string

The tenant ID associated with the private cloud. This property will only be provided for a system assigned identity.

type

The type of identity used for the private cloud. The type 'SystemAssigned' refers to an implicitly created identity. The type 'None' will remove any identities from the Private Cloud.

PrivateCloudProvisioningState

The provisioning state

Name Type Description
Building
  • string
Canceled
  • string
Cancelled
  • string
Deleting
  • string
Failed
  • string
Pending
  • string
Succeeded
  • string
Updating
  • string

ResourceIdentityType

The type of identity used for the private cloud. The type 'SystemAssigned' refers to an implicitly created identity. The type 'None' will remove any identities from the Private Cloud.

Name Type Description
None
  • string
SystemAssigned
  • string

Sku

The resource model definition representing SKU

Name Type Description
name
  • string

The name of the SKU.

SslEnum

Protect LDAP communication using SSL certificate (LDAPS)

Name Type Description
Disabled
  • string
Enabled
  • string