Accounts - Create Or Update

Service:

Playwright Testing Service

API Version:

2024-12-01

Create a Account

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzurePlaywrightService/accounts/{accountName}?api-version=2024-12-01

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z]{1}[a-zA-Z0-9]{2,63}$	Name of account.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
location	True	string	The geo-location where the resource lives
properties.localAuth		EnablementStatus	When enabled, this feature allows the workspace to use local auth (through service access token) for executing operations.
properties.regionalAffinity		EnablementStatus	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.
properties.reporting		EnablementStatus	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.
properties.scalableExecution		EnablementStatus	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.
tags		object	Resource tags.

Responses

Name	Type	Description
200 OK	Account	Resource 'Account' update operation succeeded
201 Created	Account	Resource 'Account' create operation succeeded Headers Retry-After: integer
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Accounts_CreateOrUpdate

Sample request

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount?api-version=2024-12-01

{
  "location": "westus",
  "tags": {
    "Team": "Dev Exp"
  },
  "properties": {
    "regionalAffinity": "Enabled"
  }
}

Java

import com.azure.resourcemanager.playwrighttesting.models.AccountProperties;
import com.azure.resourcemanager.playwrighttesting.models.EnablementStatus;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Accounts CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2024-12-01/Accounts_CreateOrUpdate.json
     */
    /**
     * Sample code: Accounts_CreateOrUpdate.
     * 
     * @param manager Entry point to PlaywrightTestingManager.
     */
    public static void
        accountsCreateOrUpdate(com.azure.resourcemanager.playwrighttesting.PlaywrightTestingManager manager) {
        manager.accounts().define("myPlaywrightAccount").withRegion("westus").withExistingResourceGroup("dummyrg")
            .withTags(mapOf("Team", "Dev Exp"))
            .withProperties(new AccountProperties().withRegionalAffinity(EnablementStatus.ENABLED)).create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.playwrighttesting import PlaywrightTestingMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-playwrighttesting
# USAGE
    python accounts_create_or_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PlaywrightTestingMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.accounts.begin_create_or_update(
        resource_group_name="dummyrg",
        account_name="myPlaywrightAccount",
        resource={"location": "westus", "properties": {"regionalAffinity": "Enabled"}, "tags": {"Team": "Dev Exp"}},
    ).result()
    print(response)


# x-ms-original-file: 2024-12-01/Accounts_CreateOrUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armplaywrighttesting_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/playwrighttesting/armplaywrighttesting"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/2bde125befabb21807a2021765901f20e3e74ec8/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/stable/2024-12-01/examples/Accounts_CreateOrUpdate.json
func ExampleAccountsClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armplaywrighttesting.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewAccountsClient().BeginCreateOrUpdate(ctx, "dummyrg", "myPlaywrightAccount", armplaywrighttesting.Account{
		Location: to.Ptr("westus"),
		Tags: map[string]*string{
			"Team": to.Ptr("Dev Exp"),
		},
		Properties: &armplaywrighttesting.AccountProperties{
			RegionalAffinity: to.Ptr(armplaywrighttesting.EnablementStatusEnabled),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Account = armplaywrighttesting.Account{
	// 	Name: to.Ptr("myPlaywrightAccount"),
	// 	Type: to.Ptr("Microsoft.AzurePlaywrightService/accounts"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount"),
	// 	SystemData: &armplaywrighttesting.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-09-28T12:32:33.000Z"); return t}()),
	// 		CreatedBy: to.Ptr("userId1001"),
	// 		CreatedByType: to.Ptr(armplaywrighttesting.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-09-28T12:32:33.000Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("userId1001"),
	// 		LastModifiedByType: to.Ptr(armplaywrighttesting.CreatedByTypeUser),
	// 	},
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"Team": to.Ptr("Dev Exp"),
	// 	},
	// 	Properties: &armplaywrighttesting.AccountProperties{
	// 		DashboardURI: to.Ptr("https://dashboard.00000000-0000-0000-0000-000000000000.domain.com"),
	// 		LocalAuth: to.Ptr(armplaywrighttesting.EnablementStatusEnabled),
	// 		ProvisioningState: to.Ptr(armplaywrighttesting.ProvisioningStateSucceeded),
	// 		RegionalAffinity: to.Ptr(armplaywrighttesting.EnablementStatusEnabled),
	// 		Reporting: to.Ptr(armplaywrighttesting.EnablementStatusEnabled),
	// 		ScalableExecution: to.Ptr(armplaywrighttesting.EnablementStatusEnabled),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AzurePlaywrightServiceClient } = require("@azure/arm-playwrighttesting");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to create a Account
 *
 * @summary create a Account
 * x-ms-original-file: 2024-12-01/Accounts_CreateOrUpdate.json
 */
async function accountsCreateOrUpdate() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new AzurePlaywrightServiceClient(credential, subscriptionId);
  const result = await client.accounts.createOrUpdate("dummyrg", "myPlaywrightAccount", {
    location: "westus",
    tags: { Team: "Dev Exp" },
    properties: { regionalAffinity: "Enabled" },
  });
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.PlaywrightTesting.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.PlaywrightTesting;

// Generated from example definition: 2024-12-01/Accounts_CreateOrUpdate.json
// this example is just showing the usage of "Account_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "dummyrg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this PlaywrightTestingAccountResource
PlaywrightTestingAccountCollection collection = resourceGroupResource.GetPlaywrightTestingAccounts();

// invoke the operation
string accountName = "myPlaywrightAccount";
PlaywrightTestingAccountData data = new PlaywrightTestingAccountData(new AzureLocation("westus"))
{
    Properties = new PlaywrightTestingAccountProperties
    {
        RegionalAffinity = PlaywrightTestingEnablementStatus.Enabled,
    },
    Tags =
    {
    ["Team"] = "Dev Exp"
    },
};
ArmOperation<PlaywrightTestingAccountResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, accountName, data);
PlaywrightTestingAccountResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
PlaywrightTestingAccountData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "location": "westus",
  "properties": {
    "dashboardUri": "https://dashboard.00000000-0000-0000-0000-000000000000.domain.com",
    "provisioningState": "Succeeded",
    "regionalAffinity": "Enabled",
    "scalableExecution": "Enabled",
    "reporting": "Enabled",
    "localAuth": "Enabled"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount",
  "name": "myPlaywrightAccount",
  "type": "Microsoft.AzurePlaywrightService/accounts",
  "tags": {
    "Team": "Dev Exp"
  },
  "systemData": {
    "createdBy": "userId1001",
    "createdByType": "User",
    "createdAt": "2021-09-28T12:32:33Z",
    "lastModifiedBy": "userId1001",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-09-28T12:32:33Z"
  }
}

Status code:

201

Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.PlaywrightTesting/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2023-06-01-preview

{
  "location": "westus",
  "properties": {
    "dashboardUri": "https://dashboard.00000000-0000-0000-0000-000000000000.domain.com",
    "provisioningState": "Succeeded",
    "regionalAffinity": "Enabled",
    "scalableExecution": "Enabled",
    "reporting": "Enabled",
    "localAuth": "Enabled"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount",
  "name": "myPlaywrightAccount",
  "type": "Microsoft.AzurePlaywrightService/accounts",
  "tags": {
    "Team": "Dev Exp"
  },
  "systemData": {
    "createdBy": "userId1001",
    "createdByType": "User",
    "createdAt": "2021-09-28T12:32:33Z",
    "lastModifiedBy": "userId1001",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-09-28T12:32:33Z"
  }
}

Definitions

Name	Description
Account	A Playwright service account resource.
createdByType	The type of identity that created the resource.
EnablementStatus	The enablement status of a feature.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ProvisioningState	The status of the current operation.
systemData	Metadata pertaining to creation and last modification of the resource.

Account

Object

A Playwright service account resource.

Name	Type	Default value	Description
id	string (arm-id)		Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string		The geo-location where the resource lives
name	string		The name of the resource
properties.dashboardUri	string (uri)		The Playwright testing dashboard URI for the account resource.
properties.localAuth	EnablementStatus	Disabled	When enabled, this feature allows the workspace to use local auth (through service access token) for executing operations.
properties.provisioningState	ProvisioningState		The status of the last operation.
properties.regionalAffinity	EnablementStatus	Enabled	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.
properties.reporting	EnablementStatus	Enabled	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.
properties.scalableExecution	EnablementStatus	Enabled	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.
systemData	systemData		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"

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

EnablementStatus

Enumeration

The enablement status of a feature.

Value	Description
Enabled	The feature is Enabled.
Disabled	The feature is Disabled.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ProvisioningState

Enumeration

The status of the current operation.

Value	Description
Succeeded	Resource has been created.
Failed	Resource creation failed.
Canceled	Resource creation was canceled.
Creating	Creation in progress..
Deleting	Deletion in progress..
Accepted	Change accepted for processing..

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.