identity_providers

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

Overview

Name	identity_providers
Type	Resource
Id	azure.api_management.identity_providers

Fields

The following fields are returned by SELECT queries:

get

The response body contains the specified IdentityProvider entity configuration details.

Name	Datatype	Description
properties	object	Identity Provider contract properties.

list_by_service

Lists a collection of Identity Providers.

Name	Datatype	Description
properties	object	Identity Provider contract properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, identityProviderName, subscriptionId		Gets the configuration details of the identity Provider configured in specified service instance.
list_by_service	select	resourceGroupName, serviceName, subscriptionId		Lists a collection of Identity Provider configured in the specified service instance.
create_or_update	insert	resourceGroupName, serviceName, identityProviderName, subscriptionId	If-Match	Creates or Updates the IdentityProvider configuration.
update	update	resourceGroupName, serviceName, identityProviderName, If-Match, subscriptionId		Updates an existing IdentityProvider configuration.
delete	delete	resourceGroupName, serviceName, identityProviderName, If-Match, subscriptionId		Deletes the specified identity provider configuration.

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.
identityProviderName	string	Identity Provider Type identifier.
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.
If-Match	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.

SELECT examples

get

Gets the configuration details of the identity Provider configured in specified service instance.

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

list_by_service

Lists a collection of Identity Provider configured in the specified service instance.

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

INSERT examples

create_or_update

Creates or Updates the IdentityProvider configuration.

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

Manifest

# Description fields are for documentation purposes
- name: identity_providers
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the identity_providers resource.
    - name: serviceName
      value: string
      description: Required parameter for the identity_providers resource.
    - name: identityProviderName
      value: string
      description: Required parameter for the identity_providers resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the identity_providers resource.
    - name: properties
      value: object
      description: |
        Identity 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 an existing IdentityProvider configuration.

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

DELETE examples

delete

Deletes the specified identity provider configuration.

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