registered_prefixes

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

Overview

Name	registered_prefixes
Type	Resource
Id	azure.peering.registered_prefixes

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 prefix.
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 prefix.
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, registeredPrefixName, subscriptionId		Gets an existing registered prefix with the specified name under the given subscription, resource group and peering.
list_by_peering	select	resourceGroupName, peeringName, subscriptionId		Lists all registered prefixes under the given subscription, resource group and peering.
create_or_update	insert	resourceGroupName, peeringName, registeredPrefixName, subscriptionId		Creates a new registered prefix with the specified name under the given subscription, resource group and peering.
delete	delete	resourceGroupName, peeringName, registeredPrefixName, subscriptionId		Deletes an existing registered prefix with the specified name under the given subscription, resource group and peering.
validate	exec	resourceGroupName, peeringName, registeredPrefixName, subscriptionId		Validates an existing registered prefix 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.
registeredPrefixName	string	The name of the registered prefix.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	The Azure subscription ID.

SELECT examples

get

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

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

list_by_peering

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

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

INSERT examples

create_or_update

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

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

Manifest

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

DELETE examples

delete

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

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

Lifecycle Methods

validate

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

EXEC azure.peering.registered_prefixes.validate 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@peeringName='{{ peeringName }}' --required, 
@registeredPrefixName='{{ registeredPrefixName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;