authorization_provider

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

Overview

Name	authorization_provider
Type	Resource
Id	azure.api_management.authorization_provider

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.
displayName	string	Authorization Provider name. Must be 1 to 300 characters long.
identityProvider	string	Identity provider name. Must be 1 to 300 characters long.
oauth2	object	OAuth2 settings.
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_service

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.
displayName	string	Authorization Provider name. Must be 1 to 300 characters long.
identityProvider	string	Identity provider name. Must be 1 to 300 characters long.
oauth2	object	OAuth2 settings.
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, subscription_id		Gets the details of the authorization provider specified by its identifier.
list_by_service	select	resource_group_name, service_name, subscription_id	$filter, $top, $skip	Lists a collection of authorization providers defined within a service instance.
create_or_update	insert	resource_group_name, service_name, authorization_provider_id, subscription_id		Creates or updates authorization provider.
create_or_update	replace	resource_group_name, service_name, authorization_provider_id, subscription_id		Creates or updates authorization provider.
delete	delete	resource_group_name, service_name, authorization_provider_id, subscription_id		Deletes specific authorization provider from the API Management service instance.
refresh_secret	exec	resource_group_name, service_name, authorization_provider_id, subscription_id		Refreshes the Key Vault reference secret for the specified authorization provider.

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

SELECT
id,
name,
displayName,
identityProvider,
oauth2,
systemData,
type
FROM azure.api_management.authorization_provider
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
;

list_by_service

Lists a collection of authorization providers defined within a service instance.

SELECT
id,
name,
displayName,
identityProvider,
oauth2,
systemData,
type
FROM azure.api_management.authorization_provider
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- 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 provider.

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

Manifest

# Description fields are for documentation purposes
- name: authorization_provider
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the authorization_provider resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the authorization_provider resource.
  - name: authorization_provider_id
    value: "{{ authorization_provider_id }}"
    description: Required parameter for the authorization_provider resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the authorization_provider resource.
  - name: properties
    description: |
      Properties of the Authorization Provider Contract.
    value:
      displayName: "{{ displayName }}"
      identityProvider: "{{ identityProvider }}"
      oauth2:
        redirectUrl: "{{ redirectUrl }}"
        grantTypes:
          authorizationCode: "{{ authorizationCode }}"
          clientCredentials: "{{ clientCredentials }}"
        keyVault:
          secretIdentifier: "{{ secretIdentifier }}"
          updated: "{{ updated }}"
          lastStatus:
            code: "{{ code }}"
            message: "{{ message }}"
            timeStampUtc: "{{ timeStampUtc }}"

REPLACE examples

create_or_update

Creates or updates authorization provider.

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

DELETE examples

delete

Deletes specific authorization provider from the API Management service instance.

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

Lifecycle Methods

refresh_secret

Refreshes the Key Vault reference secret for the specified authorization provider.

EXEC azure.api_management.authorization_provider.refresh_secret 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@authorization_provider_id='{{ authorization_provider_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;