Microsoft.ApiManagement service/identityProviders 2019-01-01
- Latest
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Bicep resource definition
The service/identityProviders resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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@2019-01-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
allowedTenants: [
'string'
]
authority: 'string'
clientId: 'string'
clientSecret: 'string'
passwordResetPolicyName: 'string'
profileEditingPolicyName: 'string'
signinPolicyName: 'string'
signinTenant: 'string'
signupPolicyName: 'string'
type: 'string'
}
}
Property values
IdentityProviderContractProperties
| Name | Description | Value |
|---|---|---|
| allowedTenants | List of Allowed Tenants when configuring Azure Active Directory login. | string[] |
| authority | OpenID Connect discovery endpoint hostname for AAD or AAD B2C. | 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) |
| passwordResetPolicyName | Password Reset Policy Name. Only applies to AAD B2C Identity Provider. | string Constraints: Min length = 1 |
| profileEditingPolicyName | Profile Editing Policy Name. Only applies to AAD B2C Identity Provider. | string Constraints: Min length = 1 |
| signinPolicyName | Signin Policy Name. Only applies to AAD B2C Identity Provider. | string Constraints: Min length = 1 |
| signinTenant | The TenantId to use instead of Common when logging into Active Directory | string |
| signupPolicyName | Signup Policy Name. Only applies to AAD B2C Identity Provider. | string Constraints: Min length = 1 |
| type | Identity Provider Type identifier. | 'aad' 'aadB2C' 'facebook' 'google' 'microsoft' 'twitter' |
Microsoft.ApiManagement/service/identityProviders
| Name | Description | Value |
|---|---|---|
| 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 |
| properties | Identity Provider contract properties. | IdentityProviderContractProperties |
ARM template resource definition
The service/identityProviders resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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": "2019-01-01",
"name": "string",
"properties": {
"allowedTenants": [ "string" ],
"authority": "string",
"clientId": "string",
"clientSecret": "string",
"passwordResetPolicyName": "string",
"profileEditingPolicyName": "string",
"signinPolicyName": "string",
"signinTenant": "string",
"signupPolicyName": "string",
"type": "string"
}
}
Property values
IdentityProviderContractProperties
| Name | Description | Value |
|---|---|---|
| allowedTenants | List of Allowed Tenants when configuring Azure Active Directory login. | string[] |
| authority | OpenID Connect discovery endpoint hostname for AAD or AAD B2C. | 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) |
| passwordResetPolicyName | Password Reset Policy Name. Only applies to AAD B2C Identity Provider. | string Constraints: Min length = 1 |
| profileEditingPolicyName | Profile Editing Policy Name. Only applies to AAD B2C Identity Provider. | string Constraints: Min length = 1 |
| signinPolicyName | Signin Policy Name. Only applies to AAD B2C Identity Provider. | string Constraints: Min length = 1 |
| signinTenant | The TenantId to use instead of Common when logging into Active Directory | string |
| signupPolicyName | Signup Policy Name. Only applies to AAD B2C Identity Provider. | string Constraints: Min length = 1 |
| type | Identity Provider Type identifier. | 'aad' 'aadB2C' 'facebook' 'google' 'microsoft' 'twitter' |
Microsoft.ApiManagement/service/identityProviders
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2019-01-01' |
| name | The resource name | 'aad' 'aadB2C' 'facebook' 'google' 'microsoft' 'twitter' (required) |
| properties | Identity Provider contract properties. | IdentityProviderContractProperties |
| 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@2019-01-01"
name = "string"
body = jsonencode({
properties = {
allowedTenants = [
"string"
]
authority = "string"
clientId = "string"
clientSecret = "string"
passwordResetPolicyName = "string"
profileEditingPolicyName = "string"
signinPolicyName = "string"
signinTenant = "string"
signupPolicyName = "string"
type = "string"
}
})
}
Property values
IdentityProviderContractProperties
| Name | Description | Value |
|---|---|---|
| allowedTenants | List of Allowed Tenants when configuring Azure Active Directory login. | string[] |
| authority | OpenID Connect discovery endpoint hostname for AAD or AAD B2C. | 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) |
| passwordResetPolicyName | Password Reset Policy Name. Only applies to AAD B2C Identity Provider. | string Constraints: Min length = 1 |
| profileEditingPolicyName | Profile Editing Policy Name. Only applies to AAD B2C Identity Provider. | string Constraints: Min length = 1 |
| signinPolicyName | Signin Policy Name. Only applies to AAD B2C Identity Provider. | string Constraints: Min length = 1 |
| signinTenant | The TenantId to use instead of Common when logging into Active Directory | string |
| signupPolicyName | Signup Policy Name. Only applies to AAD B2C Identity Provider. | string Constraints: Min length = 1 |
| type | Identity Provider Type identifier. | 'aad' 'aadB2C' 'facebook' 'google' 'microsoft' 'twitter' |
Microsoft.ApiManagement/service/identityProviders
| Name | Description | Value |
|---|---|---|
| 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 |
| properties | Identity Provider contract properties. | IdentityProviderContractProperties |
| type | The resource type | "Microsoft.ApiManagement/service/identityProviders@2019-01-01" |