open_id_connect_providers

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

Overview

Name	open_id_connect_providers
Type	Resource
Id	azure.api_management.open_id_connect_providers

Fields

The following fields are returned by SELECT queries:

get

The response body contains the specified OpenId Connect Provider entity without secrets.

Name	Datatype	Description
properties	object	OpenId Connect Provider contract properties.

list_by_service

Lists of all the OpenId Connect Providers.

Name	Datatype	Description
properties	object	OpenId Connect Provider contract properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, opid, subscriptionId		Gets specific OpenID Connect Provider without secrets.
list_by_service	select	resourceGroupName, serviceName, subscriptionId	$filter, $top, $skip	Lists of all the OpenId Connect Providers.
create_or_update	insert	resourceGroupName, serviceName, opid, subscriptionId	If-Match	Creates or updates the OpenID Connect Provider.
update	update	resourceGroupName, serviceName, opid, If-Match, subscriptionId		Updates the specific OpenID Connect Provider.
delete	delete	resourceGroupName, serviceName, opid, If-Match, subscriptionId		Deletes specific OpenID Connect Provider of the API Management service 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.
opid	string	Identifier of the OpenID Connect Provider.
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 specific OpenID Connect Provider without secrets.

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

list_by_service

Lists of all the OpenId Connect Providers.

SELECT
properties
FROM azure.api_management.open_id_connect_providers
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 or updates the OpenID Connect Provider.

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

Manifest

# Description fields are for documentation purposes
- name: open_id_connect_providers
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the open_id_connect_providers resource.
    - name: serviceName
      value: string
      description: Required parameter for the open_id_connect_providers resource.
    - name: opid
      value: string
      description: Required parameter for the open_id_connect_providers resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the open_id_connect_providers resource.
    - name: properties
      value: object
      description: |
        OpenId Connect Provider contract properties.
    - 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 specific OpenID Connect Provider.

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

DELETE examples

delete

Deletes specific OpenID Connect Provider of the API Management service instance.

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