Compute Node - Add User

Service:

Batch Service

API Version:

2023-11-01.18.0

Hiermee voegt u een gebruikersaccount toe aan het opgegeven rekenknooppunt.
U kunt een gebruikersaccount alleen toevoegen aan een rekenknooppunt als het niet-actief of actief is.

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

URI-parameters

Name	In	Vereist	Type	Description
batchUrl	path	True	string	De basis-URL voor alle Azure Batch serviceaanvragen.
nodeId	path	True	string	De id van de computer waarop u een gebruikersaccount wilt maken.
poolId	path	True	string	De id van de pool die het rekenknooppunt bevat.
api-version	query	True	string	Client-API-versie.
timeout	query		integer int32	De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden.

Aanvraagkoptekst

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

Name	Vereist	Type	Description
client-request-id		string uuid	De door de aanroeper gegenereerde aanvraagidentiteit, in de vorm van een GUID zonder decoratie, zoals accolades, bijvoorbeeld 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Of de server de client-request-id in het antwoord moet retourneren.
ocp-date		string date-time-rfc1123	Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige systeemkloktijd; stel deze expliciet in als u de REST API rechtstreeks aanroept.

Aanvraagbody

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

Name	Vereist	Type	Description
name	True	string	De gebruikersnaam van het account.
expiryTime		string	Het tijdstip waarop het account moet verlopen. Als u dit weglaat, is de standaardwaarde 1 dag vanaf de huidige tijd. Voor Linux-rekenknooppunten heeft de expiryTime een precisie van maximaal één dag.
isAdmin		boolean	Of het account een beheerder moet zijn op het rekenknooppunt. De standaardwaarde is false.
password		string	Het wachtwoord van het account. Het wachtwoord is vereist voor Windows-rekenknooppunten (die zijn gemaakt met 'cloudServiceConfiguration' of die zijn gemaakt met 'virtualMachineConfiguration' met behulp van een Windows-installatiekopiereferentie). Voor Linux-rekenknooppunten kan het wachtwoord optioneel samen met de eigenschap sshPublicKey worden opgegeven.
sshPublicKey		string	De openbare SSH-sleutel die kan worden gebruikt voor externe aanmelding bij het rekenknooppunt. De openbare sleutel moet compatibel zijn met OpenSSH-codering en moet zijn gecodeerd met base 64. Deze eigenschap kan alleen worden opgegeven voor Linux-rekenknooppunten. Als dit is opgegeven voor een Windows-rekenknooppunt, weigert de Batch-service de aanvraag; Als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (ongeldige aanvraag).

Antwoorden

Name	Type	Description
201 Created		De aanvraag voor de Batch-service is geslaagd. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	De fout van de Batch-service.

Beveiliging

azure_auth

Microsoft Entra OAuth 2.0-verificatiecodestroom

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

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Authorization

Type: apiKey
In: header

Voorbeelden

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

Definities

Name	Description
BatchError	Een foutbericht ontvangen van de Azure Batch-service.
BatchErrorDetail	Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
ComputeNodeUser	Een gebruikersaccount voor RDP- of SSH-toegang op een rekenknooppunt.
ErrorMessage	Een foutbericht ontvangen in een Azure Batch foutbericht.

BatchError

Een foutbericht ontvangen van de Azure Batch-service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
message	ErrorMessage	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
values	BatchErrorDetail[]	Een verzameling sleutel-waardeparen met aanvullende informatie over de fout.

BatchErrorDetail

Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.

Name	Type	Description
key	string	Een id die de betekenis van de eigenschap Value aangeeft.
value	string	De aanvullende informatie die is opgenomen in de foutreactie.

ComputeNodeUser

Een gebruikersaccount voor RDP- of SSH-toegang op een rekenknooppunt.

Name	Type	Description
expiryTime	string	Het tijdstip waarop het account moet verlopen. Als u dit weglaat, is de standaardwaarde 1 dag vanaf de huidige tijd. Voor Linux-rekenknooppunten heeft de expiryTime een precisie van maximaal één dag.
isAdmin	boolean	Of het account een beheerder moet zijn op het rekenknooppunt. De standaardwaarde is false.
name	string	De gebruikersnaam van het account.
password	string	Het wachtwoord van het account. Het wachtwoord is vereist voor Windows-rekenknooppunten (die zijn gemaakt met 'cloudServiceConfiguration' of die zijn gemaakt met 'virtualMachineConfiguration' met behulp van een Windows-installatiekopiereferentie). Voor Linux-rekenknooppunten kan het wachtwoord optioneel samen met de eigenschap sshPublicKey worden opgegeven.
sshPublicKey	string	De openbare SSH-sleutel die kan worden gebruikt voor externe aanmelding bij het rekenknooppunt. De openbare sleutel moet compatibel zijn met OpenSSH-codering en moet zijn gecodeerd met base 64. Deze eigenschap kan alleen worden opgegeven voor Linux-rekenknooppunten. Als dit is opgegeven voor een Windows-rekenknooppunt, weigert de Batch-service de aanvraag; Als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (ongeldige aanvraag).

ErrorMessage

Een foutbericht ontvangen in een Azure Batch foutbericht.

Name	Type	Description
lang	string	De taalcode van het foutbericht
value	string	De tekst van het bericht.