peering_services

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

Overview

Name	peering_services
Type	Resource
Id	azure.peering.peering_services

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.
location	string	The location of the resource. Required.
peeringServiceLocation	string	The PeeringServiceLocation of the Customer.
peeringServiceProvider	string	The MAPS Provider Name.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Updating", "Deleting", and "Failed".
tags	object	The resource tags.
type	string	The type of the resource.

list_by_resource_group

Name	Datatype	Description
id	string	The ID of the resource.
name	string	The name of the resource.
location	string	The location of the resource. Required.
peeringServiceLocation	string	The PeeringServiceLocation of the Customer.
peeringServiceProvider	string	The MAPS Provider Name.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Updating", "Deleting", and "Failed".
tags	object	The resource tags.
type	string	The type of the resource.

list_by_subscription

Name	Datatype	Description
id	string	The ID of the resource.
name	string	The name of the resource.
location	string	The location of the resource. Required.
peeringServiceLocation	string	The PeeringServiceLocation of the Customer.
peeringServiceProvider	string	The MAPS Provider Name.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Updating", "Deleting", and "Failed".
tags	object	The resource tags.
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, subscription_id		Gets an existing peering service with the specified name under the given subscription and resource group.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all of the peering services under the given subscription and resource group.
list_by_subscription	select	subscription_id		Lists all of the peerings under the given subscription.
create_or_update	insert	resource_group_name, peering_service_name, subscription_id, location		Creates a new peering service or updates an existing peering with the specified name under the given subscription and resource group.
update	update	resource_group_name, peering_service_name, subscription_id		Updates tags for a peering service with the specified name under the given subscription and resource group.
create_or_update	replace	resource_group_name, peering_service_name, subscription_id, location		Creates a new peering service or updates an existing peering with the specified name under the given subscription and resource group.
delete	delete	resource_group_name, peering_service_name, subscription_id		Deletes an existing peering service with the specified name under the given subscription and 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 name of the peering service. Required.
resource_group_name	string	The name of the resource group. Required.
subscription_id	string

SELECT examples

get

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

SELECT
id,
name,
location,
peeringServiceLocation,
peeringServiceProvider,
provisioningState,
tags,
type
FROM azure.peering.peering_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND peering_service_name = '{{ peering_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all of the peering services under the given subscription and resource group.

SELECT
id,
name,
location,
peeringServiceLocation,
peeringServiceProvider,
provisioningState,
tags,
type
FROM azure.peering.peering_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists all of the peerings under the given subscription.

SELECT
id,
name,
location,
peeringServiceLocation,
peeringServiceProvider,
provisioningState,
tags,
type
FROM azure.peering.peering_services
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates a new peering service or updates an existing peering with the specified name under the given subscription and resource group.

INSERT INTO azure.peering.peering_services (
location,
tags,
properties,
resource_group_name,
peering_service_name,
subscription_id
)
SELECT 
'{{ location }}' /* required */,
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ peering_service_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: peering_services
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the peering_services resource.
  - name: peering_service_name
    value: "{{ peering_service_name }}"
    description: Required parameter for the peering_services resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the peering_services resource.
  - name: location
    value: "{{ location }}"
    description: |
      The location of the resource. Required.
  - name: tags
    value: "{{ tags }}"
    description: |
      The resource tags.
  - name: properties
    value:
      peeringServiceLocation: "{{ peeringServiceLocation }}"
      peeringServiceProvider: "{{ peeringServiceProvider }}"

UPDATE examples

update

Updates tags for a peering service with the specified name under the given subscription and resource group.

UPDATE azure.peering.peering_services
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND peering_service_name = '{{ peering_service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Creates a new peering service or updates an existing peering with the specified name under the given subscription and resource group.

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

DELETE examples

delete

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

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