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.
kind	string	The kind of the peering.
location	string	The location of the resource.
properties	object	The properties that define a peering.
sku	object	The SKU that defines the tier and kind of the peering.
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.
kind	string	The kind of the peering.
location	string	The location of the resource.
properties	object	The properties that define a peering.
sku	object	The SKU that defines the tier and kind of the peering.
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.
kind	string	The kind of the peering.
location	string	The location of the resource.
properties	object	The properties that define a peering.
sku	object	The SKU that defines the tier and kind of the peering.
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	resourceGroupName, peeringName, subscriptionId		Gets an existing peering with the specified name under the given subscription and resource group.
list_by_resource_group	select	resourceGroupName, subscriptionId		Lists all of the peerings under the given subscription and resource group.
list_by_subscription	select	subscriptionId		Lists all of the peerings under the given subscription.
create_or_update	insert	resourceGroupName, peeringName, subscriptionId, data__sku, data__kind, data__location		Creates a new peering or updates an existing peering with the specified name under the given subscription and resource group.
update	update	resourceGroupName, peeringName, subscriptionId		Updates tags for a peering with the specified name under the given subscription and resource group.
delete	delete	resourceGroupName, peeringName, subscriptionId		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
peeringName	string	The name of the peering.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	The Azure subscription ID.

SELECT examples

get

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

SELECT
id,
name,
kind,
location,
properties,
sku,
tags,
type
FROM azure.peering.peerings
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND peeringName = '{{ peeringName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

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

SELECT
id,
name,
kind,
location,
properties,
sku,
tags,
type
FROM azure.peering.peerings
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscription

Lists all of the peerings under the given subscription.

SELECT
id,
name,
kind,
location,
properties,
sku,
tags,
type
FROM azure.peering.peerings
WHERE subscriptionId = '{{ subscriptionId }}' -- 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 (
data__sku,
data__kind,
data__properties,
data__location,
data__tags,
resourceGroupName,
peeringName,
subscriptionId
)
SELECT 
'{{ sku }}' /* required */,
'{{ kind }}' /* required */,
'{{ properties }}',
'{{ location }}' /* required */,
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ peeringName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
kind,
location,
properties,
sku,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: peerings
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the peerings resource.
    - name: peeringName
      value: string
      description: Required parameter for the peerings resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the peerings resource.
    - name: sku
      value: object
      description: |
        The SKU that defines the tier and kind of the peering.
    - name: kind
      value: string
      description: |
        The kind of the peering.
      valid_values: ['Direct', 'Exchange']
    - name: properties
      value: object
      description: |
        The properties that define a peering.
    - name: location
      value: string
      description: |
        The location of the resource.
    - name: tags
      value: object
      description: |
        The resource tags.

UPDATE examples

update

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

UPDATE azure.peering.peerings
SET 
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND peeringName = '{{ peeringName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --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 resourceGroupName = '{{ resourceGroupName }}' --required
AND peeringName = '{{ peeringName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;