updated soft delete setting parameters

added examples for New/Update backup vault
re-recorded test case

Author: hiaga

src/DataProtection/Az.DataProtection.psd1

@@ -50,8 +50,7 @@
                'Stop-AzDataProtectionBackupInstanceProtection',
                'Suspend-AzDataProtectionBackupInstanceBackup',
                'Sync-AzDataProtectionBackupInstance',
-               'Update-AzDataProtectionResourceGuard',
-               'New-AzDataProtectionSoftDeleteSettingObject'
+               'Update-AzDataProtectionResourceGuard'
   AliasesToExport = '*'
   PrivateData = @{
     PSData = @{

src/DataProtection/README.md

@@ -66,6 +66,18 @@ directive:
       parameter-name: CrossSubscriptionRestoreState
       parameter-description: Cross subscription restore state of the vault. Allowed values are Disabled, Enabled, PermanentlyDisabled.
     clear-alias: true
+  - where:      
+      parameter-name: SoftDeleteSettingRetentionDurationInDay
+    set:
+      parameter-name: SoftDeleteRetentionDurationInDay
+      parameter-description: Soft delete retention duration in days.
+    clear-alias: true
+  - where:      
+      parameter-name: SoftDeleteSettingState
+    set:
+      parameter-name: SoftDeleteState
+      parameter-description: Soft delete state of the vault. Allowed values are Off, On, AlwaysOn.
+    clear-alias: true
   - where:      
       parameter-name: SecuritySettingSoftDeleteSetting
     set:
@@ -249,6 +261,14 @@ directive:
       property-name: CrossSubscriptionRestoreSettingState
     set:
       property-name: CrossSubscriptionRestoreState
+  - where:
+      property-name: SoftDeleteSettingRetentionDurationInDay
+    set:
+      property-name: SoftDeleteRetentionDurationInDay
+  - where:
+      property-name: SoftDeleteSettingState
+    set:
+      property-name: SoftDeleteState
   - where:
       model-name: BackupVaultResource
     set:
@@ -268,8 +288,7 @@ directive:
     - RestoreTargetInfoBase
     - PolicyParameters
     - SecretStoreBasedAuthCredentials
-    - SecretStoreResource
-    - SoftDeleteSettings
+    - SecretStoreResource    
     - SystemData
     - UserFacingError    
   - from: source-file-csharp

src/DataProtection/custom/Cmdlets/Platform/Vault/New-AzDataProtectionBackupVault.ps1

@@ -48,9 +48,14 @@
         [ValidateSet('Disabled','Enabled', 'PermanentlyDisabled')]
         ${CrossSubscriptionRestoreState},
 
-        [Parameter(Mandatory=$false, HelpMessage='Soft delete related settings')]
-        [Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20221201.ISoftDeleteSettings]
-        ${SoftDeleteSetting},
+        [Parameter(Mandatory=$false, HelpMessage='Soft delete retention duration in days')]
+        [System.Double]
+        ${SoftDeleteRetentionDurationInDay},
+
+        [Parameter(Mandatory=$false, HelpMessage='Soft delete state of the vault. Allowed values are Off, On, AlwaysOn')]
+        [Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.SoftDeleteState]
+        [ValidateSet('Off','On', 'AlwaysOn')]  
+        ${SoftDeleteState},
 
         [Parameter(HelpMessage='Resource tags.')]
         [System.Collections.Hashtable]

src/DataProtection/custom/Cmdlets/Platform/Vault/New-AzDataProtectionSoftDeleteSettingObject.ps1

@@ -80,9 +80,6 @@ Creates a resource guard under a resource group
 ### [New-AzDataProtectionRetentionLifeCycleClientObject](New-AzDataProtectionRetentionLifeCycleClientObject.md)
 Creates new Lifecycle object
 
-### [New-AzDataProtectionSoftDeleteSettingObject](New-AzDataProtectionSoftDeleteSettingObject.md)
-Get Backup Vault soft delete setting object
-
 ### [Remove-AzDataProtectionBackupInstance](Remove-AzDataProtectionBackupInstance.md)
 Delete a backupInstances
 

src/DataProtection/docs/Az.DataProtection.md

@@ -18,8 +18,8 @@ New-AzDataProtectionBackupVault -Location <String> -ResourceGroupName <String>
  [-AzureMonitorAlertsForAllJobFailure <AlertsState>]
  [-CrossSubscriptionRestoreState <CrossSubscriptionRestoreState>] [-DefaultProfile <PSObject>]
  [-ETag <String>] [-IdentityType <String>] [-ImmutabilityState <ImmutabilityState>] [-NoWait]
- [-SoftDeleteSetting <ISoftDeleteSettings>] [-SubscriptionId <String>] [-Tag <Hashtable>] [-Confirm] [-WhatIf]
- [<CommonParameters>]
+ [-SoftDeleteRetentionDurationInDay <Double>] [-SoftDeleteState <SoftDeleteState>] [-SubscriptionId <String>]
+ [-Tag <Hashtable>] [-Confirm] [-WhatIf] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -42,6 +42,21 @@ ETag IdentityPrincipalId IdentityTenantId IdentityType Location Name    Type
 
 This command creates a new backup vault.
 
+### Example 2: Create a new backup vault with ImmutabilityState, CrossSubscriptionRestoreState, soft delete settings
+```powershell
+$sub = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+$storagesetting = New-AzDataProtectionBackupVaultStorageSettingObject -DataStoreType VaultStore -Type LocallyRedundant
+New-AzDataProtectionBackupVault -SubscriptionId $sub "resourceGroupName" -VaultName "vaultName" -Location westus -StorageSetting $storagesetting -CrossSubscriptionRestoreState Enabled -ImmutabilityState Unlocked -SoftDeleteRetentionDurationInDay 100 -SoftDeleteState On
+```
+
+```output
+ETag IdentityPrincipalId IdentityTenantId IdentityType Location Name    Type
+---- ------------------- ---------------- ------------ -------- ----    ----
+                                                       westus   MyVault Microsoft.DataProtection/backupVaults
+```
+
+This command creates a new backup vault while setting Immutability state, cross subscription restore state, soft delete settings of the vault at creation time.
+
 ## PARAMETERS
 
 ### -AsJob
@@ -197,12 +212,27 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -SoftDeleteSetting
-Soft delete related settings
-To construct, see NOTES section for SOFTDELETESETTING properties and create a hash table.
+### -SoftDeleteRetentionDurationInDay
+Soft delete retention duration in days
+
+```yaml
+Type: System.Double
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -SoftDeleteState
+Soft delete state of the vault.
+Allowed values are Off, On, AlwaysOn
 
 ```yaml
-Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20221201.ISoftDeleteSettings
+Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.SoftDeleteState
 Parameter Sets: (All)
 Aliases:
 
@@ -324,10 +354,6 @@ COMPLEX PARAMETER PROPERTIES
 To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
 
 
-`SOFTDELETESETTING <ISoftDeleteSettings>`: Soft delete related settings
-  - `[RetentionDurationInDay <Double?>]`: Soft delete retention duration
-  - `[State <SoftDeleteState?>]`: State of soft delete
-
 `STORAGESETTING <IStorageSetting[]>`: Storage Settings of the vault. Use New-AzDataProtectionBackupVaultStorageSetting Cmdlet to Create.
   - `[DatastoreType <StorageSettingStoreTypes?>]`: Gets or sets the type of the datastore.
   - `[Type <StorageSettingTypes?>]`: Gets or sets the type.

src/DataProtection/docs/New-AzDataProtectionBackupVault.md

@@ -18,17 +18,19 @@ For example, updating tags for a resource.
 Update-AzDataProtectionBackupVault -ResourceGroupName <String> -VaultName <String> [-SubscriptionId <String>]
  [-AzureMonitorAlertsForAllJobFailure <AlertsState>]
  [-CrossSubscriptionRestoreState <CrossSubscriptionRestoreState>] [-IdentityType <String>]
- [-ImmutabilityState <ImmutabilityState>] [-SoftDeleteSetting <ISoftDeleteSettings>] [-Tag <Hashtable>]
- [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>]
+ [-ImmutabilityState <ImmutabilityState>] [-SoftDeleteRetentionDurationInDay <Double>]
+ [-SoftDeleteState <SoftDeleteState>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait]
+ [-Confirm] [-WhatIf] [<CommonParameters>]
 ```
 
 ### UpdateViaIdentityExpanded
 ```
 Update-AzDataProtectionBackupVault -InputObject <IDataProtectionIdentity>
  [-AzureMonitorAlertsForAllJobFailure <AlertsState>]
  [-CrossSubscriptionRestoreState <CrossSubscriptionRestoreState>] [-IdentityType <String>]
- [-ImmutabilityState <ImmutabilityState>] [-SoftDeleteSetting <ISoftDeleteSettings>] [-Tag <Hashtable>]
- [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>]
+ [-ImmutabilityState <ImmutabilityState>] [-SoftDeleteRetentionDurationInDay <Double>]
+ [-SoftDeleteState <SoftDeleteState>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait]
+ [-Confirm] [-WhatIf] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -67,6 +69,20 @@ This command disables the monitor alerts for all the job failures for the backup
 Allowed values are: Enabled, Disabled.
 Note that by default this setting is enabled.
 
+### Example 3: Update vault ImmutabilityState, CrossSubscriptionRestoreState, soft delete settings
+```powershell
+Update-AzDataProtectionBackupVault -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -CrossSubscriptionRestoreState Disabled -ImmutabilityState Disabled -SoftDeleteRetentionDurationInDay 99 -SoftDeleteState Off
+```
+
+```output
+Name          Location      Type                                  IdentityType
+----          --------      ----                                  ------------
+vaultName southeastasia Microsoft.DataProtection/backupVaults SystemAssigned
+```
+
+This command is used to modify Immutability state, cross subscription restore state, soft delete settings of the vault.
+These parameters are optional and can be used independently.
+
 ## PARAMETERS
 
 ### -AsJob
@@ -209,12 +225,27 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -SoftDeleteSetting
-Soft delete related settings
-To construct, see NOTES section for SOFTDELETESETTING properties and create a hash table.
+### -SoftDeleteRetentionDurationInDay
+Soft delete retention duration in days.
 
 ```yaml
-Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20221201.ISoftDeleteSettings
+Type: System.Double
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -SoftDeleteState
+Soft delete state of the vault.
+Allowed values are Off, On, AlwaysOn.
+
+```yaml
+Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.SoftDeleteState
 Parameter Sets: (All)
 Aliases:
 
@@ -336,9 +367,5 @@ To create the parameters described below, construct a hash table containing the
   - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID.
   - `[VaultName <String>]`: The name of the backup vault.
 
-`SOFTDELETESETTING <ISoftDeleteSettings>`: Soft delete related settings
-  - `[RetentionDurationInDay <Double?>]`: Soft delete retention duration
-  - `[State <SoftDeleteState?>]`: State of soft delete
-
 ## RELATED LINKS
 

src/DataProtection/docs/New-AzDataProtectionSoftDeleteSettingObject.md

@@ -13,3 +13,17 @@ ETag IdentityPrincipalId IdentityTenantId IdentityType Location Name    Type
 
 This command creates a new backup vault.
 
+### Example 2: Create a new backup vault with ImmutabilityState, CrossSubscriptionRestoreState, soft delete settings
+```powershell
+$sub = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+$storagesetting = New-AzDataProtectionBackupVaultStorageSettingObject -DataStoreType VaultStore -Type LocallyRedundant
+New-AzDataProtectionBackupVault -SubscriptionId $sub "resourceGroupName" -VaultName "vaultName" -Location westus -StorageSetting $storagesetting -CrossSubscriptionRestoreState Enabled -ImmutabilityState Unlocked -SoftDeleteRetentionDurationInDay 100 -SoftDeleteState On
+```
+
+```output
+ETag IdentityPrincipalId IdentityTenantId IdentityType Location Name    Type
+---- ------------------- ---------------- ------------ -------- ----    ----
+                                                       westus   MyVault Microsoft.DataProtection/backupVaults
+```
+
+This command creates a new backup vault while setting Immutability state, cross subscription restore state, soft delete settings of the vault at creation time.