virtual_networks

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

Overview

Name	virtual_networks
Type	Resource
Id	azure.system_center_vm_manager.virtual_networks

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
extendedLocation	object	The extended location.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_resource_group

Azure operation completed successfully.

Name	Datatype	Description
extendedLocation	object	The extended location.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_subscription

Azure operation completed successfully.

Name	Datatype	Description
extendedLocation	object	The extended location.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, virtualNetworkName		Implements VirtualNetwork GET method.
list_by_resource_group	select	subscriptionId, resourceGroupName		List of VirtualNetworks in a resource group.
list_by_subscription	select	subscriptionId		List of VirtualNetworks in a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, virtualNetworkName, data__extendedLocation		Onboards the ScVmm virtual network as an Azure virtual network resource.
update	update	subscriptionId, resourceGroupName, virtualNetworkName		Updates the VirtualNetworks resource.
delete	delete	subscriptionId, resourceGroupName, virtualNetworkName	force	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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
virtualNetworkName	string	Name of the VirtualNetwork.
force	string	Forces the resource to be deleted.

SELECT examples

get

Implements VirtualNetwork GET method.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.system_center_vm_manager.virtual_networks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualNetworkName = '{{ virtualNetworkName }}' -- required
;

list_by_resource_group

List of VirtualNetworks in a resource group.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.system_center_vm_manager.virtual_networks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

List of VirtualNetworks in a subscription.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.system_center_vm_manager.virtual_networks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Onboards the ScVmm virtual network as an Azure virtual network resource.

INSERT INTO azure.system_center_vm_manager.virtual_networks (
data__properties,
data__extendedLocation,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
virtualNetworkName
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ virtualNetworkName }}'
RETURNING
extendedLocation,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: virtual_networks
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the virtual_networks resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the virtual_networks resource.
    - name: virtualNetworkName
      value: string
      description: Required parameter for the virtual_networks resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: extendedLocation
      value: object
      description: |
        The extended location.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Updates the VirtualNetworks resource.

UPDATE azure.system_center_vm_manager.virtual_networks
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND virtualNetworkName = '{{ virtualNetworkName }}' --required
RETURNING
extendedLocation,
location,
properties,
tags;

DELETE examples

delete

Deregisters the ScVmm virtual network from Azure.

DELETE FROM azure.system_center_vm_manager.virtual_networks
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND virtualNetworkName = '{{ virtualNetworkName }}' --required
AND force = '{{ force }}'
;