[Az.DevCenter] Update control plane to 2024-05-01-preview and add deprecation warnings (#25801)

* Schedule list as default, environment action test

* Update commands pass 1

* Update rest of commands

* Add customization

* Add examples

* Update examples

* update link

* Fix params

* Update commands

* Update version of autorest

* Update tests

* Updated tests

* Update data plane tests

* Data plane fixes

* Update tests

* Update tests

* Add subscription

* Add new project catalog test

* Update project catalog test

* Remove test

* update test

* Fix dp build errors

* Fix docs and examples

* Fix examples

* Fix examples

* Revert to previous operation status v3

* Fix data plane cmdlets

* Update env log and env type data plane

* Revert data plane to 2023-10-01, add warning to operation status for control plane

* Undo warning

* Add deprecation warnings

Author: am-lim

src/DevCenter/DevCenter.AutoRest/Az.DevCenter.psd1

@@ -11,7 +11,7 @@
   DotNetFrameworkVersion = '4.7.2'
   RequiredAssemblies = './bin/Az.DevCenter.private.dll'
   FormatsToProcess = './Az.DevCenter.format.ps1xml'
-  FunctionsToExport = 'Get-AzDevCenterAdminAttachedNetwork', 'Get-AzDevCenterAdminCatalog', 'Get-AzDevCenterAdminCatalogSyncErrorDetail', 'Get-AzDevCenterAdminDevBoxDefinition', 'Get-AzDevCenterAdminDevCenter', 'Get-AzDevCenterAdminEnvironmentDefinition', 'Get-AzDevCenterAdminEnvironmentDefinitionErrorDetail', 'Get-AzDevCenterAdminEnvironmentType', 'Get-AzDevCenterAdminGallery', 'Get-AzDevCenterAdminImage', 'Get-AzDevCenterAdminImageVersion', 'Get-AzDevCenterAdminNetworkConnection', 'Get-AzDevCenterAdminNetworkConnectionHealthDetail', 'Get-AzDevCenterAdminNetworkConnectionOutboundNetworkDependencyEndpoint', 'Get-AzDevCenterAdminOperationStatus', 'Get-AzDevCenterAdminPool', 'Get-AzDevCenterAdminProject', 'Get-AzDevCenterAdminProjectAllowedEnvironmentType', 'Get-AzDevCenterAdminProjectEnvironmentType', 'Get-AzDevCenterAdminSchedule', 'Get-AzDevCenterAdminSku', 'Get-AzDevCenterAdminUsage', 'Invoke-AzDevCenterAdminExecuteCheckNameAvailability', 'New-AzDevCenterAdminAttachedNetwork', 'New-AzDevCenterAdminCatalog', 'New-AzDevCenterAdminDevBoxDefinition', 'New-AzDevCenterAdminDevCenter', 'New-AzDevCenterAdminEnvironmentType', 'New-AzDevCenterAdminGallery', 'New-AzDevCenterAdminNetworkConnection', 'New-AzDevCenterAdminPool', 'New-AzDevCenterAdminProject', 'New-AzDevCenterAdminProjectEnvironmentType', 'New-AzDevCenterAdminSchedule', 'Remove-AzDevCenterAdminAttachedNetwork', 'Remove-AzDevCenterAdminCatalog', 'Remove-AzDevCenterAdminDevBoxDefinition', 'Remove-AzDevCenterAdminDevCenter', 'Remove-AzDevCenterAdminEnvironmentType', 'Remove-AzDevCenterAdminGallery', 'Remove-AzDevCenterAdminNetworkConnection', 'Remove-AzDevCenterAdminPool', 'Remove-AzDevCenterAdminProject', 'Remove-AzDevCenterAdminProjectEnvironmentType', 'Remove-AzDevCenterAdminSchedule', 'Start-AzDevCenterAdminNetworkConnectionHealthCheck', 'Start-AzDevCenterAdminPoolHealthCheck', 'Sync-AzDevCenterAdminCatalog', 'Update-AzDevCenterAdminCatalog', 'Update-AzDevCenterAdminDevBoxDefinition', 'Update-AzDevCenterAdminDevCenter', 'Update-AzDevCenterAdminEnvironmentType', 'Update-AzDevCenterAdminNetworkConnection', 'Update-AzDevCenterAdminPool', 'Update-AzDevCenterAdminProject', 'Update-AzDevCenterAdminProjectEnvironmentType', 'Update-AzDevCenterAdminSchedule', '*'
+  FunctionsToExport = 'Connect-AzDevCenterAdminCatalog', 'Connect-AzDevCenterAdminProjectCatalog', 'Get-AzDevCenterAdminAttachedNetwork', 'Get-AzDevCenterAdminCatalog', 'Get-AzDevCenterAdminCatalogSyncErrorDetail', 'Get-AzDevCenterAdminCustomizationTask', 'Get-AzDevCenterAdminCustomizationTaskErrorDetail', 'Get-AzDevCenterAdminDevBoxDefinition', 'Get-AzDevCenterAdminDevCenter', 'Get-AzDevCenterAdminEnvironmentDefinition', 'Get-AzDevCenterAdminEnvironmentDefinitionErrorDetail', 'Get-AzDevCenterAdminEnvironmentType', 'Get-AzDevCenterAdminGallery', 'Get-AzDevCenterAdminImage', 'Get-AzDevCenterAdminImageVersion', 'Get-AzDevCenterAdminNetworkConnection', 'Get-AzDevCenterAdminNetworkConnectionHealthDetail', 'Get-AzDevCenterAdminNetworkConnectionOutboundNetworkDependencyEndpoint', 'Get-AzDevCenterAdminOperationStatus', 'Get-AzDevCenterAdminPlan', 'Get-AzDevCenterAdminPlanMember', 'Get-AzDevCenterAdminPool', 'Get-AzDevCenterAdminProject', 'Get-AzDevCenterAdminProjectAllowedEnvironmentType', 'Get-AzDevCenterAdminProjectCatalog', 'Get-AzDevCenterAdminProjectCatalogSyncErrorDetail', 'Get-AzDevCenterAdminProjectEnvironmentDefinition', 'Get-AzDevCenterAdminProjectEnvironmentDefinitionErrorDetail', 'Get-AzDevCenterAdminProjectEnvironmentType', 'Get-AzDevCenterAdminProjectInheritedSetting', 'Get-AzDevCenterAdminSchedule', 'Get-AzDevCenterAdminSku', 'Get-AzDevCenterAdminUsage', 'Invoke-AzDevCenterAdminExecuteCheckNameAvailability', 'Invoke-AzDevCenterAdminExecuteCheckScopedNameAvailability', 'New-AzDevCenterAdminAttachedNetwork', 'New-AzDevCenterAdminCatalog', 'New-AzDevCenterAdminDevBoxDefinition', 'New-AzDevCenterAdminDevCenter', 'New-AzDevCenterAdminEnvironmentType', 'New-AzDevCenterAdminGallery', 'New-AzDevCenterAdminNetworkConnection', 'New-AzDevCenterAdminPlan', 'New-AzDevCenterAdminPlanMember', 'New-AzDevCenterAdminPool', 'New-AzDevCenterAdminProject', 'New-AzDevCenterAdminProjectCatalog', 'New-AzDevCenterAdminProjectEnvironmentType', 'New-AzDevCenterAdminSchedule', 'Remove-AzDevCenterAdminAttachedNetwork', 'Remove-AzDevCenterAdminCatalog', 'Remove-AzDevCenterAdminDevBoxDefinition', 'Remove-AzDevCenterAdminDevCenter', 'Remove-AzDevCenterAdminEnvironmentType', 'Remove-AzDevCenterAdminGallery', 'Remove-AzDevCenterAdminNetworkConnection', 'Remove-AzDevCenterAdminPlan', 'Remove-AzDevCenterAdminPlanMember', 'Remove-AzDevCenterAdminPool', 'Remove-AzDevCenterAdminProject', 'Remove-AzDevCenterAdminProjectCatalog', 'Remove-AzDevCenterAdminProjectEnvironmentType', 'Remove-AzDevCenterAdminSchedule', 'Start-AzDevCenterAdminNetworkConnectionHealthCheck', 'Start-AzDevCenterAdminPoolHealthCheck', 'Sync-AzDevCenterAdminCatalog', 'Sync-AzDevCenterAdminProjectCatalog', 'Update-AzDevCenterAdminCatalog', 'Update-AzDevCenterAdminDevBoxDefinition', 'Update-AzDevCenterAdminDevCenter', 'Update-AzDevCenterAdminEnvironmentType', 'Update-AzDevCenterAdminNetworkConnection', 'Update-AzDevCenterAdminPlan', 'Update-AzDevCenterAdminPlanMember', 'Update-AzDevCenterAdminPool', 'Update-AzDevCenterAdminProject', 'Update-AzDevCenterAdminProjectCatalog', 'Update-AzDevCenterAdminProjectEnvironmentType', 'Update-AzDevCenterAdminSchedule', '*'
   AliasesToExport = '*'
   PrivateData = @{
     PSData = @{

src/DevCenter/DevCenter.AutoRest/README.md

@@ -3,9 +3,6 @@
 This directory contains the PowerShell module for the DevCenter service.
 
 ---
-## Status
-[![Az.DevCenter](https://img.shields.io/powershellgallery/v/Az.DevCenter.svg?style=flat-square&label=Az.DevCenter "Az.DevCenter")](https://www.powershellgallery.com/packages/Az.DevCenter/)
-
 ## Info
 - Modifiable: yes
 - Generated: all
@@ -31,14 +28,14 @@ For information on how to develop for `Az.DevCenter`, see [how-to.md](how-to.md)
 
 ```yaml
 # pin the swagger version by using the commit id instead of branch name
-commit: b5e14f2fcc1e0de74c4dcf1d6e518f9faf743417
+commit: 490e7fec728b018ff3ab103a6e1cb09644452ccf
 require:
 # readme.azure.noprofile.md is the common configuration file
   - $(this-folder)/../../readme.azure.noprofile.md
 input-file:
-  - $(repo)/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2023-10-01-preview/commonDefinitions.json
-  - $(repo)/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2023-10-01-preview/devcenter.json
-  - $(repo)/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2023-10-01-preview/vdi.json
+  - $(repo)/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-05-01-preview/commonDefinitions.json
+  - $(repo)/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-05-01-preview/devcenter.json
+  - $(repo)/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-05-01-preview/vdi.json
 # For new modules, please avoid setting 3.x using the use-extension method and instead, use 4.x as the default option
 use-extension:
   "@autorest/powershell": "3.x"
@@ -50,6 +47,24 @@ directive:
       $['200'] = {
         "description": "OK. Successfully initiated sync."
       }
+  - from: swagger-document
+    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/sync"].post.responses
+    transform: >
+      $['200'] = {
+        "description": "OK. Successfully initiated sync."
+      }
+  - from: swagger-document
+    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/connect"].post.responses
+    transform: >
+      $['200'] = {
+        "description": "OK. The request has succeeded."
+      }
+  - from: swagger-document
+    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/connect"].post.responses
+    transform: >
+      $['200'] = {
+        "description": "OK. The request has succeeded."
+      }
   - from: swagger-document
     where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}"].put.responses
     transform: >
@@ -71,6 +86,147 @@ directive:
         "description": "OK. The request has succeeded.",
         "schema": {"$ref": "#/definitions/Catalog"}
       }
+  - from: swagger-document
+    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}"].put.responses
+    transform: >
+      $['200'] = {
+        "description": "OK. The request has succeeded.",
+        "schema": {"$ref": "#/definitions/Catalog"}
+      }
+  - from: swagger-document
+    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions/{environmentDefinitionName}"].get.operationId
+    transform: >-
+      return "ProjectEnvironmentDefinitions_Get"
+  - from: swagger-document
+    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions"].get.operationId
+    transform: >-
+      return "ProjectEnvironmentDefinitions_List"
+  - from: swagger-document
+    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions/{environmentDefinitionName}/getErrorDetails"].post.operationId
+    transform: >-
+      return "ProjectEnvironmentDefinitions_GetErrorDetails"
+  - from: swagger-document
+    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/attachednetworks/{attachedNetworkConnectionName}"].delete.responses
+    transform: >
+      $['200'] = {
+        "description": "OK. The request has succeeded."
+      }
+  - from: swagger-document
+    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}"].delete.responses
+    transform: >
+      $['200'] = {
+        "description": "OK. The request has succeeded."
+      }
+  - from: swagger-document
+    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}"].delete.responses
+    transform: >
+      $['200'] = {
+        "description": "OK. The request has succeeded."
+      }
+  - from: swagger-document
+    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/devboxdefinitions/{devBoxDefinitionName}"].delete.responses
+    transform: >
+      $['200'] = {
+        "description": "OK. The request has succeeded."
+      }
+  - from: swagger-document
+    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}"].delete.responses
+    transform: >
+      $['200'] = {
+        "description": "OK. The request has succeeded."
+      }
+  - from: swagger-document
+    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}"].delete.responses
+    transform: >
+      $['200'] = {
+        "description": "OK. The request has succeeded."
+      }
+  - from: swagger-document
+    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}"].delete.responses
+    transform: >
+      $['200'] = {
+        "description": "OK. The request has succeeded."
+      }
+  - from: swagger-document
+    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}"].delete.responses
+    transform: >
+      $['200'] = {
+        "description": "OK. The request has succeeded."
+      }
+  - from: swagger-document
+    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}"].delete.responses
+    transform: >
+      $['200'] = {
+        "description": "OK. The request has succeeded."
+      }
+  - from: swagger-document
+    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}/schedules/{scheduleName}"].delete.responses
+    transform: >
+      $['200'] = {
+        "description": "OK. The request has succeeded."
+      }
+  - from: swagger-document
+    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/plans/{planName}"].delete.responses
+    transform: >
+      $['200'] = {
+        "description": "OK. The request has succeeded."
+      }
+  - from: swagger-document
+    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/plans/{planName}/members/{memberName}"].delete.responses
+    transform: >
+      $['200'] = {
+        "description": "OK. The request has succeeded."
+      }
+  - from: swagger-document
+    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}/runHealthChecks"].post.responses
+    transform: >
+      $['200'] = {
+        "description": "OK. The request has succeeded."
+      }
+  - from: swagger-document
+    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}/runHealthChecks"].post.responses
+    transform: >
+      $['200'] = {
+        "description": "OK. The request has succeeded."
+      }
+  #Use v3 for OperationStatus, remove this for breaking change version
+  - from: swagger-document
+    where: $.definitions
+    transform: >
+      $['OperationStatus'] = {
+        "description": "The current status of an async operation",
+        "type": "object",
+        "allOf": [
+          {
+          "$ref": "https://github.com/Azure/azure-rest-api-specs/blob/490e7fec728b018ff3ab103a6e1cb09644452ccf/specification/common-types/resource-management/v3/types.json#/definitions/OperationStatusResult"
+          }
+        ],
+        "properties": {
+          "resourceId": {
+            "description": "The id of the resource.",
+            "type": "string",
+            "readOnly": true
+          },
+          "properties": {
+            "description": "Custom operation properties, populated only for a successful operation.",
+            "type": "object",
+            "readOnly": true
+          }
+        }
+      }
+  - where:
+      verb: Get
+      subject: OperationStatus
+    set:
+      breaking-change:
+        deprecated-cmdlet-output-type: OperationStatus
+        replacement-cmdlet-output-type: OperationStatus
+        deprecated-output-properties:
+          - ResourceId
+        change-description: The element type for property 'ResourceId' has been removed.
+        deprecated-by-version: 2.0.0
+        deprecated-by-azversion: 13.0.0
+        change-effective-date: 2024/11/19
   - where:
       parameter-name: Top
     hide: true
@@ -169,6 +325,11 @@ directive:
       subject: ExecuteCheckNameAvailability
       variant: ^Execute$|^ExecuteViaIdentity$
     remove: true
+  - where:
+      verb: Invoke
+      subject: ExecuteCheckScopedNameAvailability
+      variant: ^Execute$|^ExecuteViaIdentity$
+    remove: true
 # Set required parameters    
   - where:
       verb: New
@@ -187,14 +348,10 @@ directive:
     hide: true
   - where:
       verb: New
-      subject: ^AttachedNetwork$|^Catalog$|^DevBoxDefinition$|^Gallery$|^NetworkConnection$|^Pool$|^Project$|^ProjectEnvironmentType$
-    hide: true
-  - where:
-      subject: ^CatalogDevBoxDefinition$|^CatalogDevBoxDefinitionErrorDetail$|^CustomizationTask|^CustomizationTaskErrorDetail$
+      subject: ^AttachedNetwork$|^Catalog$|^DevBoxDefinition$|^Gallery$|^NetworkConnection$|^Pool$|^Project$|^ProjectEnvironmentType$|^ProjectCatalog$|^Plan$|^PlanMember$
     hide: true
   - where:
-      verb: Connect
-      subject: Catalog
+      subject: ^CatalogDevBoxDefinition$|^CatalogDevBoxDefinitionErrorDetail$|^EncryptionSet$
     hide: true
   - where:
       subject: OperationStatuses

src/DevCenter/DevCenter.AutoRest/UX/Microsoft.DevCenter/devcenters-attachednetworks.json

@@ -1,6 +1,6 @@
 {
   "resourceType": "devcenters/attachednetworks",
-  "apiVersion": "2023-10-01-preview",
+  "apiVersion": "2024-05-01-preview",
   "learnMore": {
     "url": "https://learn.microsoft.com/powershell/module/az.devcenter"
   },

src/DevCenter/DevCenter.AutoRest/UX/Microsoft.DevCenter/devcenters-catalogs-environmentDefinitions.json

@@ -1,6 +1,6 @@
 {
   "resourceType": "devcenters/catalogs/environmentDefinitions",
-  "apiVersion": "2023-10-01-preview",
+  "apiVersion": "2024-05-01-preview",
   "learnMore": {
     "url": "https://learn.microsoft.com/powershell/module/az.devcenter"
   },