virtual_routers

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

Overview

Name	virtual_routers
Type	Resource
Id	azure.network.virtual_routers

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns a Virtual Router resource.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the Virtual Router.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_resource_group

Success. The operation returns a list of Virtual Router resources.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the Virtual Router.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

Success. The operation returns a list of Virtual Router resources.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the Virtual Router.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, virtualRouterName, subscriptionId	$expand	Gets the specified Virtual Router.
list_by_resource_group	select	resourceGroupName, subscriptionId		Lists all Virtual Routers in a resource group.
list	select	subscriptionId		Gets all the Virtual Routers in a subscription.
create_or_update	insert	resourceGroupName, virtualRouterName, subscriptionId		Creates or updates the specified Virtual Router.
delete	delete	resourceGroupName, virtualRouterName, subscriptionId		Deletes the specified Virtual Router.

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.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
virtualRouterName	string	The name of the Virtual Router.
$expand	string	Expands referenced resources.

SELECT examples

get

Gets the specified Virtual Router.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.virtual_routers
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualRouterName = '{{ virtualRouterName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_resource_group

Lists all Virtual Routers in a resource group.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.virtual_routers
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Gets all the Virtual Routers in a subscription.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.virtual_routers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates the specified Virtual Router.

INSERT INTO azure.network.virtual_routers (
data__properties,
resourceGroupName,
virtualRouterName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ virtualRouterName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_routers
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the virtual_routers resource.
    - name: virtualRouterName
      value: string
      description: Required parameter for the virtual_routers resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the virtual_routers resource.
    - name: properties
      value: object
      description: |
        Properties of the Virtual Router.

DELETE examples

delete

Deletes the specified Virtual Router.

DELETE FROM azure.network.virtual_routers
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND virtualRouterName = '{{ virtualRouterName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;