open_id_connect_provider

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

Overview

Name	open_id_connect_provider
Type	Resource
Id	azure.api_management.open_id_connect_provider

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
clientId	string	Client ID of developer console which is the client application. Required.
clientSecret	string	Client Secret of developer console which is the client application.
description	string	User-friendly description of OpenID Connect Provider.
displayName	string	User-friendly OpenID Connect Provider name. Required.
metadataEndpoint	string	Metadata endpoint URI. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
useInApiDocumentation	boolean	If true, the Open ID Connect provider will be used in the API documentation in the developer portal. False by default if no value is provided.
useInTestConsole	boolean	If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided.

list_by_service

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
clientId	string	Client ID of developer console which is the client application. Required.
clientSecret	string	Client Secret of developer console which is the client application.
description	string	User-friendly description of OpenID Connect Provider.
displayName	string	User-friendly OpenID Connect Provider name. Required.
metadataEndpoint	string	Metadata endpoint URI. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
useInApiDocumentation	boolean	If true, the Open ID Connect provider will be used in the API documentation in the developer portal. False by default if no value is provided.
useInTestConsole	boolean	If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, opid, subscription_id		Gets specific OpenID Connect Provider without secrets.
list_by_service	select	resource_group_name, service_name, subscription_id	$filter, $top, $skip	Lists of all the OpenId Connect Providers.
create_or_update	insert	resource_group_name, service_name, opid, subscription_id		Creates or updates the OpenID Connect Provider.
update	update	resource_group_name, service_name, opid, subscription_id		Updates the specific OpenID Connect Provider.
create_or_update	replace	resource_group_name, service_name, opid, subscription_id		Creates or updates the OpenID Connect Provider.
delete	delete	resource_group_name, service_name, opid, subscription_id		Deletes specific OpenID Connect Provider of the API Management service instance.
get_entity_tag	exec	resource_group_name, service_name, opid, subscription_id		Gets the entity state (Etag) version of the openIdConnectProvider specified by its identifier.
list_secrets	exec	resource_group_name, service_name, opid, subscription_id		Gets the client secret details of the OpenID Connect Provider.

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
opid	string	Identifier of the OpenID Connect Provider. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string
$filter	string	| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |. Default value is None.
$skip	integer	Number of records to skip. Default value is None.
$top	integer	Number of records to return. Default value is None.

SELECT examples

get

Gets specific OpenID Connect Provider without secrets.

SELECT
id,
name,
clientId,
clientSecret,
description,
displayName,
metadataEndpoint,
systemData,
type,
useInApiDocumentation,
useInTestConsole
FROM azure.api_management.open_id_connect_provider
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND opid = '{{ opid }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_service

Lists of all the OpenId Connect Providers.

SELECT
id,
name,
clientId,
clientSecret,
description,
displayName,
metadataEndpoint,
systemData,
type,
useInApiDocumentation,
useInTestConsole
FROM azure.api_management.open_id_connect_provider
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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_provider (
properties,
resource_group_name,
service_name,
opid,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ opid }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: open_id_connect_provider
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the open_id_connect_provider resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the open_id_connect_provider resource.
  - name: opid
    value: "{{ opid }}"
    description: Required parameter for the open_id_connect_provider resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the open_id_connect_provider resource.
  - name: properties
    description: |
      OpenId Connect Provider contract properties.
    value:
      displayName: "{{ displayName }}"
      description: "{{ description }}"
      metadataEndpoint: "{{ metadataEndpoint }}"
      clientId: "{{ clientId }}"
      clientSecret: "{{ clientSecret }}"
      useInTestConsole: {{ useInTestConsole }}
      useInApiDocumentation: {{ useInApiDocumentation }}

UPDATE examples

update

Updates the specific OpenID Connect Provider.

UPDATE azure.api_management.open_id_connect_provider
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND opid = '{{ opid }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Creates or updates the OpenID Connect Provider.

REPLACE azure.api_management.open_id_connect_provider
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND opid = '{{ opid }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

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

DELETE FROM azure.api_management.open_id_connect_provider
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND opid = '{{ opid }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_entity_tag

Gets the entity state (Etag) version of the openIdConnectProvider specified by its identifier.

EXEC azure.api_management.open_id_connect_provider.get_entity_tag 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@opid='{{ opid }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_secrets

Gets the client secret details of the OpenID Connect Provider.

EXEC azure.api_management.open_id_connect_provider.list_secrets 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@opid='{{ opid }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;