Compartir a través de

Servicio Microsoft.ApiManagement/users 2022-08-01

  • 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 recurso

Para crear un recurso Microsoft.ApiManagement/service/users, agregue lo siguiente a la plantilla de Bicep.

resource symbolicname 'Microsoft.ApiManagement/service/users@2022-08-01' = {
  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 Valor
nombre 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 la letra y termine con alfanumérico.
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 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'
Correo electrónico Dirección de correo electrónico. No debe estar vacío y debe ser único dentro de la instancia de servicio. string (obligatorio)

Restricciones:
Longitud mínima = 1
Longitud máxima = 254
firstName Nombre. string (obligatorio)

Restricciones:
Longitud mínima = 1
Longitud máxima = 100
Identidades Colección de identidades de usuario. UserIdentityContract[]
lastName Apellido. string (obligatorio)

Restricciones:
Longitud mínima = 1
Longitud máxima = 100
nota Nota opcional sobre un usuario establecido por el administrador. cuerda
contraseña Contraseña de usuario. Si no se proporciona ningún valor, se genera una contraseña predeterminada. cuerda
estado 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 productos suscritos. El estado predeterminado es Activo. 'activo'
"bloqueado"
'deleted'
'Pendiente'

UserIdentityContract

Nombre Descripción Valor
identificación Valor de identificador dentro del proveedor. cuerda
proveedor Nombre del proveedor de identidades. cuerda

Plantillas de inicio rápido

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

Plantilla Descripción
Crear una instancia de API Management y todos los subrecursos mediante de 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 recurso

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

{
  "type": "Microsoft.ApiManagement/service/users",
  "apiVersion": "2022-08-01",
  "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 Valor
tipo El tipo de recurso "Microsoft.ApiManagement/service/users"
apiVersion La versión de la API de recursos '2022-08-01'
nombre El nombre del recurso

Vea 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 la letra y termine con alfanumérico.
Propiedades 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'
Correo electrónico Dirección de correo electrónico. No debe estar vacío y debe ser único dentro de la instancia de servicio. string (obligatorio)

Restricciones:
Longitud mínima = 1
Longitud máxima = 254
firstName Nombre. string (obligatorio)

Restricciones:
Longitud mínima = 1
Longitud máxima = 100
Identidades Colección de identidades de usuario. UserIdentityContract[]
lastName Apellido. string (obligatorio)

Restricciones:
Longitud mínima = 1
Longitud máxima = 100
nota Nota opcional sobre un usuario establecido por el administrador. cuerda
contraseña Contraseña de usuario. Si no se proporciona ningún valor, se genera una contraseña predeterminada. cuerda
estado 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 productos suscritos. El estado predeterminado es Activo. 'activo'
"bloqueado"
'deleted'
'Pendiente'

UserIdentityContract

Nombre Descripción Valor
identificación Valor de identificador dentro del proveedor. cuerda
proveedor Nombre del proveedor de identidades. cuerda

Plantillas de inicio rápido

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

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

Implementación en Azure 		Esta plantilla 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 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/users, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/users@2022-08-01"
  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 Valor
tipo El tipo de recurso "Microsoft.ApiManagement/service/users@2022-08-01"
nombre El nombre del recurso string (obligatorio)

Límite de caracteres: 1-80

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

Comience con la letra y termine con alfanumérico.
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: de servicio de
Propiedades 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. "invitar"
"signup"
Correo electrónico Dirección de correo electrónico. No debe estar vacío y debe ser único dentro de la instancia de servicio. string (obligatorio)

Restricciones:
Longitud mínima = 1
Longitud máxima = 254
firstName Nombre. string (obligatorio)

Restricciones:
Longitud mínima = 1
Longitud máxima = 100
Identidades Colección de identidades de usuario. UserIdentityContract[]
lastName Apellido. string (obligatorio)

Restricciones:
Longitud mínima = 1
Longitud máxima = 100
nota Nota opcional sobre un usuario establecido por el administrador. cuerda
contraseña Contraseña de usuario. Si no se proporciona ningún valor, se genera una contraseña predeterminada. cuerda
estado 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 productos suscritos. El estado predeterminado es Activo. "activo"
"bloqueado"
"eliminado"
"Pendiente"

UserIdentityContract

Nombre Descripción Valor
identificación Valor de identificador dentro del proveedor. cuerda
proveedor Nombre del proveedor de identidades. cuerda