Microsoft. ApiManagement service/identityProviders 2021-08-01

  • Artigo
  • 6 minutos para o fim da leitura

Definição de recurso do Bicep

O tipo de recurso service/identityProviders pode ser implantado em:

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

Formato de recurso

Para criar um Microsoft. Recurso ApiManagement/service/identityProviders, adicione o Bicep a seguir ao modelo.

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

Valores de propriedade

service/identityProviders

Nome Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos filho no Bicep.		 cadeia de caracteres (obrigatório)

Limite de caracteres: 1 a 80

Caracteres válidos:
Caracteres alfanuméricos e hifens.

Comece com uma letra e termine com um caractere alfanumérico.
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 o recurso do tipo: serviço
properties Propriedades do contrato do Provedor de Identidade. IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

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. string
clientId ID do cliente do aplicativo no provedor de identidade externo. É id do aplicativo para logon do Facebook, ID do cliente para logon do Google, ID do aplicativo para Microsoft. cadeia de caracteres (obrigatório)
clientSecret Segredo do cliente do aplicativo no Provedor de Identidade externo, usado para autenticar a solicitação de logon. Por exemplo, é Segredo do Aplicativo para logon do Facebook, Chave de API para logon do Google, Chave Pública para Microsoft. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor. cadeia de caracteres (obrigatório)
passwordResetPolicyName Nome da Política de Redefinição de Senha. Aplica-se somente ao Provedor de Identidade do AAD B2C. string
profileEditingPolicyName Nome da Política de Edição de Perfil. Aplica-se somente ao Provedor de Identidade do AAD B2C. string
signinPolicyName Nome da Política de Entrada. Aplica-se somente ao Provedor de Identidade do AAD B2C. string
signinTenant A TenantId a ser usada em vez de Comum ao fazer logon no Active Directory string
signupPolicyName Nome da Política de Inscrição. Aplica-se somente ao Provedor de Identidade do AAD B2C. string
type Identificador de tipo de provedor de identidade. 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter'

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Criar uma instância de Gerenciamento de API e todos os sub-recursos usando um modelo

Implantar no Azure		 Este modelo demonstra como criar um serviço de Gerenciamento de API e configurar subentidades

Definição de recurso de modelo do ARM

O tipo de recurso service/identityProviders pode ser implantado em:

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

Formato de recurso

Para criar um Microsoft. Recurso ApiManagement/service/identityProviders, adicione o JSON a seguir ao modelo.

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

Valores de propriedade

service/identityProviders

Nome Descrição Valor
type O tipo de recurso 'Microsoft. ApiManagement/service/identityProviders'
apiVersion A versão da API de recursos '2021-08-01'
name O nome do recurso

Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON.		 cadeia de caracteres (obrigatório)

Limite de caracteres: 1 a 80

Caracteres válidos:
Caracteres alfanuméricos e hifens.

Comece com uma letra e termine com um caractere alfanumérico.
properties Propriedades do contrato do Provedor de Identidade. IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

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. string
clientId ID do cliente do aplicativo no provedor de identidade externo. É id do aplicativo para logon do Facebook, ID do cliente para logon do Google, ID do aplicativo para Microsoft. cadeia de caracteres (obrigatório)
clientSecret Segredo do cliente do aplicativo no Provedor de Identidade externo, usado para autenticar a solicitação de logon. Por exemplo, é o logon do Segredo do Aplicativo para Facebook, a Chave de API para logon do Google, a Chave Pública para Microsoft. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor. cadeia de caracteres (obrigatório)
passwordResetPolicyName Nome da política de redefinição de senha. Aplica-se apenas ao Provedor de Identidade B2C do AAD. string
profileEditingPolicyName Nome da Política de Edição de Perfil. Aplica-se apenas ao Provedor de Identidade B2C do AAD. string
signinPolicyName Nome da Política de Entrada. Aplica-se apenas ao Provedor de Identidade B2C do AAD. string
signinTenant A TenantId a ser usada em vez de Comum ao fazer logon no Active Directory string
signupPolicyName Nome da Política de Inscrição. Aplica-se apenas ao Provedor de Identidade B2C do AAD. string
type Identificador de tipo de provedor de identidade. 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter'

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Criar uma instância de Gerenciamento de API e todos os sub-recursos usando um modelo

Implantar no Azure		 Este modelo demonstra como criar um serviço de Gerenciamento de API e configurar sub-entidades

Definição de recurso do Terraform (provedor AzAPI)

O tipo de recurso service/identityProviders pode ser implantado em:

  • Grupos de recursos

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

Formato de recurso

Para criar um Microsoft. Recurso ApiManagement/service/identityProviders, adicione o Terraform a seguir ao modelo.

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

Valores de propriedade

service/identityProviders

Nome Descrição Valor
type O tipo de recurso "Microsoft. ApiManagement/service/identityProviders@2021-08-01"
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 1 a 80

Caracteres válidos:
Caracteres alfanuméricos e hifens.

Comece com uma letra e termine com um caractere alfanumérico.
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: serviço
properties Propriedades do contrato do Provedor de Identidade. IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

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. string
clientId ID do cliente do aplicativo no provedor de identidade externo. É id do aplicativo para logon do Facebook, ID do cliente para logon do Google, ID do aplicativo para Microsoft. cadeia de caracteres (obrigatório)
clientSecret Segredo do cliente do aplicativo no Provedor de Identidade externo, usado para autenticar a solicitação de logon. Por exemplo, é Segredo do Aplicativo para logon do Facebook, Chave de API para logon do Google, Chave Pública para Microsoft. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor. cadeia de caracteres (obrigatório)
passwordResetPolicyName Nome da Política de Redefinição de Senha. Aplica-se somente ao Provedor de Identidade do AAD B2C. string
profileEditingPolicyName Nome da Política de Edição de Perfil. Aplica-se somente ao Provedor de Identidade do AAD B2C. string
signinPolicyName Nome da Política de Entrada. Aplica-se somente ao Provedor de Identidade do AAD B2C. string
signinTenant A TenantId a ser usada em vez de Comum ao fazer logon no Active Directory string
signupPolicyName Nome da Política de Inscrição. Aplica-se somente ao Provedor de Identidade do AAD B2C. string
type Identificador de tipo de provedor de identidade. "aad"
"aadB2C"
"facebook"
"google"
"microsoft"
"twitter"