你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Remote Rendering - Create Session

创建新的呈现会话。

PUT {endpoint}/accounts/{account_id}/sessions/{session_id}?api-version=2021-01-01

URI 参数

Name In Required Type Description
account_id
path True
  • string
uuid

Azure 远程渲染帐户 ID。

endpoint
path True
  • string

要使用的终结点,例如 https://remoterendering.eastus.mixedreality.azure.com。 A list can be found at https://docs.microsoft.com/azure/remote-rendering/reference/regions.

session_id
path True
  • string

唯一标识给定帐户的呈现会话的 ID。 ID 区分大小写,可以包含字母数字字符(包括连字符和下划线)的任意组合,并且不能包含超过 256 个字符。

api-version
query True
  • string

要与 HTTP 请求一起使用的 API 版本。

请求头

Name Required Type Description
Authorization True
  • string

混合现实安全令牌服务返回的持有者令牌。 有关详细信息,请参阅https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens

请求正文

Name Required Type Description
maxLeaseTimeMinutes True
  • integer

会话到达“就绪”状态后,会话运行的时间(以分钟为单位)。 它必须介于 0 到 1440 之间。

size True

用于呈现会话的服务器的大小。 大小会影响服务器可以呈现的多边形数。 请参阅 https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes 了解详细信息。

响应

Name Type Description
200 OK

没问题。 指示已存在具有相同设置的会话。 重试会话创建时,预期会出现这种情况。

201 Created

Created. 已成功创建会话。

Headers

  • MS-CV: string
400 Bad Request

错误的请求。 返回的错误对象描述发生的问题。

Headers

  • MS-CV: string
401 Unauthorized

未授权。 缺少或无效的授权。

Headers

  • MS-CV: string
  • WWW-Authenticate: string
403 Forbidden

已禁止。 给定资源的授权不足。

Headers

  • MS-CV: string
500 Internal Server Error

内部错误。 服务器遇到内部错误。 重试请求可能会产生成功的结果。

Headers

  • MS-CV: string
Other Status Codes

冲突。 远程呈现帐户已存在 ID 的呈现会话。

Other Status Codes

请求过多。 已超出速率限制。 在Retry-After标头中给定的持续时间之后重试请求。

Headers

  • MS-CV: string
  • Retry-After: integer

安全性

Authorization

混合现实安全令牌服务返回的持有者令牌。 有关详细信息,请参阅https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens

Type: apiKey
In: header

示例

Create a rendering session

Sample Request

PUT https://remoterendering.eastus.mixedreality.azure.com/accounts/30ea64bd-100f-4bf0-adc9-29fa45d4880c/sessions/contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28?api-version=2021-01-01

{
  "maxLeaseTimeMinutes": 60,
  "size": "Standard"
}

Sample Response

MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
  "creationTime": "2020-11-11T11:11:11.111Z",
  "maxLeaseTimeMinutes": 60,
  "size": "Standard",
  "status": "Starting",
  "error": null
}
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
  "creationTime": "2020-11-11T11:11:11.111Z",
  "maxLeaseTimeMinutes": 60,
  "size": "Standard",
  "status": "Starting",
  "error": null
}
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "error": {
    "code": "BadRequest",
    "message": "The request was malformed."
  }
}
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "error": {
    "code": "Conflict",
    "message": "A resource already exists under the given ID."
  }
}
WWW-Authenticate: Bearer error="invalid_token"
MS-CV: dKEFmka2kkSlDmp/af+sOw
MS-CV: dKEFmka2kkSlDmp/af+sOw
Retry-After: 15
MS-CV: dKEFmka2kkSlDmp/af+sOw
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "error": {
    "code": "InternalServerError",
    "message": "An internal server error occurred."
  }
}

定义

create_session_settings

要创建的会话设置。

error

包含请求失败原因的详细信息的错误对象。

error_response

错误响应包含请求失败原因的详细信息。

session_properties

呈现会话的属性。

session_size

用于呈现会话的服务器的大小。 大小会影响服务器可以呈现的多边形数。 请参阅 https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes 了解详细信息。

session_status

呈现会话的状态。 终端状态为“Error”、“Expired”和“Stopped”。

create_session_settings

要创建的会话设置。

Name Type Description
maxLeaseTimeMinutes
  • integer

会话到达“就绪”状态后,会话运行的时间(以分钟为单位)。 它必须介于 0 到 1440 之间。

size

用于呈现会话的服务器的大小。 大小会影响服务器可以呈现的多边形数。 请参阅 https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes 了解详细信息。

error

包含请求失败原因的详细信息的错误对象。

Name Type Description
code
  • string

错误代码。

details

导致此报告错误的特定错误的详细信息数组。

innerError

包含与当前对象有关错误的更具体信息的对象。

message
  • string

错误的人工可读表示形式。

target
  • string

特定错误的目标 (例如错误) 属性的名称。

error_response

错误响应包含请求失败原因的详细信息。

Name Type Description
error

包含请求失败原因的详细信息的错误对象。

session_properties

呈现会话的属性。

Name Type Description
arrInspectorPort
  • integer

托管 Azure 远程渲染 检查器工具的 TCP 端口。

creationTime
  • string

创建呈现会话的时间。 ISO 8601 格式的日期和时间。

elapsedTimeMinutes
  • integer

会话处于“就绪”状态或处于“就绪”状态的时间(以分钟为单位)。 时间向下舍入为整分钟。

error

包含有关呈现会话启动失败的详细信息的错误对象。

handshakePort
  • integer

建立连接时用于握手的 TCP 端口。

hostname
  • string

可访问呈现会话的主机名。

id
  • string

创建会话时提供的会话 ID。

maxLeaseTimeMinutes
  • integer

会话到达“就绪”状态后,会话运行的时间(以分钟为单位)。

size

用于呈现会话的服务器的大小。 大小会影响服务器可以呈现的多边形数。 请参阅 https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes 了解详细信息。

status

呈现会话的状态。 终端状态为“Error”、“Expired”和“Stopped”。

teraflops
  • number

以 teraflops 度量的呈现会话 GPU 的计算能力。

session_size

用于呈现会话的服务器的大小。 大小会影响服务器可以呈现的多边形数。 请参阅 https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes 了解详细信息。

Name Type Description
Premium
  • string

高级版呈现会话大小。

Standard
  • string

标准呈现会话大小。

session_status

呈现会话的状态。 终端状态为“Error”、“Expired”和“Stopped”。

Name Type Description
Error
  • string

呈现会话遇到错误,并且不可用。 这是终端状态。

Expired
  • string

呈现会话在处于“就绪”状态超过其租约时间时进入“已过期”状态。 这是终端状态。

Ready
  • string

呈现会话已准备好用于传入连接。

Starting
  • string

呈现会话正在启动,但尚未接受传入连接。

Stopped
  • string

呈现会话已停止,并执行“停止会话”操作。 这是终端状态。