Compute Node - Get Remote Login Settings
Ruft die Einstellungen ab, die für die Remoteanmeldung bei einem Computeknoten erforderlich sind.
Bevor Sie sich über die Remoteanmeldungseinstellungen bei einem Computeknoten anmelden können, müssen Sie ein Benutzerkonto auf dem Computeknoten erstellen. Diese API kann nur für Pools aufgerufen werden, die mit der Konfigurationseigenschaft des virtuellen Computers erstellt wurden. Informationen zu Pools, die mit einer Clouddienstkonfiguration erstellt wurden, finden Sie unter GetRemoteDesktop-API.
GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/remoteloginsettings?api-version=2023-11-01.18.0
GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/remoteloginsettings?timeout={timeout}&api-version=2023-11-01.18.0
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
batch
|
path | True |
string |
Die Basis-URL für alle Azure Batch-Dienstanforderungen. |
node
|
path | True |
string |
Die ID des Computeknotens, für den die Remoteanmeldungseinstellungen abgerufen werden sollen. |
pool
|
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 aufwenden kann. Der Standardwert ist 30 Sekunden. |
Anforderungsheader
Media Types: "application/json; odata=minimalmetadata"
Name | Erforderlich | 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 client-request-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 |
Eine Antwort mit den Anmeldeeinstellungen. Headers
|
|
Other Status Codes |
Der Fehler vom Batch-Dienst. |
Sicherheit
azure_auth
Microsoft Entra OAuth 2.0-Authentifizierungscodeflow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Authorization
Type:
apiKey
In:
header
Beispiele
Node get remote login settings
Sample Request
GET account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/remoteloginsettings?api-version=2023-11-01.18.0
Sample Response
{
"remoteLoginIPAddress": "1.1.1.1",
"remoteLoginPort": 50000
}
Definitionen
Name | Beschreibung |
---|---|
Batch |
Eine Vom Azure Batch-Dienst empfangene Fehlerantwort. |
Batch |
Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind. |
Compute |
Die Remoteanmeldungseinstellungen für einen Computeknoten. |
Error |
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 sollten programmgesteuert verwendet werden. |
message |
Eine Meldung, die den Fehler beschreibt, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll. |
|
values |
Eine Auflistung von Schlüssel-Wert-Paaren mit zusätzlichen Details zum Fehler. |
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. |
ComputeNodeGetRemoteLoginSettingsResult
Die Remoteanmeldungseinstellungen für einen Computeknoten.
Name | Typ | Beschreibung |
---|---|---|
remoteLoginIPAddress |
string |
Die IP-Adresse, die für die Remoteanmeldung beim Computeknoten verwendet wird. |
remoteLoginPort |
integer |
Der Port, der für die Remoteanmeldung beim Computeknoten verwendet wird. |
ErrorMessage
Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wurde.
Name | Typ | Beschreibung |
---|---|---|
lang |
string |
Der Sprachcode der Fehlermeldung |
value |
string |
Der Text der Meldung. |