accounts

Creates, updates, deletes, gets or lists an accounts resource.

Overview

Name	accounts
Type	Resource
Id	azure.playwright_testing.accounts

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}. # pylint: disable=line-too-long
name	string	The name of the resource.
dashboardUri	string	The Playwright testing dashboard URI for the account resource.
localAuth	string	When enabled, this feature allows the workspace to use local auth(through access key) for authentication of test runs. 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 operation. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Creating, Deleting, Accepted)
regionalAffinity	string	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. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
reporting	string	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. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
scalableExecution	string	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. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
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".

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}. # pylint: disable=line-too-long
name	string	The name of the resource.
dashboardUri	string	The Playwright testing dashboard URI for the account resource.
localAuth	string	When enabled, this feature allows the workspace to use local auth(through access key) for authentication of test runs. 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 operation. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Creating, Deleting, Accepted)
regionalAffinity	string	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. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
reporting	string	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. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
scalableExecution	string	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. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
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".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
dashboardUri	string	The Playwright testing dashboard URI for the account resource.
localAuth	string	When enabled, this feature allows the workspace to use local auth(through access key) for authentication of test runs. 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 operation. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Creating, Deleting, Accepted)
regionalAffinity	string	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. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
reporting	string	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. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
scalableExecution	string	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. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, subscription_id		Get a Account.
list_by_resource_group	select	resource_group_name, subscription_id		List Account resources by resource group.
list_by_subscription	select	subscription_id		List Account resources by subscription ID.
create_or_update	insert	resource_group_name, account_name, subscription_id, location		Create a Account.
update	update	resource_group_name, account_name, subscription_id		Update a Account.
create_or_update	replace	resource_group_name, account_name, subscription_id, location		Create a Account.
delete	delete	resource_group_name, account_name, subscription_id		Delete a Account.
check_name_availability	exec	subscription_id		Adds check global name availability operation, normally used if a resource name must be globally unique.

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
account_name	string	Name of account. 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 Account.

SELECT
id,
name,
dashboardUri,
localAuth,
location,
provisioningState,
regionalAffinity,
reporting,
scalableExecution,
systemData,
tags,
type
FROM azure.playwright_testing.accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List Account resources by resource group.

SELECT
id,
name,
dashboardUri,
localAuth,
location,
provisioningState,
regionalAffinity,
reporting,
scalableExecution,
systemData,
tags,
type
FROM azure.playwright_testing.accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List Account resources by subscription ID.

SELECT
id,
name,
dashboardUri,
localAuth,
location,
provisioningState,
regionalAffinity,
reporting,
scalableExecution,
systemData,
tags,
type
FROM azure.playwright_testing.accounts
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a Account.

INSERT INTO azure.playwright_testing.accounts (
tags,
location,
properties,
resource_group_name,
account_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: accounts
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the accounts resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the accounts resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the accounts 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:
      dashboardUri: "{{ dashboardUri }}"
      regionalAffinity: "{{ regionalAffinity }}"
      scalableExecution: "{{ scalableExecution }}"
      reporting: "{{ reporting }}"
      localAuth: "{{ localAuth }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Update a Account.

UPDATE azure.playwright_testing.accounts
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a Account.

REPLACE azure.playwright_testing.accounts
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a Account.

DELETE FROM azure.playwright_testing.accounts
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

check_name_availability

Adds check global name availability operation, normally used if a resource name must be globally unique.

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