Partilhar via

Nodes - Create Node User

Serviço:
Batch Service
Versão da API:
2025-06-01

Adiciona uma Conta de utilizador ao Nó de Computação especificado.
Pode adicionar uma Conta de utilizador a um Nó de Computação apenas quando este estiver em estado de inatividade ou a correr.

POST {endpoint}/pools/{poolId}/nodes/{nodeId}/users?api-version=2025-06-01
Com parâmetros opcionais: 
POST {endpoint}/pools/{poolId}/nodes/{nodeId}/users?api-version=2025-06-01&timeOut={timeOut}

Parâmetros do URI

Name Em Necessário Tipo Description
endpoint
 path True

string (uri)

Ponto de extremidade da conta em lote (por exemplo: https://batchaccount.eastus2.batch.azure.com).
nodeId
 path True

string

O ID da máquina onde pretende criar uma conta de utilizador.
poolId
 path True

string

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

string

minLength: 1

A versão da API a utilizar para esta operação.
timeOut
 query

integer (int32)

O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos. Se o valor for superior a 30, será usado o padrão em vez disso.".

Cabeçalho do Pedido

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

Name Necessário Tipo Description
client-request-id

string

A identidade de solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves encaracoladas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

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

string (date-time-rfc7231)

A hora em que o pedido foi emitido. As bibliotecas de cliente normalmente definem isso para a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando 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 (date-time)

A data em que a conta deverá expirar. Se for omitido, o padrão é 1 dia a partir da hora atual. Para os Nós de Computação Linux, o expiryTime tem uma precisão até um dia.
isAdmin

boolean

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

string (password)

A palavra-passe da Conta. A palavra-passe é necessária para os Nós de Computação do Windows. Para os Nós de Computação Linux, a palavra-passe pode ser opcionalmente especificada juntamente com a propriedade sshPublicKey.
sshPublicKey

string

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

Respostas

Name Tipo Description
201 Created

O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso.

Cabeçalhos

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

BatchError

Uma resposta de erro inesperada.

Segurança

OAuth2Auth

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Âmbitos

Name Description
https://batch.core.windows.net//.default

Exemplos

Node create user

Pedido de amostra

POST {endpoint}/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/users?api-version=2025-06-01



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

Resposta da amostra

Código de estado:
201

Definições

Name Description
BatchError

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

Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.
BatchErrorMessage

Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.
BatchNodeUserCreateOptions

Parâmetros para criar uma conta de usuário para acesso RDP ou SSH em um nó de computação em lote do Azure.

BatchError

Object

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

Name Tipo Description
code

string

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

BatchErrorMessage

Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
values

BatchErrorDetail[]

Uma coleção de pares chave-valor contendo detalhes adicionais sobre o erro.

BatchErrorDetail

Object

Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.

Name Tipo Description
key

string

Um identificador que especifica o significado da propriedade Value.
value

string

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

BatchErrorMessage

Object

Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.

Name Tipo Description
lang

string

O código da linguagem da mensagem de erro.
value

string

O texto da mensagem.

BatchNodeUserCreateOptions

Object

Parâmetros para criar uma conta de usuário para acesso RDP ou SSH em um nó de computação em lote do Azure.

Name Tipo Description
expiryTime

string (date-time)

A data em que a conta deverá expirar. Se for omitido, o padrão é 1 dia a partir da hora atual. Para os Nós de Computação Linux, o expiryTime tem uma precisão até um dia.
isAdmin

boolean

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

string

O nome de utilizador da Conta.
password

string (password)

A palavra-passe da Conta. A palavra-passe é necessária para os Nós de Computação do Windows. Para os Nós de Computação Linux, a palavra-passe pode ser opcionalmente especificada juntamente com a propriedade sshPublicKey.
sshPublicKey

string

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