Compute Node - Get Remote Login Settings

Referenz

Dienst:: Batch Service

API-Version:: 2024-07-01.20.0

Ruft die Einstellungen ab, die für die Remoteanmeldung bei einem Computeknoten erforderlich sind.
Bevor Sie sich mithilfe der Remoteanmeldungseinstellungen remote bei einem Computeknoten anmelden können, müssen Sie ein Benutzerkonto auf dem Computeknoten erstellen.

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/remoteloginsettings?api-version=2024-07-01.20.0

Mit optionalen Parametern:

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/remoteloginsettings?timeout={timeout}&api-version=2024-07-01.20.0

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
batchUrl	path	True	string	Die Basis-URL für alle Azure Batch-Dienstanforderungen.
nodeId	path	True	string	Die ID des Computeknotens, für den die Remoteanmeldungseinstellungen ermittelt werden sollen.
poolId	path	True	string	Die ID des Pools, der den Computeknoten enthält.
api-version	query	True	string	Client-API-Version.
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. Wenn der Wert größer als 30 ist, wird stattdessen der Standardwert verwendet.

Anforderungsheader

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

Name	Typ	Beschreibung
client-request-id	string uuid	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-rfc1123	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	ComputeNodeGetRemoteLoginSettingsResult	Eine Antwort, die die Anmeldeeinstellungen enthält. Header client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Der Fehler vom Batchdienst.

Name

Typ

Beschreibung

200 OK

ComputeNodeGetRemoteLoginSettingsResult

Eine Antwort, die die Anmeldeeinstellungen enthält.

Header

client-request-id: string
request-id: string
ETag: string
Last-Modified: string

Other Status Codes

BatchError

Der Fehler vom Batchdienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodefluss

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Authorization

Typ: apiKey
In: header

Beispiele

Beispielanforderung

HTTP

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

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.
ComputeNodeGetRemoteLoginSettingsResult	Die Remoteanmeldungseinstellungen für einen Computeknoten.
ErrorMessage	Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.

BatchError

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	ErrorMessage	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

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.