prefixes

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

Overview

Name	prefixes
Type	Resource
Id	azure.peering.prefixes

Fields

vw_prefixes

Name	Datatype	Description
id	text	The ID of the resource.
name	text	The name of the resource.
error_message	text	field from the properties object
events	text	field from the properties object
learned_type	text	field from the properties object
peeringServiceName	text	field from the properties object
peering_service_prefix_key	text	field from the properties object
prefix	text	field from the properties object
prefixName	text	field from the properties object
prefix_validation_state	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	The type of the resource.

prefixes

Name	Datatype	Description
id	string	The ID of the resource.
name	string	The name of the resource.
properties	object	The peering service prefix properties class.
type	string	The type of the resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	peeringServiceName, prefixName, resourceGroupName, subscriptionId	Gets an existing prefix with the specified name under the given subscription, resource group and peering service.
list_by_peering_service	SELECT	peeringServiceName, resourceGroupName, subscriptionId	Lists all prefixes under the given subscription, resource group and peering service.
create_or_update	INSERT	peeringServiceName, prefixName, resourceGroupName, subscriptionId	Creates a new prefix with the specified name under the given subscription, resource group and peering service.
delete	DELETE	peeringServiceName, prefixName, resourceGroupName, subscriptionId	Deletes an existing prefix with the specified name under the given subscription, resource group and peering service.

SELECT examples

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

vw_prefixes

SELECT
id,
name,
error_message,
events,
learned_type,
peeringServiceName,
peering_service_prefix_key,
prefix,
prefixName,
prefix_validation_state,
provisioning_state,
resourceGroupName,
subscriptionId,
type
FROM azure.peering.vw_prefixes
WHERE peeringServiceName = '{{ peeringServiceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

prefixes

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

INSERT example

Use the following StackQL query and manifest file to create a new prefixes resource.

All Properties

/*+ create */
INSERT INTO azure.peering.prefixes (
peeringServiceName,
prefixName,
resourceGroupName,
subscriptionId,
properties
)
SELECT 
'{{ peeringServiceName }}',
'{{ prefixName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: id
      value: string
    - name: type
      value: string
    - name: properties
      value:
        - name: prefix
          value: string
        - name: prefixValidationState
          value: string
        - name: learnedType
          value: string
        - name: errorMessage
          value: string
        - name: events
          value:
            - - name: eventTimestamp
                value: string
              - name: eventType
                value: string
              - name: eventSummary
                value: string
              - name: eventLevel
                value: string
              - name: eventDescription
                value: string
        - name: peeringServicePrefixKey
          value: string
        - name: provisioningState
          value: string

DELETE example

Deletes the specified prefixes resource.

/*+ delete */
DELETE FROM azure.peering.prefixes
WHERE peeringServiceName = '{{ peeringServiceName }}'
AND prefixName = '{{ prefixName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';