registered_asns

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

Overview

Name	registered_asns
Type	Resource
Id	azure.peering.registered_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 registered ASN.
type	string	The type of the resource.

list_by_peering

Name	Datatype	Description
id	string	The ID of the resource.
name	string	The name of the resource.
properties	object	The properties that define a registered 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	resourceGroupName, peeringName, registeredAsnName, subscriptionId		Gets an existing registered ASN with the specified name under the given subscription, resource group and peering.
list_by_peering	select	resourceGroupName, peeringName, subscriptionId		Lists all registered ASNs under the given subscription, resource group and peering.
create_or_update	insert	resourceGroupName, peeringName, registeredAsnName, subscriptionId		Creates a new registered ASN with the specified name under the given subscription, resource group and peering.
delete	delete	resourceGroupName, peeringName, registeredAsnName, subscriptionId		Deletes an existing registered ASN with the specified name under the given subscription, resource group and peering.

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.
registeredAsnName	string	The name of the registered ASN.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	The Azure subscription ID.

SELECT examples

get

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

SELECT
id,
name,
properties,
type
FROM azure.peering.registered_asns
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND peeringName = '{{ peeringName }}' -- required
AND registeredAsnName = '{{ registeredAsnName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_peering

Lists all registered ASNs under the given subscription, resource group and peering.

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

INSERT examples

create_or_update

Creates a new registered ASN with the specified name under the given subscription, resource group and peering.

INSERT INTO azure.peering.registered_asns (
data__properties,
resourceGroupName,
peeringName,
registeredAsnName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ peeringName }}',
'{{ registeredAsnName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: registered_asns
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the registered_asns resource.
    - name: peeringName
      value: string
      description: Required parameter for the registered_asns resource.
    - name: registeredAsnName
      value: string
      description: Required parameter for the registered_asns resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the registered_asns resource.
    - name: properties
      value: object
      description: |
        The properties that define a registered ASN.

DELETE examples

delete

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

DELETE FROM azure.peering.registered_asns
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND peeringName = '{{ peeringName }}' --required
AND registeredAsnName = '{{ registeredAsnName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;