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 token de acesso JWT ao portador fornecido pelo Entra ID.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string (uri)	Ponto de extremidade da API do Serviço de Playwright (protocolo e nome do host) formatado como https://{region}.api.playwright.microsoft.com. A região corresponde ao local do seu espaço de trabalho do Azure Playwright. Você pode encontrar esse valor em suas propriedades do espaço de trabalho 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]+)+	O ID do espaço de trabalho no formato GUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

Name	Necessá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ção adicional do cliente quando o cabeçalho padrão 'User-Agent' não pode ser explicitamente definido, como ao usar o Playwright Client. O valor deve seguir o formato padrão de cabeçalho 'User-Agent'.

Respostas

Name	Tipo	Description
200 OK	BrowserSession	O pedido foi bem-sucedido. 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

Name

Tipo

Description

200 OK

BrowserSession

O pedido foi bem-sucedido.

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
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

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

Exemplos

BrowserSessions_Get

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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

Name	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta contendo 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 usada 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 estado da sessão do navegador.
BrowserType	O tipo de navegador para configurar para execução remota de scripts.
OS	O sistema operativo para configurar para execução remota de scripts.

Azure.Core.Foundations.Error

Object

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
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 por humanos do erro.
target	string	O alvo do erro.

Azure.Core.Foundations.ErrorResponse

Object

Uma resposta contendo detalhes do erro.

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

Azure.Core.Foundations.InnerError

Object

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.

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

BrowserSession

Object

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

Name	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 apresentação da sessão do navegador.
durationInMilliseconds	integer (int64)	A duração da sessão do navegador em milissegundos.
endTime	string (date-time)	A hora 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 operativo da sessão do navegador.
source	BrowserSessionSource	Detalhes da fonte da sessão do navegador.
startTime	string (date-time)	A hora de início da sessão do navegador em UTC.
status	BrowserSessionStatus	O estado da sessão do navegador.

BrowserSessionSource

Object

Detalhes da fonte da sessão do navegador.

Name	Tipo	Default value	Description
id	string		O ID da fonte da sessão do navegador seria o mesmo que o 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 do 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 estado 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 terminou.
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 operativo para configurar para execução remota de scripts.

Valor	Description
Linux	Sistema operacional Linux.
Windows	Sistema operativo Windows.

Partilhar via

Browser Sessions - Get

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

OAuth2Auth

Âmbitos

Exemplos

BrowserSessions_Get

Pedido de amostra

Resposta da amostra

Definições

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

BrowserSession

BrowserSessionSource

BrowserSessionSourceType

BrowserSessionStatus

BrowserType

OS