Compute Node - Update User

Aggiorna 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 è 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 è in stato di inattività o in esecuzione.

PUT {batchUrl}/pools/{poolId}/nodes/{nodeId}/users/{userName}?api-version=2020-09-01.12.0
PUT {batchUrl}/pools/{poolId}/nodes/{nodeId}/users/{userName}?timeout={timeout}&api-version=2020-09-01.12.0

Parametri dell'URI

Name In Required Type Description
batchUrl
path True
  • string

URL di base per tutte le richieste Azure Batch servizio.

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 API client.

timeout
query
  • integer
int32

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

Intestazione della richiesta

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

Name Required Type Description
client-request-id
  • string
uuid

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

return-client-request-id
  • boolean

Indica se il server deve restituire client-request-id nella risposta.

ocp-date
  • string
date-time-rfc1123

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

Corpo della richiesta

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

Name Type Description
expiryTime
  • string

Ora di scadenza dell'account.
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 Windows). Per i nodi di calcolo Linux, la password può essere facoltativamente specificata 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, qualsiasi chiave pubblica SSH esistente viene rimossa.

Risposte

Name Type Description
200 OK

La richiesta al servizio Batch è riuscita.

Headers

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

Errore del servizio Batch.

Sicurezza

azure_auth

Azure Active Directory flusso OAuth2

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

Scopes

Name Description
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=2020-09-01.12.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "password": "12345",
  "expiryTime": "2016-11-27T00:45:48.7320857Z"
}

Sample Response

Definizioni

BatchError

Risposta di errore ricevuta dal Azure Batch servizio.

BatchErrorDetail

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

ErrorMessage

Messaggio di errore ricevuto in una risposta Azure Batch errore.

NodeUpdateUserParameter

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

BatchError

Risposta di errore ricevuta dal Azure Batch servizio.

Name Type Description
code
  • string

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

message

Messaggio che descrive l'errore, destinato alla visualizzazione in un'interfaccia utente.

values

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

BatchErrorDetail

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

Name Type Description
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 Azure Batch errore.

Name Type Description
lang
  • string

Codice lingua del messaggio di errore

value
  • string

Testo del messaggio.

NodeUpdateUserParameter

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

Name Type Description
expiryTime
  • string

Ora di scadenza dell'account.
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 Windows). Per i nodi di calcolo Linux, la password può essere facoltativamente specificata 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, qualsiasi chiave pubblica SSH esistente viene rimossa.