open_id_connect_providers

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

Overview

Name	open_id_connect_providers
Type	Resource
Id	azure.api_management.open_id_connect_providers

Fields

vw_open_id_connect_providers

Name	Datatype	Description
description	text	field from the properties object
client_id	text	field from the properties object
client_secret	text	field from the properties object
display_name	text	field from the properties object
metadata_endpoint	text	field from the properties object
opid	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
use_in_api_documentation	text	field from the properties object
use_in_test_console	text	field from the properties object

open_id_connect_providers

Name	Datatype	Description
properties	object	OpenID Connect Providers Contract.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	opid, resourceGroupName, serviceName, subscriptionId	Gets specific OpenID Connect Provider without secrets.
list_by_service	SELECT	resourceGroupName, serviceName, subscriptionId	Lists of all the OpenId Connect Providers.
create_or_update	INSERT	opid, resourceGroupName, serviceName, subscriptionId	Creates or updates the OpenID Connect Provider.
delete	DELETE	If-Match, opid, resourceGroupName, serviceName, subscriptionId	Deletes specific OpenID Connect Provider of the API Management service instance.
update	UPDATE	If-Match, opid, resourceGroupName, serviceName, subscriptionId	Updates the specific OpenID Connect Provider.

SELECT examples

Lists of all the OpenId Connect Providers.

vw_open_id_connect_providers

SELECT
description,
client_id,
client_secret,
display_name,
metadata_endpoint,
opid,
resourceGroupName,
serviceName,
subscriptionId,
use_in_api_documentation,
use_in_test_console
FROM azure.api_management.vw_open_id_connect_providers
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

open_id_connect_providers

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

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: displayName
          value: string
        - name: description
          value: string
        - name: metadataEndpoint
          value: string
        - name: clientId
          value: string
        - name: clientSecret
          value: string
        - name: useInTestConsole
          value: boolean
        - name: useInApiDocumentation
          value: boolean

UPDATE example

Updates a open_id_connect_providers resource.

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

DELETE example

Deletes the specified open_id_connect_providers resource.

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