Compute Node - Get Remote Login Settings

Ссылка

Service:: Batch Service

API Version:: 2022-01-01.15.0

Возвращает параметры, необходимые для удаленного входа в вычислительный узел.
Прежде чем удаленно войти в вычислительный узел с помощью параметров удаленного входа, необходимо создать учетную запись пользователя на вычислительном узле. Этот API можно вызывать только в пулах, созданных со свойством конфигурации виртуальной машины. Сведения о пулах, созданных с помощью конфигурации облачной службы, см. в api GetRemoteDesktop.

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/remoteloginsettings?api-version=2022-01-01.15.0

With optional parameters:

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/remoteloginsettings?timeout={timeout}&api-version=2022-01-01.15.0

Параметры URI

Name	In	Required	Type	Description
batchUrl	path	True	string	Базовый URL-адрес для всех запросов на обслуживание пакетная служба Azure.
nodeId	path	True	string	Идентификатор вычислительного узла, для которого необходимо получить параметры удаленного входа.
poolId	path	True	string	Идентификатор пула, содержащего вычислительный узел.
api-version	query	True	string	Версия КЛИЕНТСКОго API.
timeout	query		integer int32	Максимальное время, затрачивается сервером на обработку запроса в секундах. По умолчанию это 30 секунд.

Заголовок запроса

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

Name	Type	Description
client-request-id	string uuid	Удостоверение запроса, созданное вызывающим абонентом, в виде GUID без оформления, например фигурных скобок, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Должен ли сервер возвращать идентификатор client-request-id в ответе.
ocp-date	string date-time-rfc1123	Время выдачи запроса. Клиентские библиотеки обычно задают для текущего системного времени часов; задайте его явным образом, если вы вызываете REST API напрямую.

Ответы

Name	Type	Description
200 OK	ComputeNodeGetRemoteLoginSettingsResult	Ответ, содержащий параметры входа. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Ошибка пакетной службы.

Name

Type

Description

200 OK

ComputeNodeGetRemoteLoginSettingsResult

Ответ, содержащий параметры входа.

Headers

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

Other Status Codes

BatchError

Ошибка пакетной службы.

Безопасность

azure_auth

Flow OAuth2 Azure Active Directory

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

Scopes

Name	Description
user_impersonation	Олицетворение учетной записи пользователя

Authorization

Type: apiKey
In: header

Примеры

Sample Request

HTTP

GET account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/remoteloginsettings?api-version=2022-01-01.15.0

Sample Response

Status code:: 200

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

Определения

BatchError	Ответ об ошибке, полученный от службы пакетная служба Azure.
BatchErrorDetail	Элемент дополнительных сведений, включенных в ответ на ошибку пакетная служба Azure.
ComputeNodeGetRemoteLoginSettingsResult	Параметры удаленного входа для вычислительного узла.
ErrorMessage	Сообщение об ошибке, полученное в ответе на ошибку пакетная служба Azure.

BatchError

Ответ об ошибке, полученный от службы пакетная служба Azure.

Name	Type	Description
code	string	Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.
message	ErrorMessage	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
values	BatchErrorDetail[]	Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

Элемент дополнительных сведений, включенных в ответ на ошибку пакетная служба Azure.

Name	Type	Description
key	string	Идентификатор, указывающий значение свойства Value.
value	string	Дополнительные сведения, включенные в ответ на ошибку.