virtual_networks

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

Overview

Name	virtual_networks
Type	Resource
Id	azure_isv.vmware_cloud_simple.virtual_networks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	virtual network id (privateCloudId:vsphereId)
name	string	{VirtualNetworkName}
assignable	boolean	can be used in vm creation/deletion
location	string	Azure region
properties	object	Virtual Network properties
type	string	{resourceProviderNamespace}/{resourceType}

list

successful operation

Name	Datatype	Description
id	string	virtual network id (privateCloudId:vsphereId)
name	string	{VirtualNetworkName}
assignable	boolean	can be used in vm creation/deletion
location	string	Azure region
properties	object	Virtual Network properties
type	string	{resourceProviderNamespace}/{resourceType}

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, regionId, pcName, virtualNetworkName	api-version	Return virtual network by its name
list	select	subscriptionId, regionId, pcName, resourcePoolName	api-version	Return list of virtual networks in location for private cloud

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
pcName	string	The private cloud name
regionId	string	The region Id (westus, eastus)
resourcePoolName	string	Resource pool used to derive vSphere cluster which contains virtual networks
subscriptionId	string	The subscription ID.
virtualNetworkName	string	virtual network id (vsphereId)
api-version	string	Client API version.

SELECT examples

get

Return virtual network by its name

SELECT
id,
name,
assignable,
location,
properties,
type
FROM azure_isv.vmware_cloud_simple.virtual_networks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND regionId = '{{ regionId }}' -- required
AND pcName = '{{ pcName }}' -- required
AND virtualNetworkName = '{{ virtualNetworkName }}' -- required
AND api-version = '{{ api-version }}'
;

list

Return list of virtual networks in location for private cloud

SELECT
id,
name,
assignable,
location,
properties,
type
FROM azure_isv.vmware_cloud_simple.virtual_networks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND regionId = '{{ regionId }}' -- required
AND pcName = '{{ pcName }}' -- required
AND resourcePoolName = '{{ resourcePoolName }}' -- required
AND api-version = '{{ api-version }}'
;