Compute Node - Update User

Atualizações a palavra-passe e o tempo de validade de uma Conta de utilizador no nó computacional especificado.
Esta operação substitui todas as propriedades updatable da Conta. Por exemplo, se o elemento de expiraçãoTime não for especificado, o valor atual é substituído pelo valor predefinido, não deixado sem modificação. Só é possível atualizar uma conta de utilizador num nó computacional quando estiver no estado de marcha lenta ou em funcionamento.

PUT {batchUrl}/pools/{poolId}/nodes/{nodeId}/users/{userName}?api-version=2022-01-01.15.0
PUT {batchUrl}/pools/{poolId}/nodes/{nodeId}/users/{userName}?timeout={timeout}&api-version=2022-01-01.15.0

Parâmetros do URI

Name In Required Type Description
batchUrl
path True
  • string

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

nodeId
path True
  • string

O ID da máquina na qual pretende atualizar uma Conta de Utilizador.

poolId
path True
  • string

O ID da Piscina que contém o Nó Compute.

userName
path True
  • string

O nome da Conta de utilizador a atualizar.

api-version
query True
  • string

Versão API do 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 Required Type Description
client-request-id
  • string
uuid

A identidade do pedido gerado pelo chamador, sob a 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 devolver o id de pedido do cliente na resposta.

ocp-date
  • string
date-time-rfc1123

A hora em que o pedido foi emitido. As bibliotecas de clientes normalmente definem isto para o tempo atual do relógio do sistema; desa defini-lo explicitamente se você estiver chamando a API REST diretamente.

Corpo do Pedido

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

Name Type Description
expiryTime
  • string

O momento em que a Conta deve expirar.
Se omitido, o padrão é de 1 dia a partir da hora atual. Para os Nóns Linux Compute, o tempo de validade tem uma precisão até um dia.

password
  • string

A senha da Conta.
A palavra-passe é necessária para os nóns do Windows Compute (os criados com 'cloudServiceConfiguration', ou criados com 'virtualMachineConfiguration' utilizando uma referência de Imagem do Windows). Para os Nóns Linux Compute, a palavra-passe pode ser especificada opcionalmente juntamente com a propriedade sshPublicKey. Se omitido, qualquer palavra-passe existente é removida.

sshPublicKey
  • string

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

Respostas

Name Type Description
200 OK

O pedido ao serviço Batch foi bem sucedido.

Headers

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

Erro do serviço Batch.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation Personificar a sua conta de utilizador

Authorization

Type: apiKey
In: header

Exemplos

Node update user

Sample Request

PUT account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/users/userName?api-version=2022-01-01.15.0



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

Sample Response

Definições

BatchError

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

BatchErrorDetail

Um item de informação adicional incluído numa resposta de erro Azure Batch.

ErrorMessage

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

NodeUpdateUserParameter

O conjunto de alterações a fazer a uma conta de utilizador num nó computacional.

BatchError

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

Name Type Description
code
  • string

Um identificador do erro. Os códigos são invariantes e destinam-se a ser consumidos programáticamente.

message

Uma mensagem que descreve o erro, destinada a ser exibida numa interface de utilizador.

values

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

BatchErrorDetail

Um item de informação adicional incluído numa resposta de erro Azure Batch.

Name Type Description
key
  • string

Um identificador especificando o significado da propriedade Value.

value
  • string

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

ErrorMessage

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

Name Type Description
lang
  • string

O código de linguagem da mensagem de erro

value
  • string

O texto da mensagem.

NodeUpdateUserParameter

O conjunto de alterações a fazer a uma conta de utilizador num nó computacional.

Name Type Description
expiryTime
  • string

O momento em que a Conta deve expirar.
Se omitido, o padrão é de 1 dia a partir da hora atual. Para os Nóns Linux Compute, o tempo de validade tem uma precisão até um dia.

password
  • string

A senha da Conta.
A palavra-passe é necessária para os nóns do Windows Compute (os criados com 'cloudServiceConfiguration', ou criados com 'virtualMachineConfiguration' utilizando uma referência de Imagem do Windows). Para os Nóns Linux Compute, a palavra-passe pode ser especificada opcionalmente juntamente com a propriedade sshPublicKey. Se omitido, qualquer palavra-passe existente é removida.

sshPublicKey
  • string

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