virtual_router_peerings

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

Overview

Name	virtual_router_peerings
Type	Resource
Id	azure.network.virtual_router_peerings

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns a Virtual Router Peering resource.

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the virtual router peering that is unique within a virtual router.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	The properties of the Virtual Router Peering.
type	string	Peering type.

list

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

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the virtual router peering that is unique within a virtual router.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	The properties of the Virtual Router Peering.
type	string	Peering type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, virtualRouterName, peeringName, subscriptionId		Gets the specified Virtual Router Peering.
list	select	resourceGroupName, virtualRouterName, subscriptionId		Lists all Virtual Router Peerings in a Virtual Router resource.
create_or_update	insert	resourceGroupName, virtualRouterName, peeringName, subscriptionId		Creates or updates the specified Virtual Router Peering.
delete	delete	resourceGroupName, virtualRouterName, peeringName, subscriptionId		Deletes the specified peering from a 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
peeringName	string	The name of the peering.
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.

SELECT examples

get

Gets the specified Virtual Router Peering.

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

list

Lists all Virtual Router Peerings in a Virtual Router resource.

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

INSERT examples

create_or_update

Creates or updates the specified Virtual Router Peering.

INSERT INTO azure.network.virtual_router_peerings (
data__properties,
data__name,
data__id,
resourceGroupName,
virtualRouterName,
peeringName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ id }}',
'{{ resourceGroupName }}',
'{{ virtualRouterName }}',
'{{ peeringName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_router_peerings
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the virtual_router_peerings resource.
    - name: virtualRouterName
      value: string
      description: Required parameter for the virtual_router_peerings resource.
    - name: peeringName
      value: string
      description: Required parameter for the virtual_router_peerings resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the virtual_router_peerings resource.
    - name: properties
      value: object
      description: |
        The properties of the Virtual Router Peering.
    - name: name
      value: string
      description: |
        Name of the virtual router peering that is unique within a virtual router.
    - name: id
      value: string
      description: |
        Resource ID.

DELETE examples

delete

Deletes the specified peering from a Virtual Router.

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