virtual_networks

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

Overview

Name	virtual_networks
Type	Resource
Id	azure_isv.connectedvmware.virtual_networks

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Gets or sets the Id.
name	string	Gets or sets the name.
customResourceName	string	Gets the name of the corresponding resource in Kubernetes.
extendedLocation	object	Gets or sets the extended location.
inventoryItemId	string	Gets or sets the inventory Item ID for the virtual network.
kind	string	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
location	string	Gets or sets the location. Required.
moName	string	Gets or sets the vCenter Managed Object name for the virtual network.
moRefId	string	Gets or sets the vCenter MoRef (Managed Object Reference) ID for the virtual network.
provisioningState	string	Gets the provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
statuses	array	The resource status information.
systemData	object	The system data.
tags	object	Gets or sets the Resource tags.
type	string	Gets or sets the type of the resource.
uuid	string	Gets or sets a unique identifier for this resource.
vCenterId	string	Gets or sets the ARM Id of the vCenter resource in which this template resides.

list_by_resource_group

Name	Datatype	Description
id	string	Gets or sets the Id.
name	string	Gets or sets the name.
customResourceName	string	Gets the name of the corresponding resource in Kubernetes.
extendedLocation	object	Gets or sets the extended location.
inventoryItemId	string	Gets or sets the inventory Item ID for the virtual network.
kind	string	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
location	string	Gets or sets the location. Required.
moName	string	Gets or sets the vCenter Managed Object name for the virtual network.
moRefId	string	Gets or sets the vCenter MoRef (Managed Object Reference) ID for the virtual network.
provisioningState	string	Gets the provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
statuses	array	The resource status information.
systemData	object	The system data.
tags	object	Gets or sets the Resource tags.
type	string	Gets or sets the type of the resource.
uuid	string	Gets or sets a unique identifier for this resource.
vCenterId	string	Gets or sets the ARM Id of the vCenter resource in which this template resides.

list

Name	Datatype	Description
id	string	Gets or sets the Id.
name	string	Gets or sets the name.
customResourceName	string	Gets the name of the corresponding resource in Kubernetes.
extendedLocation	object	Gets or sets the extended location.
inventoryItemId	string	Gets or sets the inventory Item ID for the virtual network.
kind	string	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
location	string	Gets or sets the location. Required.
moName	string	Gets or sets the vCenter Managed Object name for the virtual network.
moRefId	string	Gets or sets the vCenter MoRef (Managed Object Reference) ID for the virtual network.
provisioningState	string	Gets the provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
statuses	array	The resource status information.
systemData	object	The system data.
tags	object	Gets or sets the Resource tags.
type	string	Gets or sets the type of the resource.
uuid	string	Gets or sets a unique identifier for this resource.
vCenterId	string	Gets or sets the ARM Id of the vCenter resource in which this template resides.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, virtual_network_name, subscription_id		Gets a virtual network. Implements virtual network GET method.
list_by_resource_group	select	resource_group_name, subscription_id		Implements GET virtualNetworks in a resource group. List of virtualNetworks in a resource group.
list	select	subscription_id		Implements GET virtualNetworks in a subscription. List of virtualNetworks in a subscription.
create	insert	resource_group_name, virtual_network_name, subscription_id, location		Implements virtual network PUT method. Create Or Update virtual network.
update	update	resource_group_name, virtual_network_name, subscription_id		Updates a virtual network. API to update certain properties of the virtual network resource.
delete	delete	resource_group_name, virtual_network_name, subscription_id	force	Deletes an virtual network. Implements virtual network DELETE method.

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
resource_group_name	string	The Resource Group Name. Required.
subscription_id	string
virtual_network_name	string	Name of the virtual network resource. Required.
force	boolean	Whether force delete was specified. Default value is None.

SELECT examples

get

Gets a virtual network. Implements virtual network GET method.

SELECT
id,
name,
customResourceName,
extendedLocation,
inventoryItemId,
kind,
location,
moName,
moRefId,
provisioningState,
statuses,
systemData,
tags,
type,
uuid,
vCenterId
FROM azure_isv.connectedvmware.virtual_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_network_name = '{{ virtual_network_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Implements GET virtualNetworks in a resource group. List of virtualNetworks in a resource group.

SELECT
id,
name,
customResourceName,
extendedLocation,
inventoryItemId,
kind,
location,
moName,
moRefId,
provisioningState,
statuses,
systemData,
tags,
type,
uuid,
vCenterId
FROM azure_isv.connectedvmware.virtual_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Implements GET virtualNetworks in a subscription. List of virtualNetworks in a subscription.

SELECT
id,
name,
customResourceName,
extendedLocation,
inventoryItemId,
kind,
location,
moName,
moRefId,
provisioningState,
statuses,
systemData,
tags,
type,
uuid,
vCenterId
FROM azure_isv.connectedvmware.virtual_networks
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Implements virtual network PUT method. Create Or Update virtual network.

INSERT INTO azure_isv.connectedvmware.virtual_networks (
location,
extendedLocation,
tags,
kind,
properties,
resource_group_name,
virtual_network_name,
subscription_id
)
SELECT 
'{{ location }}' /* required */,
'{{ extendedLocation }}',
'{{ tags }}',
'{{ kind }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ virtual_network_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
kind,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_networks
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the virtual_networks resource.
  - name: virtual_network_name
    value: "{{ virtual_network_name }}"
    description: Required parameter for the virtual_networks resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the virtual_networks resource.
  - name: location
    value: "{{ location }}"
    description: |
      Gets or sets the location. Required.
  - name: extendedLocation
    description: |
      Gets or sets the extended location.
    value:
      type: "{{ type }}"
      name: "{{ name }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Gets or sets the Resource tags.
  - name: kind
    value: "{{ kind }}"
    description: |
      Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
  - name: properties
    value:
      vCenterId: "{{ vCenterId }}"
      moRefId: "{{ moRefId }}"
      inventoryItemId: "{{ inventoryItemId }}"

UPDATE examples

update

Updates a virtual network. API to update certain properties of the virtual network resource.

UPDATE azure_isv.connectedvmware.virtual_networks
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_network_name = '{{ virtual_network_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
extendedLocation,
kind,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes an virtual network. Implements virtual network DELETE method.

DELETE FROM azure_isv.connectedvmware.virtual_networks
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND virtual_network_name = '{{ virtual_network_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND force = '{{ force }}'
;