[Az.ElasticSan] Added support for soft delete and backup/restore validation (#27556)

Author: EmmaZhu

src/ElasticSan/ElasticSan.Autorest/README.md

@@ -28,11 +28,11 @@ For information on how to develop for `Az.ElasticSan`, see [how-to.md](how-to.md
 
 ``` yaml
 # Please specify the commit id that includes your features to make sure generated codes stable.
-commit: 3ca7edabc2edf1117b7d912ba34f2694721e3ff3
+commit: 3db6867b8e524ea6d1bc7a3bbb989fe50dd2f184
 require:
   - $(this-folder)/../../readme.azure.noprofile.md
 input-file:
-  - $(repo)/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/elasticsan.json
+  - $(repo)/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-07-01-preview/elasticsan.json
 
 # Normally, title is the service name
 title: ElasticSan
@@ -109,6 +109,22 @@ directive:
       subject: VolumeSnapshot
       verb: Update
     remove: true
+  - where:
+      verb: Backup
+      subject: VolumePre
+    set:
+      verb: Test
+      subject: VolumeBackup
+  - where:
+      verb: Restore
+      subject: VolumePre
+    set:
+      verb: Test
+      subject: VolumeRestore
+  - where:
+      parameter-name: ^XmsAccessSoftDeletedResource$
+    set:
+      parameter-name: AccessSoftDeletedResource
   - where:
       parameter-name: EncryptionIdentityEncryptionUserAssignedIdentity
     set:

src/ElasticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans-volumegroups-snapshots.json

@@ -1,6 +1,6 @@
 {
   "resourceType": "elasticSans/volumegroups/snapshots",
-  "apiVersion": "2024-06-01-preview",
+  "apiVersion": "2024-07-01-preview",
   "learnMore": {
     "url": "https://learn.microsoft.com/powershell/module/az.elasticsan"
   },

src/ElasticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans-volumegroups-volumes.json

@@ -1,6 +1,6 @@
 {
   "resourceType": "elasticSans/volumegroups/volumes",
-  "apiVersion": "2024-06-01-preview",
+  "apiVersion": "2024-07-01-preview",
   "learnMore": {
     "url": "https://learn.microsoft.com/powershell/module/az.elasticsan"
   },
@@ -54,12 +54,12 @@
       ]
     },
     {
-      "name": "Remove-AzElasticSanVolume",
-      "description": "Delete an Volume.",
-      "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}",
+      "name": "Restore-AzElasticSanVolume",
+      "description": "Restore Soft Deleted Volumes.\nThe volume name is obtained by using the API to list soft deleted volumes by volume group",
+      "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}/restore",
       "help": {
         "learnMore": {
-          "url": "https://learn.microsoft.com/powershell/module/az.elasticsan/remove-azelasticsanvolume"
+          "url": "https://learn.microsoft.com/powershell/module/az.elasticsan/restore-azelasticsanvolume"
         },
         "parameterSets": [
           {
@@ -75,7 +75,7 @@
       },
       "examples": [
         {
-          "description": "Delete an Volume.",
+          "description": "Restore Soft Deleted Volumes. The volume name is obtained by using the API to list soft deleted volumes by volume group",
           "parameters": [
             {
               "name": "-ElasticSanName",

src/ElasticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans-volumegroups.json

@@ -1,6 +1,6 @@
 {
   "resourceType": "elasticSans/volumegroups",
-  "apiVersion": "2024-06-01-preview",
+  "apiVersion": "2024-07-01-preview",
   "learnMore": {
     "url": "https://learn.microsoft.com/powershell/module/az.elasticsan"
   },

src/ElasticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans.json

@@ -1,6 +1,6 @@
 {
   "resourceType": "elasticSans",
-  "apiVersion": "2024-06-01-preview",
+  "apiVersion": "2024-07-01-preview",
   "learnMore": {
     "url": "https://learn.microsoft.com/powershell/module/az.elasticsan"
   },

src/ElasticSan/ElasticSan.Autorest/custom/New-AzElasticSanVolumeGroup.ps1

@@ -97,6 +97,19 @@ function New-AzElasticSanVolumeGroup {
         # Identity Parameter
         # To construct, see NOTES section for ELASTICSANINPUTOBJECT properties and create a hash table.
         ${ElasticSanInputObject},
+
+        [Parameter()]
+        [Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Category('Body')]
+        [System.Int32]
+        # The number of days to retain the resources after deletion.
+        ${DeleteRetentionPolicyRetentionPeriodDay},
+
+        [Parameter()]
+        [Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.PSArgumentCompleterAttribute("Enabled", "Disabled")]
+        [Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Category('Body')]
+        [System.String]
+        # .
+        ${DeleteRetentionPolicyState},
 
         [Parameter(ParameterSetName='CreateViaIdentityExpanded', Mandatory, ValueFromPipeline)]
         [Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Category('Path')]

src/ElasticSan/ElasticSan.Autorest/custom/Update-AzElasticSanVolumeGroup.ps1

@@ -105,6 +105,19 @@ function Update-AzElasticSanVolumeGroup {
         # To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
         ${InputObject},
 
+        [Parameter()]
+        [Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Category('Body')]
+        [System.Int32]
+        # The number of days to retain the resources after deletion.
+        ${DeleteRetentionPolicyRetentionPeriodDay},
+
+        [Parameter()]
+        [Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.PSArgumentCompleterAttribute("Enabled", "Disabled")]
+        [Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Category('Body')]
+        [System.String]
+        # .
+        ${DeleteRetentionPolicyState},
+
         [Parameter()]
         [Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Category('Body')]
         [System.Boolean]

src/ElasticSan/ElasticSan.Autorest/docs/Az.ElasticSan.md

@@ -1,6 +1,6 @@
 ---
 Module Name: Az.ElasticSan
-Module Guid: ed90c36c-f150-4ad2-96ae-57e0ebb0a376
+Module Guid: 3e5cf2f0-9988-4c0d-9161-6b9b49729845
 Download Help Link: https://learn.microsoft.com/powershell/module/az.elasticsan
 Help Version: 1.0.0.0
 Locale: en-US
@@ -59,6 +59,16 @@ Remove a list of virtual network rules from a VolumeGroup
 ### [Remove-AzElasticSanVolumeSnapshot](Remove-AzElasticSanVolumeSnapshot.md)
 Delete a Volume Snapshot.
 
+### [Restore-AzElasticSanVolume](Restore-AzElasticSanVolume.md)
+Restore Soft Deleted Volumes.
+The volume name is obtained by using the API to list soft deleted volumes by volume group
+
+### [Test-AzElasticSanVolumeBackup](Test-AzElasticSanVolumeBackup.md)
+Validate whether a disk snapshot backup can be taken for list of volumes.
+
+### [Test-AzElasticSanVolumeRestore](Test-AzElasticSanVolumeRestore.md)
+Validate whether a list of backed up disk snapshots can be restored into ElasticSan volumes.
+
 ### [Update-AzElasticSan](Update-AzElasticSan.md)
 update a Elastic San.
 

src/ElasticSan/ElasticSan.Autorest/docs/Get-AzElasticSanVolume.md

@@ -15,7 +15,8 @@ Get either a list of all volumes from a volume group or get a single volume from
 ### List (Default)
 ```
 Get-AzElasticSanVolume -ElasticSanName <String> -ResourceGroupName <String> -VolumeGroupName <String>
- [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>]
+ [-SubscriptionId <String[]>] [-AccessSoftDeletedResource <String>] [-DefaultProfile <PSObject>]
+ [<CommonParameters>]
 ```
 
 ### Get
@@ -124,8 +125,54 @@ VolumeId                       : abababab-abab-abab-abab-abababababab
 
 This command gets a specific volume.
 
+### Example 3: List soft deleted volumes in a volume group
+```powershell
+Get-AzElasticSanVolume -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -VolumeGroupName myvolumegroup -AccessSoftDeletedResource true
+```
+
+```output
+CreationDataCreateSource       : 
+CreationDataSourceUri          : 
+Id                             : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan/volumegroups/myvolumegroup/volumes/namefordeletedvolume
+ManagedByResourceId            : None
+Name                           : namefordeletedvolume
+SizeGiB                        : 100
+StorageTargetIqn               : iqn.2022-09.net.windows.core.blob.ElasticSan.es-3ibot5m2r3y0:myvolume
+StorageTargetPortalHostname    : es-3ibot5m2r3y0.z1.blob.storage.azure.net
+StorageTargetPortalPort        : 3260
+StorageTargetProvisioningState : Succeeded
+StorageTargetStatus            : Running
+SystemDataCreatedAt            : 9/19/2022 2:39:28 AM
+SystemDataCreatedBy            : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy
+SystemDataCreatedByType        : Application
+SystemDataLastModifiedAt       : 9/19/2022 2:39:28 AM
+SystemDataLastModifiedBy       : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy
+SystemDataLastModifiedByType   : Application
+Tag                            : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags
+Type                           : Microsoft.ElasticSan/ElasticSans
+VolumeId                       : abababab-abab-abab-abab-abababababab
+```
+
+This command gets soft deleted volumes in a volume group.
+
 ## PARAMETERS
 
+### -AccessSoftDeletedResource
+Optional, returns only soft deleted volumes if set to true.
+If set to false or if not specified, returns only active volumes.
+
+```yaml
+Type: System.String
+Parameter Sets: List
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -DefaultProfile
 The DefaultProfile parameter is not functional.
 Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

src/ElasticSan/ElasticSan.Autorest/docs/Get-AzElasticSanVolumeGroup.md

@@ -15,7 +15,7 @@ Get either a list of all volume groups from an Elastic SAN or get a single volum
 ### List (Default)
 ```
 Get-AzElasticSanVolumeGroup -ElasticSanName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>]
- [-DefaultProfile <PSObject>] [<CommonParameters>]
+ [-AccessSoftDeletedResource <String>] [-DefaultProfile <PSObject>] [<CommonParameters>]
 ```
 
 ### Get
@@ -105,8 +105,64 @@ Type                          : Microsoft.ElasticSan/ElasticSans
 
 This command gets a specific volume group.
 
+### Example 3: Get soft deleted volume groups in an Elastic SAN
+```powershell
+Get-AzElasticSanVolumeGroup -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -AccessSoftDeletedResource true
+```
+
+```output
+DeleteRetentionPolicyRetentionPeriodDay                : 7
+DeleteRetentionPolicyState                             : Enabled
+Encryption                                             : EncryptionAtRestWithPlatformKey
+EncryptionIdentityEncryptionUserAssignedIdentity       :
+EnforceDataIntegrityCheckForIscsi                      : True
+Id                                                     : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan/volumeGroups/myvolumegroup
+IdentityPrincipalId                                    :
+IdentityTenantId                                       :
+IdentityType                                           :
+IdentityUserAssignedIdentity                           : {
+                                                         }
+KeyVaultPropertyCurrentVersionedKeyExpirationTimestamp :
+KeyVaultPropertyCurrentVersionedKeyIdentifier          :
+KeyVaultPropertyKeyName                                :
+KeyVaultPropertyKeyVaultUri                            :
+KeyVaultPropertyKeyVersion                             :
+KeyVaultPropertyLastKeyRotationTimestamp               :
+Name                                                   : myvolumegroup
+NetworkAclsVirtualNetworkRule                          :
+PrivateEndpointConnection                              :
+ProtocolType                                           : iSCSI
+ProvisioningState                                      : Deleted
+ResourceGroupName                                      : myresourcegroup
+SystemDataCreatedAt                                    : 4/8/2025 2:31:52 AM
+SystemDataCreatedBy                                    : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy
+SystemDataCreatedByType                                : User
+SystemDataLastModifiedAt                               : 4/9/2025 3:22:04 AM
+SystemDataLastModifiedBy                               : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy
+SystemDataLastModifiedByType                           : User
+Type                                                   : Microsoft.ElasticSan/elasticSans/volumeGroups
+```
+
+This command gets soft deleted volume groups in the Elastic SAN myelasticsan.
+
 ## PARAMETERS
 
+### -AccessSoftDeletedResource
+Optional, returns only soft deleted volume groups if set to true.
+If set to false or if not specified, returns only active volume groups.
+
+```yaml
+Type: System.String
+Parameter Sets: List
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -DefaultProfile
 The DefaultProfile parameter is not functional.
 Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.