private_clouds

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

Overview

Name	private_clouds
Type	Resource
Id	azure_isv.vmwarecloudsimple.private_clouds

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Azure Id, e.g. "/subscriptions/4da99247-a172-4ed6-8ae9-ebed2d12f839/providers/Microsoft.VMwareCloudSimple/privateClouds/cloud123".
name	string	Private cloud name.
availabilityZoneId	string	Availability Zone id, e.g. "az1".
availabilityZoneName	string	Availability Zone name, e.g. "Availability Zone 1".
clustersNumber	integer	Number of clusters.
createdBy	string	User's emails who created cloud.
createdOn	string (date-time)	When private cloud was created.
dnsServers	array	Array of DNS servers.
expires	string	Expiration date of PC.
location	string	Location where private cloud created, e.g "westus".
nsxType	string	Nsx Type, e.g. "Advanced".
placementGroupId	string	Placement Group id, e.g. "n1".
placementGroupName	string	Placement Group name.
privateCloudId	string	Id of a private cloud.
resourcePools	array	The list of Resource Pools.
state	string	Private Cloud state, e.g. "operational".
totalCpuCores	integer	Number of cores.
totalNodes	integer	Number of nodes.
totalRam	integer	Memory size.
totalStorage	number	Disk space in TB.
type	string	Azure Resource type. Default value is "Microsoft.VMwareCloudSimple/privateClouds".
vSphereVersion	string	e.g. "6.5u2".
vcenterFqdn	string	FQDN for vcenter access.
vcenterRefid	string	Vcenter ip address.
virtualMachineTemplates	array	The list of Virtual Machine Templates.
virtualNetworks	array	The list of Virtual Networks.
vrOpsEnabled	boolean	Is Vrops enabled/disabled.

list

Name	Datatype	Description
id	string	Azure Id, e.g. "/subscriptions/4da99247-a172-4ed6-8ae9-ebed2d12f839/providers/Microsoft.VMwareCloudSimple/privateClouds/cloud123".
name	string	Private cloud name.
availabilityZoneId	string	Availability Zone id, e.g. "az1".
availabilityZoneName	string	Availability Zone name, e.g. "Availability Zone 1".
clustersNumber	integer	Number of clusters.
createdBy	string	User's emails who created cloud.
createdOn	string (date-time)	When private cloud was created.
dnsServers	array	Array of DNS servers.
expires	string	Expiration date of PC.
location	string	Location where private cloud created, e.g "westus".
nsxType	string	Nsx Type, e.g. "Advanced".
placementGroupId	string	Placement Group id, e.g. "n1".
placementGroupName	string	Placement Group name.
privateCloudId	string	Id of a private cloud.
resourcePools	array	The list of Resource Pools.
state	string	Private Cloud state, e.g. "operational".
totalCpuCores	integer	Number of cores.
totalNodes	integer	Number of nodes.
totalRam	integer	Memory size.
totalStorage	number	Disk space in TB.
type	string	Azure Resource type. Default value is "Microsoft.VMwareCloudSimple/privateClouds".
vSphereVersion	string	e.g. "6.5u2".
vcenterFqdn	string	FQDN for vcenter access.
vcenterRefid	string	Vcenter ip address.
virtualMachineTemplates	array	The list of Virtual Machine Templates.
virtualNetworks	array	The list of Virtual Networks.
vrOpsEnabled	boolean	Is Vrops enabled/disabled.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	pc_name, region_id, subscription_id		Implements private cloud GET method. Returns private cloud by its name.
list	select	region_id, subscription_id		Implements private cloud list GET method. Returns list of private clouds in particular region.

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
pc_name	string	The private cloud name. Required.
region_id	string	The region Id (westus, eastus). Required.
subscription_id	string

SELECT examples

get

Implements private cloud GET method. Returns private cloud by its name.

SELECT
id,
name,
availabilityZoneId,
availabilityZoneName,
clustersNumber,
createdBy,
createdOn,
dnsServers,
expires,
location,
nsxType,
placementGroupId,
placementGroupName,
privateCloudId,
resourcePools,
state,
totalCpuCores,
totalNodes,
totalRam,
totalStorage,
type,
vSphereVersion,
vcenterFqdn,
vcenterRefid,
virtualMachineTemplates,
virtualNetworks,
vrOpsEnabled
FROM azure_isv.vmwarecloudsimple.private_clouds
WHERE pc_name = '{{ pc_name }}' -- required
AND region_id = '{{ region_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Implements private cloud list GET method. Returns list of private clouds in particular region.

SELECT
id,
name,
availabilityZoneId,
availabilityZoneName,
clustersNumber,
createdBy,
createdOn,
dnsServers,
expires,
location,
nsxType,
placementGroupId,
placementGroupName,
privateCloudId,
resourcePools,
state,
totalCpuCores,
totalNodes,
totalRam,
totalStorage,
type,
vSphereVersion,
vcenterFqdn,
vcenterRefid,
virtualMachineTemplates,
virtualNetworks,
vrOpsEnabled
FROM azure_isv.vmwarecloudsimple.private_clouds
WHERE region_id = '{{ region_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;