你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Compute Node - Get Remote Login Settings
获取远程登录到计算节点所需的设置。
必须先在计算节点上创建用户帐户,然后才能使用远程登录设置远程登录到计算节点。 只能在使用虚拟机配置属性创建的池上调用此 API。 有关使用云服务配置创建的池,请参阅 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 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
batch
|
path | True |
string |
所有Azure Batch服务请求的基 URL。 |
node
|
path | True |
string |
要为其获取远程登录设置的计算节点的 ID。 |
pool
|
path | True |
string |
包含计算节点的池的 ID。 |
api-version
|
query | True |
string |
客户端 API 版本。 |
timeout
|
query |
integer int32 |
服务器处理请求的最长时间(以秒为单位)。 默认为 30 秒。 |
请求头
Media Types: "application/json; odata=minimalmetadata"
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
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,请显式设置它。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
包含登录设置的响应。 标头
|
|
Other Status Codes |
Batch 服务中的错误。 |
安全性
azure_auth
Microsoft Entra OAuth 2.0 身份验证代码流
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
Authorization
类型:
apiKey
在:
header
示例
Node get remote login settings
示例请求
GET account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/remoteloginsettings?api-version=2023-11-01.18.0
示例响应
{
"remoteLoginIPAddress": "1.1.1.1",
"remoteLoginPort": 50000
}
定义
名称 | 说明 |
---|---|
Batch |
从Azure Batch服务收到的错误响应。 |
Batch |
Azure Batch错误响应中包含的其他信息项。 |
Compute |
计算节点的远程登录设置。 |
Error |
Azure Batch错误响应中收到的错误消息。 |
BatchError
从Azure Batch服务收到的错误响应。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误的标识符。 代码是固定的,旨在以编程方式使用。 |
message |
描述错误的消息,该消息适用于在用户界面中显示。 |
|
values |
包含有关错误的其他详细信息的键值对的集合。 |
BatchErrorDetail
Azure Batch错误响应中包含的其他信息项。
名称 | 类型 | 说明 |
---|---|---|
key |
string |
指定 Value 属性的含义的标识符。 |
value |
string |
错误响应附带的其他信息。 |
ComputeNodeGetRemoteLoginSettingsResult
计算节点的远程登录设置。
名称 | 类型 | 说明 |
---|---|---|
remoteLoginIPAddress |
string |
用于远程登录到计算节点的 IP 地址。 |
remoteLoginPort |
integer |
用于远程登录到计算节点的端口。 |
ErrorMessage
Azure Batch错误响应中收到的错误消息。
名称 | 类型 | 说明 |
---|---|---|
lang |
string |
错误消息的语言代码 |
value |
string |
消息的文本。 |