Serviço Microsoft.ApiManagement/identityProviders
- última
- 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
Definição de recurso do Bicep
O tipo de recurso service/identityProviders pode ser implantado com operações direcionadas:
- Grupos de recursos - Consulte comandos de implantação do grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.ApiManagement/service/identityProviders, adicione o Bicep a seguir ao modelo.
resource symbolicname 'Microsoft.ApiManagement/service/identityProviders@2024-06-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
allowedTenants: [
'string'
]
authority: 'string'
certificateId: 'string'
clientId: 'string'
clientLibrary: 'string'
clientSecret: 'string'
passwordResetPolicyName: 'string'
profileEditingPolicyName: 'string'
signinPolicyName: 'string'
signinTenant: 'string'
signupPolicyName: 'string'
type: 'string'
}
}
Valores de propriedade
IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties
| Nome | Descrição | Valor |
|---|---|---|
| allowedTenants | Lista de locatários permitidos ao configurar o logon do Azure Active Directory. | string[] |
| autoridade | Nome do host do ponto de extremidade de descoberta do OpenID Connect para AAD ou AAD B2C. | corda |
| certificateId | ID de recurso completo do certificado usada no Provedor de Identidade externo | corda |
| clientId | ID do cliente do aplicativo no Provedor de Identidade externo. É a ID do Aplicativo para logon do Facebook, a ID do Cliente para logon do Google, a ID do aplicativo para a Microsoft. | corda Restrições: Comprimento mínimo = 1 (obrigatório) |
| clientLibrary | A biblioteca de clientes a ser usada no portal do desenvolvedor. Aplica-se apenas ao AAD e ao Provedor de Identidade B2C do AAD. | corda Restrições: Comprimento máximo = |
| clientSecret | Segredo do cliente do aplicativo no Provedor de Identidade externo, usado para autenticar a solicitação de logon. Por exemplo, é o segredo do aplicativo para logon do Facebook, a Chave de API para logon do Google, a Chave Pública da Microsoft. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor. | corda Restrições: Comprimento mínimo = 1 Valor confidencial. Passe como um parâmetro seguro. (obrigatório) |
| passwordResetPolicyName | Nome da política de redefinição de senha. Aplica-se apenas ao Provedor de Identidade B2C do AAD. | corda Restrições: Comprimento mínimo = 1 |
| profileEditingPolicyName | Nome da política de edição de perfil. Aplica-se apenas ao Provedor de Identidade B2C do AAD. | corda Restrições: Comprimento mínimo = 1 |
| signinPolicyName | Nome da política de entrada. Aplica-se apenas ao Provedor de Identidade B2C do AAD. | corda Restrições: Comprimento mínimo = 1 |
| signinTenant | A TenantId a ser usada em vez de Comum ao fazer logon no Active Directory | corda |
| signupPolicyName | Nome da política de inscrição. Aplica-se apenas ao Provedor de Identidade B2C do AAD. | corda Restrições: Comprimento mínimo = 1 |
| tipo | Identificador de tipo de provedor de identidade. | 'aad' 'aadB2C' 'facebook' 'google' 'microsoft' 'twitter' |
Microsoft.ApiManagement/service/identityProviders
| Nome | Descrição | Valor |
|---|---|---|
| nome | O nome do recurso | 'aad' 'aadB2C' 'facebook' 'google' 'microsoft' 'twitter' (obrigatório) |
| pai | No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai. Para obter mais informações, consulte recurso filho fora do recurso pai. |
Nome simbólico do recurso do tipo: de serviço |
| Propriedades | Propriedades do contrato do Provedor de Identidade. | IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties |
Definição de recurso de modelo do ARM
O tipo de recurso service/identityProviders pode ser implantado com operações direcionadas:
- Grupos de recursos - Consulte comandos de implantação do grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.ApiManagement/service/identityProviders, adicione o JSON a seguir ao modelo.
{
"type": "Microsoft.ApiManagement/service/identityProviders",
"apiVersion": "2024-06-01-preview",
"name": "string",
"properties": {
"allowedTenants": [ "string" ],
"authority": "string",
"certificateId": "string",
"clientId": "string",
"clientLibrary": "string",
"clientSecret": "string",
"passwordResetPolicyName": "string",
"profileEditingPolicyName": "string",
"signinPolicyName": "string",
"signinTenant": "string",
"signupPolicyName": "string",
"type": "string"
}
}
Valores de propriedade
IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties
| Nome | Descrição | Valor |
|---|---|---|
| allowedTenants | Lista de locatários permitidos ao configurar o logon do Azure Active Directory. | string[] |
| autoridade | Nome do host do ponto de extremidade de descoberta do OpenID Connect para AAD ou AAD B2C. | corda |
| certificateId | ID de recurso completo do certificado usada no Provedor de Identidade externo | corda |
| clientId | ID do cliente do aplicativo no Provedor de Identidade externo. É a ID do Aplicativo para logon do Facebook, a ID do Cliente para logon do Google, a ID do aplicativo para a Microsoft. | corda Restrições: Comprimento mínimo = 1 (obrigatório) |
| clientLibrary | A biblioteca de clientes a ser usada no portal do desenvolvedor. Aplica-se apenas ao AAD e ao Provedor de Identidade B2C do AAD. | corda Restrições: Comprimento máximo = |
| clientSecret | Segredo do cliente do aplicativo no Provedor de Identidade externo, usado para autenticar a solicitação de logon. Por exemplo, é o segredo do aplicativo para logon do Facebook, a Chave de API para logon do Google, a Chave Pública da Microsoft. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor. | corda Restrições: Comprimento mínimo = 1 Valor confidencial. Passe como um parâmetro seguro. (obrigatório) |
| passwordResetPolicyName | Nome da política de redefinição de senha. Aplica-se apenas ao Provedor de Identidade B2C do AAD. | corda Restrições: Comprimento mínimo = 1 |
| profileEditingPolicyName | Nome da política de edição de perfil. Aplica-se apenas ao Provedor de Identidade B2C do AAD. | corda Restrições: Comprimento mínimo = 1 |
| signinPolicyName | Nome da política de entrada. Aplica-se apenas ao Provedor de Identidade B2C do AAD. | corda Restrições: Comprimento mínimo = 1 |
| signinTenant | A TenantId a ser usada em vez de Comum ao fazer logon no Active Directory | corda |
| signupPolicyName | Nome da política de inscrição. Aplica-se apenas ao Provedor de Identidade B2C do AAD. | corda Restrições: Comprimento mínimo = 1 |
| tipo | Identificador de tipo de provedor de identidade. | 'aad' 'aadB2C' 'facebook' 'google' 'microsoft' 'twitter' |
Microsoft.ApiManagement/service/identityProviders
| Nome | Descrição | Valor |
|---|---|---|
| apiVersion | A versão da API | '2024-06-01-preview' |
| nome | O nome do recurso | 'aad' 'aadB2C' 'facebook' 'google' 'microsoft' 'twitter' (obrigatório) |
| Propriedades | Propriedades do contrato do Provedor de Identidade. | IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties |
| tipo | O tipo de recurso | 'Microsoft.ApiManagement/service/identityProviders' |
Definição de recurso do Terraform (provedor de AzAPI)
O tipo de recurso service/identityProviders pode ser implantado com operações direcionadas:
- grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.ApiManagement/service/identityProviders, adicione o Terraform a seguir ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/identityProviders@2024-06-01-preview"
name = "string"
body = jsonencode({
properties = {
allowedTenants = [
"string"
]
authority = "string"
certificateId = "string"
clientId = "string"
clientLibrary = "string"
clientSecret = "string"
passwordResetPolicyName = "string"
profileEditingPolicyName = "string"
signinPolicyName = "string"
signinTenant = "string"
signupPolicyName = "string"
type = "string"
}
})
}
Valores de propriedade
IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties
| Nome | Descrição | Valor |
|---|---|---|
| allowedTenants | Lista de locatários permitidos ao configurar o logon do Azure Active Directory. | string[] |
| autoridade | Nome do host do ponto de extremidade de descoberta do OpenID Connect para AAD ou AAD B2C. | corda |
| certificateId | ID de recurso completo do certificado usada no Provedor de Identidade externo | corda |
| clientId | ID do cliente do aplicativo no Provedor de Identidade externo. É a ID do Aplicativo para logon do Facebook, a ID do Cliente para logon do Google, a ID do aplicativo para a Microsoft. | corda Restrições: Comprimento mínimo = 1 (obrigatório) |
| clientLibrary | A biblioteca de clientes a ser usada no portal do desenvolvedor. Aplica-se apenas ao AAD e ao Provedor de Identidade B2C do AAD. | corda Restrições: Comprimento máximo = |
| clientSecret | Segredo do cliente do aplicativo no Provedor de Identidade externo, usado para autenticar a solicitação de logon. Por exemplo, é o segredo do aplicativo para logon do Facebook, a Chave de API para logon do Google, a Chave Pública da Microsoft. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor. | corda Restrições: Comprimento mínimo = 1 Valor confidencial. Passe como um parâmetro seguro. (obrigatório) |
| passwordResetPolicyName | Nome da política de redefinição de senha. Aplica-se apenas ao Provedor de Identidade B2C do AAD. | corda Restrições: Comprimento mínimo = 1 |
| profileEditingPolicyName | Nome da política de edição de perfil. Aplica-se apenas ao Provedor de Identidade B2C do AAD. | corda Restrições: Comprimento mínimo = 1 |
| signinPolicyName | Nome da política de entrada. Aplica-se apenas ao Provedor de Identidade B2C do AAD. | corda Restrições: Comprimento mínimo = 1 |
| signinTenant | A TenantId a ser usada em vez de Comum ao fazer logon no Active Directory | corda |
| signupPolicyName | Nome da política de inscrição. Aplica-se apenas ao Provedor de Identidade B2C do AAD. | corda Restrições: Comprimento mínimo = 1 |
| tipo | Identificador de tipo de provedor de identidade. | 'aad' 'aadB2C' 'facebook' 'google' 'microsoft' 'twitter' |
Microsoft.ApiManagement/service/identityProviders
| Nome | Descrição | Valor |
|---|---|---|
| nome | O nome do recurso | 'aad' 'aadB2C' 'facebook' 'google' 'microsoft' 'twitter' (obrigatório) |
| parent_id | A ID do recurso que é o pai desse recurso. | ID do recurso do tipo: serviço |
| Propriedades | Propriedades do contrato do Provedor de Identidade. | IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties |
| tipo | O tipo de recurso | "Microsoft.ApiManagement/service/identityProviders@2024-06-01-preview" |