Compartir a través de

Servicio Microsoft.ApiManagement/users 2021-12-01-preview

  • Artículo

Definición de recursos de Bicep

El tipo de recurso service/users 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 los recursos

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

resource symbolicname 'Microsoft.ApiManagement/service/users@2021-12-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    appType: 'string'
    confirmation: 'string'
    email: 'string'
    firstName: 'string'
    identities: [
      {
        id: 'string'
        provider: 'string'
      }
    ]
    lastName: 'string'
    note: 'string'
    password: 'string'
    state: 'string'
  }
}

Valores de propiedad

service/users

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 Las propiedades del contrato de creación de entidades de usuario. UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

Nombre Descripción Valor
appType Determina el tipo de aplicación que envía la solicitud de creación del usuario. El valor predeterminado es el portal heredado. 'developerPortal'
'portal'
Confirmación Determina el tipo de correo electrónico de confirmación que se enviará al usuario recién creado. 'invite'
'signup'
email Dirección de correo electrónico. No debe estar vacía y debe ser única dentro de la instancia de servicio. string (obligatorio)
firstName Nombre. string (obligatorio)
Identidades Colección de identidades de usuario. UserIdentityContract[]
lastName Apellidos. string (obligatorio)
nota Nota opcional sobre un usuario, establecida por el administrador. string
password Contraseña de usuario. Si no se proporciona ningún valor, se genera una contraseña predeterminada. string
state Estado de la cuenta. Especifica si el usuario está activo o no. Los usuarios bloqueados no pueden iniciar sesión en el portal para desarrolladores ni llamar a ninguna API de los productos a los que están suscritos. El estado predeterminado es Activo. 'activo'
"bloqueado"
'deleted'
'Pendiente'

UserIdentityContract

Nombre Descripción Value
id Valor de identificador dentro del proveedor. string
provider Nombre del proveedor de identidades. string

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		 Esta plantilla muestra cómo crear un servicio API Management y configurar subentidades

Definición de recursos de plantilla de ARM

El tipo de recurso service/users 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 los recursos

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

{
  "type": "Microsoft.ApiManagement/service/users",
  "apiVersion": "2021-12-01-preview",
  "name": "string",
  "properties": {
    "appType": "string",
    "confirmation": "string",
    "email": "string",
    "firstName": "string",
    "identities": [
      {
        "id": "string",
        "provider": "string"
      }
    ],
    "lastName": "string",
    "note": "string",
    "password": "string",
    "state": "string"
  }
}

Valores de propiedad

service/users

Nombre Descripción Value
type Tipo de recurso "Microsoft.ApiManagement/service/users"
apiVersion La versión de la API de recursos "2021-12-01-preview"
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 Las propiedades del contrato de creación de entidades de usuario. UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

Nombre Descripción Valor
appType Determina el tipo de aplicación que envía la solicitud de creación de usuario. El valor predeterminado es el portal heredado. "developerPortal"
'portal'
Confirmación Determina el tipo de correo electrónico de confirmación que se enviará al usuario recién creado. 'invite'
'signup'
email Dirección de correo electrónico. No debe estar vacía y debe ser única dentro de la instancia de servicio. string (obligatorio)
firstName Nombre. string (obligatorio)
Identidades Colección de identidades de usuario. UserIdentityContract[]
lastName Apellidos. string (obligatorio)
nota Nota opcional sobre un usuario, establecida por el administrador. string
password Contraseña de usuario. Si no se proporciona ningún valor, se genera una contraseña predeterminada. string
state Estado de la cuenta. Especifica si el usuario está activo o no. Los usuarios bloqueados no pueden iniciar sesión en el portal para desarrolladores ni llamar a ninguna API de los productos a los que están suscritos. El estado predeterminado es Activo. 'activo'
"bloqueado"
'deleted'
'Pendiente'

UserIdentityContract

Nombre Descripción Value
id Valor de identificador dentro del proveedor. string
provider Nombre del proveedor de identidades. string

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/users se puede implementar con operaciones destinadas a:

  • 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/users, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/users@2021-12-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      appType = "string"
      confirmation = "string"
      email = "string"
      firstName = "string"
      identities = [
        {
          id = "string"
          provider = "string"
        }
      ]
      lastName = "string"
      note = "string"
      password = "string"
      state = "string"
    }
  })
}

Valores de propiedad

service/users

Nombre Descripción Value
type Tipo de recurso "Microsoft.ApiManagement/service/users@2021-12-01-preview"
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 Las propiedades del contrato de creación de entidades de usuario. UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

Nombre Descripción Valor
appType Determina el tipo de aplicación que envía la solicitud de creación del usuario. El valor predeterminado es el portal heredado. "developerPortal"
"portal"
Confirmación Determina el tipo de correo electrónico de confirmación que se enviará al usuario recién creado. "invitar"
"registro"
email Dirección de correo electrónico. No debe estar vacía y debe ser única dentro de la instancia de servicio. string (obligatorio)
firstName Nombre. string (obligatorio)
Identidades Colección de identidades de usuario. UserIdentityContract[]
lastName Apellidos. string (obligatorio)
nota Nota opcional sobre un usuario, establecida por el administrador. string
password Contraseña de usuario. Si no se proporciona ningún valor, se genera una contraseña predeterminada. string
state Estado de la cuenta. Especifica si el usuario está activo o no. Los usuarios bloqueados no pueden iniciar sesión en el portal para desarrolladores ni llamar a ninguna API de los productos a los que están suscritos. El estado predeterminado es Activo. "activo"
"bloqueado"
"eliminado"
"Pendiente"

UserIdentityContract

Nombre Descripción Value
id Valor de identificador dentro del proveedor. string
provider Nombre del proveedor de identidades. string