playwright_workspaces

Creates, updates, deletes, gets or lists a playwright_workspaces resource.

Overview

Name	playwright_workspaces
Type	Resource
Id	azure.playwright.playwright_workspaces

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dataplaneUri	string	The workspace data plane service API URI.
identity	object	The managed service identities assigned to this resource.
localAuth	string	Enables the workspace to use local authentication through service access tokens for operations. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last resource operation. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Creating, Deleting, Accepted)
regionalAffinity	string	Controls the connection region for client workers to cloud-hosted browsers. When enabled, workers connect to browsers in the closest Azure region for lower latency. When disabled, workers connect to browsers in the Azure region where the workspace was created. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
reporting	string	Indicates whether reporting is enabled for the workspace. When set to true, reports will be generated and available for the workspace. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
storageUri	string	The URI of the Azure storage account used to store workspace artifacts, test results, and reports.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workspaceId	string	The workspace ID in GUID format.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dataplaneUri	string	The workspace data plane service API URI.
identity	object	The managed service identities assigned to this resource.
localAuth	string	Enables the workspace to use local authentication through service access tokens for operations. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last resource operation. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Creating, Deleting, Accepted)
regionalAffinity	string	Controls the connection region for client workers to cloud-hosted browsers. When enabled, workers connect to browsers in the closest Azure region for lower latency. When disabled, workers connect to browsers in the Azure region where the workspace was created. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
reporting	string	Indicates whether reporting is enabled for the workspace. When set to true, reports will be generated and available for the workspace. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
storageUri	string	The URI of the Azure storage account used to store workspace artifacts, test results, and reports.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workspaceId	string	The workspace ID in GUID format.

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dataplaneUri	string	The workspace data plane service API URI.
identity	object	The managed service identities assigned to this resource.
localAuth	string	Enables the workspace to use local authentication through service access tokens for operations. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last resource operation. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Creating, Deleting, Accepted)
regionalAffinity	string	Controls the connection region for client workers to cloud-hosted browsers. When enabled, workers connect to browsers in the closest Azure region for lower latency. When disabled, workers connect to browsers in the Azure region where the workspace was created. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
reporting	string	Indicates whether reporting is enabled for the workspace. When set to true, reports will be generated and available for the workspace. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
storageUri	string	The URI of the Azure storage account used to store workspace artifacts, test results, and reports.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workspaceId	string	The workspace ID in GUID format.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, playwright_workspace_name, subscription_id		Get a PlaywrightWorkspace.
list_by_resource_group	select	resource_group_name, subscription_id		List PlaywrightWorkspace resources by resource group.
list_by_subscription	select	subscription_id		List PlaywrightWorkspace resources by subscription ID.
create_or_update	insert	resource_group_name, playwright_workspace_name, subscription_id, location		Create a PlaywrightWorkspace.
update	update	resource_group_name, playwright_workspace_name, subscription_id		Updates a Playwright workspace resource synchronously.
create_or_update	replace	resource_group_name, playwright_workspace_name, subscription_id, location		Create a PlaywrightWorkspace.
delete	delete	resource_group_name, playwright_workspace_name, subscription_id		Deletes a Playwright workspace resource asynchronously.
check_name_availability	exec	subscription_id		Checks if a Playwright workspace name is available globally.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
playwright_workspace_name	string	The name of the PlaywrightWorkspace. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a PlaywrightWorkspace.

SELECT
id,
name,
dataplaneUri,
identity,
localAuth,
location,
provisioningState,
regionalAffinity,
reporting,
storageUri,
systemData,
tags,
type,
workspaceId
FROM azure.playwright.playwright_workspaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND playwright_workspace_name = '{{ playwright_workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List PlaywrightWorkspace resources by resource group.

SELECT
id,
name,
dataplaneUri,
identity,
localAuth,
location,
provisioningState,
regionalAffinity,
reporting,
storageUri,
systemData,
tags,
type,
workspaceId
FROM azure.playwright.playwright_workspaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List PlaywrightWorkspace resources by subscription ID.

SELECT
id,
name,
dataplaneUri,
identity,
localAuth,
location,
provisioningState,
regionalAffinity,
reporting,
storageUri,
systemData,
tags,
type,
workspaceId
FROM azure.playwright.playwright_workspaces
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a PlaywrightWorkspace.

INSERT INTO azure.playwright.playwright_workspaces (
tags,
location,
properties,
identity,
resource_group_name,
playwright_workspace_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ playwright_workspace_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: playwright_workspaces
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the playwright_workspaces resource.
  - name: playwright_workspace_name
    value: "{{ playwright_workspace_name }}"
    description: Required parameter for the playwright_workspaces resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the playwright_workspaces resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      dataplaneUri: "{{ dataplaneUri }}"
      regionalAffinity: "{{ regionalAffinity }}"
      localAuth: "{{ localAuth }}"
      workspaceId: "{{ workspaceId }}"
      reporting: "{{ reporting }}"
      storageUri: "{{ storageUri }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Updates a Playwright workspace resource synchronously.

UPDATE azure.playwright.playwright_workspaces
SET 
identity = '{{ identity }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND playwright_workspace_name = '{{ playwright_workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a PlaywrightWorkspace.

REPLACE azure.playwright.playwright_workspaces
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND playwright_workspace_name = '{{ playwright_workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a Playwright workspace resource asynchronously.

DELETE FROM azure.playwright.playwright_workspaces
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND playwright_workspace_name = '{{ playwright_workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

check_name_availability

Checks if a Playwright workspace name is available globally.

EXEC azure.playwright.playwright_workspaces.check_name_availability 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;