Browser Sessions - Get

Dienst:: Azure App Testing

API-Version:: 2026-04-01-preview

Holen Sie sich eine Browsersitzung für die angegebene Sitzung und die Arbeitsbereich-ID. Erfordert ein Bearer-JWT-Zugriffstoken, das von Entra ID bereitgestellt wird.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Playwright-Dienst-API-Endpunkt (Protokoll und Hostname) im Format https://{region}.api.playwright.microsoft.com. Die Region entspricht dem Standort Ihres Azure Playwright-Arbeitsbereichs. Sie finden diesen Wert in den Eigenschaften Ihres Azure Playwright-Arbeitsbereichs unter `dataplaneUri`.
sessionId	path	True	string minLength: 3 maxLength: 36 pattern: [A-Za-z0-9]+(-[A-Za-z0-9]+)+	Die Browser-Session-ID im GUID-Format.
workspaceId	path	True	string minLength: 3 maxLength: 36 pattern: [A-Za-z0-9]+(-[A-Za-z0-9]+)+	Die Arbeitsbereichs-ID im GUID-Format.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string (uuid)	Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.
x-ms-useragent		string	Optionaler Header zur Spezifikation zusätzlicher Client-Informationen, wenn der Standard-Header 'User-Agent' nicht explizit gesetzt werden kann, wie zum Beispiel bei Playwright Client. Der Wert sollte dem Standard-Header-Format 'User-Agent' folgen.

Antworten

Name	Typ	Beschreibung
200 OK	BrowserSession	Die Anforderung ist erfolgreich. Header x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

BrowserSession

Die Anforderung ist erfolgreich.

Header

x-ms-client-request-id: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Unerwartete Fehlerantwort.

Header

x-ms-error-code: string

Sicherheit

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

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

Beispiele

BrowserSessions_Get

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
Azure.Core.Foundations.Error	Das Fehlerobjekt.
Azure.Core.Foundations.ErrorResponse	Eine Antwort, die Fehlerdetails enthält.
Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß Azure REST-API-Richtlinien – https://aka.ms/AzureRestApiGuidelines#handling-errors.
BrowserSession	Modell einer Browsersitzung, die zu Tracking-Zwecken verwendet wird.
BrowserSessionSource	Details zur Quellquelle der Browsersitzungen.
BrowserSessionSourceType	Der Quelltyp der Browsersitzungen.
BrowserSessionStatus	Status der Browsersitzung.
BrowserType	Der Browsertyp, der für die entfernte Skriptausführung konfiguriert werden soll.
OS	Das Betriebssystem zur Konfiguration für die Fernausführung von Skripten.

Azure.Core.Foundations.Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	Azure.Core.Foundations.Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

Azure.Core.Foundations.ErrorResponse

Objekt

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	Azure.Core.Foundations.Error	Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Objekt

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß Azure REST-API-Richtlinien – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	Azure.Core.Foundations.InnerError	Innerer Fehler.

BrowserSession

Objekt

Modell einer Browsersitzung, die zu Tracking-Zwecken verwendet wird.

Name	Typ	Beschreibung
browserType	BrowserType	Der Browser-Session-Browsertyp.
creatorId	string	Die ID des Browser-Session-Erstellers.
displayName	string minLength: 1 maxLength: 200	Der Anzeigename der Browsersitzung.
durationInMilliseconds	integer (int64)	Die Dauer der Browsersitzung beträgt Millisekunden.
endTime	string (date-time)	Die Endzeit der Browsersitzung ist in UTC.
id	string minLength: 3 maxLength: 36 pattern: [A-Za-z0-9]+(-[A-Za-z0-9]+)+	Die Browser-Session-ID im GUID-Format.
operatingSystem	OS	Das Browser-Session-Betriebssystem.
source	BrowserSessionSource	Details zur Quellquelle der Browsersitzungen.
startTime	string (date-time)	Die Startzeit der Browsersitzung in UTC.
status	BrowserSessionStatus	Status der Browsersitzung.

BrowserSessionSource

Objekt

Details zur Quellquelle der Browsersitzungen.

Name	Typ	Standardwert	Beschreibung
id	string		Die Quell-ID der Browser-Sitzung wäre für Testläufe dieselbe wie runId.
type	BrowserSessionSourceType	Others	Der Quelltyp der Browsersitzungen.

BrowserSessionSourceType

Enumeration

Der Quelltyp der Browsersitzungen.

Wert	Beschreibung
PlaywrightWorkspacesTestRun	Die Browser-Sessionsquelle ist ein Playwright Workspaces-Testlauf.
BrowserAutomationTool	Die Browser-Sessionsquelle ist ein Browser-Automatisierungstool.
Others	Die Quellquelle der Browsersitzungen ist von anderen Arten.

BrowserSessionStatus

Enumeration

Status der Browsersitzung.

Wert	Beschreibung
Created	Die Browsersitzung wird erstellt.
Active	Die Browsersitzung ist derzeit aktiv.
Completed	Die Browsersitzung ist abgeschlossen.
Failed	Die Browsersitzung ist gescheitert.

BrowserType

Enumeration

Der Browsertyp, der für die entfernte Skriptausführung konfiguriert werden soll.

Wert	Beschreibung
Chromium	Chromium-Browsertyp.
Firefox	Firefox-Browsertyp.
Webkit	WebKit-Browsertyp.

OS

Enumeration

Das Betriebssystem zur Konfiguration für die Fernausführung von Skripten.

Wert	Beschreibung
Linux	Linux-Betriebssystem.
Windows	Windows Betriebssystem.

Freigeben über

Browser Sessions - Get

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

OAuth2Auth

Bereiche

Beispiele

BrowserSessions_Get

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

BrowserSession

BrowserSessionSource

BrowserSessionSourceType

BrowserSessionStatus

BrowserType

OS