authorizations

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

Overview

Name	authorizations
Type	Resource
Id	azure.api_management.authorizations

Fields

vw_authorizations

Name	Datatype	Description
authorizationId	text	field from the properties object
authorizationProviderId	text	field from the properties object
authorization_type	text	field from the properties object
error	text	field from the properties object
oauth2grant_type	text	field from the properties object
parameters	text	field from the properties object
resourceGroupName	text	field from the properties object
serviceName	text	field from the properties object
status	text	field from the properties object
subscriptionId	text	field from the properties object

authorizations

Name	Datatype	Description
properties	object	Authorization details.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	authorizationId, authorizationProviderId, resourceGroupName, serviceName, subscriptionId	Gets the details of the authorization specified by its identifier.
list_by_authorization_provider	SELECT	authorizationProviderId, resourceGroupName, serviceName, subscriptionId	Lists a collection of authorization providers defined within a authorization provider.
create_or_update	INSERT	authorizationId, authorizationProviderId, resourceGroupName, serviceName, subscriptionId	Creates or updates authorization.
delete	DELETE	If-Match, authorizationId, authorizationProviderId, resourceGroupName, serviceName, subscriptionId	Deletes specific Authorization from the Authorization provider.
confirm_consent_code	EXEC	authorizationId, authorizationProviderId, resourceGroupName, serviceName, subscriptionId	Confirm valid consent code to suppress Authorizations anti-phishing page.

SELECT examples

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

vw_authorizations

SELECT
authorizationId,
authorizationProviderId,
authorization_type,
error,
oauth2grant_type,
parameters,
resourceGroupName,
serviceName,
status,
subscriptionId
FROM azure.api_management.vw_authorizations
WHERE authorizationProviderId = '{{ authorizationProviderId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

authorizations

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

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: authorizationType
          value: string
        - name: oauth2grantType
          value: string
        - name: parameters
          value: object
        - name: error
          value:
            - name: code
              value: string
            - name: message
              value: string
        - name: status
          value: string

DELETE example

Deletes the specified authorizations resource.

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