Compute Node - Add User

Servizio:

Batch Service

Versione API:

2024-07-01.20.0

Aggiunge un account utente al nodo di calcolo specificato.
È possibile aggiungere un account utente a un nodo di calcolo solo quando si trova nello stato di inattività o in esecuzione.

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/users?api-version=2024-07-01.20.0

Con parametri facoltativi:

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/users?timeout={timeout}&api-version=2024-07-01.20.0

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
batchUrl	path	True	string	URL di base per tutte le richieste del servizio Azure Batch.
nodeId	path	True	string	ID del computer in cui si vuole creare un account utente.
poolId	path	True	string	ID del pool che contiene il nodo di calcolo.
api-version	query	True	string	Versione dell'API client.
timeout	query		integer (int32)	Tempo massimo di elaborazione della richiesta da parte del server, espresso in secondi. Il valore predefinito è 30 secondi. Se il valore è maggiore di 30, verrà usato il valore predefinito.

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 in genere impostano 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	Necessario	Tipo	Descrizione
name	True	string	Nome utente dell'account.
expiryTime		string (date-time)	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.
isAdmin		boolean	Indica se l'account deve essere un amministratore nel nodo di calcolo. Il valore predefinito è false.
password		string	Password dell'account. La password è necessaria per i nodi di calcolo Windows. Per i nodi di calcolo Linux, la password può essere specificata facoltativamente insieme alla proprietà sshPublicKey.
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).

Risposte

Nome	Tipo	Descrizione
201 Created		La richiesta al servizio Batch ha avuto esito positivo. Intestazioni 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

Flusso del codice di autenticazione di Microsoft Entra OAuth 2.0

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	Rappresentare l'account utente

Authorization

Tipo: apiKey
In: header

Esempio

Node add user

Esempio di richiesta

HTTP

POST account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/users?api-version=2024-07-01.20.0



{
  "name": "userName",
  "isAdmin": false,
  "expiryTime": "2017-08-01T00:00:00Z",
  "password": "Password"
}

Risposta di esempio

Codice di stato:

201

Definizioni

Nome	Descrizione
BatchError	Risposta di errore ricevuta dal servizio Azure Batch.
BatchErrorDetail	Elemento di informazioni aggiuntive incluse in una risposta di errore di Azure Batch.
ComputeNodeUser	Un account utente per l'accesso RDP o SSH in un nodo di calcolo.
ErrorMessage	Messaggio di errore ricevuto in una risposta di errore di Azure Batch.

BatchError

Object

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, destinato a essere adatto per la visualizzazione in un'interfaccia utente.
values	BatchErrorDetail[]	Raccolta di coppie chiave-valore contenenti dettagli aggiuntivi sull'errore.

BatchErrorDetail

Object

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

Nome	Tipo	Descrizione
key	string	Identificatore che specifica il significato della proprietà Value.
value	string	Informazioni aggiuntive incluse nella risposta di errore.

ComputeNodeUser

Object

Un account utente per l'accesso RDP o SSH in un nodo di calcolo.

Nome	Tipo	Descrizione
expiryTime	string (date-time)	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.
isAdmin	boolean	Indica se l'account deve essere un amministratore nel nodo di calcolo. Il valore predefinito è false.
name	string	Nome utente dell'account.
password	string	Password dell'account. La password è necessaria per i nodi di calcolo Windows. Per i nodi di calcolo Linux, la password può essere specificata facoltativamente insieme alla proprietà sshPublicKey.
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).

ErrorMessage

Object

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

Nome	Tipo	Descrizione
lang	string	Codice linguistico del messaggio di errore
value	string	Testo del messaggio.