private_clouds

Creates, updates, deletes, gets or lists a private_clouds resource.

Overview

Name	private_clouds
Type	Resource
Id	azure_isv.avs.private_clouds

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
availability	object	Properties describing how the cloud is distributed across availability zones.
circuit	object	An ExpressRoute Circuit.
dnsZoneType	string	The type of DNS zone to use. Known values are: "Public" and "Private". (Public, Private)
encryption	object	Customer managed key encryption, can be enabled or disabled.
endpoints	object	The endpoints.
extendedNetworkBlocks	array	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).
externalCloudLinks	array	Array of cloud link IDs from other clouds that connect to this one.
identity	object	The managed service identities assigned to this resource.
identitySources	array	vCenter Single Sign On Identity Sources.
internet	string	Connectivity to internet is enabled or disabled. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
location	string	The geo-location where the resource lives. Required.
managementCluster	object	The default cluster used for management. Required.
managementNetwork	string	Network used to access vCenter Server and NSX-T Manager.
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. Required.
nsxPublicIpQuotaRaised	string	Flag to indicate whether the private cloud has the quota for provisioned NSX Public IP count raised from 64 to 1024. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
nsxtCertificateThumbprint	string	Thumbprint of the NSX-T Manager SSL certificate.
nsxtPassword	string	Optionally, set the NSX-T Manager password when the private cloud is created.
provisioningNetwork	string	Used for virtual machine cold migration, cloning, and snapshot migration.
provisioningState	string	The provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Cancelled", "Pending", "Building", "Deleting", and "Updating". (Succeeded, Failed, Canceled, Cancelled, Pending, Building, Deleting, Updating)
secondaryCircuit	object	A secondary expressRoute circuit from a separate AZ. Only present in a stretched private cloud.
sku	object	The SKU (Stock Keeping Unit) assigned to this resource. Required.
systemData	object	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".
vcenterCertificateThumbprint	string	Thumbprint of the vCenter Server SSL certificate.
vcenterPassword	string	Optionally, set the vCenter admin password when the private cloud is created.
vcfLicense	object	The private cloud license.
virtualNetworkId	string	Azure resource ID of the virtual network.
vmotionNetwork	string	Used for live migration of virtual machines.
zones	array	The availability zones.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
availability	object	Properties describing how the cloud is distributed across availability zones.
circuit	object	An ExpressRoute Circuit.
dnsZoneType	string	The type of DNS zone to use. Known values are: "Public" and "Private". (Public, Private)
encryption	object	Customer managed key encryption, can be enabled or disabled.
endpoints	object	The endpoints.
extendedNetworkBlocks	array	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).
externalCloudLinks	array	Array of cloud link IDs from other clouds that connect to this one.
identity	object	The managed service identities assigned to this resource.
identitySources	array	vCenter Single Sign On Identity Sources.
internet	string	Connectivity to internet is enabled or disabled. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
location	string	The geo-location where the resource lives. Required.
managementCluster	object	The default cluster used for management. Required.
managementNetwork	string	Network used to access vCenter Server and NSX-T Manager.
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. Required.
nsxPublicIpQuotaRaised	string	Flag to indicate whether the private cloud has the quota for provisioned NSX Public IP count raised from 64 to 1024. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
nsxtCertificateThumbprint	string	Thumbprint of the NSX-T Manager SSL certificate.
nsxtPassword	string	Optionally, set the NSX-T Manager password when the private cloud is created.
provisioningNetwork	string	Used for virtual machine cold migration, cloning, and snapshot migration.
provisioningState	string	The provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Cancelled", "Pending", "Building", "Deleting", and "Updating". (Succeeded, Failed, Canceled, Cancelled, Pending, Building, Deleting, Updating)
secondaryCircuit	object	A secondary expressRoute circuit from a separate AZ. Only present in a stretched private cloud.
sku	object	The SKU (Stock Keeping Unit) assigned to this resource. Required.
systemData	object	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".
vcenterCertificateThumbprint	string	Thumbprint of the vCenter Server SSL certificate.
vcenterPassword	string	Optionally, set the vCenter admin password when the private cloud is created.
vcfLicense	object	The private cloud license.
virtualNetworkId	string	Azure resource ID of the virtual network.
vmotionNetwork	string	Used for live migration of virtual machines.
zones	array	The availability zones.

list_in_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
availability	object	Properties describing how the cloud is distributed across availability zones.
circuit	object	An ExpressRoute Circuit.
dnsZoneType	string	The type of DNS zone to use. Known values are: "Public" and "Private". (Public, Private)
encryption	object	Customer managed key encryption, can be enabled or disabled.
endpoints	object	The endpoints.
extendedNetworkBlocks	array	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).
externalCloudLinks	array	Array of cloud link IDs from other clouds that connect to this one.
identity	object	The managed service identities assigned to this resource.
identitySources	array	vCenter Single Sign On Identity Sources.
internet	string	Connectivity to internet is enabled or disabled. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
location	string	The geo-location where the resource lives. Required.
managementCluster	object	The default cluster used for management. Required.
managementNetwork	string	Network used to access vCenter Server and NSX-T Manager.
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. Required.
nsxPublicIpQuotaRaised	string	Flag to indicate whether the private cloud has the quota for provisioned NSX Public IP count raised from 64 to 1024. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
nsxtCertificateThumbprint	string	Thumbprint of the NSX-T Manager SSL certificate.
nsxtPassword	string	Optionally, set the NSX-T Manager password when the private cloud is created.
provisioningNetwork	string	Used for virtual machine cold migration, cloning, and snapshot migration.
provisioningState	string	The provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Cancelled", "Pending", "Building", "Deleting", and "Updating". (Succeeded, Failed, Canceled, Cancelled, Pending, Building, Deleting, Updating)
secondaryCircuit	object	A secondary expressRoute circuit from a separate AZ. Only present in a stretched private cloud.
sku	object	The SKU (Stock Keeping Unit) assigned to this resource. Required.
systemData	object	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".
vcenterCertificateThumbprint	string	Thumbprint of the vCenter Server SSL certificate.
vcenterPassword	string	Optionally, set the vCenter admin password when the private cloud is created.
vcfLicense	object	The private cloud license.
virtualNetworkId	string	Azure resource ID of the virtual network.
vmotionNetwork	string	Used for live migration of virtual machines.
zones	array	The availability zones.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, private_cloud_name, subscription_id		Get a PrivateCloud.
list	select	resource_group_name, subscription_id		List PrivateCloud resources by resource group.
list_in_subscription	select	subscription_id		List PrivateCloud resources by subscription ID.
create_or_update	insert	resource_group_name, private_cloud_name, subscription_id, location, sku		Create a PrivateCloud.
update	update	resource_group_name, private_cloud_name, subscription_id		Update a PrivateCloud.
create_or_update	replace	resource_group_name, private_cloud_name, subscription_id, location, sku		Create a PrivateCloud.
delete	delete	resource_group_name, private_cloud_name, subscription_id		Delete a PrivateCloud.
list_admin_credentials	exec	resource_group_name, private_cloud_name, subscription_id		List the admin credentials for the private cloud.
get_vcf_license	exec	resource_group_name, private_cloud_name, subscription_id		Get the license for the private cloud.
rotate_vcenter_password	exec	resource_group_name, private_cloud_name, subscription_id		Rotate the vCenter password.
rotate_nsxt_password	exec	resource_group_name, private_cloud_name, subscription_id		Rotate the NSX-T Manager password.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
private_cloud_name	string	Name of the private cloud. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a PrivateCloud.

SELECT
id,
name,
availability,
circuit,
dnsZoneType,
encryption,
endpoints,
extendedNetworkBlocks,
externalCloudLinks,
identity,
identitySources,
internet,
location,
managementCluster,
managementNetwork,
networkBlock,
nsxPublicIpQuotaRaised,
nsxtCertificateThumbprint,
nsxtPassword,
provisioningNetwork,
provisioningState,
secondaryCircuit,
sku,
systemData,
tags,
type,
vcenterCertificateThumbprint,
vcenterPassword,
vcfLicense,
virtualNetworkId,
vmotionNetwork,
zones
FROM azure_isv.avs.private_clouds
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List PrivateCloud resources by resource group.

SELECT
id,
name,
availability,
circuit,
dnsZoneType,
encryption,
endpoints,
extendedNetworkBlocks,
externalCloudLinks,
identity,
identitySources,
internet,
location,
managementCluster,
managementNetwork,
networkBlock,
nsxPublicIpQuotaRaised,
nsxtCertificateThumbprint,
nsxtPassword,
provisioningNetwork,
provisioningState,
secondaryCircuit,
sku,
systemData,
tags,
type,
vcenterCertificateThumbprint,
vcenterPassword,
vcfLicense,
virtualNetworkId,
vmotionNetwork,
zones
FROM azure_isv.avs.private_clouds
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_in_subscription

List PrivateCloud resources by subscription ID.

SELECT
id,
name,
availability,
circuit,
dnsZoneType,
encryption,
endpoints,
extendedNetworkBlocks,
externalCloudLinks,
identity,
identitySources,
internet,
location,
managementCluster,
managementNetwork,
networkBlock,
nsxPublicIpQuotaRaised,
nsxtCertificateThumbprint,
nsxtPassword,
provisioningNetwork,
provisioningState,
secondaryCircuit,
sku,
systemData,
tags,
type,
vcenterCertificateThumbprint,
vcenterPassword,
vcfLicense,
virtualNetworkId,
vmotionNetwork,
zones
FROM azure_isv.avs.private_clouds
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a PrivateCloud.

INSERT INTO azure_isv.avs.private_clouds (
tags,
location,
properties,
sku,
identity,
zones,
resource_group_name,
private_cloud_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ sku }}' /* required */,
'{{ identity }}',
'{{ zones }}',
'{{ resource_group_name }}',
'{{ private_cloud_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type,
zones
;

Manifest

# Description fields are for documentation purposes
- name: private_clouds
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the private_clouds resource.
  - name: private_cloud_name
    value: "{{ private_cloud_name }}"
    description: Required parameter for the private_clouds resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the private_clouds resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      managementCluster:
        clusterSize: {{ clusterSize }}
        provisioningState: "{{ provisioningState }}"
        clusterId: {{ clusterId }}
        hosts:
          - "{{ hosts }}"
        vsanDatastoreName: "{{ vsanDatastoreName }}"
      internet: "{{ internet }}"
      identitySources:
        - name: "{{ name }}"
          alias: "{{ alias }}"
          domain: "{{ domain }}"
          baseUserDN: "{{ baseUserDN }}"
          baseGroupDN: "{{ baseGroupDN }}"
          primaryServer: "{{ primaryServer }}"
          secondaryServer: "{{ secondaryServer }}"
          ssl: "{{ ssl }}"
          username: "{{ username }}"
          password: "{{ password }}"
      availability:
        strategy: "{{ strategy }}"
        zone: {{ zone }}
        secondaryZone: {{ secondaryZone }}
      encryption:
        status: "{{ status }}"
        keyVaultProperties:
          keyName: "{{ keyName }}"
          keyVersion: "{{ keyVersion }}"
          autoDetectedKeyVersion: "{{ autoDetectedKeyVersion }}"
          keyVaultUrl: "{{ keyVaultUrl }}"
          keyState: "{{ keyState }}"
          versionType: "{{ versionType }}"
      extendedNetworkBlocks:
        - "{{ extendedNetworkBlocks }}"
      provisioningState: "{{ provisioningState }}"
      circuit:
        primarySubnet: "{{ primarySubnet }}"
        secondarySubnet: "{{ secondarySubnet }}"
        expressRouteID: "{{ expressRouteID }}"
        expressRoutePrivatePeeringID: "{{ expressRoutePrivatePeeringID }}"
      endpoints:
        nsxtManager: "{{ nsxtManager }}"
        vcsa: "{{ vcsa }}"
        hcxCloudManager: "{{ hcxCloudManager }}"
        nsxtManagerIp: "{{ nsxtManagerIp }}"
        vcenterIp: "{{ vcenterIp }}"
        hcxCloudManagerIp: "{{ hcxCloudManagerIp }}"
      networkBlock: "{{ networkBlock }}"
      managementNetwork: "{{ managementNetwork }}"
      provisioningNetwork: "{{ provisioningNetwork }}"
      vmotionNetwork: "{{ vmotionNetwork }}"
      vcenterPassword: "{{ vcenterPassword }}"
      nsxtPassword: "{{ nsxtPassword }}"
      vcenterCertificateThumbprint: "{{ vcenterCertificateThumbprint }}"
      nsxtCertificateThumbprint: "{{ nsxtCertificateThumbprint }}"
      externalCloudLinks:
        - "{{ externalCloudLinks }}"
      secondaryCircuit:
        primarySubnet: "{{ primarySubnet }}"
        secondarySubnet: "{{ secondarySubnet }}"
        expressRouteID: "{{ expressRouteID }}"
        expressRoutePrivatePeeringID: "{{ expressRoutePrivatePeeringID }}"
      nsxPublicIpQuotaRaised: "{{ nsxPublicIpQuotaRaised }}"
      virtualNetworkId: "{{ virtualNetworkId }}"
      dnsZoneType: "{{ dnsZoneType }}"
      vcfLicense:
        kind: "{{ kind }}"
        provisioningState: "{{ provisioningState }}"
  - name: sku
    description: |
      The SKU (Stock Keeping Unit) assigned to this resource. Required.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
      size: "{{ size }}"
      family: "{{ family }}"
      capacity: {{ capacity }}
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
  - name: zones
    value:
      - "{{ zones }}"
    description: |
      The availability zones.

UPDATE examples

update

Update a PrivateCloud.

UPDATE azure_isv.avs.private_clouds
SET 
tags = '{{ tags }}',
sku = '{{ sku }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type,
zones;

REPLACE examples

create_or_update

Create a PrivateCloud.

REPLACE azure_isv.avs.private_clouds
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
sku = '{{ sku }}',
identity = '{{ identity }}',
zones = '{{ zones }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND sku = '{{ sku }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type,
zones;

DELETE examples

delete

Delete a PrivateCloud.

DELETE FROM azure_isv.avs.private_clouds
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_admin_credentials

List the admin credentials for the private cloud.

EXEC azure_isv.avs.private_clouds.list_admin_credentials 
@resource_group_name='{{ resource_group_name }}' --required, 
@private_cloud_name='{{ private_cloud_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_vcf_license

Get the license for the private cloud.

EXEC azure_isv.avs.private_clouds.get_vcf_license 
@resource_group_name='{{ resource_group_name }}' --required, 
@private_cloud_name='{{ private_cloud_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

rotate_vcenter_password

Rotate the vCenter password.

EXEC azure_isv.avs.private_clouds.rotate_vcenter_password 
@resource_group_name='{{ resource_group_name }}' --required, 
@private_cloud_name='{{ private_cloud_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

rotate_nsxt_password

Rotate the NSX-T Manager password.

EXEC azure_isv.avs.private_clouds.rotate_nsxt_password 
@resource_group_name='{{ resource_group_name }}' --required, 
@private_cloud_name='{{ private_cloud_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;