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:

list_by_peering_service

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
list_by_peering_service	select	resource_group_name, peering_service_name, subscription_id		Lists the peerings prefix in the resource group.

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.
resource_group_name	string	The resource group name. Required.
subscription_id	string

SELECT examples

list_by_peering_service

Lists the peerings prefix in the resource group.

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