virtual_networks

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

Overview

Name	virtual_networks
Type	Resource
Id	azure.hybrid_aks.virtual_networks

Fields

The following fields are returned by SELECT queries:

list_by_resource_group

Lists the virtual networks in the specified resource group

Name	Datatype	Description
extendedLocation	object	Extended location pointing to the underlying infrastructure
location	string	The geo-location where the resource lives
properties	object	Properties of the virtual network resource
tags	object	Resource tags.

list_by_subscription

Lists the virtual networks in the specified subscription

Name	Datatype	Description
extendedLocation	object	Extended location pointing to the underlying infrastructure
location	string	The geo-location where the resource lives
properties	object	Properties of the virtual network resource
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists the virtual networks in the specified resource group
list_by_subscription	select	subscriptionId		Lists the virtual networks in the specified subscription
create_or_update	insert	subscriptionId, resourceGroupName, virtualNetworkName		Creates or updates the virtual network resource
update	update	subscriptionId, resourceGroupName, virtualNetworkName		Patches the virtual network resource
delete	delete	subscriptionId, resourceGroupName, virtualNetworkName		Deletes the specified virtual network resource
retrieve	exec	subscriptionId, resourceGroupName, virtualNetworkName		Gets the specified virtual network resource

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	Parameter for the name of the virtual network

SELECT examples

list_by_resource_group

Lists the virtual networks in the specified resource group

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

list_by_subscription

Lists the virtual networks in the specified subscription

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

INSERT examples

create_or_update

Creates or updates the virtual network resource

INSERT INTO azure.hybrid_aks.virtual_networks (
data__properties,
data__extendedLocation,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
virtualNetworkName
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}',
'{{ 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: |
        Properties of the virtual network resource
    - name: extendedLocation
      value: object
      description: |
        Extended location pointing to the underlying infrastructure
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Patches the virtual network resource

UPDATE azure.hybrid_aks.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

Deletes the specified virtual network resource

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

Lifecycle Methods

retrieve

Gets the specified virtual network resource

EXEC azure.hybrid_aks.virtual_networks.retrieve 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@virtualNetworkName='{{ virtualNetworkName }}' --required
;