authorizations

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

Overview

Name	authorizations
Type	Resource
Id	azure.avs.authorizations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
expressRouteAuthorizationId	string	The ID of the ExpressRoute Circuit Authorization.
expressRouteAuthorizationKey	string	The key of the ExpressRoute Circuit Authorization.
expressRouteId	string	The ID of the ExpressRoute Circuit.
provisioningState	string	The state of the ExpressRoute Circuit Authorization provisioning. Known values are: "Succeeded", "Failed", "Canceled", and "Updating". (Succeeded, Failed, Canceled, Updating)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
expressRouteAuthorizationId	string	The ID of the ExpressRoute Circuit Authorization.
expressRouteAuthorizationKey	string	The key of the ExpressRoute Circuit Authorization.
expressRouteId	string	The ID of the ExpressRoute Circuit.
provisioningState	string	The state of the ExpressRoute Circuit Authorization provisioning. Known values are: "Succeeded", "Failed", "Canceled", and "Updating". (Succeeded, Failed, Canceled, Updating)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, private_cloud_name, authorization_name, subscription_id		Get a ExpressRouteAuthorization.
list	select	resource_group_name, private_cloud_name, subscription_id		List ExpressRouteAuthorization resources by PrivateCloud.
create_or_update	insert	resource_group_name, private_cloud_name, authorization_name, subscription_id		Create a ExpressRouteAuthorization.
create_or_update	replace	resource_group_name, private_cloud_name, authorization_name, subscription_id		Create a ExpressRouteAuthorization.
delete	delete	resource_group_name, private_cloud_name, authorization_name, subscription_id		Delete a ExpressRouteAuthorization.

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	Name of the ExpressRoute Circuit Authorization. Required.
private_cloud_name	string	Name of the private cloud. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a ExpressRouteAuthorization.

SELECT
id,
name,
expressRouteAuthorizationId,
expressRouteAuthorizationKey,
expressRouteId,
provisioningState,
systemData,
type
FROM azure.avs.authorizations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND authorization_name = '{{ authorization_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List ExpressRouteAuthorization resources by PrivateCloud.

SELECT
id,
name,
expressRouteAuthorizationId,
expressRouteAuthorizationKey,
expressRouteId,
provisioningState,
systemData,
type
FROM azure.avs.authorizations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a ExpressRouteAuthorization.

INSERT INTO azure.avs.authorizations (
properties,
resource_group_name,
private_cloud_name,
authorization_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ private_cloud_name }}',
'{{ authorization_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: authorizations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the authorizations resource.
  - name: private_cloud_name
    value: "{{ private_cloud_name }}"
    description: Required parameter for the authorizations resource.
  - name: authorization_name
    value: "{{ authorization_name }}"
    description: Required parameter for the authorizations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the authorizations resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      expressRouteAuthorizationId: "{{ expressRouteAuthorizationId }}"
      expressRouteAuthorizationKey: "{{ expressRouteAuthorizationKey }}"
      expressRouteId: "{{ expressRouteId }}"

REPLACE examples

create_or_update

Create a ExpressRouteAuthorization.

REPLACE azure.avs.authorizations
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND authorization_name = '{{ authorization_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a ExpressRouteAuthorization.

DELETE FROM azure.avs.authorizations
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND authorization_name = '{{ authorization_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;