virtual_networks

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

Overview

Name	virtual_networks
Type	Resource
Id	azure_isv.vmwarecloudsimple.virtual_networks

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	virtual network id (privateCloudId:vsphereId). Required.
name	string	{VirtualNetworkName}.
assignable	boolean	can be used in vm creation/deletion.
location	string	Azure region.
privateCloudId	string	The Private Cloud id.
type	string	{resourceProviderNamespace}/{resourceType}.

list

Name	Datatype	Description
id	string	virtual network id (privateCloudId:vsphereId). Required.
name	string	{VirtualNetworkName}.
assignable	boolean	can be used in vm creation/deletion.
location	string	Azure region.
privateCloudId	string	The Private Cloud id.
type	string	{resourceProviderNamespace}/{resourceType}.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	region_id, pc_name, virtual_network_name, subscription_id		Implements virtual network GET method. Return virtual network by its name.
list	select	region_id, pc_name, subscription_id, resourcePoolName		Implements list available virtual networks within a subscription method. 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
pc_name	string	The private cloud name. Required.
region_id	string	The region Id (westus, eastus). Required.
resourcePoolName	string	Resource pool used to derive vSphere cluster which contains virtual networks. Required.
subscription_id	string
virtual_network_name	string	virtual network id (vsphereId). Required.

SELECT examples

get

Implements virtual network GET method. Return virtual network by its name.

SELECT
id,
name,
assignable,
location,
privateCloudId,
type
FROM azure_isv.vmwarecloudsimple.virtual_networks
WHERE region_id = '{{ region_id }}' -- required
AND pc_name = '{{ pc_name }}' -- required
AND virtual_network_name = '{{ virtual_network_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Implements list available virtual networks within a subscription method. Return list of virtual networks in location for private cloud.

SELECT
id,
name,
assignable,
location,
privateCloudId,
type
FROM azure_isv.vmwarecloudsimple.virtual_networks
WHERE region_id = '{{ region_id }}' -- required
AND pc_name = '{{ pc_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND resourcePoolName = '{{ resourcePoolName }}' -- required
;