Browser Sessions - Get

Usługa:: Azure App Testing

Wersja interfejsu API:: 2026-04-01-preview

Pobierz sesję przeglądarkową dla podanego identyfikatora sesji i workspace. Wymaga tokenu dostępu JWT okaziciela dostarczonego przez identyfikator Entra.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (uri)	Punkt końcowy interfejsu API usługi Playwright (protokół i nazwa hosta) sformatowany jako https://{region}.api.playwright.microsoft.com. Region odpowiada lokalizacji obszaru roboczego usługi Azure Playwright. Tę wartość można znaleźć we właściwościach obszaru roboczego usługi Azure Playwright w obszarze `dataplaneUri`.
sessionId	path	True	string minLength: 3 maxLength: 36 pattern: [A-Za-z0-9]+(-[A-Za-z0-9]+)+	ID sesji przeglądarki w formacie GUID.
workspaceId	path	True	string minLength: 3 maxLength: 36 pattern: [A-Za-z0-9]+(-[A-Za-z0-9]+)+	Identyfikator obszaru roboczego w formacie identyfikatora GUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string (uuid)	Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.
x-ms-useragent		string	Opcjonalny nagłówek do określenia dodatkowych informacji o kliencie, gdy standardowy nagłówek 'User-Agent' nie może być ustawiony jawnie, na przykład przy użyciu Playwright Client. Wartość powinna odpowiadać standardowemu formatowi nagłówka 'User-Agent'.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	BrowserSession	Żądanie zakończyło się pomyślnie. Nagłówki x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Nazwa

Typ

Opis

200 OK

BrowserSession

Żądanie zakończyło się pomyślnie.

Nagłówki

x-ms-client-request-id: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Nagłówki

x-ms-error-code: string

Zabezpieczenia

OAuth2Auth

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
https://playwright.microsoft.com/.default

Przykłady

BrowserSessions_Get

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu API REST Azure — https://aka.ms/AzureRestApiGuidelines#handling-errors.
BrowserSession	Model sesji przeglądarkowej używany do śledzenia.
BrowserSessionSource	Szczegóły źródła sesji przeglądarki.
BrowserSessionSourceType	Typ źródła sesji przeglądarki.
BrowserSessionStatus	Status sesji przeglądarki.
BrowserType	Typ przeglądarki do konfiguracji zdalnego wykonywania skryptów.
OS	System operacyjny do konfiguracji zdalnego wykonywania skryptów.

Azure.Core.Foundations.Error

Objekt

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

Azure.Core.Foundations.ErrorResponse

Objekt

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt błędu.

Azure.Core.Foundations.InnerError

Objekt

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu API REST Azure — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.

BrowserSession

Objekt

Model sesji przeglądarkowej używany do śledzenia.

Nazwa	Typ	Opis
browserType	BrowserType	Typ przeglądarki sesyjnej przeglądarki.
creatorId	string	ID twórcy sesji przeglądarki.
displayName	string minLength: 1 maxLength: 200	Nazwa wyświetlania sesji przeglądarki.
durationInMilliseconds	integer (int64)	Czas trwania sesji przeglądarki to milisekundy.
endTime	string (date-time)	Koniec sesji przeglądarki w UTC.
id	string minLength: 3 maxLength: 36 pattern: [A-Za-z0-9]+(-[A-Za-z0-9]+)+	ID sesji przeglądarki w formacie GUID.
operatingSystem	OS	System operacyjny sesji przeglądarki.
source	BrowserSessionSource	Szczegóły źródła sesji przeglądarki.
startTime	string (date-time)	Czas rozpoczęcia sesji przeglądarki w UTC.
status	BrowserSessionStatus	Status sesji przeglądarki.

BrowserSessionSource

Objekt

Szczegóły źródła sesji przeglądarki.

Nazwa	Typ	Domyślna wartość	Opis
id	string		ID źródła sesji przeglądarki będzie takie samo jak runId dla testowych uruchomień.
type	BrowserSessionSourceType	Others	Typ źródła sesji przeglądarki.

BrowserSessionSourceType

Wyliczenie

Typ źródła sesji przeglądarki.

Wartość	Opis
PlaywrightWorkspacesTestRun	Źródło sesji przeglądarki to testowy uruchomienie Playwright Workspaces.
BrowserAutomationTool	Źródło sesji przeglądarki to narzędzie do automatyzacji przeglądarki.
Others	Źródło sesji przeglądarki ma inne typy.

BrowserSessionStatus

Wyliczenie

Status sesji przeglądarki.

Wartość	Opis
Created	Sesja przeglądarki zostaje utworzona.
Active	Sesja przeglądarki jest obecnie aktywna.
Completed	Sesja przeglądarki została zakończona.
Failed	Sesja przeglądarki zakończyła się niepowodzeniem.

BrowserType

Wyliczenie

Typ przeglądarki do konfiguracji zdalnego wykonywania skryptów.

Wartość	Opis
Chromium	Typ przeglądarki Chromium.
Firefox	Typ przeglądarki Firefox.
Webkit	Typ przeglądarki WebKit.

OS

Wyliczenie

System operacyjny do konfiguracji zdalnego wykonywania skryptów.

Wartość	Opis
Linux	System operacyjny Linux.
Windows	System operacyjny Windows.

Udostępnij za pośrednictwem

Browser Sessions - Get

Parametry identyfikatora URI

Nagłówek żądania

Odpowiedzi

Zabezpieczenia

OAuth2Auth

Zakresy

Przykłady

BrowserSessions_Get

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

BrowserSession

BrowserSessionSource

BrowserSessionSourceType

BrowserSessionStatus

BrowserType

OS