Sign in

Get details of the Azure resource mapped to a workspace for the given workspace id. Authorization required is Bearer JWT Access token provided by EntraID.

get/playwrightworkspaces/{workspaceId}

Path parameters

workspaceIdstring required

The workspace ID in GUID format.

Query parameters

api-versionstring required

The API version to use for this operation.

Headers

x-ms-client-request-idstring uuid

An opaque, globally-unique, client-generated string identifier for the request.

x-ms-useragentstring

Optional header to specify additional client information when the standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. The value should follow the standard 'User-Agent' header format.

Response

The request has succeeded.

idstring required

The workspace ID in GUID format.

resourceIdstring required

The fully-qualified Azure resource id for the workspace.

namestring required

The workspace name.

state'Active' | 'Inactive' required

The Playwright workspace state.

subscriptionIdstring required

The Azure subscription id in GUID format for the workspace.

subscriptionState'Registered' | 'Warned' | 'Suspended' | 'Deleted' | 'Unregistered' required

The Azure subscription state.

tenantIdstring required

The Azure tenant id in GUID format for the workspace.

locationstring required

The workspace resource location in Azure, for eg. eastus, southeastasia.

regionalAffinity'Enabled' | 'Disabled'

This property sets the connection region for Playwright client workers to cloud-hosted browsers. If enabled, workers connect to browsers in the closest Azure region, ensuring lower latency. If disabled, workers connect to browsers in the Azure region in which the workspace was initially created.

localAuth'Enabled' | 'Disabled'

When enabled, this feature allows the workspace to use local auth (through service access token) for executing operations.

storageUristring uri

When set on Playwright workspace resource, it provides the URI of the Azure storage account used to store workspace artifacts, test results, and reports.

Changes

Changed in 3 of the 9 revisions of this API.21