Compute Node - Update User

Aggiornamenti la password e l'ora di scadenza di un account utente nel nodo di calcolo specificato.
Questa operazione sostituisce tutte le proprietà aggiornabili dell'account. Ad esempio, se l'elemento expiryTime non viene specificato, il valore corrente viene sostituito con il valore predefinito, non lasciato invariato. È possibile aggiornare un account utente in un nodo di calcolo solo quando è inattiva o in esecuzione.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
batchUrl
path True

string

URL di base per tutte le richieste di servizio Azure Batch.

nodeId
path True

string

ID del computer in cui si vuole aggiornare un account utente.

poolId
path True

string

ID del pool che contiene il nodo di calcolo.

userName
path True

string

Nome dell'account utente da aggiornare.

api-version
query True

string

Versione dell'API client.

timeout
query

integer

int32

Tempo massimo per cui il server può dedicare l'elaborazione della richiesta, in secondi. Il valore predefinito è 30 secondi.

Intestazione della richiesta

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

Nome Necessario Tipo Descrizione
client-request-id

string

uuid

Identità della richiesta generata dal chiamante, sotto forma di GUID senza decorazioni come parentesi graffe, ad esempio 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id

boolean

Indica se il server deve restituire l'ID richiesta client nella risposta.

ocp-date

string

date-time-rfc1123

Ora di emissione della richiesta. Le librerie client impostano in genere questo valore sull'ora corrente dell'orologio di sistema; impostarla in modo esplicito se si chiama direttamente l'API REST.

Corpo della richiesta

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

Nome Tipo Descrizione
expiryTime

string

Ora in cui l'account deve scadere.
Se omesso, il valore predefinito è 1 giorno dall'ora corrente. Per i nodi di calcolo Linux, expiryTime ha una precisione fino a un giorno.

password

string

Password dell'account.
La password è necessaria per i nodi di calcolo Windows (quelli creati con 'cloudServiceConfiguration', o creati con 'virtualMachineConfiguration' usando un riferimento a un'immagine di Windows). Per i nodi di calcolo Linux, la password può essere specificata facoltativamente insieme alla proprietà sshPublicKey. Se omesso, qualsiasi password esistente viene rimossa.

sshPublicKey

string

Chiave pubblica SSH che può essere usata per l'accesso remoto al nodo di calcolo.
La chiave pubblica deve essere compatibile con la codifica OpenSSH e deve essere codificata in base 64. Questa proprietà può essere specificata solo per i nodi di calcolo Linux. Se viene specificato per un nodo di calcolo Windows, il servizio Batch rifiuta la richiesta; se si chiama direttamente l'API REST, il codice di stato HTTP è 400 (richiesta non valida). Se omesso, viene rimossa qualsiasi chiave pubblica SSH esistente.

Risposte

Nome Tipo Descrizione
200 OK

La richiesta al servizio Batch ha avuto esito positivo.

Headers

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

BatchError

Errore del servizio Batch.

Sicurezza

azure_auth

Microsoft Entra flusso del codice di autenticazione OAuth 2.0

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

Scopes

Nome Descrizione
user_impersonation Rappresentare l'account utente

Authorization

Type: apiKey
In: header

Esempio

Node update user

Sample Request

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

Definizioni

Nome Descrizione
BatchError

Risposta di errore ricevuta dal servizio Azure Batch.

BatchErrorDetail

Elemento di informazioni aggiuntive incluse in una risposta di errore Azure Batch.

ErrorMessage

Messaggio di errore ricevuto in una risposta di errore Azure Batch.

NodeUpdateUserParameter

Set di modifiche da apportare a un account utente in un nodo di calcolo.

BatchError

Risposta di errore ricevuta dal servizio Azure Batch.

Nome Tipo Descrizione
code

string

Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.

message

ErrorMessage

Messaggio che descrive l'errore, che deve essere adatto per la visualizzazione in un'interfaccia utente.

values

BatchErrorDetail[]

Raccolta di coppie chiave-valore contenenti dettagli aggiuntivi sull'errore.

BatchErrorDetail

Elemento di informazioni aggiuntive incluse in una risposta di errore Azure Batch.

Nome Tipo Descrizione
key

string

Identificatore che specifica il significato della proprietà Value.

value

string

Informazioni aggiuntive incluse nella risposta di errore.

ErrorMessage

Messaggio di errore ricevuto in una risposta di errore Azure Batch.

Nome Tipo Descrizione
lang

string

Codice linguistico del messaggio di errore

value

string

Testo del messaggio.

NodeUpdateUserParameter

Set di modifiche da apportare a un account utente in un nodo di calcolo.

Nome Tipo Descrizione
expiryTime

string

Ora in cui l'account deve scadere.
Se omesso, il valore predefinito è 1 giorno dall'ora corrente. Per i nodi di calcolo Linux, expiryTime ha una precisione fino a un giorno.

password

string

Password dell'account.
La password è necessaria per i nodi di calcolo Windows (quelli creati con 'cloudServiceConfiguration', o creati con 'virtualMachineConfiguration' usando un riferimento a un'immagine di Windows). Per i nodi di calcolo Linux, la password può essere specificata facoltativamente insieme alla proprietà sshPublicKey. Se omesso, qualsiasi password esistente viene rimossa.

sshPublicKey

string

Chiave pubblica SSH che può essere usata per l'accesso remoto al nodo di calcolo.
La chiave pubblica deve essere compatibile con la codifica OpenSSH e deve essere codificata in base 64. Questa proprietà può essere specificata solo per i nodi di calcolo Linux. Se viene specificato per un nodo di calcolo Windows, il servizio Batch rifiuta la richiesta; se si chiama direttamente l'API REST, il codice di stato HTTP è 400 (richiesta non valida). Se omesso, viene rimossa qualsiasi chiave pubblica SSH esistente.