Azure Resource Manager Playwright Dotnet

1---
2name: azure-resource-manager-playwright-dotnet
3description: |
4  Azure Resource Manager SDK for Microsoft Playwright Testing in .NET. Use for MANAGEMENT PLANE operations: creating/managing Playwright Testing workspaces, checking name availability, and managing workspace quotas via Azure Resource Manager. NOT for running Playwright tests - use Azure.Developer.MicrosoftPlaywrightTesting.NUnit for that. Triggers: "Playwright workspace", "create Playwright Testing workspace", "manage Playwright resources", "ARM Playwright", "PlaywrightWorkspaceResource", "provision Playwright Testing".
5package: Azure.ResourceManager.Playwright
6---
7 
8# Azure.ResourceManager.Playwright (.NET)
9 
10Management plane SDK for provisioning and managing Microsoft Playwright Testing workspaces via Azure Resource Manager.
11 
12> **⚠️ Management vs Test Execution**
13> - **This SDK (Azure.ResourceManager.Playwright)**: Create workspaces, manage quotas, check name availability
14> - **Test Execution SDK (Azure.Developer.MicrosoftPlaywrightTesting.NUnit)**: Run Playwright tests at scale on cloud browsers
15 
16## Installation
17 
18```bash
19dotnet add package Azure.ResourceManager.Playwright
20dotnet add package Azure.Identity
21```
22 
23**Current Versions**: Stable v1.0.0, Preview v1.0.0-beta.1
24 
25## Environment Variables
26 
27```bash
28AZURE_SUBSCRIPTION_ID=<your-subscription-id>
29# For service principal auth (optional)
30AZURE_TENANT_ID=<tenant-id>
31AZURE_CLIENT_ID=<client-id>
32AZURE_CLIENT_SECRET=<client-secret>
33```
34 
35## Authentication
36 
37```csharp
38using Azure.Identity;
39using Azure.ResourceManager;
40using Azure.ResourceManager.Playwright;
41 
42// Always use DefaultAzureCredential
43var credential = new DefaultAzureCredential();
44var armClient = new ArmClient(credential);
45 
46// Get subscription
47var subscriptionId = Environment.GetEnvironmentVariable("AZURE_SUBSCRIPTION_ID");
48var subscription = armClient.GetSubscriptionResource(
49    new ResourceIdentifier($"/subscriptions/{subscriptionId}"));
50```
51 
52## Resource Hierarchy
53 
54```
55ArmClient
56└── SubscriptionResource
57    ├── PlaywrightQuotaResource (subscription-level quotas)
58    └── ResourceGroupResource
59        └── PlaywrightWorkspaceResource
60            └── PlaywrightWorkspaceQuotaResource (workspace-level quotas)
61```
62 
63## Core Workflow
64 
65### 1. Create Playwright Workspace
66 
67```csharp
68using Azure.ResourceManager.Playwright;
69using Azure.ResourceManager.Playwright.Models;
70 
71// Get resource group
72var resourceGroup = await subscription
73    .GetResourceGroupAsync("my-resource-group");
74 
75// Define workspace
76var workspaceData = new PlaywrightWorkspaceData(AzureLocation.WestUS3)
77{
78    // Optional: Configure regional affinity and local auth
79    RegionalAffinity = PlaywrightRegionalAffinity.Enabled,
80    LocalAuth = PlaywrightLocalAuth.Enabled,
81    Tags =
82    {
83        ["Team"] = "Dev Exp",
84        ["Environment"] = "Production"
85    }
86};
87 
88// Create workspace (long-running operation)
89var workspaceCollection = resourceGroup.Value.GetPlaywrightWorkspaces();
90var operation = await workspaceCollection.CreateOrUpdateAsync(
91    WaitUntil.Completed,
92    "my-playwright-workspace",
93    workspaceData);
94 
95PlaywrightWorkspaceResource workspace = operation.Value;
96 
97// Get the data plane URI for running tests
98Console.WriteLine($"Data Plane URI: {workspace.Data.DataplaneUri}");
99Console.WriteLine($"Workspace ID: {workspace.Data.WorkspaceId}");
100```
101 
102### 2. Get Existing Workspace
103 
104```csharp
105// Get by name
106var workspace = await workspaceCollection.GetAsync("my-playwright-workspace");
107 
108// Or check if exists first
109bool exists = await workspaceCollection.ExistsAsync("my-playwright-workspace");
110if (exists)
111{
112    var existingWorkspace = await workspaceCollection.GetAsync("my-playwright-workspace");
113    Console.WriteLine($"Workspace found: {existingWorkspace.Value.Data.Name}");
114}
115```
116 
117### 3. List Workspaces
118 
119```csharp
120// List in resource group
121await foreach (var workspace in workspaceCollection.GetAllAsync())
122{
123    Console.WriteLine($"Workspace: {workspace.Data.Name}");
124    Console.WriteLine($"  Location: {workspace.Data.Location}");
125    Console.WriteLine($"  State: {workspace.Data.ProvisioningState}");
126    Console.WriteLine($"  Data Plane URI: {workspace.Data.DataplaneUri}");
127}
128 
129// List across subscription
130await foreach (var workspace in subscription.GetPlaywrightWorkspacesAsync())
131{
132    Console.WriteLine($"Workspace: {workspace.Data.Name}");
133}
134```
135 
136### 4. Update Workspace
137 
138```csharp
139var patch = new PlaywrightWorkspacePatch
140{
141    Tags =
142    {
143        ["Team"] = "Dev Exp",
144        ["Environment"] = "Staging",
145        ["UpdatedAt"] = DateTime.UtcNow.ToString("o")
146    }
147};
148 
149var updatedWorkspace = await workspace.Value.UpdateAsync(patch);
150```
151 
152### 5. Check Name Availability
153 
154```csharp
155using Azure.ResourceManager.Playwright.Models;
156 
157var checkRequest = new PlaywrightCheckNameAvailabilityContent
158{
159    Name = "my-new-workspace",
160    ResourceType = "Microsoft.LoadTestService/playwrightWorkspaces"
161};
162 
163var result = await subscription.CheckPlaywrightNameAvailabilityAsync(checkRequest);
164 
165if (result.Value.IsNameAvailable == true)
166{
167    Console.WriteLine("Name is available!");
168}
169else
170{
171    Console.WriteLine($"Name unavailable: {result.Value.Message}");
172    Console.WriteLine($"Reason: {result.Value.Reason}");
173}
174```
175 
176### 6. Get Quota Information
177 
178```csharp
179// Subscription-level quotas
180await foreach (var quota in subscription.GetPlaywrightQuotasAsync(AzureLocation.WestUS3))
181{
182    Console.WriteLine($"Quota: {quota.Data.Name}");
183    Console.WriteLine($"  Limit: {quota.Data.Limit}");
184    Console.WriteLine($"  Used: {quota.Data.Used}");
185}
186 
187// Workspace-level quotas
188var workspaceQuotas = workspace.Value.GetAllPlaywrightWorkspaceQuota();
189await foreach (var quota in workspaceQuotas.GetAllAsync())
190{
191    Console.WriteLine($"Workspace Quota: {quota.Data.Name}");
192}
193```
194 
195### 7. Delete Workspace
196 
197```csharp
198// Delete (long-running operation)
199await workspace.Value.DeleteAsync(WaitUntil.Completed);
200```
201 
202## Key Types Reference
203 
204| Type | Purpose |
205|------|---------|
206| `ArmClient` | Entry point for all ARM operations |
207| `PlaywrightWorkspaceResource` | Represents a Playwright Testing workspace |
208| `PlaywrightWorkspaceCollection` | Collection for workspace CRUD |
209| `PlaywrightWorkspaceData` | Workspace creation/response payload |
210| `PlaywrightWorkspacePatch` | Workspace update payload |
211| `PlaywrightQuotaResource` | Subscription-level quota information |
212| `PlaywrightWorkspaceQuotaResource` | Workspace-level quota information |
213| `PlaywrightExtensions` | Extension methods for ARM resources |
214| `PlaywrightCheckNameAvailabilityContent` | Name availability check request |
215 
216## Workspace Properties
217 
218| Property | Description |
219|----------|-------------|
220| `DataplaneUri` | URI for running tests (e.g., `https://api.dataplane.{guid}.domain.com`) |
221| `WorkspaceId` | Unique workspace identifier (GUID) |
222| `RegionalAffinity` | Enable/disable regional affinity for test execution |
223| `LocalAuth` | Enable/disable local authentication (access tokens) |
224| `ProvisioningState` | Current provisioning state (Succeeded, Failed, etc.) |
225 
226## Best Practices
227 
2281. **Use `WaitUntil.Completed`** for operations that must finish before proceeding
2292. **Use `WaitUntil.Started`** when you want to poll manually or run operations in parallel
2303. **Always use `DefaultAzureCredential`** — never hardcode keys
2314. **Handle `RequestFailedException`** for ARM API errors
2325. **Use `CreateOrUpdateAsync`** for idempotent operations
2336. **Navigate hierarchy** via `Get*` methods (e.g., `resourceGroup.GetPlaywrightWorkspaces()`)
2347. **Store the DataplaneUri** after workspace creation for test execution configuration
235 
236## Error Handling
237 
238```csharp
239using Azure;
240 
241try
242{
243    var operation = await workspaceCollection.CreateOrUpdateAsync(
244        WaitUntil.Completed, workspaceName, workspaceData);
245}
246catch (RequestFailedException ex) when (ex.Status == 409)
247{
248    Console.WriteLine("Workspace already exists");
249}
250catch (RequestFailedException ex) when (ex.Status == 400)
251{
252    Console.WriteLine($"Bad request: {ex.Message}");
253}
254catch (RequestFailedException ex)
255{
256    Console.WriteLine($"ARM Error: {ex.Status} - {ex.ErrorCode}: {ex.Message}");
257}
258```
259 
260## Integration with Test Execution
261 
262After creating a workspace, use the `DataplaneUri` to configure your Playwright tests:
263 
264```csharp
265// 1. Create workspace (this SDK)
266var workspace = await workspaceCollection.CreateOrUpdateAsync(
267    WaitUntil.Completed, "my-workspace", workspaceData);
268 
269// 2. Get the service URL
270var serviceUrl = workspace.Value.Data.DataplaneUri;
271 
272// 3. Set environment variable for test execution
273Environment.SetEnvironmentVariable("PLAYWRIGHT_SERVICE_URL", serviceUrl.ToString());
274 
275// 4. Run tests using Azure.Developer.MicrosoftPlaywrightTesting.NUnit
276// (separate package for test execution)
277```
278 
279## Related SDKs
280 
281| SDK | Purpose | Install |
282|-----|---------|---------|
283| `Azure.ResourceManager.Playwright` | Management plane (this SDK) | `dotnet add package Azure.ResourceManager.Playwright` |
284| `Azure.Developer.MicrosoftPlaywrightTesting.NUnit` | Run NUnit Playwright tests at scale | `dotnet add package Azure.Developer.MicrosoftPlaywrightTesting.NUnit --prerelease` |
285| `Azure.Developer.Playwright` | Playwright client library | `dotnet add package Azure.Developer.Playwright` |
286 
287## API Information
288 
289- **Resource Provider**: `Microsoft.LoadTestService`
290- **Default API Version**: `2025-09-01`
291- **Resource Type**: `Microsoft.LoadTestService/playwrightWorkspaces`
292 
293## Documentation Links
294 
295- [Azure.ResourceManager.Playwright API Reference](https://learn.microsoft.com/en-us/dotnet/api/azure.resourcemanager.playwright)
296- [Microsoft Playwright Testing Overview](https://learn.microsoft.com/en-us/azure/playwright-testing/overview-what-is-microsoft-playwright-testing)
297- [Quickstart: Run Playwright Tests at Scale](https://learn.microsoft.com/en-us/azure/playwright-testing/quickstart-run-end-to-end-tests)
298