authorization_access_policy

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

Overview

Name	authorization_access_policy
Type	Resource
Id	azure.api_management.authorization_access_policy

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.
appIds	array	The allowed Azure Active Directory Application IDs.
objectId	string	The Object Id.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantId	string	The Tenant Id.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_authorization

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.
appIds	array	The allowed Azure Active Directory Application IDs.
objectId	string	The Object Id.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantId	string	The Tenant Id.
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, service_name, authorization_provider_id, authorization_id, authorization_access_policy_id, subscription_id		Gets the details of the authorization access policy specified by its identifier.
list_by_authorization	select	resource_group_name, service_name, authorization_provider_id, authorization_id, subscription_id	$filter, $top, $skip	Lists a collection of authorization access policy defined within a authorization.
create_or_update	insert	resource_group_name, service_name, authorization_provider_id, authorization_id, authorization_access_policy_id, subscription_id		Creates or updates Authorization Access Policy.
create_or_update	replace	resource_group_name, service_name, authorization_provider_id, authorization_id, authorization_access_policy_id, subscription_id		Creates or updates Authorization Access Policy.
delete	delete	resource_group_name, service_name, authorization_provider_id, authorization_id, authorization_access_policy_id, subscription_id		Deletes specific access policy from the Authorization.

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_access_policy_id	string	Identifier of the authorization access policy. Required.
authorization_id	string	Identifier of the authorization. Required.
authorization_provider_id	string	Identifier of the authorization provider. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string
$filter	string	| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |. Default value is None.
$skip	integer	Number of records to skip. Default value is None.
$top	integer	Number of records to return. Default value is None.

SELECT examples

get

Gets the details of the authorization access policy specified by its identifier.

SELECT
id,
name,
appIds,
objectId,
systemData,
tenantId,
type
FROM azure.api_management.authorization_access_policy
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND authorization_provider_id = '{{ authorization_provider_id }}' -- required
AND authorization_id = '{{ authorization_id }}' -- required
AND authorization_access_policy_id = '{{ authorization_access_policy_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_authorization

Lists a collection of authorization access policy defined within a authorization.

SELECT
id,
name,
appIds,
objectId,
systemData,
tenantId,
type
FROM azure.api_management.authorization_access_policy
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND authorization_provider_id = '{{ authorization_provider_id }}' -- required
AND authorization_id = '{{ authorization_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

Creates or updates Authorization Access Policy.

INSERT INTO azure.api_management.authorization_access_policy (
properties,
resource_group_name,
service_name,
authorization_provider_id,
authorization_id,
authorization_access_policy_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ authorization_provider_id }}',
'{{ authorization_id }}',
'{{ authorization_access_policy_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: authorization_access_policy
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the authorization_access_policy resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the authorization_access_policy resource.
  - name: authorization_provider_id
    value: "{{ authorization_provider_id }}"
    description: Required parameter for the authorization_access_policy resource.
  - name: authorization_id
    value: "{{ authorization_id }}"
    description: Required parameter for the authorization_access_policy resource.
  - name: authorization_access_policy_id
    value: "{{ authorization_access_policy_id }}"
    description: Required parameter for the authorization_access_policy resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the authorization_access_policy resource.
  - name: properties
    description: |
      Properties of the Authorization Contract.
    value:
      appIds:
        - "{{ appIds }}"
      tenantId: "{{ tenantId }}"
      objectId: "{{ objectId }}"

REPLACE examples

create_or_update

Creates or updates Authorization Access Policy.

REPLACE azure.api_management.authorization_access_policy
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND authorization_provider_id = '{{ authorization_provider_id }}' --required
AND authorization_id = '{{ authorization_id }}' --required
AND authorization_access_policy_id = '{{ authorization_access_policy_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes specific access policy from the Authorization.

DELETE FROM azure.api_management.authorization_access_policy
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND authorization_provider_id = '{{ authorization_provider_id }}' --required
AND authorization_id = '{{ authorization_id }}' --required
AND authorization_access_policy_id = '{{ authorization_access_policy_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;