authorization

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

Overview

Name	authorization
Type	Resource
Id	azure.api_management.authorization

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.
authorizationType	string	Authorization type options. "OAuth2" (OAuth2)
error	object	Authorization error details.
oauth2grantType	string	OAuth2 grant type options. Known values are: "AuthorizationCode" and "ClientCredentials". (AuthorizationCode, ClientCredentials)
parameters	object	Authorization parameters.
status	string	Status of the Authorization.
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_by_authorization_provider

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.
authorizationType	string	Authorization type options. "OAuth2" (OAuth2)
error	object	Authorization error details.
oauth2grantType	string	OAuth2 grant type options. Known values are: "AuthorizationCode" and "ClientCredentials". (AuthorizationCode, ClientCredentials)
parameters	object	Authorization parameters.
status	string	Status of the Authorization.
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, service_name, authorization_provider_id, authorization_id, subscription_id		Gets the details of the authorization specified by its identifier.
list_by_authorization_provider	select	resource_group_name, service_name, authorization_provider_id, subscription_id	$filter, $top, $skip	Lists a collection of authorization providers defined within a authorization provider.
create_or_update	insert	resource_group_name, service_name, authorization_provider_id, authorization_id, subscription_id		Creates or updates authorization.
create_or_update	replace	resource_group_name, service_name, authorization_provider_id, authorization_id, subscription_id		Creates or updates authorization.
delete	delete	resource_group_name, service_name, authorization_provider_id, authorization_id, subscription_id		Deletes specific Authorization from the Authorization provider.
confirm_consent_code	exec	resource_group_name, service_name, authorization_provider_id, authorization_id, subscription_id		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
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 specified by its identifier.

SELECT
id,
name,
authorizationType,
error,
oauth2grantType,
parameters,
status,
systemData,
type
FROM azure.api_management.authorization
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
;

list_by_authorization_provider

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

SELECT
id,
name,
authorizationType,
error,
oauth2grantType,
parameters,
status,
systemData,
type
FROM azure.api_management.authorization
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND authorization_provider_id = '{{ authorization_provider_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.

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

Manifest

# Description fields are for documentation purposes
- name: authorization
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the authorization resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the authorization resource.
  - name: authorization_provider_id
    value: "{{ authorization_provider_id }}"
    description: Required parameter for the authorization resource.
  - name: authorization_id
    value: "{{ authorization_id }}"
    description: Required parameter for the authorization resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the authorization resource.
  - name: properties
    description: |
      Properties of the Authorization Contract.
    value:
      authorizationType: "{{ authorizationType }}"
      oauth2grantType: "{{ oauth2grantType }}"
      parameters: "{{ parameters }}"
      error:
        code: "{{ code }}"
        message: "{{ message }}"
      status: "{{ status }}"

REPLACE examples

create_or_update

Creates or updates authorization.

REPLACE azure.api_management.authorization
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 subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes specific Authorization from the Authorization provider.

DELETE FROM azure.api_management.authorization
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
;

Lifecycle Methods

confirm_consent_code

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

EXEC azure.api_management.authorization.confirm_consent_code 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@authorization_provider_id='{{ authorization_provider_id }}' --required, 
@authorization_id='{{ authorization_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"consentCode": "{{ consentCode }}"
}'
;