Browser Sessions - Get

Serviço:: Azure App Testing

Versão da API:: 2026-04-01-preview

Obtenha uma sessão de navegador para o ID de sessão e espaço de trabalho especificados. Requer o token de acesso JWT do portador fornecido pelo ID do Entra.

GET {endpoint}/playwrightworkspaces/{workspaceId}/browser-sessions/{sessionId}?api-version=2026-04-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string (uri)	Ponto de extremidade da API de serviço do Playwright (protocolo e nome do host) formatado como https://{region}.api.playwright.microsoft.com. A região corresponde ao local do workspace do Azure Playwright. Você pode encontrar esse valor nas propriedades do workspace do Azure Playwright em `dataplaneUri`.
sessionId	path	True	string minLength: 3 maxLength: 36 pattern: [A-Za-z0-9]+(-[A-Za-z0-9]+)+	O ID da sessão do navegador em formato GUID.
workspaceId	path	True	string minLength: 3 maxLength: 36 pattern: [A-Za-z0-9]+(-[A-Za-z0-9]+)+	A ID do workspace no formato GUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string (uuid)	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.
x-ms-useragent		string	Cabeçalho opcional para especificar informações adicionais do cliente quando o cabeçalho padrão 'User-Agent' não pode ser definido explicitamente, como ao usar o Playwright Client. O valor deve seguir o formato padrão de cabeçalho 'User-Agent'.

Respostas

Nome	Tipo	Description
200 OK	BrowserSession	A solicitação foi bem-sucedida. Cabeçalhos x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Nome

Tipo

Description

200 OK

BrowserSession

A solicitação foi bem-sucedida.

Cabeçalhos

x-ms-client-request-id: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
https://playwright.microsoft.com/.default

Exemplos

BrowserSessions_Get

Solicitação de exemplo

HTTP

GET {endpoint}/playwrightworkspaces/00000000-0000-0000-0000-000000000000/browser-sessions/00000000-0000-0000-0000-000000000000?api-version=2026-04-01-preview

Resposta de exemplo

Código de status:: 200

{
  "id": "00000000-0000-0000-0000-000000000000",
  "displayName": "<BrowserSession_Timestamp>",
  "creatorId": "string",
  "source": {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "PlaywrightWorkspacesTestRun"
  },
  "startTime": "2025-06-06T11:43:28.954Z",
  "endTime": "2025-06-06T11:43:28.954Z",
  "durationInMilliseconds": 0,
  "status": "Created",
  "browserType": "Chromium",
  "operatingSystem": "Windows"
}

Definições

Nome	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta que contém detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com Azure diretrizes da API REST – https://aka.ms/AzureRestApiGuidelines#handling-errors.
BrowserSession	Modelo de uma sessão de navegador usado para fins de rastreamento.
BrowserSessionSource	Detalhes da fonte da sessão do navegador.
BrowserSessionSourceType	O tipo de fonte da sessão do navegador.
BrowserSessionStatus	O status da sessão do navegador.
BrowserType	O tipo de navegador para configurar para execução remota de scripts.
OS	O sistema operacional para configurar para execução remota de scripts.

Azure.Core.Foundations.Error

Objeto

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	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 ser humano do erro.
target	string	O destino do erro.

Azure.Core.Foundations.ErrorResponse

Objeto

Uma resposta que contém detalhes do erro.

Nome	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Objeto

Um objeto que contém informações mais específicas sobre o erro. De acordo com Azure diretrizes da API REST – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

BrowserSession

Objeto

Modelo de uma sessão de navegador usado para fins de rastreamento.

Nome	Tipo	Description
browserType	BrowserType	O tipo de navegador da sessão do navegador.
creatorId	string	O ID do criador da sessão do navegador.
displayName	string minLength: 1 maxLength: 200	O nome de exibição da sessão do navegador.
durationInMilliseconds	integer (int64)	A duração da sessão do navegador em milissegundos.
endTime	string (date-time)	O horário de término da sessão do navegador no UTC.
id	string minLength: 3 maxLength: 36 pattern: [A-Za-z0-9]+(-[A-Za-z0-9]+)+	O ID da sessão do navegador em formato GUID.
operatingSystem	OS	O sistema operacional da sessão do navegador.
source	BrowserSessionSource	Detalhes da fonte da sessão do navegador.
startTime	string (date-time)	O horário de início da sessão do navegador no UTC.
status	BrowserSessionStatus	O status da sessão do navegador.

BrowserSessionSource

Objeto

Detalhes da fonte da sessão do navegador.

Nome	Tipo	Valor padrão	Description
id	string		O ID da fonte da sessão do navegador seria o mesmo do runID para testes.
type	BrowserSessionSourceType	Others	O tipo de fonte da sessão do navegador.

BrowserSessionSourceType

Enumeração

O tipo de fonte da sessão do navegador.

Valor	Description
PlaywrightWorkspacesTestRun	A fonte da sessão do navegador é um teste executado pelo Playwright Workspaces.
BrowserAutomationTool	A fonte da sessão do navegador é uma ferramenta de automação do navegador.
Others	A fonte da sessão do navegador é de outros tipos.

BrowserSessionStatus

Enumeração

O status da sessão do navegador.

Valor	Description
Created	A sessão do navegador é criada.
Active	A sessão do navegador está atualmente ativa.
Completed	A sessão do navegador foi concluída.
Failed	A sessão do navegador falhou.

BrowserType

Enumeração

O tipo de navegador para configurar para execução remota de scripts.

Valor	Description
Chromium	Tipo de navegador Chromium.
Firefox	Tipo de navegador Firefox.
Webkit	Tipo de navegador WebKit.

OS

Enumeração

O sistema operacional para configurar para execução remota de scripts.

Valor	Description
Linux	Sistema operacional Linux.
Windows	Windows sistema operacional.

Compartilhar via

Browser Sessions - Get

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Segurança

OAuth2Auth

Escopos

Exemplos

BrowserSessions_Get

Solicitação de exemplo

Resposta de exemplo

Definições

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

BrowserSession

BrowserSessionSource

BrowserSessionSourceType

BrowserSessionStatus

BrowserType

OS