Irakurri ingelesez

Partekatu honen bidez:

Servicio Microsoft.ApiManagement/identityProviders 2021-08-01

  • Artikulua
Elección de un idioma de implementación

Definición de recursos de Bicep

El tipo de recurso service/identityProviders se puede implementar con operaciones destinadas a:

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

Formato de recurso

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

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

IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Nombre Descripción Valor
allowedTenants Lista de inquilinos permitidos al configurar el inicio de sesión de Azure Active Directory. string[]
autoridad Nombre de host del punto de conexión de detección de OpenID Connect para AAD o AAD B2C. cuerda
clientId Id. de cliente de la aplicación en el proveedor de identidades externo. Es id. de aplicación para el inicio de sesión de Facebook, id. de cliente para el inicio de sesión de Google, id. de aplicación para Microsoft. cuerda

Restricciones:
Longitud mínima = 1 (obligatorio)
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 el inicio de sesión de Facebook, 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. cuerda

Restricciones:
Longitud mínima = 1
Valor confidencial. Pase como parámetro seguro. (obligatorio)
passwordResetPolicyName Nombre de la directiva de restablecimiento de contraseña. Solo se aplica al proveedor de identidades de AAD B2C. cuerda

Restricciones:
Longitud mínima = 1
profileEditingPolicyName Nombre de la directiva de edición de perfiles. Solo se aplica al proveedor de identidades de AAD B2C. cuerda

Restricciones:
Longitud mínima = 1
signinPolicyName Nombre de la directiva de inicio de sesión. Solo se aplica al proveedor de identidades de AAD B2C. cuerda

Restricciones:
Longitud mínima = 1
signinTenant TenantId que se va a usar en lugar de Common al iniciar sesión en Active Directory cuerda
signupPolicyName Nombre de la directiva de registro. Solo se aplica al proveedor de identidades de AAD B2C. cuerda

Restricciones:
Longitud mínima = 1
tipo Identificador de tipo de proveedor de identidades. 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter'

Microsoft.ApiManagement/service/identityProviders

Nombre Descripción Valor
nombre El nombre del recurso 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter' (obligatorio)
padre 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 obtener más información, consulte recurso secundario fuera del recurso primario.		 Nombre simbólico del recurso de tipo: de servicio de
Propiedades Propiedades del contrato del proveedor de identidades. IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Definición de recursos de plantilla de ARM

El tipo de recurso service/identityProviders se puede implementar con operaciones destinadas a:

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

Formato de recurso

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

JSON 
{
  "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 propiedad

IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Nombre Descripción Valor
allowedTenants Lista de inquilinos permitidos al configurar el inicio de sesión de Azure Active Directory. string[]
autoridad Nombre de host del punto de conexión de detección de OpenID Connect para AAD o AAD B2C. cuerda
clientId Id. de cliente de la aplicación en el proveedor de identidades externo. Es id. de aplicación para el inicio de sesión de Facebook, id. de cliente para el inicio de sesión de Google, id. de aplicación para Microsoft. cuerda

Restricciones:
Longitud mínima = 1 (obligatorio)
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 el inicio de sesión de Facebook, 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. cuerda

Restricciones:
Longitud mínima = 1
Valor confidencial. Pase como parámetro seguro. (obligatorio)
passwordResetPolicyName Nombre de la directiva de restablecimiento de contraseña. Solo se aplica al proveedor de identidades de AAD B2C. cuerda

Restricciones:
Longitud mínima = 1
profileEditingPolicyName Nombre de la directiva de edición de perfiles. Solo se aplica al proveedor de identidades de AAD B2C. cuerda

Restricciones:
Longitud mínima = 1
signinPolicyName Nombre de la directiva de inicio de sesión. Solo se aplica al proveedor de identidades de AAD B2C. cuerda

Restricciones:
Longitud mínima = 1
signinTenant TenantId que se va a usar en lugar de Common al iniciar sesión en Active Directory cuerda
signupPolicyName Nombre de la directiva de registro. Solo se aplica al proveedor de identidades de AAD B2C. cuerda

Restricciones:
Longitud mínima = 1
tipo Identificador de tipo de proveedor de identidades. 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter'

Microsoft.ApiManagement/service/identityProviders

Nombre Descripción Valor
apiVersion La versión de api '2021-08-01'
nombre El nombre del recurso 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter' (obligatorio)
Propiedades Propiedades del contrato del proveedor de identidades. IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties
tipo El tipo de recurso "Microsoft.ApiManagement/service/identityProviders"

Ejemplos de uso

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso service/identityProviders se puede implementar con operaciones destinadas a:

  • grupos de recursos de

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

Formato de recurso

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

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

IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Nombre Descripción Valor
allowedTenants Lista de inquilinos permitidos al configurar el inicio de sesión de Azure Active Directory. string[]
autoridad Nombre de host del punto de conexión de detección de OpenID Connect para AAD o AAD B2C. cuerda
clientId Id. de cliente de la aplicación en el proveedor de identidades externo. Es id. de aplicación para el inicio de sesión de Facebook, id. de cliente para el inicio de sesión de Google, id. de aplicación para Microsoft. cuerda

Restricciones:
Longitud mínima = 1 (obligatorio)
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 el inicio de sesión de Facebook, 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. cuerda

Restricciones:
Longitud mínima = 1
Valor confidencial. Pase como parámetro seguro. (obligatorio)
passwordResetPolicyName Nombre de la directiva de restablecimiento de contraseña. Solo se aplica al proveedor de identidades de AAD B2C. cuerda

Restricciones:
Longitud mínima = 1
profileEditingPolicyName Nombre de la directiva de edición de perfiles. Solo se aplica al proveedor de identidades de AAD B2C. cuerda

Restricciones:
Longitud mínima = 1
signinPolicyName Nombre de la directiva de inicio de sesión. Solo se aplica al proveedor de identidades de AAD B2C. cuerda

Restricciones:
Longitud mínima = 1
signinTenant TenantId que se va a usar en lugar de Common al iniciar sesión en Active Directory cuerda
signupPolicyName Nombre de la directiva de registro. Solo se aplica al proveedor de identidades de AAD B2C. cuerda

Restricciones:
Longitud mínima = 1
tipo Identificador de tipo de proveedor de identidades. 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter'

Microsoft.ApiManagement/service/identityProviders

Nombre Descripción Valor
nombre El nombre del recurso 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter' (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: de servicio de
Propiedades Propiedades del contrato del proveedor de identidades. IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties
tipo El tipo de recurso "Microsoft.ApiManagement/service/identityProviders@2021-08-01"