Skip to content

Commit 4457a46

Browse files
azure-sdkazure-sdk
committed
Update docs metadata
1 parent 7e25785 commit 4457a46

File tree

2 files changed

+84
-31
lines changed

2 files changed

+84
-31
lines changed

‎api/overview/azure/preview/developer.playwright.nunit-readme.md

Lines changed: 79 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,24 @@
11
---
22
title: Azure Playwright NUnit client library for .NET
33
keywords: Azure, dotnet, SDK, API, Azure.Developer.Playwright.NUnit, loadtestservice
4-
ms.date: 07/01/2025
4+
ms.date: 08/06/2025
55
ms.topic: reference
66
ms.devlang: dotnet
77
ms.service: loadtestservice
88
---
9-
# Azure Playwright NUnit client library for .NET - version 1.0.0-beta.1
9+
# Azure Playwright NUnit client library for .NET - version 1.0.0-beta.2
1010

1111

1212
Azure Playwright is a fully managed service that uses the cloud to enable you to run Playwright tests with much higher parallelization across different operating system-browser combinations simultaneously. This means faster test runs with broader scenario coverage, which helps speed up delivery of features without sacrificing quality. The service also enables you to publish test results and related artifacts to the service and view them in the service portal enabling faster and easier troubleshooting. With Azure Playwright, you can release features faster and more confidently.
1313

14-
Ready to get started? Jump into our [quickstart guide](https://github.com/Azure/azure-sdk-for-net/tree/Azure.Developer.Playwright.NUnit_1.0.0-beta.1/sdk/loadtestservice/Azure.Developer.Playwright.NUnit/README.md#getting-started)!
14+
Ready to get started? Jump into our [quickstart guide](https://github.com/Azure/azure-sdk-for-net/tree/Azure.Developer.Playwright.NUnit_1.0.0-beta.2/sdk/loadtestservice/Azure.Developer.Playwright.NUnit/README.md#getting-started)!
1515

1616
## Useful links
1717

18-
- [Quickstart: Run end-to-end tests at scale](https://aka.ms/mpt/quickstart)
19-
- [View Azure Playwright service demo](https://youtu.be/GenC1jAeTZE)
20-
- [Documentation](https://aka.ms/mpt/docs)
21-
- [Pricing](https://aka.ms/mpt/pricing)
22-
- [Share feedback](https://aka.ms/mpt/feedback)
18+
- [Quickstart: Run end-to-end tests at scale](https://aka.ms/pww/docs/quickstart)
19+
- [Documentation](https://aka.ms/pww/docs)
20+
- [Pricing](https://aka.ms/pww/docs/pricing)
21+
- [Share feedback](https://aka.ms/pww/docs/feedback)
2322

2423
## Getting started
2524

@@ -38,21 +37,46 @@ dotnet add package Azure.Developer.Playwright.NUnit --prerelease
3837

3938
### Authenticate the client
4039

41-
To learn more about options for Microsoft Entra Id authentication, refer to [Azure.Identity credentials](https://github.com/Azure/azure-sdk-for-net/tree/Azure.Developer.Playwright.NUnit_1.0.0-beta.1/sdk/identity/Azure.Identity#credentials).
40+
To learn more about options for Microsoft Entra Id authentication, refer to [Azure.Identity credentials](https://github.com/Azure/azure-sdk-for-net/tree/Azure.Developer.Playwright.NUnit_1.0.0-beta.2/sdk/identity/Azure.Identity#credentials).
4241

4342
#### Create a Workspace
4443

45-
1. Sign in to the [Playwright portal](https://aka.ms/mpt/portal) with your Azure account.
44+
1. Sign in to the [Azure portal](https://portal.azure.com/) with your Azure account.
4645

47-
2. Create the Workspace
46+
1. Create the Workspace.
4847

49-
![Create new workspace](https://github.com/microsoft/playwright-testing-service/assets/12104064/d571e86b-9d43-48ac-a2b7-63afb9bb86a8)
48+
- Select the menu button in the upper-left corner of the portal, and then select Create a resource.
5049

51-
| Field | Description |
52-
| ---------------------- | ----------------------------------------------------------------------------------------------------- |
53-
| **Workspace Name** | A unique name to identify your workspace.<BR>The name can't contain special characters or whitespace. |
54-
| **Azure Subscription** | Select an Azure subscription where you want to create the workspace. |
55-
| **Region** | This is where test run data will be stored for your workspace. |
50+
![Create a resource in Azure portal](https://aka.ms/pww/docs/createurlsnapshot)
51+
52+
- Enter **Playwright Workspaces** in the search box.
53+
54+
- Select the **Playwright Workspaces** card, and then select **Create**.
55+
56+
![Search for Playwright Workspaces in Azure Marketplace](https://aka.ms/pww/docs/searchurlsnapshot)
57+
58+
- Provide the following information to configure a new Playwright workspace:
59+
60+
| Field | Description |
61+
|-------|-------------|
62+
| **Subscription** | Select the Azure subscription that you want to use for this Playwright workspace. |
63+
| **Resource group** | Select an existing resource group. Or select **Create new**, and then enter a unique name for the new resource group. |
64+
| **Name** | Enter a unique name to identify your workspace.<br/>The name can only consist of alphanumerical characters, and have a length between 3 and 64 characters. |
65+
| **Location** | Select a geographic location to host your workspace.<br/>This location also determines where the test execution results are stored. |
66+
67+
> [!NOTE]
68+
> Optionally, you can configure more details on the **Tags** tab. Tags are name/value pairs that enable you to categorize resources and view consolidated billing by applying the same tag to multiple resources and resource groups.
69+
70+
- After you're finished configuring the resource, select **Review + Create**.
71+
72+
- Review all the configuration settings and select **Create** to start the deployment of the Playwright workspace.
73+
74+
- When the process has finished, a deployment success message appears.
75+
76+
- To view the new workspace, select **Go to resource**.
77+
78+
![Deployment complete - Go to resource](https://aka.ms/pww/docs/deploymenturlsnapshot)
79+
|
5680

5781
> [!NOTE]
5882
> If you don't see this screen, select an existing workspace and go to the next section.
@@ -70,17 +94,46 @@ using Azure.Identity;
7094
namespace PlaywrightService.SampleTests; // Remember to change this as per your project namespace
7195
7296
[SetUpFixture]
73-
public class PlaywrightServiceNUnitSetup : PlaywrightServiceBrowserNUnit { }
97+
public class PlaywrightServiceNUnitSetup : PlaywrightServiceBrowserNUnit
98+
{
99+
public PlaywrightServiceNUnitSetup() : base(
100+
credential: new DefaultAzureCredential()
101+
)
102+
{ }
103+
}
104+
```
105+
106+
### Setup Azure Playwright cloud browser connection
107+
108+
Override builtin PageTest fixture with Azure Playwright cloud browser connection and use ServicePageTest in all test classes.
109+
110+
```csharp
111+
using Microsoft.Playwright.NUnit;
112+
using Azure.Developer.Playwright;
113+
using Azure.Identity;
114+
using Microsoft.Playwright;
115+
116+
namespace PlaywrightService.SampleTests;
117+
118+
public class ServicePageTest : PageTest
119+
{
120+
public override async Task<(string, BrowserTypeConnectOptions?)?> ConnectOptionsAsync()
121+
{
122+
PlaywrightServiceBrowserClient client = new PlaywrightServiceBrowserClient(credential: new DefaultAzureCredential());
123+
var connectOptions = await client.GetConnectOptionsAsync<BrowserTypeConnectOptions>();
124+
return (connectOptions.WsEndpoint, connectOptions.Options);
125+
}
126+
}
74127
```
75128

76129
> [!NOTE]
77-
> Make sure your project uses `Microsoft.Playwright.NUnit` version 1.37 or above.
130+
> Make sure your project uses `Microsoft.Playwright.NUnit` version 1.50.0 or above.
78131
79132
### Obtain region endpoint
80133

81-
1. In the [Playwright portal](https://aka.ms/mpt/portal), copy the command under **Add region endpoint in your set up**.
134+
1. In the [Playwright portal](https://portal.azure.com/), copy the command under **Add region endpoint in your set up**.
82135

83-
![Set workspace endpoint](https://github.com/microsoft/playwright-testing-service/assets/12104064/d81ca629-2b23-4d34-8b70-67b6f7061a83)
136+
![Set workspace endpoint](https://aka.ms/pww/docs/copyurlsnapshot)
84137

85138
The endpoint URL corresponds to the workspace region. You might see a different endpoint URL in the Playwright portal, depending on the region you selected when creating the workspace.
86139

@@ -98,13 +151,13 @@ dotnet test
98151

99152
## Key concepts
100153

101-
Key concepts of the Azure Playwright NUnit SDK for .NET can be found [here](https://aka.ms/mpt/what-is-mpt)
154+
Key concepts of the Azure Playwright NUnit SDK for .NET can be found [here](https://aka.ms/pww/docs/overview)
102155

103156
## Examples
104157

105158
Code samples for using this SDK can be found in the following locations
106159

107-
- [.NET Azure Playwright NUnit Library Code Samples](https://aka.ms/mpt/sample)
160+
- [.NET Azure Playwright NUnit Library Code Samples](https://aka.ms/pww/samples)
108161

109162
## Troubleshooting
110163

@@ -113,11 +166,11 @@ Code samples for using this SDK can be found in the following locations
113166

114167
## Next steps
115168

116-
- Run tests in a [CI/CD pipeline.](https://aka.ms/mpt/configure-pipeline)
169+
- Run tests in a [CI/CD pipeline.](https://aka.ms/pww/docs/configure-pipeline)
117170

118-
- Learn how to [manage access](https://aka.ms/mpt/manage-access) to the created workspace.
171+
- Learn how to [manage access](https://aka.ms/pww/docs/manage-access) to the created workspace.
119172

120-
- Experiment with different number of workers to [determine the optimal configuration of your test suite](https://aka.ms/mpt/parallelism).
173+
- Experiment with different number of workers to [determine the optimal configuration of your test suite](https://aka.ms/pww/docs/parallelism).
121174

122175
## Contributing
123176

‎metadata/preview/Azure.Developer.Playwright.NUnit.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"Name": "Azure.Developer.Playwright.NUnit",
3-
"Version": "1.0.0-beta.1",
3+
"Version": "1.0.0-beta.2",
44
"DevVersion": null,
55
"DirectoryPath": "sdk/loadtestservice/Azure.Developer.Playwright.NUnit",
66
"ServiceDirectory": "loadtestservice",
@@ -10,19 +10,19 @@
1010
"SdkType": "client",
1111
"IsNewSdk": true,
1212
"ArtifactName": "Azure.Developer.Playwright.NUnit",
13-
"ReleaseStatus": "2025-07-01",
13+
"ReleaseStatus": "2025-08-06",
1414
"IncludedForValidation": false,
1515
"AdditionalValidationPackages": null,
1616
"ArtifactDetails": {
17-
"name": "Azure.Developer.Playwright.NUnit",
17+
"safeName": "AzureDeveloperPlaywrightNUnit",
1818
"triggeringPaths": [
1919
"/sdk/loadtestservice/ci.yml"
2020
],
21-
"safeName": "AzureDeveloperPlaywrightNUnit"
21+
"name": "Azure.Developer.Playwright.NUnit"
2222
},
2323
"CIParameters": {
24-
"BuildSnippets": false,
2524
"CheckAOTCompat": false,
25+
"BuildSnippets": false,
2626
"CIMatrixConfigs": [],
2727
"AOTTestInputs": []
2828
},

0 commit comments

Comments
 (0)