Nodes - Replace Node User

Serviço:: Batch Service

Versão da API:: 2025-06-01

Atualiza a senha e o tempo de expiração de uma conta de usuário no Nó de Computação especificado.
Essa operação substitui todas as propriedades atualizáveis da Conta. Por exemplo, se o elemento expiryTime não for especificado, o valor atual é substituído pelo valor padrão, não deixado sem modificação. Você pode atualizar uma conta de usuário em um Nó de Computação apenas quando ele estiver em estado ocioso ou em execução.

PUT {endpoint}/pools/{poolId}/nodes/{nodeId}/users/{userName}?api-version=2025-06-01

Com parâmetros opcionais:

PUT {endpoint}/pools/{poolId}/nodes/{nodeId}/users/{userName}?api-version=2025-06-01&timeOut={timeOut}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string (uri)	Ponto de extremidade da conta do Lote (por exemplo: https://batchaccount.eastus2.batch.azure.com).
nodeId	path	True	string	O ID da máquina na qual você deseja atualizar uma conta de usuário.
poolId	path	True	string	A ID do pool que contém o Nó de Computação.
userName	path	True	string	O nome da conta de usuário a ser atualizada.
api-version	query	True	string minLength: 1	A versão da API a ser usada 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 maior que 30, o padrão será usado em seu lugar.".

Cabeçalho da solicitação

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

Nome	Tipo	Description
client-request-id	string	A identidade da solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Se o servidor deve retornar a ID de solicitação do cliente na resposta.
ocp-date	string (date-time-rfc7231)	A hora em que a solicitação foi emitida. As bibliotecas de cliente normalmente definem isso como a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.

Corpo da solicitação

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

Nome	Tipo	Description
expiryTime	string (date-time)	O momento em que a conta deve expirar. Se omitido, o padrão é 1 dia a partir do tempo atual. Para os Nós de Computação do Linux, o expiryTime tem precisão de até um dia.
password	string (password)	A senha da Conta. A senha é necessária para os Nós de Computação do Windows. Para os Nós de Computação do Linux, a senha pode ser opcionalmente especificada junto com a propriedade sshPublicKey. Se omitida, qualquer senha existente é removida.
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. Essa propriedade pode ser especificada apenas para os Nós de Computação do Linux. Se isso for especificado para um Nó de Computação do Windows, então o serviço Batch rejeita a solicitação; se você está chamando diretamente a API REST, o código de status HTTP é 400 (Solicitação Ruim). Se omitida, qualquer chave pública SSH existente é removida.

Respostas

Nome	Tipo	Description
200 OK		A solicitação foi bem-sucedida. 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.

Nome

Tipo

Description

200 OK

A solicitação foi bem-sucedida.

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
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Escopos

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

Exemplos

Node update user

Solicitação de exemplo

HTTP

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



{
  "password": "12345",
  "expiryTime": "2025-11-27T00:45:48.7320857Z"
}

Resposta de exemplo

Código de status:: 200

Definições

Nome	Description
BatchError	Uma resposta de erro recebida do serviço do Lote 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.
BatchNodeUserUpdateOptions	Parâmetros para atualizar uma conta de usuário para acesso RDP ou SSH em um Nó de Computação em Lote do Azure.

BatchError

Objeto

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

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
message	BatchErrorMessage	Uma mensagem que descreve 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

Objeto

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

Nome	Tipo	Description
key	string	Um identificador que especifica o significado da propriedade Value.
value	string	As informações adicionais incluídas na resposta de erro.

BatchErrorMessage

Objeto

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

Nome	Tipo	Description
lang	string	O código de idioma da mensagem de erro.
value	string	O texto da mensagem.

BatchNodeUserUpdateOptions

Objeto

Parâmetros para atualizar uma conta de usuário para acesso RDP ou SSH em um Nó de Computação em Lote do Azure.

Nome	Tipo	Description
expiryTime	string (date-time)	O momento em que a conta deve expirar. Se omitido, o padrão é 1 dia a partir do tempo atual. Para os Nós de Computação do Linux, o expiryTime tem precisão de até um dia.
password	string (password)	A senha da Conta. A senha é necessária para os Nós de Computação do Windows. Para os Nós de Computação do Linux, a senha pode ser opcionalmente especificada junto com a propriedade sshPublicKey. Se omitida, qualquer senha existente é removida.
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. Essa propriedade pode ser especificada apenas para os Nós de Computação do Linux. Se isso for especificado para um Nó de Computação do Windows, então o serviço Batch rejeita a solicitação; se você está chamando diretamente a API REST, o código de status HTTP é 400 (Solicitação Ruim). Se omitida, qualquer chave pública SSH existente é removida.

Compartilhar via

Nodes - Replace Node User

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

OAuth2Auth

Escopos

Exemplos

Node update user

Solicitação de exemplo

Resposta de exemplo

Definições

BatchError

BatchErrorDetail

BatchErrorMessage

BatchNodeUserUpdateOptions