Browser Sessions - Get

Layanan:

Azure App Testing

Versi API:

2026-04-01-preview

Dapatkan sesi browser untuk ID sesi dan ruang kerja yang ditentukan. Memerlukan token akses Bearer JWT yang disediakan oleh Entra ID.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string (uri)	Titik akhir Playwright Service API (protokol dan nama host) diformat sebagai https://{region}.api.playwright.microsoft.com. Wilayah tersebut sesuai dengan lokasi ruang kerja Azure Playwright Anda. Anda dapat menemukan nilai ini di properti ruang kerja Azure Playwright di bawah dataplaneUri.
sessionId	path	True	string minLength: 3 maxLength: 36 pattern: [A-Za-z0-9]+(-[A-Za-z0-9]+)+	ID sesi browser dalam format GUID.
workspaceId	path	True	string minLength: 3 maxLength: 36 pattern: [A-Za-z0-9]+(-[A-Za-z0-9]+)+	ID ruang kerja dalam format GUID.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-request-id		string (uuid)	Pengidentifikasi string yang buram dan unik secara global yang dihasilkan klien untuk permintaan tersebut.
x-ms-useragent		string	Header opsional untuk menentukan informasi klien tambahan saat header 'User-Agent' standar tidak dapat diatur secara eksplisit, seperti saat menggunakan Klien Playwright. Nilainya harus mengikuti format header 'User-Agent' standar.

Respons

Nama	Jenis	Deskripsi
200 OK	BrowserSession	Permintaan telah berhasil. Header x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Respons kesalahan tak terduga. Header x-ms-error-code: string

Keamanan

OAuth2Auth

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
https://playwright.microsoft.com/.default

Contoh

BrowserSessions_Get

Permintaan sampel

HTTP

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

Respon sampel

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

Definisi

Nama	Deskripsi
Azure.Core.Foundations.Error	Objek kesalahan.
Azure.Core.Foundations.ErrorResponse	Respons yang berisi detail kesalahan.
Azure.Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai panduan REST API Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.
BrowserSession	Model sesi browser yang digunakan untuk tujuan pelacakan.
BrowserSessionSource	Detail sumber sesi browser.
BrowserSessionSourceType	Jenis sumber sesi browser.
BrowserSessionStatus	Status sesi browser.
BrowserType	Jenis browser yang akan dikonfigurasi untuk eksekusi skrip jarak jauh.
OS	Sistem operasi yang akan dikonfigurasi untuk eksekusi skrip jarak jauh.

Azure.Core.Foundations.Error

Objek

Objek kesalahan.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
details	Azure.Core.Foundations.Error[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror	Azure.Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.
target	string	Target kesalahan.

Azure.Core.Foundations.ErrorResponse

Objek

Respons yang berisi detail kesalahan.

Nama	Jenis	Deskripsi
error	Azure.Core.Foundations.Error	Objek kesalahan.

Azure.Core.Foundations.InnerError

Objek

Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai panduan REST API Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
innererror	Azure.Core.Foundations.InnerError	Kesalahan dalam.

BrowserSession

Objek

Model sesi browser yang digunakan untuk tujuan pelacakan.

Nama	Jenis	Deskripsi
browserType	BrowserType	Jenis browser sesi browser.
creatorId	string	ID pembuat sesi browser.
displayName	string minLength: 1 maxLength: 200	Nama tampilan sesi browser.
durationInMilliseconds	integer (int64)	Durasi sesi browser dalam milidetik.
endTime	string (date-time)	Waktu akhir sesi browser di UTC.
id	string minLength: 3 maxLength: 36 pattern: [A-Za-z0-9]+(-[A-Za-z0-9]+)+	ID sesi browser dalam format GUID.
operatingSystem	OS	Sistem operasi sesi browser.
source	BrowserSessionSource	Detail sumber sesi browser.
startTime	string (date-time)	Waktu mulai sesi browser di UTC.
status	BrowserSessionStatus	Status sesi browser.

BrowserSessionSource

Objek

Detail sumber sesi browser.

Nama	Jenis	Nilai default	Deskripsi
id	string		ID sumber sesi browser, akan sama dengan runId untuk uji coba.
type	BrowserSessionSourceType	Others	Jenis sumber sesi browser.

BrowserSessionSourceType

Enumerasi

Jenis sumber sesi browser.

Nilai	Deskripsi
PlaywrightWorkspacesTestRun	Sumber sesi browser adalah uji coba Playwright Workspaces.
BrowserAutomationTool	Sumber sesi browser adalah alat otomatisasi browser.
Others	Sumber sesi browser adalah jenis lain.

BrowserSessionStatus

Enumerasi

Status sesi browser.

Nilai	Deskripsi
Created	Sesi browser dibuat.
Active	Sesi browser saat ini aktif.
Completed	Sesi browser telah selesai.
Failed	Sesi browser gagal.

BrowserType

Enumerasi

Jenis browser yang akan dikonfigurasi untuk eksekusi skrip jarak jauh.

Nilai	Deskripsi
Chromium	Jenis browser Chromium.
Firefox	Jenis browser Firefox.
Webkit	Jenis browser WebKit.

OS

Enumerasi

Sistem operasi yang akan dikonfigurasi untuk eksekusi skrip jarak jauh.

Nilai	Deskripsi
Linux	Sistem operasi Linux.
Windows	Windows sistem operasi.