peer_asns

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

Overview

Name	peer_asns
Type	Resource
Id	azure.peering.peer_asns

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.
properties	object	The properties that define a peer's ASN.
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.
properties	object	The properties that define a peer's ASN.
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	peerAsnName, subscriptionId		Gets the peer ASN with the specified name under the given subscription.
list_by_subscription	select	subscriptionId		Lists all of the peer ASNs under the given subscription.
create_or_update	insert	peerAsnName, subscriptionId		Creates a new peer ASN or updates an existing peer ASN with the specified name under the given subscription.
delete	delete	peerAsnName, subscriptionId		Deletes an existing peer ASN with the specified name under the given subscription.

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
peerAsnName	string	The peer ASN name.
subscriptionId	string	The Azure subscription ID.

SELECT examples

get

Gets the peer ASN with the specified name under the given subscription.

SELECT
id,
name,
properties,
type
FROM azure.peering.peer_asns
WHERE peerAsnName = '{{ peerAsnName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscription

Lists all of the peer ASNs under the given subscription.

SELECT
id,
name,
properties,
type
FROM azure.peering.peer_asns
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates a new peer ASN or updates an existing peer ASN with the specified name under the given subscription.

INSERT INTO azure.peering.peer_asns (
data__properties,
peerAsnName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ peerAsnName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: peer_asns
  props:
    - name: peerAsnName
      value: string
      description: Required parameter for the peer_asns resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the peer_asns resource.
    - name: properties
      value: object
      description: |
        The properties that define a peer's ASN.

DELETE examples

delete

Deletes an existing peer ASN with the specified name under the given subscription.

DELETE FROM azure.peering.peer_asns
WHERE peerAsnName = '{{ peerAsnName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;