Compartilhar via

Remote Rendering - Create Session

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

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

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
account_id
 path True

string

uuid

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

string

O ponto de extremidade a ser usado, por exemplo, https://remoterendering.eastus.mixedreality.azure.com. Uma lista pode ser encontrada em https://docs.microsoft.com/azure/remote-rendering/reference/regions.
session_id
 path True

string

Uma ID que identifica exclusivamente a sessão de renderização da conta fornecida. A ID diferencia maiúsculas de minúsculas, pode conter qualquer combinação de caracteres alfanuméricos, incluindo hifens e sublinhados, e não pode conter mais de 256 caracteres.
api-version
 query True

string

A versão da API a ser usada com a solicitação HTTP.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
Authorization True

string

Um token de portador retornado pelo serviço de token seguro Realidade Misturada. Para obter detalhes, consulte https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Corpo da solicitação

Nome Obrigatório Tipo Description
maxLeaseTimeMinutes True

integer

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

session_size

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

Respostas

Nome Tipo Description
200 OK

session_properties

OK. Indica que já havia uma sessão com as mesmas configurações presentes. Isso é 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

Solicitação inválida. O objeto de erro retornado descreve quais problemas ocorreram.

Cabeçalhos

MS-CV: string
401 Unauthorized

Não autorizado. Autorização ausente ou inválida.

Cabeçalhos

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

Negado. Autorização insuficiente para determinado recurso.

Cabeçalhos

MS-CV: string
429 Too Many Requests

Excesso de solicitações. O limite de taxa foi excedido. Repita a solicitação após a duração fornecida 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 a solicitação pode produzir resultados bem-sucedidos.

Cabeçalhos

MS-CV: string
Other Status Codes

error_response

Conflito. Uma sessão de renderização com a ID já existe para a conta de renderização remota.

Segurança

Authorization

Um token de portador retornado pelo serviço de token seguro Realidade Misturada. Para obter detalhes, consulte https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Tipo: apiKey
Em: header

Exemplos

Create a rendering session

Solicitação de exemplo

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 de exemplo

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

Definições

Nome Description
create_session_settings

Configurações da sessão a ser criada.
error

O objeto de erro que contém detalhes de por que a solicitação falhou.
error_response

A resposta de erro que contém detalhes de por que a solicitação falhou.
session_properties

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

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

O status da sessão de renderização. Os estados do terminal são 'Error', 'Expired' e 'Stopped'.

create_session_settings

Configurações da sessão a ser criada.

Nome Tipo Description
maxLeaseTimeMinutes

integer

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

session_size

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

error

O objeto de erro que contém detalhes de por que a solicitação falhou.

Nome Tipo Description
code

string

Código do erro.
details

error[]

Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
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 pelo homem 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 de por que a solicitação falhou.

Nome Tipo Description
error

error

O objeto de erro que contém detalhes de por que a solicitação falhou.

session_properties

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

Nome Tipo Description
arrInspectorPort

integer

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

string

A hora em que a sessão de renderizaçã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 inicialização da sessão de renderização.
handshakePort

integer

A porta TCP usada para o handshake ao estabelecer uma conexão.
hostname

string

O nome do host sob o qual a sessão de renderização é acessível.
id

string

A 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 usado para a sessão de renderização. O tamanho afeta o número de polígonos que o servidor pode renderizar. Veja https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes para obter detalhes.
status

session_status

O status da sessão de renderização. Os estados do terminal são 'Error', 'Expired' e 'Stopped'.
teraflops

number

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

session_size

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

Nome Tipo Description
Premium

string

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

string

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

session_status

O status da sessão de renderização. Os estados do terminal são 'Error', 'Expired' e 'Stopped'.

Nome Tipo Description
Error

string

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

string

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

string

A sessão de renderização está pronta para conexões de entrada.
Starting

string

A sessão de renderização está começando, mas ainda não está aceitando conexões de entrada.
Stopped

string

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