Serviço/usuários Microsoft.ApiManagement 2021-01-01-preview
O tipo de recurso serviço/usuários pode ser implantado com operações que visam:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Para criar um recurso Microsoft.ApiManagement/service/users, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.ApiManagement/service/users@2021-01-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'
}
}
Designação | Descrição | Valor |
---|---|---|
Designação | O nome do recurso | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 80 (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 para recurso do tipo: serviço |
propriedades | Entidade de usuário criar propriedades de contrato. | UserCreateParameterPropertiesOrUserContractProperties |
Designação | Descrição | Valor |
---|---|---|
appType | Determina o tipo de aplicativo que envia a solicitação de usuário de criação. O padrão é portal herdado. | 'developerPortal' 'Portal' |
confirmação | Determina o tipo de email de confirmação que será enviado ao usuário recém-criado. | 'Convidar' 'Cadastre-se' |
Endereço de e-mail. Não deve estar vazio e deve ser exclusivo dentro da instância de serviço. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 254 (obrigatório) |
|
nomenclatura | Nome próprio. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 100 (obrigatório) |
identidades | Coleção de identidades de usuário. | UserIdentityContract[] |
sobrenome | Apelido. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 100 (obrigatório) |
Observação | Observação opcional sobre um usuário definida pelo administrador. | string |
palavra-passe | Palavra-passe de utilizador. Se nenhum valor for fornecido, uma senha padrão será gerada. | string |
Estado | Estado da conta. Especifica se o usuário está ativo ou não. Os usuários bloqueados não conseguem entrar no portal do desenvolvedor ou chamar quaisquer APIs de produtos inscritos. O estado padrão é Ativo. | 'ativo' 'bloqueado' «Suprimido» 'pendente' |
Designação | Descrição | Valor |
---|---|---|
ID | Valor do identificador dentro do provedor. | string |
fornecedor | Nome do provedor de identidade. | string |
O tipo de recurso serviço/usuários pode ser implantado com operações que visam:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Para criar um recurso Microsoft.ApiManagement/service/users, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.ApiManagement/service/users",
"apiVersion": "2021-01-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"
}
}
Designação | Descrição | Valor |
---|---|---|
apiVersion | A versão api | '2021-01-01-pré-visualização' |
Designação | O nome do recurso | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 80 (obrigatório) |
propriedades | Entidade de usuário criar propriedades de contrato. | UserCreateParameterPropertiesOrUserContractProperties |
tipo | O tipo de recurso | 'Microsoft.ApiManagement/serviço/usuários' |
Designação | Descrição | Valor |
---|---|---|
appType | Determina o tipo de aplicativo que envia a solicitação de usuário de criação. O padrão é portal herdado. | 'developerPortal' 'Portal' |
confirmação | Determina o tipo de email de confirmação que será enviado ao usuário recém-criado. | 'Convidar' 'Cadastre-se' |
Endereço de e-mail. Não deve estar vazio e deve ser exclusivo dentro da instância de serviço. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 254 (obrigatório) |
|
nomenclatura | Nome próprio. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 100 (obrigatório) |
identidades | Coleção de identidades de usuário. | UserIdentityContract[] |
sobrenome | Apelido. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 100 (obrigatório) |
Observação | Observação opcional sobre um usuário definida pelo administrador. | string |
palavra-passe | Palavra-passe de utilizador. Se nenhum valor for fornecido, uma senha padrão será gerada. | string |
Estado | Estado da conta. Especifica se o usuário está ativo ou não. Os usuários bloqueados não conseguem entrar no portal do desenvolvedor ou chamar quaisquer APIs de produtos inscritos. O estado padrão é Ativo. | 'ativo' 'bloqueado' «Suprimido» 'pendente' |
Designação | Descrição | Valor |
---|---|---|
ID | Valor do identificador dentro do provedor. | string |
fornecedor | Nome do provedor de identidade. | string |
O tipo de recurso serviço/usuários pode ser implantado com operações que visam:
- Grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Para criar um recurso Microsoft.ApiManagement/service/users, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/users@2021-01-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"
}
})
}
Designação | Descrição | Valor |
---|---|---|
Designação | O nome do recurso | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 80 (obrigatório) |
parent_id | A ID do recurso que é o pai para este recurso. | ID do recurso do tipo: serviço |
propriedades | Entidade de usuário criar propriedades de contrato. | UserCreateParameterPropertiesOrUserContractProperties |
tipo | O tipo de recurso | "Microsoft.ApiManagement/service/users@2021-01-01-preview" |
Designação | Descrição | Valor |
---|---|---|
appType | Determina o tipo de aplicativo que envia a solicitação de usuário de criação. O padrão é portal herdado. | 'developerPortal' 'Portal' |
confirmação | Determina o tipo de email de confirmação que será enviado ao usuário recém-criado. | 'Convidar' 'Cadastre-se' |
Endereço de e-mail. Não deve estar vazio e deve ser exclusivo dentro da instância de serviço. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 254 (obrigatório) |
|
nomenclatura | Nome próprio. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 100 (obrigatório) |
identidades | Coleção de identidades de usuário. | UserIdentityContract[] |
sobrenome | Apelido. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 100 (obrigatório) |
Observação | Observação opcional sobre um usuário definida pelo administrador. | string |
palavra-passe | Palavra-passe de utilizador. Se nenhum valor for fornecido, uma senha padrão será gerada. | string |
Estado | Estado da conta. Especifica se o usuário está ativo ou não. Os usuários bloqueados não conseguem entrar no portal do desenvolvedor ou chamar quaisquer APIs de produtos inscritos. O estado padrão é Ativo. | 'ativo' 'bloqueado' «Suprimido» 'pendente' |
Designação | Descrição | Valor |
---|---|---|
ID | Valor do identificador dentro do provedor. | string |
fornecedor | Nome do provedor de identidade. | string |