express_route_circuit_authorizations

Creates, updates, deletes, gets or lists an express_route_circuit_authorizations resource.

Overview

Name	express_route_circuit_authorizations
Type	Resource
Id	azure.network.express_route_circuit_authorizations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
authorizationKey	string	The authorization key.
authorizationUseStatus	string	The authorization use status. Known values are: "Available" and "InUse". (Available, InUse)
connectionResourceUri	string	The reference to the ExpressRoute connection resource using the authorization.
etag	string	A unique read-only string that changes whenever the resource is updated.
provisioningState	string	The provisioning state of the authorization resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
authorizationKey	string	The authorization key.
authorizationUseStatus	string	The authorization use status. Known values are: "Available" and "InUse". (Available, InUse)
connectionResourceUri	string	The reference to the ExpressRoute connection resource using the authorization.
etag	string	A unique read-only string that changes whenever the resource is updated.
provisioningState	string	The provisioning state of the authorization resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, circuit_name, authorization_name, subscription_id		Gets the specified authorization from the specified express route circuit.
list	select	resource_group_name, circuit_name, subscription_id		Gets all authorizations in an express route circuit.
create_or_update	insert	resource_group_name, circuit_name, authorization_name, subscription_id		Creates or updates an authorization in the specified express route circuit.
create_or_update	replace	resource_group_name, circuit_name, authorization_name, subscription_id		Creates or updates an authorization in the specified express route circuit.
delete	delete	resource_group_name, circuit_name, authorization_name, subscription_id		Deletes the specified authorization from the specified express route circuit.

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
authorization_name	string	The name of the authorization. Required.
circuit_name	string	The name of express route circuit. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the specified authorization from the specified express route circuit.

SELECT
id,
name,
authorizationKey,
authorizationUseStatus,
connectionResourceUri,
etag,
provisioningState,
type
FROM azure.network.express_route_circuit_authorizations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND circuit_name = '{{ circuit_name }}' -- required
AND authorization_name = '{{ authorization_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all authorizations in an express route circuit.

SELECT
id,
name,
authorizationKey,
authorizationUseStatus,
connectionResourceUri,
etag,
provisioningState,
type
FROM azure.network.express_route_circuit_authorizations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND circuit_name = '{{ circuit_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates an authorization in the specified express route circuit.

INSERT INTO azure.network.express_route_circuit_authorizations (
id,
name,
properties,
resource_group_name,
circuit_name,
authorization_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ name }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ circuit_name }}',
'{{ authorization_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: express_route_circuit_authorizations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the express_route_circuit_authorizations resource.
  - name: circuit_name
    value: "{{ circuit_name }}"
    description: Required parameter for the express_route_circuit_authorizations resource.
  - name: authorization_name
    value: "{{ authorization_name }}"
    description: Required parameter for the express_route_circuit_authorizations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the express_route_circuit_authorizations resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource.
  - name: properties
    description: |
      Properties of the express route circuit authorization.
    value:
      authorizationKey: "{{ authorizationKey }}"
      authorizationUseStatus: "{{ authorizationUseStatus }}"
      connectionResourceUri: "{{ connectionResourceUri }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Creates or updates an authorization in the specified express route circuit.

REPLACE azure.network.express_route_circuit_authorizations
SET 
id = '{{ id }}',
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND circuit_name = '{{ circuit_name }}' --required
AND authorization_name = '{{ authorization_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete

Deletes the specified authorization from the specified express route circuit.

DELETE FROM azure.network.express_route_circuit_authorizations
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND circuit_name = '{{ circuit_name }}' --required
AND authorization_name = '{{ authorization_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;