Compute Node - Add User

  • Referência
Service:
Batch Service
API Version:
2023-11-01.18.0

Adiciona uma Conta de utilizador ao Nó de Computação especificado.
Só pode adicionar uma Conta de utilizador a um Nó de Computação quando esta estiver no estado inativo ou em execução.

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/users?api-version=2023-11-01.18.0
With optional parameters: 
POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/users?timeout={timeout}&api-version=2023-11-01.18.0

Parâmetros do URI

Name Em Necessário Tipo Description
batchUrl
 path True

string

O URL base para todos os pedidos de serviço Azure Batch.
nodeId
 path True

string

O ID do computador no qual pretende criar uma Conta de utilizador.
poolId
 path True

string

O ID do Conjunto que contém o Nó de Computação.
api-version
 query True

string

Versão da API de Cliente.
timeout
 query

integer

int32

O tempo máximo que o servidor pode passar a processar o pedido, em segundos. A predefinição é 30 segundos.

Cabeçalho do Pedido

Media Types: "application/json; odata=minimalmetadata"

Name Necessário Tipo Description
client-request-id

string

uuid

A identidade do pedido gerado pelo autor da chamada, na forma de um GUID sem decoração, como chavetas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Se o servidor deve devolver o client-request-id na resposta.
ocp-date

string

date-time-rfc1123

A hora em que o pedido foi emitido. Normalmente, as bibliotecas de cliente definem isto como a hora atual do relógio do sistema; defina-o explicitamente se estiver a chamar a API REST diretamente.

Corpo do Pedido

Media Types: "application/json; odata=minimalmetadata"

Name Necessário Tipo Description
name True

string

O nome de utilizador da Conta.
expiryTime

string

O momento em que a Conta deve expirar.
Se omitido, a predefinição é 1 dia a partir da hora atual. Para Nós de Computação do Linux, o expiryTime tem uma precisão até um dia.
isAdmin

boolean

Se a Conta deve ser um administrador no Nó de Computação.
O valor predefinido é false.
password

string

A palavra-passe da Conta.
A palavra-passe é necessária para Nós de Computação do Windows (aqueles criados com "cloudServiceConfiguration" ou criados com "virtualMachineConfiguration" com uma referência da Imagem do Windows). Para Nós de Computação do Linux, a palavra-passe pode ser especificada opcionalmente juntamente com a propriedade sshPublicKey.
sshPublicKey

string

A chave pública SSH que pode ser utilizada para o início de sessão remoto no Nó de Computação.
A chave pública deve ser compatível com a codificação OpenSSH e deve ser codificada com base 64. Esta propriedade só pode ser especificada para Nós de Computação do Linux. Se for especificado para um Nó de Computação do Windows, o serviço Batch rejeita o pedido; se estiver a chamar a API REST diretamente, o código de estado HTTP é 400 (Pedido Incorreto).

Respostas

Name Tipo Description
201 Created

O pedido ao serviço Batch foi efetuado com êxito.

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

BatchError

O erro do serviço Batch.

Segurança

azure_auth

Microsoft Entra fluxo de código de autenticação OAuth 2.0

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Representar a sua conta de utilizador

Authorization

Type: apiKey
In: header

Exemplos

Node add user

Sample Request

POST account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/users?api-version=2023-11-01.18.0



{
  "name": "userName",
  "isAdmin": false,
  "expiryTime": "2017-08-01T00:00:00Z",
  "password": "Password"
}

Sample Response

Status code:
201

Definições

Name Description
BatchError

Uma resposta de erro recebida do serviço Azure Batch.
BatchErrorDetail

Um item de informações adicionais incluídas numa resposta de erro Azure Batch.
ComputeNodeUser

Uma Conta de utilizador para acesso RDP ou SSH num Nó de Computação.
ErrorMessage

Uma mensagem de erro recebida numa resposta de erro Azure Batch.

BatchError

Uma resposta de erro recebida do serviço Azure Batch.

Name Tipo Description
code

string

Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message

ErrorMessage

Uma mensagem que descreve o erro, destinada a ser adequada para ser apresentada numa interface de utilizador.
values

BatchErrorDetail[]

Uma coleção de pares chave-valor que contém detalhes adicionais sobre o erro.

BatchErrorDetail

Um item de informações adicionais incluídas numa resposta de erro Azure Batch.

Name Tipo Description
key

string

Um identificador que especifica o significado da propriedade Valor.
value

string

As informações adicionais incluídas na resposta de erro.

ComputeNodeUser

Uma Conta de utilizador para acesso RDP ou SSH num Nó de Computação.

Name Tipo Description
expiryTime

string

O momento em que a Conta deve expirar.
Se omitido, a predefinição é 1 dia a partir da hora atual. Para Nós de Computação do Linux, o expiryTime tem uma precisão até um dia.
isAdmin

boolean

Se a Conta deve ser um administrador no Nó de Computação.
O valor predefinido é false.
name

string

O nome de utilizador da Conta.
password

string

A palavra-passe da Conta.
A palavra-passe é necessária para Nós de Computação do Windows (aqueles criados com "cloudServiceConfiguration" ou criados com "virtualMachineConfiguration" com uma referência da Imagem do Windows). Para Nós de Computação do Linux, a palavra-passe pode ser especificada opcionalmente juntamente com a propriedade sshPublicKey.
sshPublicKey

string

A chave pública SSH que pode ser utilizada para o início de sessão remoto no Nó de Computação.
A chave pública deve ser compatível com a codificação OpenSSH e deve ser codificada com base 64. Esta propriedade só pode ser especificada para Nós de Computação do Linux. Se for especificado para um Nó de Computação do Windows, o serviço Batch rejeita o pedido; se estiver a chamar a API REST diretamente, o código de estado HTTP é 400 (Pedido Incorreto).

ErrorMessage

Uma mensagem de erro recebida numa resposta de erro Azure Batch.

Name Tipo Description
lang

string

O código de idioma da mensagem de erro
value

string

O texto da mensagem.