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

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
peerAsn	integer	Peer ASN.
peerIp	string	Peer IP.
provisioningState	string	The provisioning state of the resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
peerAsn	integer	Peer ASN.
peerIp	string	Peer IP.
provisioningState	string	The provisioning state of the resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, virtual_router_name, peering_name, subscription_id		Gets the specified Virtual Router Peering.
list	select	resource_group_name, virtual_router_name, subscription_id		Lists all Virtual Router Peerings in a Virtual Router resource.
create_or_update	insert	resource_group_name, virtual_router_name, peering_name, subscription_id		Creates or updates the specified Virtual Router Peering.
create_or_update	replace	resource_group_name, virtual_router_name, peering_name, subscription_id		Creates or updates the specified Virtual Router Peering.
delete	delete	resource_group_name, virtual_router_name, peering_name, subscription_id		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
peering_name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
virtual_router_name	string	The name of the Virtual Router. Required.

SELECT examples

get

Gets the specified Virtual Router Peering.

SELECT
id,
name,
etag,
peerAsn,
peerIp,
provisioningState,
type
FROM azure.network.virtual_router_peerings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_router_name = '{{ virtual_router_name }}' -- required
AND peering_name = '{{ peering_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all Virtual Router Peerings in a Virtual Router resource.

SELECT
id,
name,
etag,
peerAsn,
peerIp,
provisioningState,
type
FROM azure.network.virtual_router_peerings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_router_name = '{{ virtual_router_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates the specified Virtual Router Peering.

INSERT INTO azure.network.virtual_router_peerings (
id,
name,
properties,
resource_group_name,
virtual_router_name,
peering_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ name }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ virtual_router_name }}',
'{{ peering_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_router_peerings
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the virtual_router_peerings resource.
  - name: virtual_router_name
    value: "{{ virtual_router_name }}"
    description: Required parameter for the virtual_router_peerings resource.
  - name: peering_name
    value: "{{ peering_name }}"
    description: Required parameter for the virtual_router_peerings resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the virtual_router_peerings resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource.
  - name: properties
    description: |
      The properties of the Virtual Router Peering.
    value:
      peerAsn: {{ peerAsn }}
      peerIp: "{{ peerIp }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Creates or updates the specified Virtual Router Peering.

REPLACE azure.network.virtual_router_peerings
SET 
id = '{{ id }}',
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_router_name = '{{ virtual_router_name }}' --required
AND peering_name = '{{ peering_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete

Deletes the specified peering from a Virtual Router.

DELETE FROM azure.network.virtual_router_peerings
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND virtual_router_name = '{{ virtual_router_name }}' --required
AND peering_name = '{{ peering_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;