Condividi tramite


Browser Sessions - Get

Ottieni una sessione browser per l'ID di sessione e workspace specificato. Richiede il token di accesso JWT Bearer fornito da Entra ID.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
path True

string (uri)

Endpoint dell'API del servizio Playwright (protocollo e nome host) formattato come https://{region}.api.playwright.microsoft.com. L'area corrisponde alla posizione dell'area di lavoro di Azure Playwright. È possibile trovare questo valore nelle proprietà dell'area di lavoro di Azure Playwright in dataplaneUri.

sessionId
path True

string

minLength: 3
maxLength: 36
pattern: [A-Za-z0-9]+(-[A-Za-z0-9]+)+

L'ID della sessione del browser in formato GUID.

workspaceId
path True

string

minLength: 3
maxLength: 36
pattern: [A-Za-z0-9]+(-[A-Za-z0-9]+)+

ID dell'area di lavoro in formato GUID.

api-version
query True

string

minLength: 1

Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome Necessario Tipo Descrizione
x-ms-client-request-id

string (uuid)

Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta.

x-ms-useragent

string

Intestazione opzionale per specificare informazioni aggiuntive sul client quando l'intestazione standard 'User-Agent' non può essere impostata esplicitamente, come quando si utilizza Playwright Client. Il valore dovrebbe seguire il formato standard di intestazione 'User-Agent'.

Risposte

Nome Tipo Descrizione
200 OK

BrowserSession

La richiesta ha avuto esito positivo.

Intestazioni

x-ms-client-request-id: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Risposta di errore imprevista.

Intestazioni

x-ms-error-code: string

Sicurezza

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

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

Esempio

BrowserSessions_Get

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
Azure.Core.Foundations.Error

Oggetto error.

Azure.Core.Foundations.ErrorResponse

Risposta contenente i dettagli dell'errore.

Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API REST Azure: https://aka.ms/AzureRestApiGuidelines#handling-errors.

BrowserSession

Modello di sessione browser utilizzato a scopi di tracciamento.

BrowserSessionSource

Dettagli della sorgente della sessione del browser.

BrowserSessionSourceType

Il tipo di sorgente della sessione del browser.

BrowserSessionStatus

Lo stato della sessione del browser.

BrowserType

Il tipo di browser da configurare per l'esecuzione remota di script.

OS

Il sistema operativo da configurare per l'esecuzione remota di script.

Azure.Core.Foundations.Error

Oggetto error.

Nome Tipo Descrizione
code

string

Uno di un set definito dal server di codici di errore.

details

Azure.Core.Foundations.Error[]

Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.

innererror

Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.

message

string

Rappresentazione leggibile dell'errore.

target

string

Destinazione dell'errore.

Azure.Core.Foundations.ErrorResponse

Risposta contenente i dettagli dell'errore.

Nome Tipo Descrizione
error

Azure.Core.Foundations.Error

Oggetto error.

Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API REST Azure: https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nome Tipo Descrizione
code

string

Uno di un set definito dal server di codici di errore.

innererror

Azure.Core.Foundations.InnerError

Errore interno.

BrowserSession

Modello di sessione browser utilizzato a scopi di tracciamento.

Nome Tipo Descrizione
browserType

BrowserType

Il tipo di browser sessione.

creatorId

string

L'ID del creatore della sessione del browser.

displayName

string

minLength: 1
maxLength: 200

Il nome visualizzato della sessione del browser.

durationInMilliseconds

integer (int64)

La durata della sessione del browser in millisecondi.

endTime

string (date-time)

L'orario di fine della sessione del browser in UTC.

id

string

minLength: 3
maxLength: 36
pattern: [A-Za-z0-9]+(-[A-Za-z0-9]+)+

L'ID della sessione del browser in formato GUID.

operatingSystem

OS

Il sistema operativo delle sessioni browser.

source

BrowserSessionSource

Dettagli della sorgente della sessione del browser.

startTime

string (date-time)

L'orario di inizio della sessione del browser è in UTC.

status

BrowserSessionStatus

Lo stato della sessione del browser.

BrowserSessionSource

Dettagli della sorgente della sessione del browser.

Nome Tipo Valore predefinito Descrizione
id

string

L'ID della sorgente della sessione del browser sarebbe lo stesso di runID per i test-run.

type

BrowserSessionSourceType

Others

Il tipo di sorgente della sessione del browser.

BrowserSessionSourceType

Il tipo di sorgente della sessione del browser.

Valore Descrizione
PlaywrightWorkspacesTestRun

La sorgente della sessione browser è un test eseguito da Playwright Workspaces.

BrowserAutomationTool

La sorgente della sessione del browser è uno strumento di automazione del browser.

Others

La sorgente della sessione del browser è di altri tipi.

BrowserSessionStatus

Lo stato della sessione del browser.

Valore Descrizione
Created

La sessione del browser viene creata.

Active

La sessione del browser è attualmente attiva.

Completed

La sessione del browser è completata.

Failed

La sessione del browser è fallita.

BrowserType

Il tipo di browser da configurare per l'esecuzione remota di script.

Valore Descrizione
Chromium

Tipo di browser Chromium.

Firefox

Tipo di browser Firefox.

Webkit

Tipo di browser WebKit.

OS

Il sistema operativo da configurare per l'esecuzione remota di script.

Valore Descrizione
Linux

Sistema operativo Linux.

Windows

Windows sistema operativo.