[Az.DataProtection] Adding CmkEnryption parameters to Get-AzDataProtectionBackupVault, New-AzDataProtectionBackupVault and Update-AzDataProtectionBackupVault cmdlets (Azure#24654)

* cmk ps changes added

CmkEncryption tests added

CmkEncryption added to only UpdateExpanded variant

Updated help text for Update-AzDataProtectionBackupVault cmdlet

* output type and examples update

* Updated API version to 04-01
Added MUA changes for update-vault, stop-protection, suspend-backup, restore commands
re-recorded failed tests

* api version upgrade

* New-AzDataProtectionBackupVault example fix

* fixed CI issues

---------

Co-authored-by: Kartik Mahajan (from Dev Box) <[email protected]>
Co-authored-by: Himanshu Agarwal <[email protected]>

Author: 3 people

src/DataProtection/DataProtection.Autorest/Az.DataProtection.psd1

@@ -11,7 +11,7 @@
   DotNetFrameworkVersion = '4.7.2'
   RequiredAssemblies = './bin/Az.DataProtection.private.dll'
   FormatsToProcess = './Az.DataProtection.format.ps1xml'
-  FunctionsToExport = 'Backup-AzDataProtectionBackupInstanceAdhoc', 'Edit-AzDataProtectionPolicyRetentionRuleClientObject', 'Edit-AzDataProtectionPolicyTagClientObject', 'Edit-AzDataProtectionPolicyTriggerClientObject', 'Find-AzDataProtectionRestorableTimeRange', 'Get-AzDataProtectionBackupInstance', 'Get-AzDataProtectionBackupPolicy', 'Get-AzDataProtectionBackupVault', 'Get-AzDataProtectionJob', 'Get-AzDataProtectionOperation', 'Get-AzDataProtectionOperationStatus', 'Get-AzDataProtectionPolicyTemplate', 'Get-AzDataProtectionRecoveryPoint', 'Get-AzDataProtectionResourceGuard', 'Get-AzDataProtectionResourceGuardMapping', 'Get-AzDataProtectionSoftDeletedBackupInstance', 'Initialize-AzDataProtectionBackupInstance', 'Initialize-AzDataProtectionRestoreRequest', 'New-AzDataProtectionBackupConfigurationClientObject', 'New-AzDataProtectionBackupInstance', 'New-AzDataProtectionBackupPolicy', 'New-AzDataProtectionBackupVault', 'New-AzDataProtectionBackupVaultStorageSettingObject', 'New-AzDataProtectionPolicyTagCriteriaClientObject', 'New-AzDataProtectionPolicyTriggerScheduleClientObject', 'New-AzDataProtectionResourceGuard', 'New-AzDataProtectionRestoreConfigurationClientObject', 'New-AzDataProtectionRetentionLifeCycleClientObject', 'Remove-AzDataProtectionBackupInstance', 'Remove-AzDataProtectionBackupPolicy', 'Remove-AzDataProtectionBackupVault', 'Remove-AzDataProtectionResourceGuard', 'Remove-AzDataProtectionResourceGuardMapping', 'Resume-AzDataProtectionBackupInstanceProtection', 'Search-AzDataProtectionBackupInstanceInAzGraph', 'Search-AzDataProtectionBackupVaultInAzGraph', 'Search-AzDataProtectionJobInAzGraph', 'Set-AzDataProtectionMSIPermission', 'Set-AzDataProtectionResourceGuardMapping', 'Start-AzDataProtectionBackupInstanceRestore', 'Stop-AzDataProtectionBackupInstanceProtection', 'Suspend-AzDataProtectionBackupInstanceBackup', 'Sync-AzDataProtectionBackupInstance', 'Test-AzDataProtectionBackupInstanceReadiness', 'Test-AzDataProtectionBackupInstanceRestore', 'Undo-AzDataProtectionBackupInstanceDeletion', 'Unlock-AzDataProtectionResourceGuardOperation', 'Update-AzDataProtectionBackupInstance', 'Update-AzDataProtectionBackupInstanceAssociatedPolicy', 'Update-AzDataProtectionBackupVault', 'Update-AzDataProtectionResourceGuard', '*'
+  FunctionsToExport = 'Backup-AzDataProtectionBackupInstanceAdhoc', 'Edit-AzDataProtectionPolicyRetentionRuleClientObject', 'Edit-AzDataProtectionPolicyTagClientObject', 'Edit-AzDataProtectionPolicyTriggerClientObject', 'Find-AzDataProtectionRestorableTimeRange', 'Get-AzDataProtectionBackupInstance', 'Get-AzDataProtectionBackupInstancesExtensionRouting', 'Get-AzDataProtectionBackupPolicy', 'Get-AzDataProtectionBackupVault', 'Get-AzDataProtectionJob', 'Get-AzDataProtectionOperation', 'Get-AzDataProtectionOperationStatus', 'Get-AzDataProtectionPolicyTemplate', 'Get-AzDataProtectionRecoveryPoint', 'Get-AzDataProtectionResourceGuard', 'Get-AzDataProtectionResourceGuardMapping', 'Get-AzDataProtectionSoftDeletedBackupInstance', 'Initialize-AzDataProtectionBackupInstance', 'Initialize-AzDataProtectionRestoreRequest', 'New-AzDataProtectionBackupConfigurationClientObject', 'New-AzDataProtectionBackupInstance', 'New-AzDataProtectionBackupPolicy', 'New-AzDataProtectionBackupVault', 'New-AzDataProtectionBackupVaultStorageSettingObject', 'New-AzDataProtectionPolicyTagCriteriaClientObject', 'New-AzDataProtectionPolicyTriggerScheduleClientObject', 'New-AzDataProtectionResourceGuard', 'New-AzDataProtectionRestoreConfigurationClientObject', 'New-AzDataProtectionRetentionLifeCycleClientObject', 'Remove-AzDataProtectionBackupInstance', 'Remove-AzDataProtectionBackupPolicy', 'Remove-AzDataProtectionBackupVault', 'Remove-AzDataProtectionResourceGuard', 'Remove-AzDataProtectionResourceGuardMapping', 'Resume-AzDataProtectionBackupInstanceProtection', 'Search-AzDataProtectionBackupInstanceInAzGraph', 'Search-AzDataProtectionBackupVaultInAzGraph', 'Search-AzDataProtectionJobInAzGraph', 'Set-AzDataProtectionMSIPermission', 'Set-AzDataProtectionResourceGuardMapping', 'Start-AzDataProtectionBackupInstanceRestore', 'Stop-AzDataProtectionBackupInstanceProtection', 'Suspend-AzDataProtectionBackupInstanceBackup', 'Sync-AzDataProtectionBackupInstance', 'Test-AzDataProtectionBackupInstanceReadiness', 'Test-AzDataProtectionBackupInstanceRestore', 'Undo-AzDataProtectionBackupInstanceDeletion', 'Unlock-AzDataProtectionResourceGuardOperation', 'Update-AzDataProtectionBackupInstance', 'Update-AzDataProtectionBackupInstanceAssociatedPolicy', 'Update-AzDataProtectionBackupVault', 'Update-AzDataProtectionResourceGuard', '*'
   AliasesToExport = '*'
   PrivateData = @{
     PSData = @{

src/DataProtection/DataProtection.Autorest/README.md

@@ -31,11 +31,11 @@ This file contains the configuration for generating My API from the OpenAPI spec
 
 ``` yaml
 # it's the same options as command line options, just drop the double-dash!
-commit: 41d1c179dc166b7f16b7e40ef4f2a1d9c85b10cc
+commit: 72f52bc8847a889488da885f40d6871a89e0470b
 require:
   - $(this-folder)/../../readme.azure.noprofile.md
 input-file:
-  - $(repo)/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-12-01/dataprotection.json
+  - $(repo)/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/dataprotection.json
 title: DataProtection
 # For new modules, please avoid setting 3.x using the use-extension method and instead, use 4.x as the default option
 use-extension:
@@ -45,10 +45,6 @@ directive:
   - from: swagger-document
     where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}"].delete
     transform: $["description"] = "Delete a backupInstances"
-  - from: swagger-document
-    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}/unlockDelete"]["post"]["parameters"]
-    transform: >
-        $.push({"name": "x-ms-authorization-auxiliary","in": "header","type": "string"})
   - where:
       parameter-name: XmsAuthorizationAuxiliary
     set:
@@ -104,6 +100,10 @@ directive:
     set:
       parameter-name: SoftDeleteSetting
     clear-alias: true
+  - where:      
+      parameter-name: SecuritySettingEncryptionSetting
+    set:
+      parameter-name: EncryptionSetting
   - where:
       verb: Get
       subject: BackupVaultResource.*
@@ -159,15 +159,15 @@ directive:
       subject: ResourceGuardMapping
   - where:
       parameter-name: ResourceGuardProxyName
-    hide: true
+    hide: true 
     set:
       default:
         script: '"DppResourceGuardProxy"'
   - where:
       verb: New
       subject: ResourceGuardMapping
       parameter-name: LastUpdatedTime|Description|ResourceGuardOperationDetail
-    hide: true 
+    hide: true
   - where:
       verb: Get
       subject: DeletedBackupInstance
@@ -237,6 +237,26 @@ directive:
       verb: Start
       subject: .*Restore$
     hide: true
+  - where:
+      verb: Stop
+      subject: ^BackupInstanceProtection$
+      variant: Stop$|StopViaIdentityExpanded$
+    remove: true
+  - where:
+      verb: Stop
+      subject: ^BackupInstanceProtection$
+      variant: StopExpanded$|StopViaIdentity$
+    hide: true  
+  - where:
+      verb: Suspend
+      subject: ^BackupInstanceBackup$
+      variant: Suspend$|SuspendViaIdentityExpanded$
+    remove: true
+  - where:
+      verb: Suspend
+      subject: ^BackupInstanceBackup$
+      variant: SuspendExpanded$|SuspendViaIdentity$
+    hide: true
   - where:
       verb: Get
       subject: OperationResultPatch
@@ -249,6 +269,11 @@ directive:
       verb: New
       subject: BackupVault
     hide: true
+  - where:
+      verb: Update
+      subject: BackupVault
+      variant: ^UpdateExpanded$
+    hide: true
   - where:
       verb: Invoke
       variant: ^Post$|^PostViaIdentity$|^PostViaIdentityExpanded$
@@ -360,6 +385,22 @@ directive:
       property-name: SoftDeleteSettingState
     set:
       property-name: SoftDeleteState
+  - where:
+      property-name: SecuritySettingEncryptionSetting
+    set:
+      property-name: EncryptionSetting
+  - where:
+      property-name: InfrastructureEncryption
+    set:
+      property-name: CmkInfrastructureEncryption
+  - where:
+      property-name: KekIdentity
+    set:
+      property-name: CmkIdentity
+  - where:
+      property-name: KeyVaultProperty
+    set:
+      property-name: CmkKeyVaultProperty
   - where:
       subject: OperationStatus
       parameter-name: Location
@@ -396,18 +437,19 @@ directive:
     - UserFacingError    
     - ValidateRestoreRequestObject
     - ValidateCrossRegionRestoreRequestObject
+    - EncryptionSettings
   - from: source-file-csharp
     where: $
-    transform: $ = $.replace('internal Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231201.IBaseBackupPolicy Property', 'public Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231201.IBaseBackupPolicy Property');
+    transform: $ = $.replace('internal Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20240401.IBaseBackupPolicy Property', 'public Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20240401.IBaseBackupPolicy Property');
   - from: source-file-csharp
     where: $
-    transform: $ = $.replace('internal Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231201.ITriggerContext Trigger', 'public Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231201.ITriggerContext Trigger');
+    transform: $ = $.replace('internal Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20240401.ITriggerContext Trigger', 'public Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20240401.ITriggerContext Trigger');
   - from: source-file-csharp
     where: $
-    transform: $ = $.replace('internal Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231201.IBackupParameters BackupParameter', 'public Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231201.IBackupParameters BackupParameter');
+    transform: $ = $.replace('internal Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20240401.IBackupParameters BackupParameter', 'public Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20240401.IBackupParameters BackupParameter');
   - from: source-file-csharp
     where: $
-    transform: $ = $.replace('internal Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231201.IAzureBackupRecoveryPoint Property', 'public Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231201.IAzureBackupRecoveryPoint Property');
+    transform: $ = $.replace('internal Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20240401.IAzureBackupRecoveryPoint Property', 'public Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20240401.IAzureBackupRecoveryPoint Property');
 ```
 
 ## Alternate settings

src/DataProtection/DataProtection.Autorest/UX/Microsoft.DataProtection/backupVaults-backupInstances-recoveryPoints.json

@@ -1,6 +1,6 @@
 {
   "resourceType": "backupVaults/backupInstances/recoveryPoints",
-  "apiVersion": "2023-12-01",
+  "apiVersion": "2024-04-01",
   "learnMore": {
     "url": "https://learn.microsoft.com/powershell/module/az.dataprotection"
   },

src/DataProtection/DataProtection.Autorest/UX/Microsoft.DataProtection/backupVaults-backupInstances.json

@@ -1,6 +1,6 @@
 {
   "resourceType": "backupVaults/backupInstances",
-  "apiVersion": "2023-12-01",
+  "apiVersion": "2024-04-01",
   "learnMore": {
     "url": "https://learn.microsoft.com/powershell/module/az.dataprotection"
   },
@@ -177,92 +177,6 @@
         }
       ]
     },
-    {
-      "name": "Stop-AzDataProtectionBackupInstanceProtection",
-      "description": "This operation will stop protection of a backup instance and data will be held forever",
-      "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/stopProtection",
-      "help": {
-        "learnMore": {
-          "url": "https://learn.microsoft.com/powershell/module/az.dataprotection/stop-azdataprotectionbackupinstanceprotection"
-        },
-        "parameterSets": [
-          {
-            "parameters": [
-              "-BackupInstanceName <String>",
-              "-ResourceGroupName <String>",
-              "[-SubscriptionId <String>]",
-              "-VaultName <String>"
-            ]
-          }
-        ]
-      },
-      "examples": [
-        {
-          "description": "This operation will stop protection of a backup instance and data will be held forever",
-          "parameters": [
-            {
-              "name": "-BackupInstanceName",
-              "value": "[Path.backupInstanceName]"
-            },
-            {
-              "name": "-ResourceGroupName",
-              "value": "[Path.resourceGroupName]"
-            },
-            {
-              "name": "-SubscriptionId",
-              "value": "[Path.subscriptionId]"
-            },
-            {
-              "name": "-VaultName",
-              "value": "[Path.vaultName]"
-            }
-          ]
-        }
-      ]
-    },
-    {
-      "name": "Suspend-AzDataProtectionBackupInstanceBackup",
-      "description": "This operation will stop backup for a backup instance and retains the backup data as per the policy (except latest Recovery point, which will be retained forever)",
-      "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/suspendBackups",
-      "help": {
-        "learnMore": {
-          "url": "https://learn.microsoft.com/powershell/module/az.dataprotection/suspend-azdataprotectionbackupinstancebackup"
-        },
-        "parameterSets": [
-          {
-            "parameters": [
-              "-BackupInstanceName <String>",
-              "-ResourceGroupName <String>",
-              "[-SubscriptionId <String>]",
-              "-VaultName <String>"
-            ]
-          }
-        ]
-      },
-      "examples": [
-        {
-          "description": "This operation will stop backup for a backup instance and retains the backup data as per the policy (except latest Recovery point, which will be retained forever)",
-          "parameters": [
-            {
-              "name": "-BackupInstanceName",
-              "value": "[Path.backupInstanceName]"
-            },
-            {
-              "name": "-ResourceGroupName",
-              "value": "[Path.resourceGroupName]"
-            },
-            {
-              "name": "-SubscriptionId",
-              "value": "[Path.subscriptionId]"
-            },
-            {
-              "name": "-VaultName",
-              "value": "[Path.vaultName]"
-            }
-          ]
-        }
-      ]
-    },
     {
       "name": "Test-AzDataProtectionBackupInstanceRestore",
       "description": "Validates if Restore can be triggered for a DataSource",

src/DataProtection/DataProtection.Autorest/UX/Microsoft.DataProtection/backupVaults-backupJobs.json

@@ -1,6 +1,6 @@
 {
   "resourceType": "backupVaults/backupJobs",
-  "apiVersion": "2023-12-01",
+  "apiVersion": "2024-04-01",
   "learnMore": {
     "url": "https://learn.microsoft.com/powershell/module/az.dataprotection"
   },

src/DataProtection/DataProtection.Autorest/UX/Microsoft.DataProtection/backupVaults-backupPolicies.json

@@ -1,6 +1,6 @@
 {
   "resourceType": "backupVaults/backupPolicies",
-  "apiVersion": "2023-12-01",
+  "apiVersion": "2024-04-01",
   "learnMore": {
     "url": "https://learn.microsoft.com/powershell/module/az.dataprotection"
   },

src/DataProtection/DataProtection.Autorest/UX/Microsoft.DataProtection/backupVaults-backupResourceGuardProxies.json

@@ -1,6 +1,6 @@
 {
   "resourceType": "backupVaults/backupResourceGuardProxies",
-  "apiVersion": "2023-12-01",
+  "apiVersion": "2024-04-01",
   "learnMore": {
     "url": "https://learn.microsoft.com/powershell/module/az.dataprotection"
   },

src/DataProtection/DataProtection.Autorest/UX/Microsoft.DataProtection/backupVaults-deletedBackupInstances.json

@@ -1,6 +1,6 @@
 {
   "resourceType": "backupVaults/deletedBackupInstances",
-  "apiVersion": "2023-12-01",
+  "apiVersion": "2024-04-01",
   "learnMore": {
     "url": "https://learn.microsoft.com/powershell/module/az.dataprotection"
   },

src/DataProtection/DataProtection.Autorest/UX/Microsoft.DataProtection/backupVaults.json

@@ -1,6 +1,6 @@
 {
   "resourceType": "backupVaults",
-  "apiVersion": "2023-12-01",
+  "apiVersion": "2024-04-01",
   "learnMore": {
     "url": "https://learn.microsoft.com/powershell/module/az.dataprotection"
   },

src/DataProtection/DataProtection.Autorest/UX/Microsoft.DataProtection/locations-operationStatus.json

@@ -1,6 +1,6 @@
 {
   "resourceType": "locations/operationStatus",
-  "apiVersion": "2023-12-01",
+  "apiVersion": "2024-04-01",
   "learnMore": {
     "url": "https://learn.microsoft.com/powershell/module/az.dataprotection"
   },