virtual_networks

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

Overview

Name	virtual_networks
Type	Resource
Id	azure.scvmm.virtual_networks

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
extendedLocation	object	The extended location. Required.
inventoryItemId	string	Gets or sets the inventory Item ID for the resource.
location	string	The geo-location where the resource lives. Required.
networkName	string	Name of the virtual network in vmmServer.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
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".
uuid	string	Unique ID of the virtual network.
vmmServerId	string	ARM Id of the vmmServer resource in which this resource resides.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
extendedLocation	object	The extended location. Required.
inventoryItemId	string	Gets or sets the inventory Item ID for the resource.
location	string	The geo-location where the resource lives. Required.
networkName	string	Name of the virtual network in vmmServer.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
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".
uuid	string	Unique ID of the virtual network.
vmmServerId	string	ARM Id of the vmmServer resource in which this resource resides.

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
extendedLocation	object	The extended location. Required.
inventoryItemId	string	Gets or sets the inventory Item ID for the resource.
location	string	The geo-location where the resource lives. Required.
networkName	string	Name of the virtual network in vmmServer.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
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".
uuid	string	Unique ID of the virtual network.
vmmServerId	string	ARM Id of the vmmServer resource in which this resource 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 VirtualNetwork. Implements VirtualNetwork 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_by_subscription	select	subscription_id		Implements GET VirtualNetworks in a subscription. List of VirtualNetworks in a subscription.
create_or_update	insert	resource_group_name, virtual_network_name, subscription_id, location, extendedLocation		Implements VirtualNetworks PUT method. Onboards the ScVmm virtual network as an Azure virtual network resource.
update	update	resource_group_name, virtual_network_name, subscription_id		Implements the VirtualNetworks PATCH method. Updates the VirtualNetworks resource.
create_or_update	replace	resource_group_name, virtual_network_name, subscription_id, location, extendedLocation		Implements VirtualNetworks PUT method. Onboards the ScVmm virtual network as an Azure virtual network resource.
delete	delete	resource_group_name, virtual_network_name, subscription_id	force	Implements VirtualNetwork DELETE method. Deregisters the ScVmm virtual network from Azure.

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 name of the resource group. The name is case insensitive. Required.
subscription_id	string
virtual_network_name	string	Name of the VirtualNetwork. Required.
force	string	Forces the resource to be deleted. Known values are: "true" and "false". Default value is None.

SELECT examples

get

Gets a VirtualNetwork. Implements VirtualNetwork GET method.

SELECT
id,
name,
extendedLocation,
inventoryItemId,
location,
networkName,
provisioningState,
systemData,
tags,
type,
uuid,
vmmServerId
FROM azure.scvmm.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,
extendedLocation,
inventoryItemId,
location,
networkName,
provisioningState,
systemData,
tags,
type,
uuid,
vmmServerId
FROM azure.scvmm.virtual_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

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

SELECT
id,
name,
extendedLocation,
inventoryItemId,
location,
networkName,
provisioningState,
systemData,
tags,
type,
uuid,
vmmServerId
FROM azure.scvmm.virtual_networks
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Implements VirtualNetworks PUT method. Onboards the ScVmm virtual network as an Azure virtual network resource.

INSERT INTO azure.scvmm.virtual_networks (
tags,
location,
properties,
extendedLocation,
resource_group_name,
virtual_network_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ extendedLocation }}' /* required */,
'{{ resource_group_name }}',
'{{ virtual_network_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
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: 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:
      inventoryItemId: "{{ inventoryItemId }}"
      uuid: "{{ uuid }}"
      vmmServerId: "{{ vmmServerId }}"
      networkName: "{{ networkName }}"
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      The extended location. Required.
    value:
      type: "{{ type }}"
      name: "{{ name }}"

UPDATE examples

update

Implements the VirtualNetworks PATCH method. Updates the VirtualNetworks resource.

UPDATE azure.scvmm.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,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Implements VirtualNetworks PUT method. Onboards the ScVmm virtual network as an Azure virtual network resource.

REPLACE azure.scvmm.virtual_networks
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_network_name = '{{ virtual_network_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND extendedLocation = '{{ extendedLocation }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Implements VirtualNetwork DELETE method. Deregisters the ScVmm virtual network from Azure.

DELETE FROM azure.scvmm.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 }}'
;