authorization_servers

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

Overview

Name	authorization_servers
Type	Resource
Id	azure.api_management.authorization_servers

Fields

The following fields are returned by SELECT queries:

get

Gets the details of the specified authorization server. No secrets included.

Name	Datatype	Description
properties	object	Properties of the External OAuth authorization server Contract.

list_by_service

A Collection of the Authorization Server entities for the specified API Management service instance.

Name	Datatype	Description
properties	object	Properties of the External OAuth authorization server Contract.

Methods

The following methods are available for this resource:

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

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
If-Match	string	ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
authsid	string	Identifier of the authorization server.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of the API Management service.
subscriptionId	string	The ID of the target subscription.
$filter	string	| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
$skip	integer (int32)	Number of records to skip.
$top	integer (int32)	Number of records to return.
If-Match	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.

SELECT examples

get

Gets the details of the authorization server specified by its identifier.

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

list_by_service

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

SELECT
properties
FROM azure.api_management.authorization_servers
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

Creates new authorization server or updates an existing authorization server.

INSERT INTO azure.api_management.authorization_servers (
data__properties,
resourceGroupName,
serviceName,
authsid,
subscriptionId,
If-Match
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ authsid }}',
'{{ subscriptionId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: authorization_servers
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the authorization_servers resource.
    - name: serviceName
      value: string
      description: Required parameter for the authorization_servers resource.
    - name: authsid
      value: string
      description: Required parameter for the authorization_servers resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the authorization_servers resource.
    - name: properties
      value: object
      description: |
        Properties of the External OAuth authorization server Contract.
    - name: If-Match
      value: string
      description: ETag of the Entity. Not required when creating an entity, but required when updating an entity.

UPDATE examples

update

Updates the details of the authorization server specified by its identifier.

UPDATE azure.api_management.authorization_servers
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND authsid = '{{ authsid }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Deletes specific authorization server instance.

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