authorization_servers

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

Overview

Name	authorization_servers
Type	Resource
Id	azure.api_management.authorization_servers

Fields

vw_authorization_servers

Name	Datatype	Description
description	text	field from the properties object
authorization_endpoint	text	field from the properties object
authorization_methods	text	field from the properties object
authsid	text	field from the properties object
bearer_token_sending_methods	text	field from the properties object
client_authentication_method	text	field from the properties object
client_id	text	field from the properties object
client_registration_endpoint	text	field from the properties object
client_secret	text	field from the properties object
default_scope	text	field from the properties object
display_name	text	field from the properties object
grant_types	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_owner_password	text	field from the properties object
resource_owner_username	text	field from the properties object
serviceName	text	field from the properties object
subscriptionId	text	field from the properties object
support_state	text	field from the properties object
token_body_parameters	text	field from the properties object
token_endpoint	text	field from the properties object
use_in_api_documentation	text	field from the properties object
use_in_test_console	text	field from the properties object

authorization_servers

Name	Datatype	Description
properties	object	External OAuth authorization server settings Properties.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	authsid, resourceGroupName, serviceName, subscriptionId	Gets the details of the authorization server specified by its identifier.
list_by_service	SELECT	resourceGroupName, serviceName, subscriptionId	Lists a collection of authorization servers defined within a service instance.
create_or_update	INSERT	authsid, resourceGroupName, serviceName, subscriptionId	Creates new authorization server or updates an existing authorization server.
delete	DELETE	If-Match, authsid, resourceGroupName, serviceName, subscriptionId	Deletes specific authorization server instance.
update	UPDATE	If-Match, authsid, resourceGroupName, serviceName, subscriptionId	Updates the details of the authorization server specified by its identifier.

SELECT examples

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

vw_authorization_servers

SELECT
description,
authorization_endpoint,
authorization_methods,
authsid,
bearer_token_sending_methods,
client_authentication_method,
client_id,
client_registration_endpoint,
client_secret,
default_scope,
display_name,
grant_types,
resourceGroupName,
resource_owner_password,
resource_owner_username,
serviceName,
subscriptionId,
support_state,
token_body_parameters,
token_endpoint,
use_in_api_documentation,
use_in_test_console
FROM azure.api_management.vw_authorization_servers
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

authorization_servers

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

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: displayName
          value: string
        - name: useInTestConsole
          value: boolean
        - name: useInApiDocumentation
          value: boolean
        - name: clientRegistrationEndpoint
          value: string
        - name: authorizationEndpoint
          value: string
        - name: grantTypes
          value:
            - string
        - name: clientId
          value: string
        - name: clientSecret
          value: string
        - name: description
          value: string
        - name: authorizationMethods
          value:
            - string
        - name: clientAuthenticationMethod
          value:
            - string
        - name: tokenBodyParameters
          value:
            - - name: name
                value: string
              - name: value
                value: string
        - name: tokenEndpoint
          value: string
        - name: supportState
          value: boolean
        - name: defaultScope
          value: string
        - name: bearerTokenSendingMethods
          value:
            - string
        - name: resourceOwnerUsername
          value: string
        - name: resourceOwnerPassword
          value: string

UPDATE example

Updates a authorization_servers resource.

/*+ update */
UPDATE azure.api_management.authorization_servers
SET 
properties = '{{ properties }}'
WHERE 
If-Match = '{{ If-Match }}'
AND authsid = '{{ authsid }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified authorization_servers resource.

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