Compute Node - Update User

Service:

Batch Service

API Version:

2023-11-01.18.0

Uppdateringar lösenordet och förfallotiden för ett användarkonto på den angivna beräkningsnoden.
Den här åtgärden ersätter alla updatable-egenskaper för kontot. Om elementet expiryTime till exempel inte har angetts ersätts det aktuella värdet med standardvärdet och lämnas inte omodifierat. Du kan bara uppdatera ett användarkonto på en beräkningsnod när det är inaktivt eller körs.

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

With optional parameters:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
batchUrl	path	True	string	Bas-URL:en för alla Azure Batch tjänstbegäranden.
nodeId	path	True	string	ID:t för den dator där du vill uppdatera ett användarkonto.
poolId	path	True	string	ID:t för poolen som innehåller beräkningsnoden.
userName	path	True	string	Namnet på det användarkonto som ska uppdateras.
api-version	query	True	string	Klient-API-version.
timeout	query		integer int32	Den maximala tid som servern kan ägna åt att bearbeta begäran i sekunder. Standardvärdet är 30 sekunder.

Begärandehuvud

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

Name	Obligatorisk	Typ	Description
client-request-id		string uuid	Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Om servern ska returnera klient-request-id i svaret.
ocp-date		string date-time-rfc1123	Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till den aktuella systemklockatiden. ange det uttryckligen om du anropar REST-API:et direkt.

Begärandetext

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

Name	Typ	Description
expiryTime	string	Den tid då kontot ska upphöra att gälla. Om det utelämnas är standardvärdet 1 dag från den aktuella tiden. För Linux-beräkningsnoder har expiryTime en precision på upp till en dag.
password	string	Lösenordet för kontot. Lösenordet krävs för Windows-beräkningsnoder (de som skapats med "cloudServiceConfiguration" eller skapats med "virtualMachineConfiguration" med hjälp av en Windows-avbildningsreferens). För Linux-beräkningsnoder kan lösenordet anges tillsammans med egenskapen sshPublicKey. Om det utelämnas tas alla befintliga lösenord bort.
sshPublicKey	string	Den offentliga SSH-nyckeln som kan användas för fjärrinloggning till beräkningsnoden. Den offentliga nyckeln ska vara kompatibel med OpenSSH-kodning och ska vara base 64-kodad. Den här egenskapen kan endast anges för Linux-beräkningsnoder. Om detta anges för en Windows Compute-nod avvisar Batch-tjänsten begäran. om du anropar REST API direkt är HTTP-statuskoden 400 (felaktig begäran). Om den utelämnas tas alla befintliga offentliga SSH-nycklar bort.

Svar

Name	Typ	Description
200 OK		Begäran till Batch-tjänsten lyckades. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Felet från Batch-tjänsten.

Säkerhet

azure_auth

Microsoft Entra autentiseringskodflöde för OAuth 2.0

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

Scopes

Name	Description
user_impersonation	Personifiera ditt användarkonto

Authorization

Type: apiKey
In: header

Exempel

Node update user

Sample Request

HTTP

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



{
  "password": "12345",
  "expiryTime": "2016-11-27T00:45:48.7320857Z"
}

Sample Response

Status code:

200

Definitioner

Name	Description
BatchError	Ett felsvar som tagits emot från Azure Batch-tjänsten.
BatchErrorDetail	Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.
ErrorMessage	Ett felmeddelande som togs emot i ett Azure Batch felsvar.
NodeUpdateUserParameter	Den uppsättning ändringar som ska göras i ett användarkonto på en beräkningsnod.

BatchError

Ett felsvar som tagits emot från Azure Batch-tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
message	ErrorMessage	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
values	BatchErrorDetail[]	En samling nyckel/värde-par som innehåller ytterligare information om felet.

BatchErrorDetail

Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.

Name	Typ	Description
key	string	En identifierare som anger innebörden av egenskapen Value.
value	string	Den ytterligare information som ingår i felsvaret.

ErrorMessage

Ett felmeddelande som togs emot i ett Azure Batch felsvar.

Name	Typ	Description
lang	string	Språkkoden för felmeddelandet
value	string	Texten i meddelandet.

NodeUpdateUserParameter

Den uppsättning ändringar som ska göras i ett användarkonto på en beräkningsnod.

Name	Typ	Description
expiryTime	string	Den tid då kontot ska upphöra att gälla. Om det utelämnas är standardvärdet 1 dag från den aktuella tiden. För Linux-beräkningsnoder har expiryTime en precision på upp till en dag.
password	string	Lösenordet för kontot. Lösenordet krävs för Windows-beräkningsnoder (de som skapats med "cloudServiceConfiguration" eller skapats med "virtualMachineConfiguration" med hjälp av en Windows-avbildningsreferens). För Linux-beräkningsnoder kan lösenordet anges tillsammans med egenskapen sshPublicKey. Om det utelämnas tas alla befintliga lösenord bort.
sshPublicKey	string	Den offentliga SSH-nyckeln som kan användas för fjärrinloggning till beräkningsnoden. Den offentliga nyckeln ska vara kompatibel med OpenSSH-kodning och ska vara base 64-kodad. Den här egenskapen kan endast anges för Linux-beräkningsnoder. Om detta anges för en Windows Compute-nod avvisar Batch-tjänsten begäran. om du anropar REST API direkt är HTTP-statuskoden 400 (felaktig begäran). Om den utelämnas tas alla befintliga offentliga SSH-nycklar bort.