peerings

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

Overview

Name	peerings
Type	Resource
Id	azure.peering.peerings

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The ID of the resource.
name	string	The name of the resource.
direct	object	The properties that define a direct peering.
exchange	object	The properties that define an exchange peering.
kind	string	The kind of the peering. Required. Known values are: "Direct" and "Exchange".
location	string	The location of the resource. Required.
peeringLocation	string	The location of the peering.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Updating", "Deleting", and "Failed".
sku	object	The SKU that defines the tier and kind of the peering. Required.
tags	object	The resource tags.
type	string	The type of the resource.

list_by_resource_group

Name	Datatype	Description
id	string	The ID of the resource.
name	string	The name of the resource.
direct	object	The properties that define a direct peering.
exchange	object	The properties that define an exchange peering.
kind	string	The kind of the peering. Required. Known values are: "Direct" and "Exchange".
location	string	The location of the resource. Required.
peeringLocation	string	The location of the peering.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Updating", "Deleting", and "Failed".
sku	object	The SKU that defines the tier and kind of the peering. Required.
tags	object	The resource tags.
type	string	The type of the resource.

list_by_subscription

Name	Datatype	Description
id	string	The ID of the resource.
name	string	The name of the resource.
direct	object	The properties that define a direct peering.
exchange	object	The properties that define an exchange peering.
kind	string	The kind of the peering. Required. Known values are: "Direct" and "Exchange".
location	string	The location of the resource. Required.
peeringLocation	string	The location of the peering.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Updating", "Deleting", and "Failed".
sku	object	The SKU that defines the tier and kind of the peering. Required.
tags	object	The resource tags.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, peering_name, subscription_id		Gets an existing peering with the specified name under the given subscription and resource group.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all of the peerings under the given subscription and resource group.
list_by_subscription	select	subscription_id		Lists all of the peerings under the given subscription.
create_or_update	insert	resource_group_name, peering_name, subscription_id, sku, kind, location		Creates a new peering or updates an existing peering with the specified name under the given subscription and resource group.
update	update	resource_group_name, peering_name, subscription_id		Updates tags for a peering with the specified name under the given subscription and resource group.
create_or_update	replace	resource_group_name, peering_name, subscription_id, sku, kind, location		Creates a new peering or updates an existing peering with the specified name under the given subscription and resource group.
delete	delete	resource_group_name, peering_name, subscription_id		Deletes an existing peering with the specified name under the given subscription and resource group.

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 peering. Required.
resource_group_name	string	The name of the resource group. Required.
subscription_id	string

SELECT examples

get

Gets an existing peering with the specified name under the given subscription and resource group.

SELECT
id,
name,
direct,
exchange,
kind,
location,
peeringLocation,
provisioningState,
sku,
tags,
type
FROM azure.peering.peerings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND peering_name = '{{ peering_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all of the peerings under the given subscription and resource group.

SELECT
id,
name,
direct,
exchange,
kind,
location,
peeringLocation,
provisioningState,
sku,
tags,
type
FROM azure.peering.peerings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists all of the peerings under the given subscription.

SELECT
id,
name,
direct,
exchange,
kind,
location,
peeringLocation,
provisioningState,
sku,
tags,
type
FROM azure.peering.peerings
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates a new peering or updates an existing peering with the specified name under the given subscription and resource group.

INSERT INTO azure.peering.peerings (
sku,
kind,
location,
tags,
properties,
resource_group_name,
peering_name,
subscription_id
)
SELECT 
'{{ sku }}' /* required */,
'{{ kind }}' /* required */,
'{{ location }}' /* required */,
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ peering_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
location,
properties,
sku,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: peerings
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the peerings resource.
  - name: peering_name
    value: "{{ peering_name }}"
    description: Required parameter for the peerings resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the peerings resource.
  - name: sku
    description: |
      The SKU that defines the tier and kind of the peering. Required.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
      family: "{{ family }}"
      size: "{{ size }}"
  - name: kind
    value: "{{ kind }}"
    description: |
      The kind of the peering. Required. Known values are: "Direct" and "Exchange".
  - name: location
    value: "{{ location }}"
    description: |
      The location of the resource. Required.
  - name: tags
    value: "{{ tags }}"
    description: |
      The resource tags.
  - name: properties
    value:
      direct:
        connections:
          - bandwidthInMbps: {{ bandwidthInMbps }}
            provisionedBandwidthInMbps: {{ provisionedBandwidthInMbps }}
            sessionAddressProvider: "{{ sessionAddressProvider }}"
            useForPeeringService: {{ useForPeeringService }}
            peeringDBFacilityId: {{ peeringDBFacilityId }}
            connectionState: "{{ connectionState }}"
            bgpSession:
              sessionPrefixV4: "{{ sessionPrefixV4 }}"
              sessionPrefixV6: "{{ sessionPrefixV6 }}"
              microsoftSessionIPv4Address: "{{ microsoftSessionIPv4Address }}"
              microsoftSessionIPv6Address: "{{ microsoftSessionIPv6Address }}"
              peerSessionIPv4Address: "{{ peerSessionIPv4Address }}"
              peerSessionIPv6Address: "{{ peerSessionIPv6Address }}"
              sessionStateV4: "{{ sessionStateV4 }}"
              sessionStateV6: "{{ sessionStateV6 }}"
              maxPrefixesAdvertisedV4: {{ maxPrefixesAdvertisedV4 }}
              maxPrefixesAdvertisedV6: {{ maxPrefixesAdvertisedV6 }}
              md5AuthenticationKey: "{{ md5AuthenticationKey }}"
            connectionIdentifier: "{{ connectionIdentifier }}"
        useForPeeringService: {{ useForPeeringService }}
        peerAsn:
          id: "{{ id }}"
        directPeeringType: "{{ directPeeringType }}"
      exchange:
        connections:
          - peeringDBFacilityId: {{ peeringDBFacilityId }}
            connectionState: "{{ connectionState }}"
            bgpSession:
              sessionPrefixV4: "{{ sessionPrefixV4 }}"
              sessionPrefixV6: "{{ sessionPrefixV6 }}"
              microsoftSessionIPv4Address: "{{ microsoftSessionIPv4Address }}"
              microsoftSessionIPv6Address: "{{ microsoftSessionIPv6Address }}"
              peerSessionIPv4Address: "{{ peerSessionIPv4Address }}"
              peerSessionIPv6Address: "{{ peerSessionIPv6Address }}"
              sessionStateV4: "{{ sessionStateV4 }}"
              sessionStateV6: "{{ sessionStateV6 }}"
              maxPrefixesAdvertisedV4: {{ maxPrefixesAdvertisedV4 }}
              maxPrefixesAdvertisedV6: {{ maxPrefixesAdvertisedV6 }}
              md5AuthenticationKey: "{{ md5AuthenticationKey }}"
            connectionIdentifier: "{{ connectionIdentifier }}"
        peerAsn:
          id: "{{ id }}"
      peeringLocation: "{{ peeringLocation }}"

UPDATE examples

update

Updates tags for a peering with the specified name under the given subscription and resource group.

UPDATE azure.peering.peerings
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND peering_name = '{{ peering_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
kind,
location,
properties,
sku,
tags,
type;

REPLACE examples

create_or_update

Creates a new peering or updates an existing peering with the specified name under the given subscription and resource group.

REPLACE azure.peering.peerings
SET 
sku = '{{ sku }}',
kind = '{{ kind }}',
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND peering_name = '{{ peering_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND sku = '{{ sku }}' --required
AND kind = '{{ kind }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
kind,
location,
properties,
sku,
tags,
type;

DELETE examples

delete

Deletes an existing peering with the specified name under the given subscription and resource group.

DELETE FROM azure.peering.peerings
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND peering_name = '{{ peering_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;