Delen via

Nodes - Create Node User

Service:
Batch Service
API-versie:
2025-06-01

Voegt een gebruikersaccount toe aan de opgegeven Compute Node.
Je kunt een gebruikersaccount alleen toevoegen aan een Compute Node als deze in de idle of running state is. Voordat je op afstand kunt inloggen op een Compute Node, moet je toegangspoorten configureren voor SSH en RDP. Zie https://learn.microsoft.com/azure/batch/pool-endpoint-configuration voor meer informatie

POST {endpoint}/pools/{poolId}/nodes/{nodeId}/users?api-version=2025-06-01
Met optionele parameters: 
POST {endpoint}/pools/{poolId}/nodes/{nodeId}/users?api-version=2025-06-01&timeOut={timeOut}

URI-parameters

Name In Vereist Type Description
endpoint
 path True

string (uri)

Batch-accounteindpunt (bijvoorbeeld: https://batchaccount.eastus2.batch.azure.com).
nodeId
 path True

string

De ID van de machine waarop je een gebruikersaccount wilt aanmaken.
poolId
 path True

string

De id van de pool die het rekenknooppunt bevat.
api-version
 query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.
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. Als de waarde groter is dan 30, wordt de standaard in plaats daarvan gebruikt."

Aanvraagkoptekst

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

Name Vereist Type Description
client-request-id

string

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 clientaanvraag-id in het antwoord moet retourneren.
ocp-date

string (date-time-rfc7231)

Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige kloktijd van het systeem; 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 (date-time)

Het tijdstip waarop de rekening zou moeten verlopen. Als het wordt weggelaten, is de standaard 1 dag vanaf het huidige tijdstip. Voor Linux Compute Nodes heeft de expiryTime een precisie tot een dag.
isAdmin

boolean

Of het account een beheerder op de Compute Node moet zijn. De standaardwaarde is onwaar.
password

string (password)

Het wachtwoord van het account. Het wachtwoord is vereist voor Windows Compute Nodes. Voor Linux Compute Nodes kan het wachtwoord optioneel worden opgegeven samen met de eigenschap sshPublicKey.
sshPublicKey

string

De SSH publieke sleutel die gebruikt kan worden voor remote login op de Compute Node. De publieke sleutel moet compatibel zijn met OpenSSH-codering en moet basis 64 gecodeerd zijn. Deze eigenschap kan alleen worden gespecificeerd voor Linux Compute Nodes. Als dit is gespecificeerd voor een Windows Compute Node, dan wijst de Batch-service het verzoek af; als je de REST API direct aanroept, is de HTTP-statuscode 400 (Bad Request).

Antwoorden

Name Type Description
201 Created

De aanvraag is geslaagd en er is een nieuwe resource gemaakt.

Kopteksten

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

BatchError

Een onverwachte foutreactie.

Beveiliging

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiken

Name Description
https://batch.core.windows.net//.default

Voorbeelden

Node create user

Voorbeeldaanvraag

POST {endpoint}/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/users?api-version=2025-06-01



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

Voorbeeldrespons

Statuscode:
201

Definities

Name Description
BatchError

Er is een foutbericht ontvangen van de Azure Batch-service.
BatchErrorDetail

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

Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.
BatchNodeUserCreateOptions

Parameters voor het maken van een gebruikersaccount voor RDP- of SSH-toegang op een Azure Batch Compute-knooppunt.

BatchError

Object

Er is 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

BatchErrorMessage

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

Object

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 Waarde aangeeft.
value

string

De aanvullende informatie die is opgenomen in het foutbericht.

BatchErrorMessage

Object

Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.

Name Type Description
lang

string

De taalcode van het foutbericht.
value

string

De tekst van het bericht.

BatchNodeUserCreateOptions

Object

Parameters voor het maken van een gebruikersaccount voor RDP- of SSH-toegang op een Azure Batch Compute-knooppunt.

Name Type Description
expiryTime

string (date-time)

Het tijdstip waarop de rekening zou moeten verlopen. Als het wordt weggelaten, is de standaard 1 dag vanaf het huidige tijdstip. Voor Linux Compute Nodes heeft de expiryTime een precisie tot een dag.
isAdmin

boolean

Of het account een beheerder op de Compute Node moet zijn. De standaardwaarde is onwaar.
name

string

De gebruikersnaam van het account.
password

string (password)

Het wachtwoord van het account. Het wachtwoord is vereist voor Windows Compute Nodes. Voor Linux Compute Nodes kan het wachtwoord optioneel worden opgegeven samen met de eigenschap sshPublicKey.
sshPublicKey

string

De SSH publieke sleutel die gebruikt kan worden voor remote login op de Compute Node. De publieke sleutel moet compatibel zijn met OpenSSH-codering en moet basis 64 gecodeerd zijn. Deze eigenschap kan alleen worden gespecificeerd voor Linux Compute Nodes. Als dit is gespecificeerd voor een Windows Compute Node, dan wijst de Batch-service het verzoek af; als je de REST API direct aanroept, is de HTTP-statuscode 400 (Bad Request).