prefixes

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

Overview

Name	prefixes
Type	Resource
Id	azure.peering.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	Gets or sets the peering prefix properties.
type	string	The type of the resource.

list_by_peering_service

Name	Datatype	Description
id	string	The ID of the resource.
name	string	The name of the resource.
properties	object	Gets or sets the peering prefix properties.
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, peeringServiceName, prefixName, subscriptionId	$expand	Gets an existing prefix with the specified name under the given subscription, resource group and peering service.
list_by_peering_service	select	resourceGroupName, peeringServiceName, subscriptionId	$expand	Lists all prefixes under the given subscription, resource group and peering service.
create_or_update	insert	resourceGroupName, peeringServiceName, prefixName, subscriptionId		Creates a new prefix with the specified name under the given subscription, resource group and peering service.
delete	delete	resourceGroupName, peeringServiceName, prefixName, subscriptionId		Deletes an existing prefix with the specified name under the given subscription, resource group and peering service.

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
peeringServiceName	string	The name of the peering service.
prefixName	string	The name of the prefix.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	The Azure subscription ID.
$expand	string	The properties to be expanded.

SELECT examples

get

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

SELECT
id,
name,
properties,
type
FROM azure.peering.prefixes
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND peeringServiceName = '{{ peeringServiceName }}' -- required
AND prefixName = '{{ prefixName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_peering_service

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

SELECT
id,
name,
properties,
type
FROM azure.peering.prefixes
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND peeringServiceName = '{{ peeringServiceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

INSERT examples

create_or_update

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

INSERT INTO azure.peering.prefixes (
data__properties,
resourceGroupName,
peeringServiceName,
prefixName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ peeringServiceName }}',
'{{ prefixName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: prefixes
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the prefixes resource.
    - name: peeringServiceName
      value: string
      description: Required parameter for the prefixes resource.
    - name: prefixName
      value: string
      description: Required parameter for the prefixes resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the prefixes resource.
    - name: properties
      value: object
      description: |
        Gets or sets the peering prefix properties.

DELETE examples

delete

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

DELETE FROM azure.peering.prefixes
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND peeringServiceName = '{{ peeringServiceName }}' --required
AND prefixName = '{{ prefixName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;