authorizations

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

Overview

Name	authorizations
Type	Resource
Id	azure.api_management.authorizations

Fields

The following fields are returned by SELECT queries:

get

The response body contains the specified authorization entity. No secrets included

Name	Datatype	Description
properties	object	Properties of the Authorization Contract.

list_by_authorization_provider

A Collection of the Authorization 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, subscriptionId		Gets the details of the authorization specified by its identifier.
list_by_authorization_provider	select	resourceGroupName, serviceName, authorizationProviderId, subscriptionId	$filter, $top, $skip	Lists a collection of authorization providers defined within a authorization provider.
create_or_update	insert	resourceGroupName, serviceName, authorizationProviderId, authorizationId, subscriptionId	If-Match	Creates or updates authorization.
delete	delete	resourceGroupName, serviceName, authorizationProviderId, authorizationId, If-Match, subscriptionId		Deletes specific Authorization from the Authorization provider.
confirm_consent_code	exec	resourceGroupName, serviceName, authorizationProviderId, authorizationId, subscriptionId		Confirm valid consent code to suppress Authorizations anti-phishing page.

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.
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 specified by its identifier.

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

list_by_authorization_provider

Lists a collection of authorization providers defined within a authorization provider.

SELECT
properties
FROM azure.api_management.authorizations
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND authorizationProviderId = '{{ authorizationProviderId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

Creates or updates authorization.

INSERT INTO azure.api_management.authorizations (
data__properties,
resourceGroupName,
serviceName,
authorizationProviderId,
authorizationId,
subscriptionId,
If-Match
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ authorizationProviderId }}',
'{{ authorizationId }}',
'{{ subscriptionId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: authorizations
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the authorizations resource.
    - name: serviceName
      value: string
      description: Required parameter for the authorizations resource.
    - name: authorizationProviderId
      value: string
      description: Required parameter for the authorizations resource.
    - name: authorizationId
      value: string
      description: Required parameter for the authorizations resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the authorizations 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 Authorization from the Authorization provider.

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

Lifecycle Methods

confirm_consent_code

Confirm valid consent code to suppress Authorizations anti-phishing page.

EXEC azure.api_management.authorizations.confirm_consent_code 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@authorizationProviderId='{{ authorizationProviderId }}' --required, 
@authorizationId='{{ authorizationId }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"consentCode": "{{ consentCode }}"
}'
;