Partilhar via

Microsoft.ApiManagement service/identityProviders 2023-09-01-preview

  • Artigo

Definição de recursos do bíceps

O tipo de recurso service/identityProviders pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/identityProviders, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.ApiManagement/service/identityProviders@2023-09-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    allowedTenants: [
      'string'
    ]
    authority: 'string'
    clientId: 'string'
    clientLibrary: 'string'
    clientSecret: 'string'
    passwordResetPolicyName: 'string'
    profileEditingPolicyName: 'string'
    signinPolicyName: 'string'
    signinTenant: 'string'
    signupPolicyName: 'string'
    type: 'string'
  }
}

Valores de propriedade

IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Designação Descrição Valor
permitidoInquilinos Lista de Locatários Permitidos ao configurar o logon do Azure Ative Directory. string[]
autoridade Nome do host do ponto de extremidade de descoberta do OpenID Connect para AAD ou AAD B2C. string
ID do cliente ID do cliente do aplicativo no provedor de identidade externo. É o ID do aplicativo para o login do Facebook, o ID do cliente para o login do Google, o ID do aplicativo para a Microsoft. string

Restrições:
Comprimento mínimo = 1 (obrigatório)
clienteBiblioteca A biblioteca de cliente a ser usada no portal do desenvolvedor. Aplica-se apenas ao AAD e ao AAD B2C Identity Provider. string

Restrições:
Comprimento máximo = 16
clientSecret Segredo do cliente do Aplicativo no Provedor de Identidade externo, usado para autenticar a solicitação de login. Por exemplo, é App Secret para login do Facebook, API Key para login do Google, Chave Pública para Microsoft. Esta propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
passwordResetPolicyName Nome da política de redefinição de senha. Aplica-se apenas ao AAD B2C Identity Provider. string

Restrições:
Comprimento mínimo = 1
profileEditingPolicyName Nome da política de edição de perfil. Aplica-se apenas ao AAD B2C Identity Provider. string

Restrições:
Comprimento mínimo = 1
signinPolicyName Nome da política de login. Aplica-se apenas ao AAD B2C Identity Provider. string

Restrições:
Comprimento mínimo = 1
signinInTenant O TenantId a ser usado em vez de Comum ao fazer login no Ative Directory string
inscriçãoPolíticaNome Nome da política de inscrição. Aplica-se apenas ao AAD B2C Identity Provider. string

Restrições:
Comprimento mínimo = 1
tipo Identificador do tipo de provedor de identidade. 'AAD'
«aadB2C»
'Facebook'
'Google'
'Microsoft'
'Twitter'

Microsoft.ApiManagement/service/identityProviders

Designação Descrição Valor
Designação 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 para recurso do tipo: serviço
propriedades Propriedades do contrato do provedor de identidade. IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Definição de recurso de modelo ARM

O tipo de recurso service/identityProviders pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/identityProviders, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.ApiManagement/service/identityProviders",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "allowedTenants": [ "string" ],
    "authority": "string",
    "clientId": "string",
    "clientLibrary": "string",
    "clientSecret": "string",
    "passwordResetPolicyName": "string",
    "profileEditingPolicyName": "string",
    "signinPolicyName": "string",
    "signinTenant": "string",
    "signupPolicyName": "string",
    "type": "string"
  }
}

Valores de propriedade

IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Designação Descrição Valor
permitidoInquilinos Lista de Locatários Permitidos ao configurar o logon do Azure Ative Directory. string[]
autoridade Nome do host do ponto de extremidade de descoberta do OpenID Connect para AAD ou AAD B2C. string
ID do cliente ID do cliente do aplicativo no provedor de identidade externo. É o ID do aplicativo para o login do Facebook, o ID do cliente para o login do Google, o ID do aplicativo para a Microsoft. string

Restrições:
Comprimento mínimo = 1 (obrigatório)
clienteBiblioteca A biblioteca de cliente a ser usada no portal do desenvolvedor. Aplica-se apenas ao AAD e ao AAD B2C Identity Provider. string

Restrições:
Comprimento máximo = 16
clientSecret Segredo do cliente do Aplicativo no Provedor de Identidade externo, usado para autenticar a solicitação de login. Por exemplo, é App Secret para login do Facebook, API Key para login do Google, Chave Pública para Microsoft. Esta propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
passwordResetPolicyName Nome da política de redefinição de senha. Aplica-se apenas ao AAD B2C Identity Provider. string

Restrições:
Comprimento mínimo = 1
profileEditingPolicyName Nome da política de edição de perfil. Aplica-se apenas ao AAD B2C Identity Provider. string

Restrições:
Comprimento mínimo = 1
signinPolicyName Nome da política de login. Aplica-se apenas ao AAD B2C Identity Provider. string

Restrições:
Comprimento mínimo = 1
signinInTenant O TenantId a ser usado em vez de Comum ao fazer login no Ative Directory string
inscriçãoPolíticaNome Nome da política de inscrição. Aplica-se apenas ao AAD B2C Identity Provider. string

Restrições:
Comprimento mínimo = 1
tipo Identificador do tipo de provedor de identidade. 'AAD'
«aadB2C»
'Facebook'
'Google'
'Microsoft'
'Twitter'

Microsoft.ApiManagement/service/identityProviders

Designação Descrição Valor
apiVersion A versão api '2023-09-01-pré-visualização'
Designação 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 recursos Terraform (provedor 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 log de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/identityProviders, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/identityProviders@2023-09-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      allowedTenants = [
        "string"
      ]
      authority = "string"
      clientId = "string"
      clientLibrary = "string"
      clientSecret = "string"
      passwordResetPolicyName = "string"
      profileEditingPolicyName = "string"
      signinPolicyName = "string"
      signinTenant = "string"
      signupPolicyName = "string"
      type = "string"
    }
  })
}

Valores de propriedade

IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Designação Descrição Valor
permitidoInquilinos Lista de Locatários Permitidos ao configurar o logon do Azure Ative Directory. string[]
autoridade Nome do host do ponto de extremidade de descoberta do OpenID Connect para AAD ou AAD B2C. string
ID do cliente ID do cliente do aplicativo no provedor de identidade externo. É o ID do aplicativo para o login do Facebook, o ID do cliente para o login do Google, o ID do aplicativo para a Microsoft. string

Restrições:
Comprimento mínimo = 1 (obrigatório)
clienteBiblioteca A biblioteca de cliente a ser usada no portal do desenvolvedor. Aplica-se apenas ao AAD e ao AAD B2C Identity Provider. string

Restrições:
Comprimento máximo = 16
clientSecret Segredo do cliente do Aplicativo no Provedor de Identidade externo, usado para autenticar a solicitação de login. Por exemplo, é App Secret para login do Facebook, API Key para login do Google, Chave Pública para Microsoft. Esta propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
passwordResetPolicyName Nome da política de redefinição de senha. Aplica-se apenas ao AAD B2C Identity Provider. string

Restrições:
Comprimento mínimo = 1
profileEditingPolicyName Nome da política de edição de perfil. Aplica-se apenas ao AAD B2C Identity Provider. string

Restrições:
Comprimento mínimo = 1
signinPolicyName Nome da política de login. Aplica-se apenas ao AAD B2C Identity Provider. string

Restrições:
Comprimento mínimo = 1
signinInTenant O TenantId a ser usado em vez de Comum ao fazer login no Ative Directory string
inscriçãoPolíticaNome Nome da política de inscrição. Aplica-se apenas ao AAD B2C Identity Provider. string

Restrições:
Comprimento mínimo = 1
tipo Identificador do tipo de provedor de identidade. 'AAD'
«aadB2C»
'Facebook'
'Google'
'Microsoft'
'Twitter'

Microsoft.ApiManagement/service/identityProviders

Designação Descrição Valor
Designação O nome do recurso 'AAD'
«aadB2C»
'Facebook'
'Google'
'Microsoft'
'twitter' (obrigatório)
parent_id A ID do recurso que é o pai para este 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@2023-09-01-preview"