Compartir a través de

Servicio Microsoft.ApiManagement/identityProviders 2022-08-01

  • Artículo

Definición de recursos de Bicep

El tipo de recurso service/identityProviders se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.ApiManagement/service/identityProviders, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.ApiManagement/service/identityProviders@2022-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  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 propiedad

service/identityProviders

Nombre Descripción Value
name El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en Bicep.		 string (obligatorio)

Límite de caracteres: 1-80

Caracteres válidos:
Caracteres alfanuméricos y guiones.

Comience con una letra y termine con un carácter alfanumérico.
primario En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para más información, consulte Recurso secundario fuera del recurso primario.		 Nombre simbólico del recurso de tipo: servicio
properties Propiedades del contrato del proveedor de identidades. IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Nombre Descripción Valor
allowedTenants Lista de inquilinos permitidos al configurar el inicio de sesión de Azure Active Directory. string[]
authority Nombre de host del punto de conexión de detección de OpenID Connect para AAD o AAD B2C. string
clientId Id. de cliente de la aplicación en el proveedor de identidades externo. Es id. de aplicación para Facebook inicio de sesión, id. de cliente para el inicio de sesión de Google, id. de aplicación para Microsoft. string (obligatorio)
clientLibrary La biblioteca cliente que se va a usar en el portal para desarrolladores. Solo se aplica a AAD y al proveedor de identidades de AAD B2C. string
clientSecret Secreto de cliente de la aplicación en el proveedor de identidades externo, que se usa para autenticar la solicitud de inicio de sesión. Por ejemplo, es Secreto de aplicación para Facebook inicio de sesión, clave de API para el inicio de sesión de Google, clave pública para Microsoft. Esta propiedad no se rellenará en las operaciones "GET". Use la solicitud POST "/listSecrets" para obtener el valor. string (obligatorio)
passwordResetPolicyName Nombre de la directiva de restablecimiento de contraseña. Solo se aplica al proveedor de identidades de AAD B2C. string
profileEditingPolicyName Nombre de la directiva de edición de perfiles. Solo se aplica al proveedor de identidades de AAD B2C. string
signinPolicyName Nombre de la directiva de inicio de sesión. Solo se aplica al proveedor de identidades de AAD B2C. string
signinTenant TenantId que se va a usar en lugar de Common al iniciar sesión en Active Directory string
signupPolicyName Nombre de la directiva de registro. Solo se aplica al proveedor de identidades de AAD B2C. string
type Identificador de tipo de proveedor de identidades. 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter'

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
Creación de una instancia de API Management y todos los subrecursos mediante la plantilla

Implementación en Azure		 En esta plantilla se muestra cómo crear un servicio API Management y configurar subentidades.

Definición de recursos de plantilla de ARM

El tipo de recurso service/identityProviders se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.ApiManagement/service/identityProviders, agregue el siguiente código JSON a la plantilla.

{
  "type": "Microsoft.ApiManagement/service/identityProviders",
  "apiVersion": "2022-08-01",
  "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 propiedad

service/identityProviders

Nombre Descripción Value
type Tipo de recurso "Microsoft.ApiManagement/service/identityProviders"
apiVersion La versión de la API de recursos '2022-08-01'
name El nombre del recurso

Consulte cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM json.		 string (obligatorio)

Límite de caracteres: 1-80

Caracteres válidos:
Caracteres alfanuméricos y guiones.

Comience con una letra y termine con un carácter alfanumérico.
properties Propiedades del contrato del proveedor de identidades. IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Nombre Descripción Valor
allowedTenants Lista de inquilinos permitidos al configurar el inicio de sesión de Azure Active Directory. string[]
authority Nombre de host del punto de conexión de detección de OpenID Connect para AAD o AAD B2C. string
clientId Id. de cliente de la aplicación en el proveedor de identidades externo. Es id. de aplicación para Facebook inicio de sesión, id. de cliente para el inicio de sesión de Google, id. de aplicación para Microsoft. string (obligatorio)
clientLibrary La biblioteca cliente que se va a usar en el portal para desarrolladores. Solo se aplica a AAD y al proveedor de identidades de AAD B2C. string
clientSecret Secreto de cliente de la aplicación en el proveedor de identidades externo, que se usa para autenticar la solicitud de inicio de sesión. Por ejemplo, es Secreto de aplicación para Facebook inicio de sesión, clave de API para el inicio de sesión de Google, clave pública para Microsoft. Esta propiedad no se rellenará en las operaciones "GET". Use la solicitud POST "/listSecrets" para obtener el valor. string (obligatorio)
passwordResetPolicyName Nombre de la directiva de restablecimiento de contraseña. Solo se aplica al proveedor de identidades de AAD B2C. string
profileEditingPolicyName Nombre de la directiva de edición de perfiles. Solo se aplica al proveedor de identidades de AAD B2C. string
signinPolicyName Nombre de la directiva de inicio de sesión. Solo se aplica al proveedor de identidades de AAD B2C. string
signinTenant TenantId que se va a usar en lugar de Common al iniciar sesión en Active Directory string
signupPolicyName Nombre de la directiva de registro. Solo se aplica al proveedor de identidades de AAD B2C. string
type Identificador de tipo de proveedor de identidades. 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter'

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
Creación de una instancia de API Management y todos los subrecursos mediante la plantilla

Implementación en Azure		 En esta plantilla se muestra cómo crear un servicio API Management y configurar subentidades.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso service/identityProviders se puede implementar con operaciones que tienen como destino:

  • Grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.ApiManagement/service/identityProviders, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/identityProviders@2022-08-01"
  name = "string"
  parent_id = "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 propiedad

service/identityProviders

Nombre Descripción Value
type Tipo de recurso "Microsoft.ApiManagement/service/identityProviders@2022-08-01"
name El nombre del recurso string (obligatorio)

Límite de caracteres: 1-80

Caracteres válidos:
Caracteres alfanuméricos y guiones.

Comience con una letra y termine con un carácter alfanumérico.
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: servicio
properties Propiedades del contrato del proveedor de identidades. IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Nombre Descripción Valor
allowedTenants Lista de inquilinos permitidos al configurar el inicio de sesión de Azure Active Directory. string[]
authority Nombre de host del punto de conexión de detección de OpenID Connect para AAD o AAD B2C. string
clientId Id. de cliente de la aplicación en el proveedor de identidades externo. Es id. de aplicación para Facebook inicio de sesión, id. de cliente para el inicio de sesión de Google, id. de aplicación para Microsoft. string (obligatorio)
clientLibrary La biblioteca cliente que se va a usar en el portal para desarrolladores. Solo se aplica a AAD y al proveedor de identidades de AAD B2C. string
clientSecret Secreto de cliente de la aplicación en el proveedor de identidades externo, que se usa para autenticar la solicitud de inicio de sesión. Por ejemplo, es Secreto de aplicación para Facebook inicio de sesión, clave de API para el inicio de sesión de Google, clave pública para Microsoft. Esta propiedad no se rellenará en las operaciones "GET". Use la solicitud POST "/listSecrets" para obtener el valor. string (obligatorio)
passwordResetPolicyName Nombre de la directiva de restablecimiento de contraseña. Solo se aplica al proveedor de identidades de AAD B2C. string
profileEditingPolicyName Nombre de la directiva de edición de perfiles. Solo se aplica al proveedor de identidades de AAD B2C. string
signinPolicyName Nombre de la directiva de inicio de sesión. Solo se aplica al proveedor de identidades de AAD B2C. string
signinTenant TenantId que se va a usar en lugar de Common al iniciar sesión en Active Directory string
signupPolicyName Nombre de la directiva de registro. Solo se aplica al proveedor de identidades de AAD B2C. string
type Identificador de tipo de proveedor de identidades. "aad"
"aadB2C"
"facebook"
"google"
"microsoft"
"twitter"