Compute Node - Add User

Service:

Batch Service

API Version:

2023-11-01.18.0

Dodaje konto użytkownika do określonego węzła obliczeniowego.
Konto użytkownika można dodać do węzła obliczeniowego tylko wtedy, gdy jest w stanie bezczynności lub uruchomienia.

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

With optional parameters:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
batchUrl	path	True	string	Podstawowy adres URL wszystkich żądań obsługi Azure Batch.
nodeId	path	True	string	Identyfikator komputera, na którym chcesz utworzyć konto użytkownika.
poolId	path	True	string	Identyfikator puli zawierającej węzeł obliczeniowy.
api-version	query	True	string	Wersja interfejsu API klienta.
timeout	query		integer int32	Maksymalny czas, który serwer może poświęcić na przetwarzanie żądania w sekundach. Wartość domyślna to 30 sekund.

Nagłówek żądania

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

Nazwa	Wymagane	Typ	Opis
client-request-id		string uuid	Tożsamość żądania wygenerowanego przez obiekt wywołujący w postaci identyfikatora GUID bez dekoracji, takiej jak nawiasy klamrowe, np. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Czy serwer powinien zwrócić wartość client-request-id w odpowiedzi.
ocp-date		string date-time-rfc1123	Czas wystawienia żądania. Biblioteki klienckie zazwyczaj ustawiają tę wartość na bieżący czas zegara systemowego; ustaw go jawnie, jeśli bezpośrednio wywołujesz interfejs API REST.

Treść żądania

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

Nazwa	Wymagane	Typ	Opis
name	True	string	Nazwa użytkownika konta.
expiryTime		string	Czas wygaśnięcia konta. Jeśli pominięto, wartość domyślna to 1 dzień od bieżącej godziny. W przypadku węzłów obliczeniowych systemu Linux wygaśnięcieTime ma precyzję do dnia.
isAdmin		boolean	Czy konto powinno być administratorem w węźle obliczeniowym. Wartość domyślna to false.
password		string	Hasło konta. Hasło jest wymagane dla węzłów obliczeniowych systemu Windows (utworzonych przy użyciu polecenia "cloudServiceConfiguration" lub utworzonego za pomocą polecenia "virtualMachineConfiguration" przy użyciu odwołania do obrazu systemu Windows). W przypadku węzłów obliczeniowych systemu Linux hasło można opcjonalnie określić wraz z właściwością sshPublicKey.
sshPublicKey		string	Klucz publiczny SSH, który może służyć do zdalnego logowania do węzła obliczeniowego. Klucz publiczny powinien być zgodny z kodowaniem OpenSSH i powinien być zakodowany w formacie base 64. Tę właściwość można określić tylko dla węzłów obliczeniowych systemu Linux. Jeśli jest to określone dla węzła obliczeniowego systemu Windows, usługa Batch odrzuca żądanie; jeśli bezpośrednio wywołujesz interfejs API REST, kod stanu HTTP to 400 (nieprawidłowe żądanie).

Odpowiedzi

Nazwa	Typ	Opis
201 Created		Żądanie usługi Batch zakończyło się pomyślnie. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Błąd usługi Batch.

Zabezpieczenia

azure_auth

Microsoft Entra przepływ kodu uwierzytelniania OAuth 2.0

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

Scopes

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Authorization

Type: apiKey
In: header

Przykłady

Node add user

Sample Request

HTTP

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



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

Sample Response

Status code:

201

Definicje

Nazwa	Opis
BatchError	Odpowiedź o błędzie odebrana z usługi Azure Batch.
BatchErrorDetail	Element dodatkowych informacji zawartych w odpowiedzi Azure Batch błędu.
ComputeNodeUser	Konto użytkownika na potrzeby dostępu RDP lub SSH w węźle obliczeniowym.
ErrorMessage	Komunikat o błędzie odebrany w odpowiedzi Azure Batch błędu.

BatchError

Odpowiedź o błędzie odebrana z usługi Azure Batch.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
message	ErrorMessage	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
values	BatchErrorDetail[]	Kolekcja par klucz-wartość zawierająca dodatkowe szczegóły dotyczące błędu.

BatchErrorDetail

Element dodatkowych informacji zawartych w odpowiedzi Azure Batch błędu.

Nazwa	Typ	Opis
key	string	Identyfikator określający znaczenie właściwości Value.
value	string	Dodatkowe informacje zawarte w odpowiedzi na błąd.

ComputeNodeUser

Konto użytkownika na potrzeby dostępu RDP lub SSH w węźle obliczeniowym.

Nazwa	Typ	Opis
expiryTime	string	Czas wygaśnięcia konta. Jeśli pominięto, wartość domyślna to 1 dzień od bieżącej godziny. W przypadku węzłów obliczeniowych systemu Linux wygaśnięcieTime ma precyzję do dnia.
isAdmin	boolean	Czy konto powinno być administratorem w węźle obliczeniowym. Wartość domyślna to false.
name	string	Nazwa użytkownika konta.
password	string	Hasło konta. Hasło jest wymagane dla węzłów obliczeniowych systemu Windows (utworzonych przy użyciu polecenia "cloudServiceConfiguration" lub utworzonego za pomocą polecenia "virtualMachineConfiguration" przy użyciu odwołania do obrazu systemu Windows). W przypadku węzłów obliczeniowych systemu Linux hasło można opcjonalnie określić wraz z właściwością sshPublicKey.
sshPublicKey	string	Klucz publiczny SSH, który może służyć do zdalnego logowania do węzła obliczeniowego. Klucz publiczny powinien być zgodny z kodowaniem OpenSSH i powinien być zakodowany w formacie base 64. Tę właściwość można określić tylko dla węzłów obliczeniowych systemu Linux. Jeśli jest to określone dla węzła obliczeniowego systemu Windows, usługa Batch odrzuca żądanie; jeśli bezpośrednio wywołujesz interfejs API REST, kod stanu HTTP to 400 (nieprawidłowe żądanie).

ErrorMessage

Komunikat o błędzie odebrany w odpowiedzi Azure Batch błędu.

Nazwa	Typ	Opis
lang	string	Kod języka komunikatu o błędzie
value	string	Tekst wiadomości.