identity_providers

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

Overview

Name	identity_providers
Type	Resource
Id	azure.api_management.identity_providers

Fields

vw_identity_providers

Name	Datatype	Description
allowed_tenants	text	field from the properties object
authority	text	field from the properties object
client_id	text	field from the properties object
client_library	text	field from the properties object
client_secret	text	field from the properties object
identityProviderName	text	field from the properties object
password_reset_policy_name	text	field from the properties object
profile_editing_policy_name	text	field from the properties object
resourceGroupName	text	field from the properties object
serviceName	text	field from the properties object
signin_policy_name	text	field from the properties object
signin_tenant	text	field from the properties object
signup_policy_name	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	field from the properties object

identity_providers

Name	Datatype	Description
properties	object	The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	identityProviderName, resourceGroupName, serviceName, 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	identityProviderName, resourceGroupName, serviceName, subscriptionId	Creates or Updates the IdentityProvider configuration.
delete	DELETE	If-Match, identityProviderName, resourceGroupName, serviceName, subscriptionId	Deletes the specified identity provider configuration.
update	UPDATE	If-Match, identityProviderName, resourceGroupName, serviceName, subscriptionId	Updates an existing IdentityProvider configuration.

SELECT examples

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

vw_identity_providers

SELECT
allowed_tenants,
authority,
client_id,
client_library,
client_secret,
identityProviderName,
password_reset_policy_name,
profile_editing_policy_name,
resourceGroupName,
serviceName,
signin_policy_name,
signin_tenant,
signup_policy_name,
subscriptionId,
type
FROM azure.api_management.vw_identity_providers
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

identity_providers

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

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: clientId
          value: string
        - name: clientSecret
          value: string
        - name: type
          value: string
        - name: signinTenant
          value: string
        - name: allowedTenants
          value:
            - string
        - name: authority
          value: string
        - name: signupPolicyName
          value: string
        - name: signinPolicyName
          value: string
        - name: profileEditingPolicyName
          value: string
        - name: passwordResetPolicyName
          value: string
        - name: clientLibrary
          value: string

UPDATE example

Updates a identity_providers resource.

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

DELETE example

Deletes the specified identity_providers resource.

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