[DevCenter] Data Plane v2023-04-01 .NET SDK stable, tests, and samples

sdk/devcenter/Azure.Developer.DevCenter/CHANGELOG.md

@@ -1,11 +1,17 @@
 # Release History
 
-## 1.0.0-beta.4 (Unreleased)
+## 1.0.0 (Unreleased)
+This Azure DevCenter library release uses the 2023-04-01 GA API.
 
 ### Features Added
 
+- Added models and models serialization for each Dev Center concept
+- Added methods in the clients returning the serialized model, not only BinaryData
+
 ### Breaking Changes
 
+- Renamed `AzureDeveloperDevCenterClientOptions` back to `DevCenterClientOptions` 
+
 ### Bugs Fixed
 
 ### Other Changes

sdk/devcenter/Azure.Developer.DevCenter/README.md

@@ -52,6 +52,13 @@ var devBoxesClient = new DevBoxesClient(endpoint, credential);
 var environmentsClient = new DeploymentEnvironmentsClient(endpoint, credential);
 ```
 
+Alternatively  use `DevCenterClient` to create `DevBoxesClient` and `DeploymentEnvironmentsClient` sharing same endpoint and credential across clients. 
+
+```C# Snippet:Azure_DevCenter_CreateClientsFromDevCenterClient_Scenario
+devBoxesClient = devCenterClient.GetDevBoxesClient();
+environmentsClient = devCenterClient.GetDeploymentEnvironmentsClient();
+```
+
 ### Thread safety
 
 We guarantee that all client instance methods are thread-safe and independent of each other ([guideline](https://azure.github.io/azure-sdk/dotnet_introduction.html#dotnet-service-methods-thread-safety)). This ensures that the recommendation of reusing client instances is always safe, even across threads.
@@ -76,61 +83,57 @@ You can familiarize yourself with different APIs using [Samples](https://github.
 `DevCenterClient` allows you to list projects and retrieve projects by their name.
 
 ```C# Snippet:Azure_DevCenter_GetProjects_Scenario
-string targetProjectName = null;
-await foreach (BinaryData data in devCenterClient.GetProjectsAsync(null, null, null))
-{
-    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
-    targetProjectName = result.GetProperty("name").ToString();
-}
+string devCenterUri = "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com";
+var endpoint = new Uri(devCenterUri);
+var credential = new DefaultAzureCredential();
+var devCenterClient = new DevCenterClient(endpoint, credential);
+
+List<DevCenterProject> projects = await devCenterClient.GetProjectsAsync().ToEnumerableAsync();
+var projectName = projects.FirstOrDefault().Name;
 ```
 
 ### List available Dev Box Pools
 
 Interaction with DevBox pools is facilitated through the `DevBoxesClient`. Pools can be listed for a specific project or fetched individually.
 
 ```C# Snippet:Azure_DevCenter_GetPools_Scenario
-string targetPoolName = null;
-await foreach (BinaryData data in devBoxesClient.GetPoolsAsync(targetProjectName, null, null, null))
-{
-    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
-    targetPoolName = result.GetProperty("name").ToString();
-}
+// Create DevBox-es client from existing DevCenter client
+var devBoxesClient = devCenterClient.GetDevBoxesClient();
+
+// Grab a pool
+List<DevBoxPool> pools = await devBoxesClient.GetPoolsAsync(projectName).ToEnumerableAsync();
+var poolName = pools.FirstOrDefault().Name;
 ```
 
 ### Provision a Dev Box
 
 To create a new DevBox, provide the pool name in the content and specify the desired DevBox name. Upon successful execution of this operation, a DevBox should appear in the portal.
 
 ```C# Snippet:Azure_DevCenter_CreateDevBox_Scenario
-var content = new
-{
-    poolName = targetPoolName,
-};
+var devBoxName = "MyDevBox";
+var devBox = new DevBox(devBoxName, poolName);
 
-Operation<BinaryData> devBoxCreateOperation = await devBoxesClient.CreateDevBoxAsync(
+Operation<DevBox> devBoxCreateOperation = await devBoxesClient.CreateDevBoxAsync(
     WaitUntil.Completed,
-    targetProjectName,
+    projectName,
     "me",
-    "MyDevBox",
-    RequestContent.Create(content));
+    devBox);
 
-BinaryData devBoxData = await devBoxCreateOperation.WaitForCompletionAsync();
-JsonElement devBox = JsonDocument.Parse(devBoxData.ToStream()).RootElement;
-Console.WriteLine($"Completed provisioning for dev box with status {devBox.GetProperty("provisioningState")}.");
+devBox = await devBoxCreateOperation.WaitForCompletionAsync();
+Console.WriteLine($"Completed provisioning for dev box with status {devBox.ProvisioningState}.");
 ```
 
 ### Connect to your Dev Box
 
 Once a DevBox is provisioned, you can connect to it using an RDP connection string. Below is a sample code that demonstrates how to retrieve it.
 
 ```C# Snippet:Azure_DevCenter_ConnectToDevBox_Scenario
-Response remoteConnectionResponse = await devBoxesClient.GetRemoteConnectionAsync(
-    targetProjectName,
+RemoteConnection remoteConnection = await devBoxesClient.GetRemoteConnectionAsync(
+    projectName,
     "me",
-    "MyDevBox",
-    null);
-JsonElement remoteConnectionData = JsonDocument.Parse(remoteConnectionResponse.ContentStream).RootElement;
-Console.WriteLine($"Connect using web URL {remoteConnectionData.GetProperty("webUrl")}.");
+    devBoxName);
+
+Console.WriteLine($"Connect using web URL {remoteConnection.WebUri}.");
 ```
 
 ### Delete the Dev Box
@@ -140,9 +143,9 @@ Deleting a DevBox is easy. It's much faster operation than creating a new DevBox
 ```C# Snippet:Azure_DevCenter_DeleteDevBox_Scenario
 Operation devBoxDeleteOperation = await devBoxesClient.DeleteDevBoxAsync(
     WaitUntil.Completed,
-    targetProjectName,
+    projectName,
     "me",
-    "MyDevBox");
+    devBoxName);
 await devBoxDeleteOperation.WaitForCompletionResponseAsync();
 Console.WriteLine($"Completed dev box deletion.");
 ```
@@ -152,64 +155,72 @@ Console.WriteLine($"Completed dev box deletion.");
 `DeploymentEnvironmentsClient` can be used to issue a request to get all catalogs in a project.
 
 ```C# Snippet:Azure_DevCenter_GetCatalogs_Scenario
-string catalogName = null;
+// Create deployment environments client from existing DevCenter client
+var environmentsClient = devCenterClient.GetDeploymentEnvironmentsClient();
 
-await foreach (BinaryData data in environmentsClient.GetCatalogsAsync(projectName, null, null))
+//List all catalogs and grab the first one
+//Using foreach, but could also use a List
+string catalogName = default;
+await foreach (DevCenterCatalog catalog in environmentsClient.GetCatalogsAsync(projectName))
 {
-    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
-    catalogName = result.GetProperty("name").ToString();
+    catalogName = catalog.Name;
+    break;
 }
+Console.WriteLine($"Using catalog {catalogName}");
 ```
 
 ## Get all environment definitions in a project for a catalog
 
 Environment definitions are a part of the catalog associated with your project. If you don't see the expected environment definitions in the results, please ensure that you have pushed your changes to the catalog repository and synchronized the catalog.
 
 ```C# Snippet:Azure_DevCenter_GetEnvironmentDefinitionsFromCatalog_Scenario
-string environmentDefinitionName = null;
-await foreach (BinaryData data in environmentsClient.GetEnvironmentDefinitionsByCatalogAsync(projectName, catalogName, maxCount: 1, context: new()))
+//List all environment definition for a catalog and grab the first one
+string environmentDefinitionName = default;
+await foreach (EnvironmentDefinition environmentDefinition in environmentsClient.GetEnvironmentDefinitionsByCatalogAsync(projectName, catalogName))
 {
-    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
-    environmentDefinitionName = result.GetProperty("name").ToString();
+    environmentDefinitionName = environmentDefinition.Name;
+    break;
 }
+Console.WriteLine($"Using environment definition {environmentDefinitionName}");
 ```
 
 ## Get all environment types in a project
 
 Issue a request to get all environment types in a project.
 
 ```C# Snippet:Azure_DevCenter_GetEnvironmentTypes_Scenario
-string environmentTypeName = null;
-await foreach (BinaryData data in environmentsClient.GetEnvironmentTypesAsync(projectName, null, null))
+//List all environment types and grab the first one
+string environmentTypeName = default;
+await foreach (DevCenterEnvironmentType environmentType in environmentsClient.GetEnvironmentTypesAsync(projectName))
 {
-    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
-    environmentTypeName = result.GetProperty("name").ToString();
+    environmentTypeName = environmentType.Name;
+    break;
 }
+Console.WriteLine($"Using environment type {environmentTypeName}");
 ```
 
 ## Create an environment
 
 Issue a request to create an environment using a specific definition item and environment type.
 
 ```C# Snippet:Azure_DevCenter_CreateEnvironment_Scenario
-var content = new
-{
-    catalogName = catalogName,
-    environmentType = environmentTypeName,
-    environmentDefinitionName = environmentDefinitionName,
-};
+var requestEnvironment = new DevCenterEnvironment
+(
+    "DevEnvironment",
+    environmentTypeName,
+    catalogName,
+    environmentDefinitionName
+);
 
 // Deploy the environment
-Operation<BinaryData> environmentCreateOperation = await environmentsClient.CreateOrUpdateEnvironmentAsync(
+Operation<DevCenterEnvironment> environmentCreateOperation = await environmentsClient.CreateOrUpdateEnvironmentAsync(
     WaitUntil.Completed,
     projectName,
     "me",
-    "DevEnvironment",
-    RequestContent.Create(content));
+    requestEnvironment);
 
-BinaryData environmentData = await environmentCreateOperation.WaitForCompletionAsync();
-JsonElement environment = JsonDocument.Parse(environmentData.ToStream()).RootElement;
-Console.WriteLine($"Completed provisioning for environment with status {environment.GetProperty("provisioningState")}.");
+DevCenterEnvironment environment = await environmentCreateOperation.WaitForCompletionAsync();
+Console.WriteLine($"Completed provisioning for environment with status {environment.ProvisioningState}.");
 ```
 
 ## Delete an environment