Freigeben über

Nodes - Get Node Remote Login Settings

Dienst:
Batch Service
API-Version:
2025-06-01

Erhält die erforderlichen Einstellungen für die Fernanmeldung zu einem Compute-Knoten.
Bevor Sie sich mit den Remote-Login-Einstellungen aus der Ferne bei einem Compute-Node anmelden können, müssen Sie ein Benutzerkonto auf dem Compute-Node erstellen und Zugriffsportarten für SSH und RDP konfigurieren. Weitere Informationen finden Sie unter https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

GET {endpoint}/pools/{poolId}/nodes/{nodeId}/remoteloginsettings?api-version=2025-06-01
Mit optionalen Parametern: 
GET {endpoint}/pools/{poolId}/nodes/{nodeId}/remoteloginsettings?api-version=2025-06-01&timeOut={timeOut}

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
 path True

string (uri)

Batchkontoendpunkt (z. B. https://batchaccount.eastus2.batch.azure.com).
nodeId
 path True

string

Die ID des Compute-Knotens, für den die Remote-Login-Einstellungen erhalten werden.
poolId
 path True

string

Die ID des Pools, der den Computeknoten enthält.
api-version
 query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.
timeOut
 query

integer (int32)

Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden ausgeben kann. Der Standardwert ist 30 Sekunden. Ist der Wert größer als 30, wird stattdessen der Standard verwendet."

Anforderungsheader

Name Erforderlich Typ Beschreibung
client-request-id

string

Die vom Aufrufer generierte Anforderungsidentität in Form einer GUID ohne Dekoration wie geschweifte Klammern, z. B. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Gibt an, ob der Server die Clientanforderungs-ID in der Antwort zurückgeben soll.
ocp-date

string (date-time-rfc7231)

Der Zeitpunkt, zu dem die Anforderung ausgestellt wurde. Clientbibliotheken legen dies in der Regel auf die aktuelle Systemuhrzeit fest. legen Sie sie explizit fest, wenn Sie die REST-API direkt aufrufen.

Antworten

Name Typ Beschreibung
200 OK

BatchNodeRemoteLoginSettings

Die Anforderung ist erfolgreich.

Header

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

BatchError

Unerwartete Fehlerantwort.

Sicherheit

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiche

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

Beispiele

Get batch node Dual Stack Networking Remote
Node get remote login settings

Get batch node Dual Stack Networking Remote

Beispielanforderung

GET {endpoint}/pools/dualstackpool/nodes/tvmps_5d8adec89961dcc011329b38df999a841f6cc815a5710678b741f04b33556ed2_d/remoteloginsettings?api-version=2025-06-01

Beispiel für eine Antwort

Statuscode:
200 
{
  "remoteLoginIPAddress": "１.1.1.1",
  "remoteLoginPort": 40000,
  "ipv6RemoteLoginIPAddress": "fd00::1",
  "ipv6RemoteLoginPort": 40000
}

Node get remote login settings

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
BatchError

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
BatchErrorDetail

Ein Element mit zusätzlichen Informationen, die in einer Azure Batch-Fehlerantwort enthalten sind.
BatchErrorMessage

Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.
BatchNodeRemoteLoginSettings

Die Remoteanmeldungseinstellungen für einen Computeknoten.

BatchError

Objekt

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.

Name Typ Beschreibung
code

string

Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
message

BatchErrorMessage

Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
values

BatchErrorDetail[]

Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthalten.

BatchErrorDetail

Objekt

Ein Element mit zusätzlichen Informationen, die in einer Azure Batch-Fehlerantwort enthalten sind.

Name Typ Beschreibung
key

string

Ein Bezeichner, der die Bedeutung der Value-Eigenschaft angibt.
value

string

Die zusätzlichen Informationen, die in der Fehlerantwort enthalten sind.

BatchErrorMessage

Objekt

Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.

Name Typ Beschreibung
lang

string

Der Sprachcode der Fehlermeldung.
value

string

Der Text der Nachricht.

BatchNodeRemoteLoginSettings

Objekt

Die Remoteanmeldungseinstellungen für einen Computeknoten.

Name Typ Beschreibung
ipv6RemoteLoginIPAddress

string

Die IPv6-Adresse, die für die Remote-Anmeldung am Compute Node verwendet wird.
ipv6RemoteLoginPort

integer (int32)

Der Port, der für die Remoteanmeldung beim Computeknoten verwendet wird.
remoteLoginIPAddress

string

Die IP-Adresse, die für die Remoteanmeldung beim Computeknoten verwendet wird.
remoteLoginPort

integer (int32)

Der Port, der für die Remoteanmeldung beim Computeknoten verwendet wird.