Dela via


Compute Node - Get Remote Login Settings

Hämtar de inställningar som krävs för fjärrinloggning till en beräkningsnod.
Innan du kan fjärrinlogga till en beräkningsnod med hjälp av inställningarna för fjärrinloggning måste du skapa ett användarkonto på beräkningsnoden.

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/remoteloginsettings?api-version=2024-07-01.20.0
GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/remoteloginsettings?timeout={timeout}&api-version=2024-07-01.20.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 beräkningsnoden för vilken du kan hämta inställningarna för fjärrinloggning.

poolId
path True

string

ID:t för poolen som innehåller beräkningsnoden.

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. Om värdet är större än 30 används standardvärdet i stället.

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 explicit om du anropar REST-API:et direkt.

Svar

Name Typ Description
200 OK

ComputeNodeGetRemoteLoginSettingsResult

Ett svar som innehåller inloggningsinställningarna.

Sidhuvuden

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

BatchError

Felet från Batch-tjänsten.

Säkerhet

azure_auth

Autentiseringskodflöde för Microsoft Entra OAuth 2.0

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation Personifiera ditt användarkonto

Authorization

Typ: apiKey
I: header

Exempel

Node get remote login settings

Exempelbegäran

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


Exempelsvar

{
  "remoteLoginIPAddress": "1.1.1.1",
  "remoteLoginPort": 50000
}

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.

ComputeNodeGetRemoteLoginSettingsResult

Inställningarna för fjärrinloggning för en beräkningsnod.

ErrorMessage

Ett felmeddelande som togs emot i ett Azure Batch-felsvar.

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.

ComputeNodeGetRemoteLoginSettingsResult

Inställningarna för fjärrinloggning för en beräkningsnod.

Name Typ Description
remoteLoginIPAddress

string

IP-adressen som används för fjärrinloggning till beräkningsnoden.

remoteLoginPort

integer

Porten som används för fjärrinloggning till beräkningsnoden.

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.