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

vw_virtual_network_peerings

Name	Datatype	Description
id	text	Resource ID.
name	text	The name of the resource that is unique within a resource group. This name can be used to access the resource.
allow_forwarded_traffic	text	field from the properties object
allow_gateway_transit	text	field from the properties object
allow_virtual_network_access	text	field from the properties object
do_not_verify_remote_gateways	text	field from the properties object
enable_only_ipv6_peering	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
local_address_space	text	field from the properties object
local_subnet_names	text	field from the properties object
local_virtual_network_address_space	text	field from the properties object
peer_complete_vnets	text	field from the properties object
peering_state	text	field from the properties object
peering_sync_level	text	field from the properties object
provisioning_state	text	field from the properties object
remote_address_space	text	field from the properties object
remote_bgp_communities	text	field from the properties object
remote_subnet_names	text	field from the properties object
remote_virtual_network	text	field from the properties object
remote_virtual_network_address_space	text	field from the properties object
remote_virtual_network_encryption	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_guid	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	Resource type.
use_remote_gateways	text	field from the properties object
virtualNetworkName	text	field from the properties object
virtualNetworkPeeringName	text	field from the properties object

virtual_network_peerings

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

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

SELECT examples

Gets all virtual network peerings in a virtual network.

vw_virtual_network_peerings

SELECT
id,
name,
allow_forwarded_traffic,
allow_gateway_transit,
allow_virtual_network_access,
do_not_verify_remote_gateways,
enable_only_ipv6_peering,
etag,
local_address_space,
local_subnet_names,
local_virtual_network_address_space,
peer_complete_vnets,
peering_state,
peering_sync_level,
provisioning_state,
remote_address_space,
remote_bgp_communities,
remote_subnet_names,
remote_virtual_network,
remote_virtual_network_address_space,
remote_virtual_network_encryption,
resourceGroupName,
resource_guid,
subscriptionId,
type,
use_remote_gateways,
virtualNetworkName,
virtualNetworkPeeringName
FROM azure.network.vw_virtual_network_peerings
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND virtualNetworkName = '{{ virtualNetworkName }}';

virtual_network_peerings

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.network.virtual_network_peerings (
resourceGroupName,
subscriptionId,
virtualNetworkName,
virtualNetworkPeeringName,
properties,
name,
type,
id
)
SELECT 
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ virtualNetworkName }}',
'{{ virtualNetworkPeeringName }}',
'{{ properties }}',
'{{ name }}',
'{{ type }}',
'{{ id }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: allowVirtualNetworkAccess
          value: boolean
        - name: allowForwardedTraffic
          value: boolean
        - name: allowGatewayTransit
          value: boolean
        - name: useRemoteGateways
          value: boolean
        - name: remoteVirtualNetwork
          value:
            - name: id
              value: string
        - name: localAddressSpace
          value:
            - name: addressPrefixes
              value:
                - string
        - name: remoteBgpCommunities
          value:
            - name: virtualNetworkCommunity
              value: string
            - name: regionalCommunity
              value: string
        - name: remoteVirtualNetworkEncryption
          value:
            - name: enabled
              value: boolean
            - name: enforcement
              value: string
        - name: peeringState
          value: string
        - name: peeringSyncLevel
          value: string
        - name: provisioningState
          value: []
        - name: doNotVerifyRemoteGateways
          value: boolean
        - name: resourceGuid
          value: string
        - name: peerCompleteVnets
          value: boolean
        - name: enableOnlyIPv6Peering
          value: boolean
        - name: localSubnetNames
          value:
            - string
        - name: remoteSubnetNames
          value:
            - string
    - name: name
      value: string
    - name: etag
      value: string
    - name: type
      value: string
    - name: id
      value: string

DELETE example

Deletes the specified virtual_network_peerings resource.

/*+ delete */
DELETE FROM azure.network.virtual_network_peerings
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND virtualNetworkName = '{{ virtualNetworkName }}'
AND virtualNetworkPeeringName = '{{ virtualNetworkPeeringName }}';