peerings

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

Overview

Name	peerings
Type	Resource
Id	azure.peering.peerings

Fields

vw_peerings

Name	Datatype	Description
id	text	The ID of the resource.
name	text	The name of the resource.
direct	text	field from the properties object
exchange	text	field from the properties object
kind	text	The kind of the peering.
location	text	The location of the resource.
peeringName	text	field from the properties object
peering_location	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
sku	text	The SKU that defines the tier and kind of the peering.
subscriptionId	text	field from the properties object
tags	text	The resource tags.
type	text	The type of the resource.

peerings

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 connectivity to the Microsoft Cloud Edge.
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

Name	Accessible by	Required Params	Description
get	SELECT	peeringName, resourceGroupName, 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	peeringName, resourceGroupName, subscriptionId, data__kind, data__location, data__sku	Creates a new peering or updates an existing peering with the specified name under the given subscription and resource group.
delete	DELETE	peeringName, resourceGroupName, subscriptionId	Deletes an existing peering with the specified name under the given subscription and resource group.
update	UPDATE	peeringName, resourceGroupName, subscriptionId	Updates tags for a peering with the specified name under the given subscription and resource group.

SELECT examples

Lists all of the peerings under the given subscription.

vw_peerings

SELECT
id,
name,
direct,
exchange,
kind,
location,
peeringName,
peering_location,
provisioning_state,
resourceGroupName,
sku,
subscriptionId,
tags,
type
FROM azure.peering.vw_peerings
WHERE subscriptionId = '{{ subscriptionId }}';

peerings

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.peering.peerings (
peeringName,
resourceGroupName,
subscriptionId,
data__kind,
data__location,
data__sku,
sku,
kind,
properties,
location,
tags
)
SELECT 
'{{ peeringName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__kind }}',
'{{ data__location }}',
'{{ data__sku }}',
'{{ sku }}',
'{{ kind }}',
'{{ properties }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: id
      value: string
    - name: type
      value: string
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string
        - name: family
          value: string
        - name: size
          value: string
    - name: kind
      value: string
    - name: properties
      value:
        - name: direct
          value:
            - name: connections
              value:
                - - name: bandwidthInMbps
                    value: integer
                  - name: provisionedBandwidthInMbps
                    value: integer
                  - name: sessionAddressProvider
                    value: string
                  - name: useForPeeringService
                    value: boolean
                  - name: microsoftTrackingId
                    value: string
                  - name: peeringDBFacilityId
                    value: integer
                  - name: connectionState
                    value: string
                  - name: bgpSession
                    value:
                      - name: sessionPrefixV4
                        value: string
                      - name: sessionPrefixV6
                        value: string
                      - name: microsoftSessionIPv4Address
                        value: string
                      - name: microsoftSessionIPv6Address
                        value: string
                      - name: peerSessionIPv4Address
                        value: string
                      - name: peerSessionIPv6Address
                        value: string
                      - name: sessionStateV4
                        value: string
                      - name: sessionStateV6
                        value: string
                      - name: maxPrefixesAdvertisedV4
                        value: integer
                      - name: maxPrefixesAdvertisedV6
                        value: integer
                      - name: md5AuthenticationKey
                        value: string
                  - name: connectionIdentifier
                    value: string
                  - name: errorMessage
                    value: string
            - name: useForPeeringService
              value: boolean
            - name: peerAsn
              value:
                - name: id
                  value: string
            - name: directPeeringType
              value: string
        - name: exchange
          value:
            - name: connections
              value:
                - - name: peeringDBFacilityId
                    value: integer
                  - name: connectionState
                    value: string
                  - name: connectionIdentifier
                    value: string
                  - name: errorMessage
                    value: string
        - name: peeringLocation
          value: string
        - name: provisioningState
          value: string
    - name: location
      value: string
    - name: tags
      value: object

UPDATE example

Updates a peerings resource.

/*+ update */
UPDATE azure.peering.peerings
SET 
tags = '{{ tags }}'
WHERE 
peeringName = '{{ peeringName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified peerings resource.

/*+ delete */
DELETE FROM azure.peering.peerings
WHERE peeringName = '{{ peeringName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';