Microsoft.ApiManagement service/identityProviders 2016-10-10

Bicep resource definition

The service/identityProviders resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiManagement/service/identityProviders resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ApiManagement/service/identityProviders@2016-10-10' = {
  parent: resourceSymbolicName
  allowedTenants: [
    'string'
  ]
  clientId: 'string'
  clientSecret: 'string'
  name: 'string'
}

Property values

Microsoft.ApiManagement/service/identityProviders

Name Description Value
allowedTenants List of Allowed Tenants when configuring Azure Active Directory login. string[]
clientId Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft. string

Constraints:
Min length = 1 (required)
clientSecret Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. string

Constraints:
Min length = 1 (required)
name The resource name 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter' (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: service

ARM template resource definition

The service/identityProviders resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiManagement/service/identityProviders resource, add the following JSON to your template.

{
  "type": "Microsoft.ApiManagement/service/identityProviders",
  "apiVersion": "2016-10-10",
  "name": "string",
  "allowedTenants": [ "string" ],
  "clientId": "string",
  "clientSecret": "string"
}

Property values

Microsoft.ApiManagement/service/identityProviders

Name Description Value
allowedTenants List of Allowed Tenants when configuring Azure Active Directory login. string[]
apiVersion The api version '2016-10-10'
clientId Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft. string

Constraints:
Min length = 1 (required)
clientSecret Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. string

Constraints:
Min length = 1 (required)
name The resource name 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter' (required)
type The resource type 'Microsoft.ApiManagement/service/identityProviders'

Terraform (AzAPI provider) resource definition

The service/identityProviders resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiManagement/service/identityProviders resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/identityProviders@2016-10-10"
  name = "string"
  allowedTenants = [
    "string"
  ]
  clientId = "string"
  clientSecret = "string"
}

Property values

Microsoft.ApiManagement/service/identityProviders

Name Description Value
allowedTenants List of Allowed Tenants when configuring Azure Active Directory login. string[]
clientId Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft. string

Constraints:
Min length = 1 (required)
clientSecret Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. string

Constraints:
Min length = 1 (required)
name The resource name 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter' (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: service
type The resource type "Microsoft.ApiManagement/service/identityProviders@2016-10-10"