authorization_access_policies

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

Overview

Name	authorization_access_policies
Type	Resource
Id	azure.api_management.authorization_access_policies

Fields

The following fields are returned by SELECT queries:

get

The response body contains the specified authorization access policy entity.

Name	Datatype	Description
properties	object	Properties of the Authorization Contract.

list_by_authorization

A Collection of the Authorization Access Policy entities for the specified Authorization provider.

Name	Datatype	Description
properties	object	Properties of the Authorization Contract.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, authorizationProviderId, authorizationId, authorizationAccessPolicyId, subscriptionId		Gets the details of the authorization access policy specified by its identifier.
list_by_authorization	select	resourceGroupName, serviceName, authorizationProviderId, authorizationId, subscriptionId	$filter, $top, $skip	Lists a collection of authorization access policy defined within a authorization.
create_or_update	insert	resourceGroupName, serviceName, authorizationProviderId, authorizationId, authorizationAccessPolicyId, subscriptionId	If-Match	Creates or updates Authorization Access Policy.
delete	delete	resourceGroupName, serviceName, authorizationProviderId, authorizationId, authorizationAccessPolicyId, If-Match, subscriptionId		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
If-Match	string	ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
authorizationAccessPolicyId	string	Identifier of the authorization access policy.
authorizationId	string	Identifier of the authorization.
authorizationProviderId	string	Identifier of the authorization provider.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of the API Management service.
subscriptionId	string	The ID of the target subscription.
$filter	string	| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
$skip	integer (int32)	Number of records to skip.
$top	integer (int32)	Number of records to return.
If-Match	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.

SELECT examples

get

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

SELECT
properties
FROM azure.api_management.authorization_access_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND authorizationProviderId = '{{ authorizationProviderId }}' -- required
AND authorizationId = '{{ authorizationId }}' -- required
AND authorizationAccessPolicyId = '{{ authorizationAccessPolicyId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_authorization

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

SELECT
properties
FROM azure.api_management.authorization_access_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND authorizationProviderId = '{{ authorizationProviderId }}' -- required
AND authorizationId = '{{ authorizationId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- 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_policies (
data__properties,
resourceGroupName,
serviceName,
authorizationProviderId,
authorizationId,
authorizationAccessPolicyId,
subscriptionId,
If-Match
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ authorizationProviderId }}',
'{{ authorizationId }}',
'{{ authorizationAccessPolicyId }}',
'{{ subscriptionId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: authorization_access_policies
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the authorization_access_policies resource.
    - name: serviceName
      value: string
      description: Required parameter for the authorization_access_policies resource.
    - name: authorizationProviderId
      value: string
      description: Required parameter for the authorization_access_policies resource.
    - name: authorizationId
      value: string
      description: Required parameter for the authorization_access_policies resource.
    - name: authorizationAccessPolicyId
      value: string
      description: Required parameter for the authorization_access_policies resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the authorization_access_policies resource.
    - name: properties
      value: object
      description: |
        Properties of the Authorization Contract.
    - name: If-Match
      value: string
      description: ETag of the Entity. Not required when creating an entity, but required when updating an entity.

DELETE examples

delete

Deletes specific access policy from the Authorization.

DELETE FROM azure.api_management.authorization_access_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND authorizationProviderId = '{{ authorizationProviderId }}' --required
AND authorizationId = '{{ authorizationId }}' --required
AND authorizationAccessPolicyId = '{{ authorizationAccessPolicyId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;