ADLS added as backup workload + rename containers feature for ILR

Author: ianna1-admin

src/DataProtection/DataProtection.Autorest/custom/Cmdlets/Platform/BackupInstance/Initialize-AzDataProtectionBackupInstance.ps1

@@ -39,8 +39,8 @@
         [Parameter(Mandatory=$false, HelpMessage='Friendly name for backup instance')]
         [System.String]
         ${FriendlyName},
-                
-        [Parameter(Mandatory=$false, HelpMessage='Backup configuration for backup. Use this parameter to configure protection for AzureKubernetesService,AzureBlob.')]
+
+        [Parameter(Mandatory=$false, HelpMessage='Backup configuration for backup. Use this parameter to configure protection for AzureKubernetesService, AzureBlob and AzureDataLakeStorage.')]
         [Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20250701.IBackupDatasourceParameters]
         ${BackupConfiguration},
 

src/DataProtection/DataProtection.Autorest/custom/Cmdlets/Platform/BackupInstance/New-AzDataProtectionBackupConfigurationClientObject.ps1

@@ -7,7 +7,7 @@ function New-AzDataProtectionBackupConfigurationClientObject{
     param(
         [Parameter(Mandatory, HelpMessage='Datasource Type')]
         [Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.DatasourceTypes]
-        [ValidateSet('AzureKubernetesService', 'AzureBlob')]
+        [ValidateSet('AzureKubernetesService', 'AzureBlob', 'AzureDataLakeStorage')]
         ${DatasourceType},
 
         [Parameter(Mandatory=$false, HelpMessage='List of resource types to be excluded from backup')]
@@ -134,6 +134,44 @@ function New-AzDataProtectionBackupConfigurationClientObject{
                  throw $message
             }
         }
+        elseif($DatasourceType.ToString() -eq "AzureDataLakeStorage"){
+            $dataSourceParam = [Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20250701.AdlsBlobBackupDatasourceParameters]::new()
+            $dataSourceParam.ObjectType = "AdlsBlobBackupDatasourceParameters"
+            
+            if($VaultedBackupContainer -ne $null){
+
+                # exclude containers which start with $ except $web, $root
+                $unsupportedContainers = $VaultedBackupContainer | Where-Object { $_ -like '$*' -and $_ -ne "`$root" -and $_ -ne "`$web"}
+                if($unsupportedContainers.Count -gt 0){
+                    $message = "Following containers are not allowed for configure protection with AzureDataLakeStorage - $unsupportedContainers. Please remove them and proceed."
+                    throw $message
+                }
+
+                $dataSourceParam.ContainersList = $VaultedBackupContainer
+            }
+            elseif($IncludeAllContainer){
+                if($StorageAccountName -eq $null -or $StorageAccountResourceGroupName -eq $null){
+                    $message = "Please input StorageAccountName and StorageAccountResourceGroupName parameters for fetching all vaulted containers."
+                    throw $message
+                }
+
+                CheckStorageModuleDependency
+                $storageAccount = Get-AzStorageAccount -ResourceGroupName $StorageAccountResourceGroupName -Name $StorageAccountName 
+                $containers = Get-AzStorageContainer -Context $storageAccount.Context
+
+                # exclude containers which start with $ except $web, $root
+                $allContainers = $containers.Name | Where-Object { -not($_ -like '$*' -and $_ -ne "`$root" -and $_ -ne "`$web")}
+                $dataSourceParam.ContainersList = $allContainers
+            }
+            elseif($ExcludedResourceType -ne $null -or $IncludedResourceType -ne $null -or $ExcludedNamespace -ne $null -or $IncludedNamespace -ne $null -or $LabelSelector -ne $null -or $SnapshotVolume -ne $null -or $IncludeClusterScopeResource -ne $null){
+                $message = "Invalid parameters ExcludedResourceType, IncludedResourceType, ExcludedNamespace, IncludedNamespace, LabelSelector, SnapshotVolume, IncludeClusterScopeResource for given DatasourceType."
+                throw $message
+            }
+            else {
+                 $message = "Please input VaultedBackupContainer or IncludeAllContainer parameters for given workload type."
+                 throw $message
+            }
+        }
 
         $dataSourceParam
     }

src/DataProtection/DataProtection.Autorest/custom/Cmdlets/Platform/BackupInstance/Update-AzDataProtectionBackupInstance.ps1

@@ -36,7 +36,7 @@ function Update-AzDataProtectionBackupInstance
         [System.String]
         ${UserAssignedIdentityArmId},
 
-        [Parameter(Mandatory=$false, HelpMessage='List of containers to be backed up inside the VaultStore. Use this parameter for DatasourceType AzureBlob.')]
+        [Parameter(Mandatory=$false, HelpMessage='List of containers to be backed up inside the VaultStore. Use this parameter for DatasourceType AzureBlob and AzureDataLakeStorage.')]
         [System.String[]]
         ${VaultedBackupContainer},
 
@@ -135,15 +135,15 @@ function Update-AzDataProtectionBackupInstance
 
         if($hasVaultedBackupContainer){
 
-            if($DatasourceType -ne "AzureBlob"){
+            if($DatasourceType -ne "AzureBlob" -and $DatasourceType -ne "AzureDataLakeStorage"){
                 $err = "Parameter VaultedBackupContainer isn't supported for given Datasource"
                 throw $err
             }
 
             # exclude containers which start with $ except $web, $root
             $unsupportedContainers = $VaultedBackupContainer | Where-Object { $_ -like '$*' -and $_ -ne "`$root" -and $_ -ne "`$web"}
             if($unsupportedContainers.Count -gt 0){
-                $message = "Following containers are not allowed for configure protection with AzureBlob - $unsupportedContainers. Please remove them and try again."
+                $message = "Following containers are not allowed for configure protection with AzureBlob and AzureDataLakeStorage - $unsupportedContainers. Please remove them and try again."
                 throw $message
             }
 

src/DataProtection/DataProtection.Autorest/custom/Cmdlets/Platform/Restore/Initialize-AzDataProtectionRestoreRequest.ps1

@@ -107,6 +107,10 @@
         [Hashtable]
         ${PrefixMatch},
 
+        [Parameter(ParameterSetName="AlternateLocationILR", Mandatory=$false, HelpMessage='Use this parameter to rename container(s) for alternate location ILR. Input for this parameter is a hashtable where each key is the original container name and each value is the new name for the corresponding container.')]
+        [Hashtable]
+        ${RenameTo},
+
         [Parameter(ParameterSetName="OriginalLocationILR", Mandatory=$false, HelpMessage='Specify the blob restore start range for PITR. You can use this option to specify the starting range for a subset of blobs in each container to restore. use a forward slash (/) to separate the container name from the blob prefix pattern.')]
         # [Parameter(ParameterSetName="AlternateLocationILR", Mandatory=$false, HelpMessage='Minimum matching value for Item Level Recovery.')]
         [System.String[]]
@@ -296,6 +300,7 @@
 
                 if(($RecoveryPoint -ne $null) -and ($RecoveryPoint -ne "") -and $ContainersList.length -gt 0){
                     $hasPrefixMatch = $PSBoundParameters.Remove("PrefixMatch")
+                    $hasRenameTo = $PSBoundParameters.Remove("RenameTo")
                     for($i = 0; $i -lt $ContainersList.length; $i++){
 
                         $restoreCriteria = [Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20250701.ItemPathBasedRestoreCriteria]::new()
@@ -311,6 +316,19 @@
                             }
                             $restoreCriteria.SubItemPathPrefix = $pathPrefix
                         }
+                        Write-Debug "renameContainersEnabled: $manifest.renameContainersEnabled"
+                        Write-Debug "hasRenameTo: $hasRenameTo"
+                        if($manifest.renameContainersEnabled -eq $true -and $hasRenameTo){
+                            Write-Debug "renameToValue: $($RenameTo[$ContainersList[$i]])"
+                            $renameToValue = $RenameTo[$ContainersList[$i]]
+                            if($renameToValue -ne $null -and ($renameToValue -is [Array])){
+                                throw "value for RenameTo must be a string for each container"
+                            }
+                            $restoreCriteria.RenameTo = $renameToValue
+                        } 
+                        elseif( ($manifest.renameContainersEnabled -ne $true) -and ($hasRenameTo)){
+                            throw "DatasourceType $DatasourceType does not support renaming containers"
+                        }
 
                         # adding a criteria for each container given
                         $restoreCriteriaList += ($restoreCriteria)

src/DataProtection/DataProtection.Autorest/custom/Enums/Enums.cs

@@ -8,6 +8,7 @@ public enum DatasourceTypes
         AzureDisk = 0,
         AzureBlob,
         AzureDatabaseForPostgreSQL,
+        AzureDataLakeStorage,
         AzureKubernetesService,
         AzureDatabaseForPGFlexServer,
         AzureDatabaseForMySQL

src/DataProtection/DataProtection.Autorest/custom/manifests/AzureBlob.json

@@ -22,7 +22,8 @@
   "friendlyNameRequired": false,
   "customFriendlyNameAllowed": false,
   "supportSecretStoreAuthentication": false,
-  "supportCrossRegionRestore": false,
+  "supportCrossRegionRestore": true,
+  "renameContainersEnabled": true,
   "policySettings": {
     "supportedRetentionTags": [ "Weekly", "Monthly", "Yearly" ],
     "supportedDatastoreTypes": [ "OperationalStore", "VaultStore" ],

src/DataProtection/DataProtection.Autorest/custom/manifests/AzureDataLakeStorage.json

@@ -0,0 +1,92 @@
+{
+  "datasourcePermissions": [ "Storage Account Backup Contributor" ],
+  "datasourceRGPermissions": [],
+  "snapshotRGPermissions": [],
+  "keyVaultPermissions": [],
+  "dataSourceOverSnapshotRGPermissions": [],
+  "supportRestoreGrantPermission": false,
+  "datasourcePermissionsForRestore": [],
+  "storageAccountPermissionsForRestore": [],
+  "isProxyResource": false,
+  "enableDataSourceSetInfo": false,
+  "resourceType": "Microsoft.Storage/storageAccounts",
+  "parentResourceType": "Microsoft.Storage/storageAccounts",
+  "datasourceType": "Microsoft.Storage/storageAccounts/adlsBlobServices",
+  "allowedRestoreModes": [ "RecoveryPointBased" ],
+  "allowedRestoreTargetTypes": [ "AlternateLocation" ],
+  "itemLevelRecoveyEnabled": true,
+  "fileNamePrefixDisabled": false,
+  "addBackupDatasourceParametersList": true,
+  "backupConfigurationRequired": false,
+  "addDataStoreParametersList": false,
+  "friendlyNameRequired": false,
+  "customFriendlyNameAllowed": false,
+  "supportSecretStoreAuthentication": false,
+  "supportCrossRegionRestore": true,
+  "renameContainersEnabled": true,
+  "policySettings": {
+    "supportedRetentionTags": [ "Weekly", "Monthly", "Yearly" ],
+    "supportedDatastoreTypes": [ "VaultStore" ],
+    "disableAddRetentionRule": false,
+    "disableCustomRetentionTag": false,
+    "backupScheduleSupported": true,
+    "supportedBackupFrequency": [ "Daily", "Weekly" ],
+    "defaultPolicy": {
+      "policyRules": [
+        {
+          "backupParameters": {
+            "backupType": "Discrete",
+            "objectType": "AzureBackupParams"
+          },
+          "trigger": {
+            "schedule": {
+              "repeatingTimeIntervals": [
+                "R/2023-03-26T13:00:00+00:00/P1W"
+              ],
+              "timeZone": "UTC"
+            },
+            "taggingCriteria": [
+              {
+                "tagInfo": {
+                  "tagName": "Default",
+                  "id": "Default_"
+                },
+                "taggingPriority": 99,
+                "isDefault": true
+              }
+            ],
+            "objectType": "ScheduleBasedTriggerContext"
+          },
+          "dataStore": {
+            "dataStoreType": "VaultStore",
+            "objectType": "DataStoreInfoBase"
+          },
+          "name": "BackupWeekly",
+          "objectType": "AzureBackupRule"
+        },
+        {
+          "lifecycles": [
+            {
+              "deleteAfter": {
+                "objectType": "AbsoluteDeleteOption",
+                "duration": "P7D"
+              },
+              "sourceDataStore": {
+                "dataStoreType": "VaultStore",
+                "objectType": "DataStoreInfoBase"
+              }
+            }
+          ],
+          "isDefault": true,
+          "name": "Default",
+          "objectType": "AzureRetentionRule"
+        }
+      ],
+      "name": "AdlsBlobPolicy1",
+      "datasourceTypes": [
+        "Microsoft.Storage/storageAccounts/adlsBlobServices"
+      ],
+      "objectType": "BackupPolicy"
+    }
+  }
+}

src/DataProtection/DataProtection.Autorest/custom/manifests/DatasourceTypesInfo.json

@@ -12,6 +12,10 @@
       "serviceDatasourceType": "Microsoft.Storage/storageAccounts/blobServices",
       "clientDatasourceType": "AzureBlob"
     },
+    {
+      "serviceDatasourceType": "Microsoft.Storage/storageAccounts/adlsBlobServices",
+      "clientDatasourceType": "AzureDataLakeStorage"
+    },
     {
       "serviceDatasourceType": "Microsoft.ContainerService/managedClusters",
       "clientDatasourceType": "AzureKubernetesService"

src/DataProtection/DataProtection.Autorest/docs/Initialize-AzDataProtectionBackupInstance.md

@@ -115,7 +115,7 @@ The fifth command initializes the backup instance.ype AzureDatabaseForMySQL to i
 
 ### -BackupConfiguration
 Backup configuration for backup.
-Use this parameter to configure protection for AzureKubernetesService,AzureBlob.
+Use this parameter to configure protection for AzureKubernetesService, AzureBlob and AzureDataLakeStorage.
 To construct, see NOTES section for BACKUPCONFIGURATION properties and create a hash table.
 
 ```yaml
@@ -191,7 +191,7 @@ Accept wildcard characters: False
 ```
 
 ### -PolicyId
-Policy Id to be assiciated to Datasource
+Policy Id to be associated to Datasource
 
 ```yaml
 Type: System.String
@@ -238,7 +238,7 @@ Accept wildcard characters: False
 ```
 
 ### -SnapshotResourceGroupId
-Sanpshot Resource Group
+Snapshot Resource Group
 
 ```yaml
 Type: System.String

src/DataProtection/DataProtection.Autorest/docs/Initialize-AzDataProtectionRestoreRequest.md

@@ -27,7 +27,7 @@ Initialize-AzDataProtectionRestoreRequest -DatasourceType <DatasourceTypes> -Res
 Initialize-AzDataProtectionRestoreRequest -DatasourceType <DatasourceTypes> -ItemLevelRecovery
  -RestoreLocation <String> -RestoreType <RestoreTargetType> -SourceDataStore <DataStoreType>
  -TargetResourceId <String> [-ContainersList <String[]>] [-PrefixMatch <Hashtable>] [-RecoveryPoint <String>]
- [-RestoreConfiguration <PSObject>] [-UserAssignedIdentityArmId <String>]
+ [-RenameTo <Hashtable>] [-RestoreConfiguration <PSObject>] [-UserAssignedIdentityArmId <String>]
  [-UseSystemAssignedIdentity <Boolean?>] [<CommonParameters>]
 ```
 
@@ -221,7 +221,7 @@ The restore request object is then used to trigger the restore operation.
 ## PARAMETERS
 
 ### -BackupInstance
-Backup Instance object to trigger original localtion restore.
+Backup Instance object to trigger original location restore.
 To construct, see NOTES section for BACKUPINSTANCE properties and create a hash table.
 
 ```yaml
@@ -391,6 +391,22 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -RenameTo
+Use this parameter to rename container(s) for alternate location ILR.
+Input for this parameter is a hashtable where each key is the original container name and each value is the new name for the corresponding container.
+
+```yaml
+Type: System.Collections.Hashtable
+Parameter Sets: AlternateLocationILR
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -RestoreConfiguration
 Restore configuration for restore.
 Use this parameter to restore with AzureKubernetesService.