Browser Sessions - Get

Service:: Azure App Testing

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

Obtenez une session navigateur pour l’ID de session et d’espace de travail spécifiés. Nécessite le jeton d’accès JWT du porteur fourni par Entra ID.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)	Point de terminaison de l’API du service Playwright (protocole et nom d’hôte) au format https://{region}.api.playwright.microsoft.com. La région correspond à l’emplacement de votre espace de travail Azure Playwright. Vous pouvez trouver cette valeur dans les propriétés de votre espace de travail Azure Playwright sous `dataplaneUri`.
sessionId	path	True	string minLength: 3 maxLength: 36 pattern: [A-Za-z0-9]+(-[A-Za-z0-9]+)+	L’ID de session du navigateur au format GUID.
workspaceId	path	True	string minLength: 3 maxLength: 36 pattern: [A-Za-z0-9]+(-[A-Za-z0-9]+)+	L’ID de l’espace de travail au format GUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-request-id		string (uuid)	Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.
x-ms-useragent		string	En-tête optionnel pour spécifier des informations supplémentaires sur le client lorsque l’en-tête standard « User-Agent » ne peut pas être explicitement défini, comme lors de l’utilisation du client Playwright. La valeur doit suivre le format standard d’en-tête « User-Agent ».

Réponses

Nom	Type	Description
200 OK	BrowserSession	La demande a réussi. En-têtes x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Nom

Type

Description

200 OK

BrowserSession

La demande a réussi.

En-têtes

x-ms-client-request-id: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Réponse d’erreur inattendue.

En-têtes

x-ms-error-code: string

Sécurité

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

BrowserSessions_Get

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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"
}

Définitions

Nom	Description
Azure.Core.Foundations.Error	Objet d’erreur.
Azure.Core.Foundations.ErrorResponse	Réponse contenant les détails de l’erreur.
Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API REST Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.
BrowserSession	Modèle de session de navigateur utilisé à des fins de suivi.
BrowserSessionSource	Détails de la source de la session du navigateur.
BrowserSessionSourceType	Le type de source de session du navigateur.
BrowserSessionStatus	Le statut de la session du navigateur.
BrowserType	Le type de navigateur à configurer pour l’exécution de scripts à distance.
OS	Le système d’exploitation à configurer pour l’exécution de scripts à distance.

Azure.Core.Foundations.Error

Objet

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	Azure.Core.Foundations.Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

Azure.Core.Foundations.ErrorResponse

Objet

Réponse contenant les détails de l’erreur.

Nom	Type	Description
error	Azure.Core.Foundations.Error	Objet d’erreur.

Azure.Core.Foundations.InnerError

Objet

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API REST Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
innererror	Azure.Core.Foundations.InnerError	Erreur interne.

BrowserSession

Objet

Modèle de session de navigateur utilisé à des fins de suivi.

Nom	Type	Description
browserType	BrowserType	Le type de navigateur session de navigateur.
creatorId	string	L’identifiant du créateur de session du navigateur.
displayName	string minLength: 1 maxLength: 200	Le nom d’affichage de la session du navigateur.
durationInMilliseconds	integer (int64)	La durée de la session du navigateur en millisecondes.
endTime	string (date-time)	L’heure de fin de la session du navigateur est en UTC.
id	string minLength: 3 maxLength: 36 pattern: [A-Za-z0-9]+(-[A-Za-z0-9]+)+	L’ID de session du navigateur au format GUID.
operatingSystem	OS	Le système d’exploitation de session du navigateur.
source	BrowserSessionSource	Détails de la source de la session du navigateur.
startTime	string (date-time)	L’heure de début de la session du navigateur est UTC.
status	BrowserSessionStatus	Le statut de la session du navigateur.

BrowserSessionSource

Objet

Détails de la source de la session du navigateur.

Nom	Type	Valeur par défaut	Description
id	string		L’identifiant source de session du navigateur serait le même que runID pour les tests.
type	BrowserSessionSourceType	Others	Le type de source de session du navigateur.

BrowserSessionSourceType

Énumération

Le type de source de session du navigateur.

Valeur	Description
PlaywrightWorkspacesTestRun	La source de la session du navigateur est un test Playwright Workspaces.
BrowserAutomationTool	La source de session du navigateur est un outil d’automatisation du navigateur.
Others	La source de la session du navigateur est d’autres types.

BrowserSessionStatus

Énumération

Le statut de la session du navigateur.

Valeur	Description
Created	La session du navigateur est créée.
Active	La session du navigateur est actuellement active.
Completed	La session du navigateur est terminée.
Failed	La session du navigateur a échoué.

BrowserType

Énumération

Le type de navigateur à configurer pour l’exécution de scripts à distance.

Valeur	Description
Chromium	Type de navigateur Chromium.
Firefox	Type de navigateur Firefox.
Webkit	Type de navigateur WebKit.

OS

Énumération

Le système d’exploitation à configurer pour l’exécution de scripts à distance.

Valeur	Description
Linux	Système d’exploitation Linux.
Windows	Windows système d’exploitation.

Partager via

Browser Sessions - Get

Paramètres URI

En-tête de la demande

Réponses

Sécurité

OAuth2Auth

Étendues

Exemples

BrowserSessions_Get

Exemple de requête

Exemple de réponse

Définitions

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

BrowserSession

BrowserSessionSource

BrowserSessionSourceType

BrowserSessionStatus

BrowserType

OS