Serviço Microsoft.ApiManagement/identityProviders 2021-04-01-preview

  • Artigo

Definição de recurso do Bicep

O tipo de recurso service/identityProviders pode ser implementado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo 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@2021-04-01-preview' = {
  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 subordinados no Bicep.		 cadeia (obrigatório)

Limite de carateres: 1-80

Carateres válidos:
Alfanuméricos e hífenes.

Comece com letra e termine com alfanumérico.
principal No Bicep, pode especificar o recurso principal de um recurso subordinado. Só precisa de adicionar esta propriedade quando o recurso subordinado for declarado fora do recurso principal.

Para obter mais informações, veja Recurso subordinado fora do recurso principal.		 Nome simbólico para recurso do tipo: serviço
propriedades Propriedades do contrato do Fornecedor de Identidade. IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Nome Descrição Valor
allowedTenants Lista de Inquilinos Permitidos ao configurar o início de sessão do Azure Active Directory. cadeia[]
autoridade Nome do anfitrião do ponto final de deteção do OpenID Connect para o AAD ou o AAD B2C. string
clientId ID de cliente da Aplicação no Fornecedor de Identidade externo. É o ID da Aplicação para o início de sessão do Facebook, o ID do Cliente para o início de sessão do Google, o ID da Aplicação para a Microsoft. cadeia (obrigatório)
clientSecret Segredo do cliente da Aplicação no Fornecedor de Identidade externo, utilizado para autenticar o pedido de início de sessão. Por exemplo, é Segredo da Aplicação para início de sessão no Facebook, Chave de API para início de sessão do Google, Chave Pública para a Microsoft. Esta propriedade não será preenchida em operações "GET"! Utilize o pedido POST "/listSecrets" para obter o valor. cadeia (obrigatório)
passwordResetPolicyName Nome da Política de Reposição de Palavra-passe. Aplica-se apenas ao Fornecedor de Identidade do AAD B2C. string
profileEditingPolicyName Nome da Política de Edição de Perfis. Aplica-se apenas ao Fornecedor de Identidade do AAD B2C. string
signinPolicyName Nome da Política de Início de Sessão. Aplica-se apenas ao Fornecedor de Identidade do AAD B2C. string
signinTenant O TenantId a utilizar em vez de Comum ao iniciar sessão no Active Directory string
signupPolicyName Nome da Política de Inscrição. Aplica-se apenas ao Fornecedor de Identidade do AAD B2C. string
tipo Identificador do Tipo de Fornecedor de Identidade. 'aad'
"aadB2C"
'facebook'
'google'
"microsoft"
'twitter'

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Description
Criar uma instância da Gestão de API e todos os sub-recursos com modelo

Implementar no Azure		 Este modelo demonstra como criar um serviço de Gestão de API e configurar sub entidades

Definição de recurso de modelo do ARM

O tipo de recurso service/identityProviders pode ser implementado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo 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": "2021-04-01-preview",
  "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
tipo O tipo de recurso "Microsoft.ApiManagement/service/identityProviders"
apiVersion A versão da API de recursos '2021-04-01-preview'
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados em modelos arm JSON.		 cadeia (obrigatório)

Limite de carateres: 1-80

Carateres válidos:
Alfanuméricos e hífenes.

Comece com letra e termine com alfanumérico.
propriedades Propriedades do contrato do Fornecedor de Identidade. IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Nome Descrição Valor
allowedTenants Lista de Inquilinos Permitidos ao configurar o início de sessão do Azure Active Directory. string[]
autoridade Nome do anfitrião do ponto final de deteção do OpenID Connect para o AAD ou OAD B2C. string
clientId ID de cliente da Aplicação no Fornecedor de Identidade externo. É o ID da Aplicação para o início de sessão do Facebook, o ID de Cliente para o início de sessão do Google e o ID da Aplicação para a Microsoft. cadeia (obrigatório)
clientSecret Segredo do cliente da Aplicação no Fornecedor de Identidade externo, utilizado para autenticar o pedido de início de sessão. Por exemplo, é Segredo da Aplicação para início de sessão no Facebook, Chave de API para início de sessão do Google, Chave Pública para a Microsoft. Esta propriedade não será preenchida em operações "GET"! Utilize o pedido POST "/listSecrets" para obter o valor. cadeia (obrigatório)
passwordResetPolicyName Nome da Política de Reposição de Palavra-passe. Aplica-se apenas ao Fornecedor de Identidade do AAD B2C. string
profileEditingPolicyName Nome da Política de Edição de Perfil. Aplica-se apenas ao Fornecedor de Identidade do AAD B2C. string
signinPolicyName Nome da Política de Início de Sessão. Aplica-se apenas ao Fornecedor de Identidade do AAD B2C. string
signinTenant O TenantId a utilizar em vez de Comum ao iniciar sessão no Active Directory string
signupPolicyName Nome da Política de Inscrição. Aplica-se apenas ao Fornecedor de Identidade do AAD B2C. string
tipo Identificador do Tipo de Fornecedor de Identidade. 'aad'
"aadB2C"
'facebook'
'google'
'microsoft'
'twitter'

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Description
Criar uma instância da Gestão de API e todos os sub-recursos com modelo

Implementar no Azure		 Este modelo demonstra como criar um serviço de Gestão de API e configurar sub entidades

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso service/identityProviders pode ser implementado com operações que visam:

  • Grupos de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo 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@2021-04-01-preview"
  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
tipo O tipo de recurso "Microsoft.ApiManagement/service/identityProviders@2021-04-01-preview"
name O nome do recurso cadeia (obrigatório)

Limite de carateres: 1-80

Carateres válidos:
Alfanuméricos e hífenes.

Comece com letra e termine com alfanumérico.
parent_id O ID do recurso que é o principal para este recurso. ID do recurso do tipo: serviço
propriedades Propriedades do contrato do Fornecedor de Identidade. IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Nome Descrição Valor
allowedTenants Lista de Inquilinos Permitidos ao configurar o início de sessão do Azure Active Directory. cadeia[]
autoridade Nome do anfitrião do ponto final de deteção do OpenID Connect para o AAD ou o AAD B2C. string
clientId ID de cliente da Aplicação no Fornecedor de Identidade externo. É o ID da Aplicação para o início de sessão do Facebook, o ID do Cliente para o início de sessão do Google, o ID da Aplicação para a Microsoft. cadeia (obrigatório)
clientSecret Segredo do cliente da Aplicação no Fornecedor de Identidade externo, utilizado para autenticar o pedido de início de sessão. Por exemplo, é Segredo da Aplicação para início de sessão no Facebook, Chave de API para início de sessão do Google, Chave Pública para a Microsoft. Esta propriedade não será preenchida em operações "GET"! Utilize o pedido POST "/listSecrets" para obter o valor. cadeia (obrigatório)
passwordResetPolicyName Nome da Política de Reposição de Palavra-passe. Aplica-se apenas ao Fornecedor de Identidade do AAD B2C. string
profileEditingPolicyName Nome da Política de Edição de Perfis. Aplica-se apenas ao Fornecedor de Identidade do AAD B2C. string
signinPolicyName Nome da Política de Início de Sessão. Aplica-se apenas ao Fornecedor de Identidade do AAD B2C. string
signinTenant O TenantId a utilizar em vez de Comum ao iniciar sessão no Active Directory string
signupPolicyName Nome da Política de Inscrição. Aplica-se apenas ao Fornecedor de Identidade do AAD B2C. string
tipo Identificador do Tipo de Fornecedor de Identidade. "aad"
"aadB2C"
"facebook"
"google"
"microsoft"
"twitter"