authorization_providers

Creates, updates, deletes, gets or lists a authorization_providers resource.

Overview

Name	authorization_providers
Type	Resource
Id	azure.api_management.authorization_providers

Fields

vw_authorization_providers

Name	Datatype	Description
authorizationProviderId	text	field from the properties object
display_name	text	field from the properties object
identity_provider	text	field from the properties object
oauth2	text	field from the properties object
resourceGroupName	text	field from the properties object
serviceName	text	field from the properties object
subscriptionId	text	field from the properties object

authorization_providers

Name	Datatype	Description
properties	object	Authorization Provider details.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	authorizationProviderId, resourceGroupName, serviceName, subscriptionId	Gets the details of the authorization provider specified by its identifier.
list_by_service	SELECT	resourceGroupName, serviceName, subscriptionId	Lists a collection of authorization providers defined within a service instance.
create_or_update	INSERT	authorizationProviderId, resourceGroupName, serviceName, subscriptionId	Creates or updates authorization provider.
delete	DELETE	If-Match, authorizationProviderId, resourceGroupName, serviceName, subscriptionId	Deletes specific authorization provider from the API Management service instance.

SELECT examples

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

vw_authorization_providers

SELECT
authorizationProviderId,
display_name,
identity_provider,
oauth2,
resourceGroupName,
serviceName,
subscriptionId
FROM azure.api_management.vw_authorization_providers
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

authorization_providers

SELECT
properties
FROM azure.api_management.authorization_providers
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new authorization_providers resource.

All Properties

/*+ create */
INSERT INTO azure.api_management.authorization_providers (
authorizationProviderId,
resourceGroupName,
serviceName,
subscriptionId,
properties
)
SELECT 
'{{ authorizationProviderId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: displayName
          value: string
        - name: identityProvider
          value: string
        - name: oauth2
          value:
            - name: redirectUrl
              value: string
            - name: grantTypes
              value:
                - name: authorizationCode
                  value: object
                - name: clientCredentials
                  value: object

DELETE example

Deletes the specified authorization_providers resource.

/*+ delete */
DELETE FROM azure.api_management.authorization_providers
WHERE If-Match = '{{ If-Match }}'
AND authorizationProviderId = '{{ authorizationProviderId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';