Compute Node - Get Remote Login Settings

Referentie

Service:: Batch Service

API Version:: 2023-11-01.18.0

Hiermee worden de instellingen opgehaald die vereist zijn voor externe aanmelding bij een rekenknooppunt.
Voordat u zich op afstand kunt aanmelden bij een rekenknooppunt met behulp van de instellingen voor externe aanmelding, moet u een gebruikersaccount maken op het rekenknooppunt. Deze API kan alleen worden aangeroepen voor pools die zijn gemaakt met de configuratie-eigenschap van de virtuele machine. Zie de GetRemoteDesktop-API voor pools die zijn gemaakt met een cloudserviceconfiguratie.

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/remoteloginsettings?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/remoteloginsettings?timeout={timeout}&api-version=2023-11-01.18.0

URI-parameters

Name	In	Vereist	Type	Description
batchUrl	path	True	string	De basis-URL voor alle Azure Batch serviceaanvragen.
nodeId	path	True	string	De id van het rekenknooppunt waarvoor de instellingen voor externe aanmelding moeten worden opgehaald.
poolId	path	True	string	De id van de pool die het rekenknooppunt bevat.
api-version	query	True	string	Client-API-versie.
timeout	query		integer int32	De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden.

Aanvraagkoptekst

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

Name	Type	Description
client-request-id	string uuid	De door de aanroeper gegenereerde aanvraagidentiteit, in de vorm van een GUID zonder decoratie, zoals accolades, bijvoorbeeld 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Of de server de client-request-id in het antwoord moet retourneren.
ocp-date	string date-time-rfc1123	Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige systeemkloktijd; stel deze expliciet in als u de REST API rechtstreeks aanroept.

Antwoorden

Name	Type	Description
200 OK	ComputeNodeGetRemoteLoginSettingsResult	Een antwoord met de aanmeldingsinstellingen. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	De fout van de Batch-service.

Name

Type

Description

200 OK

ComputeNodeGetRemoteLoginSettingsResult

Een antwoord met de aanmeldingsinstellingen.

Headers

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

Other Status Codes

BatchError

De fout van de Batch-service.

Beveiliging

azure_auth

Microsoft Entra OAuth 2.0-verificatiecodestroom

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

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Authorization

Type: apiKey
In: header

Voorbeelden

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Definities

Name	Description
BatchError	Een foutbericht ontvangen van de Azure Batch-service.
BatchErrorDetail	Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
ComputeNodeGetRemoteLoginSettingsResult	De instellingen voor externe aanmelding voor een rekenknooppunt.
ErrorMessage	Een foutbericht ontvangen in een Azure Batch foutbericht.

BatchError

Een foutbericht ontvangen van de Azure Batch-service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
message	ErrorMessage	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
values	BatchErrorDetail[]	Een verzameling sleutel-waardeparen met aanvullende informatie over de fout.

BatchErrorDetail

Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.

Name	Type	Description
key	string	Een id die de betekenis van de eigenschap Value aangeeft.
value	string	De aanvullende informatie die is opgenomen in de foutreactie.