Compute Node - Update User

Service:

Batch Service

API Version:

2023-11-01.18.0

Atualizações 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 será 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 somente quando ela estiver no estado ocioso ou em execução.

PUT {batchUrl}/pools/{poolId}/nodes/{nodeId}/users/{userName}?api-version=2023-11-01.18.0

With optional parameters:

PUT {batchUrl}/pools/{poolId}/nodes/{nodeId}/users/{userName}?timeout={timeout}&api-version=2023-11-01.18.0

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
batchUrl	path	True	string	A URL base para todas as solicitações de serviço Lote do Azure.
nodeId	path	True	string	A ID do computador no 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	Versão da API do cliente.
timeout	query		integer int32	O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos.

Cabeçalho da solicitação

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

Nome	Obrigatório	Tipo	Description
client-request-id		string uuid	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 o client-request-id na resposta.
ocp-date		string date-time-rfc1123	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	O momento em que a Conta deve expirar. Se omitido, o padrão será 1 dia a partir da hora atual. Para nós de computação do Linux, o expirayTime tem uma precisão de até um dia.
password	string	A senha da Conta. A senha é necessária para nós de computação do Windows (aqueles criados com 'cloudServiceConfiguration', ou criados com 'virtualMachineConfiguration' usando uma referência de Imagem do Windows). Para Nós de Computação do Linux, a senha pode ser especificada opcionalmente junto com a propriedade sshPublicKey. Se omitida, qualquer senha existente será removida.
sshPublicKey	string	A chave pública SSH que pode ser usada para logon 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 só pode ser especificada para nós de computação do Linux. Se isso for especificado para um Nó de Computação do Windows, o serviço lote rejeitará a solicitação; se você estiver chamando a API REST diretamente, o código http status será 400 (solicitação incorreta). Se omitida, qualquer chave pública SSH existente será removida.

Respostas

Nome	Tipo	Description
200 OK		A solicitação para o serviço do Lote foi bem-sucedida. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	O erro do serviço do Lote.

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

Nome	Description
user_impersonation	Representar sua conta de usuário

Authorization

Type: apiKey
In: header

Exemplos

Node update user

Sample Request

HTTP

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



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

Sample Response

Status code:

200

Definições

Nome	Description
BatchError	Uma resposta de erro recebida do serviço Lote do Azure.
BatchErrorDetail	Um item de informações adicionais incluído em uma resposta de erro Lote do Azure.
ErrorMessage	Uma mensagem de erro recebida em uma resposta de erro Lote do Azure.
NodeUpdateUserParameter	O conjunto de alterações a serem feitas em uma conta de usuário em um nó de computação.

BatchError

Uma resposta de erro recebida do serviço 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	ErrorMessage	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

Um item de informações adicionais incluído em uma resposta de erro 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.

ErrorMessage

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

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

NodeUpdateUserParameter

O conjunto de alterações a serem feitas em uma conta de usuário em um nó de computação.

Nome	Tipo	Description
expiryTime	string	O momento em que a Conta deve expirar. Se omitido, o padrão será 1 dia a partir da hora atual. Para nós de computação do Linux, o expirayTime tem uma precisão de até um dia.
password	string	A senha da Conta. A senha é necessária para nós de computação do Windows (aqueles criados com 'cloudServiceConfiguration', ou criados com 'virtualMachineConfiguration' usando uma referência de Imagem do Windows). Para Nós de Computação do Linux, a senha pode ser especificada opcionalmente junto com a propriedade sshPublicKey. Se omitida, qualquer senha existente será removida.
sshPublicKey	string	A chave pública SSH que pode ser usada para logon 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 só pode ser especificada para nós de computação do Linux. Se isso for especificado para um Nó de Computação do Windows, o serviço lote rejeitará a solicitação; se você estiver chamando a API REST diretamente, o código http status será 400 (solicitação incorreta). Se omitida, qualquer chave pública SSH existente será removida.