Compartilhar via

Serviço/usuários Microsoft.ApiManagement 2023-05-01-preview

  • Artigo

Definição de recurso do Bicep

O tipo de recurso de serviço/usuários pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.ApiManagement/service/users, adicione o Bicep a seguir ao seu modelo.

resource symbolicname 'Microsoft.ApiManagement/service/users@2023-05-01-preview' = {
  parent: resourceSymbolicName
  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 propriedade

Microsoft.ApiManagement/service/users

Nome Descrição Valor
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.		 Nome simbólico do recurso do tipo: de serviço
Propriedades A entidade de usuário cria propriedades de contrato. UserCreateParameterPropertiesOrUserContractProperties

UserCreateParameterPropertiesOrUserContractProperties

Nome Descrição Valor
appType Determina o tipo de aplicativo que envia a solicitação criar usuário. O padrão é o portal herdado. 'developerPortal'
'portal'
confirmação Determina o tipo de email de confirmação que será enviado ao usuário recém-criado. 'invite'
'inscrição'
Email Endereço eletrônico. Não deve estar vazio e deve ser exclusivo dentro da instância de serviço. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
firstName Nome próprio. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
Identidades Coleção de identidades de usuário. UserIdentityContract []
lastName Apelido. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
nota Observação opcional sobre um usuário definido pelo administrador. corda
senha Senha do usuário. Se nenhum valor for fornecido, uma senha padrão será gerada. corda
estado Estado da conta. Especifica se o usuário está ativo ou não. Os usuários bloqueados não podem entrar no portal do desenvolvedor ou chamar nenhuma APIs de produtos assinados. O estado padrão é Ativo. 'ativo'
'bloqueado'
'excluído'
'pendente'

UserIdentityContract

Nome Descrição Valor
id Valor do identificador dentro do provedor. corda
provedor Nome do provedor de identidade. corda

Definição de recurso de modelo do ARM

O tipo de recurso de serviço/usuários pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.ApiManagement/service/users, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.ApiManagement/service/users",
  "apiVersion": "2023-05-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 propriedade

Microsoft.ApiManagement/service/users

Nome Descrição Valor
apiVersion A versão da API '2023-05-01-preview'
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
Propriedades A entidade de usuário cria propriedades de contrato. UserCreateParameterPropertiesOrUserContractProperties
tipo O tipo de recurso 'Microsoft.ApiManagement/service/users'

UserCreateParameterPropertiesOrUserContractProperties

Nome Descrição Valor
appType Determina o tipo de aplicativo que envia a solicitação criar usuário. O padrão é o portal herdado. 'developerPortal'
'portal'
confirmação Determina o tipo de email de confirmação que será enviado ao usuário recém-criado. 'invite'
'inscrição'
Email Endereço eletrônico. Não deve estar vazio e deve ser exclusivo dentro da instância de serviço. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
firstName Nome próprio. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
Identidades Coleção de identidades de usuário. UserIdentityContract []
lastName Apelido. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
nota Observação opcional sobre um usuário definido pelo administrador. corda
senha Senha do usuário. Se nenhum valor for fornecido, uma senha padrão será gerada. corda
estado Estado da conta. Especifica se o usuário está ativo ou não. Os usuários bloqueados não podem entrar no portal do desenvolvedor ou chamar nenhuma APIs de produtos assinados. O estado padrão é Ativo. 'ativo'
'bloqueado'
'excluído'
'pendente'

UserIdentityContract

Nome Descrição Valor
id Valor do identificador dentro do provedor. corda
provedor Nome do provedor de identidade. corda

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso de serviço/usuários pode ser implantado com operações direcionadas:

  • grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.ApiManagement/service/users, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/users@2023-05-01-preview"
  name = "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 propriedade

Microsoft.ApiManagement/service/users

Nome Descrição Valor
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: serviço
Propriedades A entidade de usuário cria propriedades de contrato. UserCreateParameterPropertiesOrUserContractProperties
tipo O tipo de recurso "Microsoft.ApiManagement/service/users@2023-05-01-preview"

UserCreateParameterPropertiesOrUserContractProperties

Nome Descrição Valor
appType Determina o tipo de aplicativo que envia a solicitação criar usuário. O padrão é o portal herdado. 'developerPortal'
'portal'
confirmação Determina o tipo de email de confirmação que será enviado ao usuário recém-criado. 'invite'
'inscrição'
Email Endereço eletrônico. Não deve estar vazio e deve ser exclusivo dentro da instância de serviço. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
firstName Nome próprio. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
Identidades Coleção de identidades de usuário. UserIdentityContract []
lastName Apelido. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
nota Observação opcional sobre um usuário definido pelo administrador. corda
senha Senha do usuário. Se nenhum valor for fornecido, uma senha padrão será gerada. corda
estado Estado da conta. Especifica se o usuário está ativo ou não. Os usuários bloqueados não podem entrar no portal do desenvolvedor ou chamar nenhuma APIs de produtos assinados. O estado padrão é Ativo. 'ativo'
'bloqueado'
'excluído'
'pendente'

UserIdentityContract

Nome Descrição Valor
id Valor do identificador dentro do provedor. corda
provedor Nome do provedor de identidade. corda