az playwright-testing workspace
Note
This reference is part of the playwright-cli-extension extension for the Azure CLI (version 2.67.0 or higher). The extension will automatically install the first time you run an az playwright-testing workspace command. Learn more about extensions.
Manage Microsoft Playwright Testing service workspace resource.
Commands
Name | Description | Type | Status |
---|---|---|---|
az playwright-testing workspace create |
Create a Microsoft Playwright Testing service Workspace resource. |
Extension | GA |
az playwright-testing workspace delete |
Delete Microsoft Azure Playwright Testing service Workspace resource. |
Extension | GA |
az playwright-testing workspace list |
List Microsoft Azure Playwright Testing service Workspace resources by subscription ID. |
Extension | GA |
az playwright-testing workspace quota |
Manage Quota resource for Microsoft Azure Playwright Testing service account. |
Extension | GA |
az playwright-testing workspace quota list |
List quotas for a given workspace. |
Extension | GA |
az playwright-testing workspace quota show |
Get quota by name for an workspace. |
Extension | GA |
az playwright-testing workspace show |
Get a Microsoft Azure Playwright Testing service Workspace resource details. |
Extension | GA |
az playwright-testing workspace update |
Update Microsoft Azure Playwright Testing service Workspace resource. |
Extension | GA |
az playwright-testing workspace wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az playwright-testing workspace create
Create a Microsoft Playwright Testing service Workspace resource.
az playwright-testing workspace create --name
--resource-group
[--local-auth {Disabled, Enabled}]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--regional-affinity {Disabled, Enabled}]
[--reporting {Disabled, Enabled}]
[--scalable-execution {Disabled, Enabled}]
[--tags]
Examples
Create Playwright Testing Workspace
az playwright-testing workspace create --resource-group SampleRG --workspace-name myPlaywrightWorkspace --location westus --regional-affinity Enabled
Required Parameters
Name of Microsoft Azure Playwright Testing service workspace.
Name of Azure resource group.
Optional Parameters
When enabled, this feature allows the workspace to use local auth(through access key) for authentication of test runs.
The geo-location where the resource lives When not specified, the location of the resource group will be used.
Do not wait for the long-running operation to finish.
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.
When enabled, this feature allows the workspace to upload and display test results, including artifacts like traces and screenshots, in the Playwright portal. This enables faster and more efficient troubleshooting.
When enabled, Playwright client workers can connect to cloud-hosted browsers. This can increase the number of parallel workers for a test run, significantly minimizing test completion durations.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az playwright-testing workspace delete
Delete Microsoft Azure Playwright Testing service Workspace resource.
az playwright-testing workspace delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
Examples
Delete Playwright Testing Workspace
az playwright-testing workspace delete --resource-group SampleRG --workspace-name myPlaywrightWorkspace
Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of Microsoft Azure Playwright Testing service workspace.
Do not wait for the long-running operation to finish.
Name of Azure resource group.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az playwright-testing workspace list
List Microsoft Azure Playwright Testing service Workspace resources by subscription ID.
az playwright-testing workspace list [--max-items]
[--next-token]
[--resource-group]
Examples
Playwright Testing Workspace_ListBySubscription
az playwright-testing workspace list
Playwright Testing Workspace_ListByResourceGroup
az playwright-testing workspace list --resource-group SampleRG
Optional Parameters
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token
argument of a subsequent command.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Name of Azure resource group.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az playwright-testing workspace show
Get a Microsoft Azure Playwright Testing service Workspace resource details.
az playwright-testing workspace show [--ids]
[--name]
[--resource-group]
[--subscription]
Examples
Get Playwright Testing Workspace
az playwright-testing workspace show --resource-group SampleRG --workspace-name myPlaywrightWorkspace
Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of Microsoft Azure Playwright Testing service workspace.
Name of Azure resource group.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az playwright-testing workspace update
Update Microsoft Azure Playwright Testing service Workspace resource.
az playwright-testing workspace update [--add]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--local-auth {Disabled, Enabled}]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--regional-affinity {Disabled, Enabled}]
[--remove]
[--reporting {Disabled, Enabled}]
[--resource-group]
[--scalable-execution {Disabled, Enabled}]
[--set]
[--subscription]
[--tags]
Examples
Update Playwright Testing Workspace_Disable Regional Affinity
az playwright-testing workspace update --resource-group SampleRG --workspace-name myPlaywrightWorkspace --regional-affinity Disabled
Optional Parameters
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>
.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
When enabled, this feature allows the workspace to use local auth(through access key) for authentication of test runs.
Name of Microsoft Azure Playwright Testing service workspace.
Do not wait for the long-running operation to finish.
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.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
When enabled, this feature allows the workspace to upload and display test results, including artifacts like traces and screenshots, in the Playwright portal. This enables faster and more efficient troubleshooting.
Name of Azure resource group.
When enabled, Playwright client workers can connect to cloud-hosted browsers. This can increase the number of parallel workers for a test run, significantly minimizing test completion durations.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az playwright-testing workspace wait
Place the CLI in a waiting state until a condition is met.
az playwright-testing workspace wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Polling interval in seconds.
Name of Microsoft Azure Playwright Testing service workspace.
Name of Azure resource group.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.