virtual_network_peerings

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

Overview

Name	virtual_network_peerings
Type	Resource
Id	azure.network.virtual_network_peerings

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting VirtualNetworkPeering resource.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the virtual network peering.
type	string	Resource type.

list

Request successful. The operation returns a list of VirtualNetworkPeering resources.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the virtual network peering.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, virtualNetworkName, virtualNetworkPeeringName, subscriptionId		Gets the specified virtual network peering.
list	select	resourceGroupName, virtualNetworkName, subscriptionId		Gets all virtual network peerings in a virtual network.
create_or_update	insert	resourceGroupName, virtualNetworkName, virtualNetworkPeeringName, subscriptionId	syncRemoteAddressSpace	Creates or updates a peering in the specified virtual network.
delete	delete	resourceGroupName, virtualNetworkName, virtualNetworkPeeringName, subscriptionId		Deletes the specified virtual network peering.

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.
virtualNetworkName	string	The name of the virtual network.
virtualNetworkPeeringName	string	The name of the virtual network peering.
syncRemoteAddressSpace	string	Parameter indicates the intention to sync the peering with the current address space on the remote vNet after it's updated.

SELECT examples

get

Gets the specified virtual network peering.

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

list

Gets all virtual network peerings in a virtual network.

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

INSERT examples

create_or_update

Creates or updates a peering in the specified virtual network.

INSERT INTO azure.network.virtual_network_peerings (
data__properties,
data__name,
data__type,
data__id,
resourceGroupName,
virtualNetworkName,
virtualNetworkPeeringName,
subscriptionId,
syncRemoteAddressSpace
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ type }}',
'{{ id }}',
'{{ resourceGroupName }}',
'{{ virtualNetworkName }}',
'{{ virtualNetworkPeeringName }}',
'{{ subscriptionId }}',
'{{ syncRemoteAddressSpace }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_network_peerings
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the virtual_network_peerings resource.
    - name: virtualNetworkName
      value: string
      description: Required parameter for the virtual_network_peerings resource.
    - name: virtualNetworkPeeringName
      value: string
      description: Required parameter for the virtual_network_peerings resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the virtual_network_peerings resource.
    - name: properties
      value: object
      description: |
        Properties of the virtual network peering.
    - name: name
      value: string
      description: |
        The name of the resource that is unique within a resource group. This name can be used to access the resource.
    - name: type
      value: string
      description: |
        Resource type.
    - name: id
      value: string
      description: |
        Resource ID.
    - name: syncRemoteAddressSpace
      value: string
      description: Parameter indicates the intention to sync the peering with the current address space on the remote vNet after it's updated.

DELETE examples

delete

Deletes the specified virtual network peering.

DELETE FROM azure.network.virtual_network_peerings
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND virtualNetworkName = '{{ virtualNetworkName }}' --required
AND virtualNetworkPeeringName = '{{ virtualNetworkPeeringName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;