peering_service_prefixes

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

Overview

Name	peering_service_prefixes
Type	Resource
Id	azure.peering.peering_service_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.
learnedType	string	The prefix learned type. Known values are: "None", "ViaPartner", and "ViaSession".
prefix	string	Valid route prefix.
prefixValidationState	string	The prefix validation state. Known values are: "None", "Invalid", "Verified", "Failed", "Pending", and "Unknown".
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Updating", "Deleting", and "Failed".
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	resource_group_name, peering_service_name, prefix_name, subscription_id		Gets the peering service prefix.
create_or_update	insert	resource_group_name, peering_service_name, prefix_name, subscription_id		Creates or updates the peering prefix.
create_or_update	replace	resource_group_name, peering_service_name, prefix_name, subscription_id		Creates or updates the peering prefix.
delete	delete	resource_group_name, peering_service_name, prefix_name, subscription_id		removes the peering prefix.

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
peering_service_name	string	The peering service name. Required.
prefix_name	string	The prefix name. Required.
resource_group_name	string	The resource group name. Required.
subscription_id	string

SELECT examples

get

Gets the peering service prefix.

SELECT
id,
name,
learnedType,
prefix,
prefixValidationState,
provisioningState,
type
FROM azure.peering.peering_service_prefixes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND peering_service_name = '{{ peering_service_name }}' -- required
AND prefix_name = '{{ prefix_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates the peering prefix.

INSERT INTO azure.peering.peering_service_prefixes (
properties,
resource_group_name,
peering_service_name,
prefix_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ peering_service_name }}',
'{{ prefix_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: peering_service_prefixes
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the peering_service_prefixes resource.
  - name: peering_service_name
    value: "{{ peering_service_name }}"
    description: Required parameter for the peering_service_prefixes resource.
  - name: prefix_name
    value: "{{ prefix_name }}"
    description: Required parameter for the peering_service_prefixes resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the peering_service_prefixes resource.
  - name: properties
    value:
      prefix: "{{ prefix }}"
      prefixValidationState: "{{ prefixValidationState }}"
      learnedType: "{{ learnedType }}"

REPLACE examples

create_or_update

Creates or updates the peering prefix.

REPLACE azure.peering.peering_service_prefixes
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND peering_service_name = '{{ peering_service_name }}' --required
AND prefix_name = '{{ prefix_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

removes the peering prefix.

DELETE FROM azure.peering.peering_service_prefixes
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND peering_service_name = '{{ peering_service_name }}' --required
AND prefix_name = '{{ prefix_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;