Partilhar via

Remote Rendering - Create Session

  • Referência
Serviço:
Mixed Reality
Versão da API:
2021-01-01

Cria uma nova sessão de composição.

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

Parâmetros do URI

Name Em Necessário Tipo Description
account_id
 path True

string

uuid

O ID da conta do Azure Remote Rendering.
endpoint
 path True

string

O ponto final a utilizar, por exemplo, https://remoterendering.eastus.mixedreality.azure.com. Pode encontrar uma lista em https://docs.microsoft.com/azure/remote-rendering/reference/regions.
session_id
 path True

string

Um ID que identifica exclusivamente a sessão de composição da conta especificada. O ID é sensível às maiúsculas e minúsculas, pode conter qualquer combinação de carateres alfanuméricos, incluindo hífenes e carateres de sublinhado, e não pode conter mais de 256 carateres.
api-version
 query True

string

A versão da API a utilizar com o pedido HTTP.

Cabeçalho do Pedido

Name Necessário Tipo Description
Authorization True

string

Um token de portador devolvido pelo Mixed Reality Secure Token Service. Veja https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens para obter detalhes.

Corpo do Pedido

Name Necessário Tipo Description
maxLeaseTimeMinutes True

integer

O tempo em minutos em que a sessão será executada depois de atingir o estado "Pronto". Tem de estar entre 0 e 1440.
size True

session_size

O tamanho do servidor utilizado para a sessão de composição. O tamanho afeta o número de polígonos que o servidor pode compor. Veja para https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes obter detalhes.

Respostas

Name Tipo Description
200 OK

session_properties

OK. Indica que já havia uma sessão com as mesmas definições presentes. Isto é esperado quando a criação da sessão é repetida.
201 Created

session_properties

Criado. A sessão foi criada com êxito.

Cabeçalhos

MS-CV: string
400 Bad Request

error_response

Pedido Incorreto. O objeto de erro devolvido descreve os problemas ocorridos.

Cabeçalhos

MS-CV: string
401 Unauthorized

Não autorizado. Autorização em falta ou inválida.

Cabeçalhos

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

Proibido. Autorização insuficiente para determinado recurso.

Cabeçalhos

MS-CV: string
429 Too Many Requests

Demasiados Pedidos. O limite de taxa foi excedido. Repita o pedido após a duração indicada no cabeçalho Retry-After.

Cabeçalhos

  • MS-CV: string
  • Retry-After: integer
500 Internal Server Error

error_response

Erro Interno. O servidor encontrou um erro interno. Repetir o pedido pode produzir resultados bem-sucedidos.

Cabeçalhos

MS-CV: string
Other Status Codes

error_response

Conflito. Já existe uma sessão de composição com o ID para a conta de composição remota.

Segurança

Authorization

Um token de portador devolvido pelo Mixed Reality Secure Token Service. Veja https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens para obter detalhes.

Tipo: apiKey
Em: header

Exemplos

Create a rendering session

Pedido de amostra

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"
}

Resposta da amostra

Código de estado:
201 
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
}
Código de estado:
200 
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
}
Código de estado:
400 
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "error": {
    "code": "BadRequest",
    "message": "The request was malformed."
  }
}
Código de estado:
409 
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "error": {
    "code": "Conflict",
    "message": "A resource already exists under the given ID."
  }
}
Código de estado:
401 
WWW-Authenticate: Bearer error="invalid_token"
MS-CV: dKEFmka2kkSlDmp/af+sOw
Código de estado:
403 
MS-CV: dKEFmka2kkSlDmp/af+sOw
Código de estado:
429 
Retry-After: 15
MS-CV: dKEFmka2kkSlDmp/af+sOw
Código de estado:
500 
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "error": {
    "code": "InternalServerError",
    "message": "An internal server error occurred."
  }
}

Definições

Name Description
create_session_settings

Definições da sessão a criar.
error

O objeto de erro que contém detalhes do motivo pelo qual o pedido falhou.
error_response

A resposta de erro que contém detalhes do motivo pelo qual o pedido falhou.
session_properties

As propriedades de uma sessão de composição.
session_size

O tamanho do servidor utilizado para a sessão de composição. O tamanho afeta o número de polígonos que o servidor pode compor. Veja para https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes obter detalhes.
session_status

O estado da sessão de composição. Os estados dos terminais são "Erro", "Expirado" e "Parado".

create_session_settings

Definições da sessão a criar.

Name Tipo Description
maxLeaseTimeMinutes

integer

O tempo em minutos em que a sessão será executada depois de atingir o estado "Pronto". Tem de estar entre 0 e 1440.
size

session_size

O tamanho do servidor utilizado para a sessão de composição. O tamanho afeta o número de polígonos que o servidor pode compor. Veja para https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes obter detalhes.

error

O objeto de erro que contém detalhes do motivo pelo qual o pedido falhou.

Name Tipo Description
code

string

Código de erro.
details

error[]

Uma matriz de detalhes sobre erros específicos que levaram a este erro reportado.
innerError

error

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message

string

Uma representação legível por humanos do erro.
target

string

O destino do erro específico (por exemplo, o nome da propriedade em erro).

error_response

A resposta de erro que contém detalhes do motivo pelo qual o pedido falhou.

Name Tipo Description
error

error

O objeto de erro que contém detalhes do motivo pelo qual o pedido falhou.

session_properties

As propriedades de uma sessão de composição.

Name Tipo Description
arrInspectorPort

integer

A porta TCP na qual a ferramenta Inspetor de Remote Rendering do Azure está alojada.
creationTime

string

A hora em que a sessão de composição foi criada. Data e hora no formato ISO 8601.
elapsedTimeMinutes

integer

Quantidade de tempo em minutos em que a sessão está ou estava no estado "Pronto". O tempo é arredondado para um minuto inteiro.
error

error

O objeto de erro que contém detalhes sobre a falha de arranque da sessão de composição.
handshakePort

integer

A porta TCP utilizada para o handshake ao estabelecer uma ligação.
hostname

string

O nome do anfitrião no qual a sessão de composição está acessível.
id

string

O ID da sessão fornecida quando a sessão foi criada.
maxLeaseTimeMinutes

integer

O tempo em minutos em que a sessão será executada depois de atingir o estado "Pronto".
size

session_size

O tamanho do servidor utilizado para a sessão de composição. O tamanho afeta o número de polígonos que o servidor pode compor. Veja para https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes obter detalhes.
status

session_status

O estado da sessão de composição. Os estados dos terminais são "Erro", "Expirado" e "Parado".
teraflops

number

O poder computacional da GPU da sessão de composição medida em teraflops.

session_size

O tamanho do servidor utilizado para a sessão de composição. O tamanho afeta o número de polígonos que o servidor pode compor. Veja para https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes obter detalhes.

Name Tipo Description
Premium

string

Tamanho da sessão de composição Premium.
Standard

string

Tamanho da sessão de composição padrão.

session_status

O estado da sessão de composição. Os estados dos terminais são "Erro", "Expirado" e "Parado".

Name Tipo Description
Error

string

A sessão de composição encontrou um erro e é inutilizável. Este é um estado terminal.
Expired

string

A sessão de composição entra no estado "Expirado" quando está no estado "Pronto" há mais tempo do que o tempo de concessão. Este é um estado terminal.
Ready

string

A sessão de composição está pronta para ligações de entrada.
Starting

string

A sessão de composição está a começar, mas ainda não aceita ligações recebidas.
Stopped

string

A sessão de composição foi interrompida com a operação "Parar Sessão". Este é um estado terminal.