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

vw_virtual_router_peerings

Name	Datatype	Description
id	text	Resource ID.
name	text	Name of the virtual router peering that is unique within a virtual router.
etag	text	A unique read-only string that changes whenever the resource is updated.
peer_asn	text	field from the properties object
peer_ip	text	field from the properties object
peeringName	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	Peering type.
virtualRouterName	text	field from the properties object

virtual_router_peerings

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	Properties of the rule group.
type	string	Peering type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	peeringName, resourceGroupName, subscriptionId, virtualRouterName	Gets the specified Virtual Router Peering.
list	SELECT	resourceGroupName, subscriptionId, virtualRouterName	Lists all Virtual Router Peerings in a Virtual Router resource.
create_or_update	INSERT	peeringName, resourceGroupName, subscriptionId, virtualRouterName	Creates or updates the specified Virtual Router Peering.
delete	DELETE	peeringName, resourceGroupName, subscriptionId, virtualRouterName	Deletes the specified peering from a Virtual Router.

SELECT examples

Lists all Virtual Router Peerings in a Virtual Router resource.

vw_virtual_router_peerings

SELECT
id,
name,
etag,
peer_asn,
peer_ip,
peeringName,
provisioning_state,
resourceGroupName,
subscriptionId,
type,
virtualRouterName
FROM azure.network.vw_virtual_router_peerings
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND virtualRouterName = '{{ virtualRouterName }}';

virtual_router_peerings

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

INSERT example

Use the following StackQL query and manifest file to create a new virtual_router_peerings resource.

All Properties

/*+ create */
INSERT INTO azure.network.virtual_router_peerings (
peeringName,
resourceGroupName,
subscriptionId,
virtualRouterName,
properties,
name,
id
)
SELECT 
'{{ peeringName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ virtualRouterName }}',
'{{ properties }}',
'{{ name }}',
'{{ id }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: peerAsn
          value: integer
        - name: peerIp
          value: string
        - name: provisioningState
          value: []
    - name: name
      value: string
    - name: etag
      value: string
    - name: type
      value: string
    - name: id
      value: string

DELETE example

Deletes the specified virtual_router_peerings resource.

/*+ delete */
DELETE FROM azure.network.virtual_router_peerings
WHERE peeringName = '{{ peeringName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND virtualRouterName = '{{ virtualRouterName }}';