re-recorded all test cases

Author: hiaga

src/DataProtection/DataProtection.Autorest/custom/Cmdlets/Backupcenter/Search-AzDataProtectionBackupInstanceInAzGraph.ps1

@@ -7,7 +7,7 @@
     param (
         [Parameter(Mandatory, HelpMessage='Subscription of Vault')]
         [System.String[]]
-        ${Subscription},
+        ${Subscription}, # TODO: add alias to all ARG command params
 
         [Parameter(Mandatory=$false, HelpMessage='Resource Group of Vault')]
         [System.String[]]

src/DataProtection/DataProtection.Autorest/custom/Cmdlets/Backupcenter/Search-AzDataProtectionBackupVaultInAzGraph.ps1

@@ -8,7 +8,7 @@
         [Parameter(Mandatory, HelpMessage='Subscription of Vault')]
         [Alias('SubscriptionId')]
         [System.String[]]
-        ${Subscription}, # TODO: add alias to all ARG command params
+        ${Subscription},
 
         [Parameter(Mandatory=$false, HelpMessage='Resource Group of Vault')]
         [Alias('ResourceGroupName')]

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

@@ -89,7 +89,7 @@
         [System.String]
         ${TargetContainerURI},
 
-        [Parameter(ParameterSetName="RestoreAsFiles", Mandatory, HelpMessage='File name to be prefixed to the restored backup data.')]
+        [Parameter(ParameterSetName="RestoreAsFiles", Mandatory=$false, HelpMessage='File name to be prefixed to the restored backup data.')]
         [System.String]
         ${FileNamePrefix},
 
@@ -192,12 +192,26 @@
            $restoreRequest.RestoreTargetInfo = [Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231201.RestoreFilesTargetInfo]::new()
            $restoreRequest.RestoreTargetInfo.ObjectType = "RestoreFilesTargetInfo"
 
-           if(!($PSBoundParameters.ContainsKey("FileNamePrefix")) -or !($PSBoundParameters.ContainsKey("TargetContainerURI")) ){
-                $errormsg = "FileNamePrefix and TargetContainerURI parameters are required for RestoreAsFiles "
-    			    throw $errormsg
+           if($manifest.fileNamePrefixDisabled -and $PSBoundParameters.ContainsKey("FileNamePrefix")){
+               $errormsg = "FileNamePrefix can't be set for given DatasourceType. Please try again after removing FileNamePrefix parameter"
+    		   throw $errormsg
+           }
+           elseif($manifest.fileNamePrefixDisabled -and !($PSBoundParameters.ContainsKey("TargetContainerURI"))){
+               $errormsg = "TargetContainerURI parameter is required for RestoreAsFiles for given DatasourceType"
+    		   throw $errormsg
+           }
+           elseif( !$manifest.fileNamePrefixDisabled -and (!($PSBoundParameters.ContainsKey("FileNamePrefix")) -or !($PSBoundParameters.ContainsKey("TargetContainerURI"))) ){
+                $errormsg = "FileNamePrefix and TargetContainerURI parameters are required for RestoreAsFiles for given DatasourceType"
+    		    throw $errormsg
            }
 
-           $restoreRequest.RestoreTargetInfo.TargetDetail.FilePrefix = $FileNamePrefix
+           if($manifest.fileNamePrefixDisabled){
+               $restoreRequest.RestoreTargetInfo.TargetDetail.FilePrefix = "dummyprefix"
+           }
+           else{
+               $restoreRequest.RestoreTargetInfo.TargetDetail.FilePrefix = $FileNamePrefix
+           }
+           
            $restoreRequest.RestoreTargetInfo.TargetDetail.RestoreTargetLocationType = "AzureBlobs"
            $restoreRequest.RestoreTargetInfo.TargetDetail.Url = $TargetContainerURI
 

src/DataProtection/DataProtection.Autorest/custom/Cmdlets/Platform/Vault/Set-AzDataProtectionMSIPermission.ps1

@@ -213,30 +213,17 @@
                       $storageAccountSubId = ($targetResourceArmId -split "/resourceGroups/")[0]
                   }
                   else{
-                      if($StorageAccountARMId -eq ""){#$StorageAccountResourceGroupName -eq $null){
+                      if($StorageAccountARMId -eq ""){
                           $err = "Permissions can't be assigned to target storage account. Please input parameter StorageAccountARMId"
                           throw $err
                       }
 
                       # storage Account subscription and resource group
-                      $storageAccountSubId = ($StorageAccountARMId -split "/resourceGroups/")[0] # "/subscriptions/" + $subscriptionIdInternal
-                      $storageAccResourceGroupId = ($StorageAccountARMId -split "/providers/")[0] #$storageAccountSubId + "/resourceGroups/" + $StorageAccountResourceGroupName
-                      
-                      # $url = $restoreRequest.RestoreTargetInfo.TargetDetail.Url
-                      # 
-                      # if(-not ($url -match "^https://.+blob.core.windows.net/.+")){
-                      #     $err = "Parameter restoreRequest.RestoreTargetInfo.TargetDetail.Url is not in correct format"
-                      #     throw $err
-                      # }
-                      # $storageAccName = (($url -split "//")[1] -split "\.")[0]
-                      # 
-                      # CheckStorageModuleDependency
-                      # $contextSub = (Get-AzContext).Subscription.Id
-                      # Set-AzContext -SubscriptionId $subscriptionIdInternal | Out-Null
+                      $storageAccountSubId = ($StorageAccountARMId -split "/resourceGroups/")[0]
+                      $storageAccResourceGroupId = ($StorageAccountARMId -split "/providers/")[0]
 
                       # storage Account ID
-                      $storageAccId = $StorageAccountARMId #(Get-AzStorageAccount -ResourceGroupName $StorageAccountResourceGroupName -Name $storageAccName).Id
-                      # Set-AzContext -SubscriptionId $contextSub | Out-Null
+                      $storageAccId = $StorageAccountARMId                      
                   }
 
                   $CheckPermission = $AllRoles | Where-Object { ($_.Scope -eq $storageAccId -or $_.Scope -eq $storageAccResourceGroupId -or  $_.Scope -eq $storageAccountSubId) -and $_.RoleDefinitionName -eq $Permission}

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

@@ -15,6 +15,7 @@
   "allowedRestoreModes": [ "PointInTimeBased", "RecoveryPointBased" ],
   "allowedRestoreTargetTypes": [ "OriginalLocation", "AlternateLocation" ],
   "itemLevelRecoveyEnabled": true,
+  "fileNamePrefixDisabled": false,
   "addBackupDatasourceParametersList": true,
   "backupConfigurationRequired": false,
   "addDataStoreParametersList": false,

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

@@ -15,6 +15,7 @@
   "allowedRestoreModes": [ "RecoveryPointBased" ],
   "allowedRestoreTargetTypes": [ "RestoreAsFiles" ],
   "itemLevelRecoveyEnabled": false,
+  "fileNamePrefixDisabled": true,
   "addBackupDatasourceParametersList": false,
   "backupConfigurationRequired": false,
   "addDataStoreParametersList": false,
@@ -28,7 +29,7 @@
     "disableAddRetentionRule": false,
     "disableCustomRetentionTag": false,
     "backupScheduleSupported": true,
-    "supportedBackupFrequency": [ "Weekly", "Monthly" ],
+    "supportedBackupFrequency": [ "Weekly" ],
     "defaultPolicy": {
       "name": "MySQLPolicy1",
       "datasourceTypes": [ "Microsoft.DBforMySQL/flexibleServers" ],

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

@@ -15,6 +15,7 @@
   "allowedRestoreModes": [ "RecoveryPointBased" ],
   "allowedRestoreTargetTypes": [ "RestoreAsFiles" ],
   "itemLevelRecoveyEnabled": false,
+  "fileNamePrefixDisabled":  true,
   "addBackupDatasourceParametersList": false,
   "backupConfigurationRequired": false,
   "addDataStoreParametersList": false,
@@ -28,7 +29,7 @@
     "disableAddRetentionRule": false,
     "disableCustomRetentionTag": false,
     "backupScheduleSupported": true,
-    "supportedBackupFrequency": [ "Weekly", "Monthly" ],
+    "supportedBackupFrequency": [ "Daily", "Weekly" ],
     "defaultPolicy": {
       "name": "PGFlexPolicy1",
       "datasourceTypes": [ "Microsoft.DBforPostgreSQL/flexibleServers" ],

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

@@ -15,6 +15,7 @@
   "allowedRestoreModes": [ "RecoveryPointBased" ],
   "allowedRestoreTargetTypes": [ "AlternateLocation", "RestoreAsFiles" ],
   "itemLevelRecoveyEnabled": false,
+  "fileNamePrefixDisabled": false,
   "addBackupDatasourceParametersList": false,
   "backupConfigurationRequired": false,
   "addDataStoreParametersList": false,

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

@@ -15,6 +15,7 @@
   "allowedRestoreModes": [ "RecoveryPointBased" ],
   "allowedRestoreTargetTypes": [ "AlternateLocation" ],
   "itemLevelRecoveyEnabled": false,
+  "fileNamePrefixDisabled": false,
   "addBackupDatasourceParametersList": false,
   "backupConfigurationRequired": false,
   "addDataStoreParametersList": true,

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

@@ -15,6 +15,7 @@
   "allowedRestoreModes": [ "RecoveryPointBased" ],
   "allowedRestoreTargetTypes": [ "AlternateLocation", "OriginalLocation" ],
   "itemLevelRecoveyEnabled": true,
+  "fileNamePrefixDisabled": false,
   "addBackupDatasourceParametersList": true,
   "backupConfigurationRequired": true,
   "addDataStoreParametersList": true,

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

@@ -68,6 +68,26 @@ The fourth command backup configuration object needed for AzureKubernetesService
 The fifth command initializes the client object for backup instance.
 This object can now be used to configure backup using New-AzDataProtectionBackupInstance after all necessary permissions are assigned with Set-AzDataProtectionMSIPermission command.
 
+### Example 3: Configure protection for AzureDatabaseForPGFlexServer
+```powershell
+$vault = Get-AzDataProtectionBackupVault -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName"
+$pol = Get-AzDataProtectionBackupPolicy -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -VaultName "vaultName" -ResourceGroupName "resourceGroupName" -Name "policyName"
+$datasourceId = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/rgName/providers/Microsoft.DBforPostgreSQL/flexibleServers/test-pgflex"
+$backupInstanceClientObject = Initialize-AzDataProtectionBackupInstance -DatasourceType AzureDatabaseForPGFlexServer -DatasourceLocation $vault.Location -PolicyId $pol[0].Id -DatasourceId $datasourceId
+```
+
+```output
+Name BackupInstanceName
+---- ------------------
+     test-pgflex-test-pgflex-ed68435e-069t-4b4a-9d84-d0c194800fc2
+```
+
+The first command gets the backup vault.
+The second command get the AzureDatabaseForPGFlexServer policy.
+The third command datasource ARM Id.
+The fourth command initializes the backup instance.
+Similarly use datasourcetype AzureDatabaseForMySQL to initialize backup instance for AzureDatabaseForMySQL.
+
 ## PARAMETERS
 
 ### -BackupConfiguration

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

@@ -12,7 +12,16 @@ Initializes Restore Request object for triggering restore on a protected backup
 
 ## SYNTAX
 
-### AlternateLocationFullRecovery (Default)
+### RestoreAsFiles (Default)
+```
+Initialize-AzDataProtectionRestoreRequest -DatasourceType <DatasourceTypes> -RestoreLocation <String>
+ -RestoreType <RestoreTargetType> -SourceDataStore <DataStoreType> -TargetContainerURI <String>
+ [-FileNamePrefix <String>] [-RecoveryPoint <String>] [-RehydrationDuration <String>]
+ [-RehydrationPriority <String>] [-SecretStoreType <SecretStoreTypes>] [-SecretStoreURI <String>]
+ [-TargetResourceIdForRestoreAsFile <String>] [<CommonParameters>]
+```
+
+### AlternateLocationFullRecovery
 ```
 Initialize-AzDataProtectionRestoreRequest -DatasourceType <DatasourceTypes> -RestoreLocation <String>
  -RestoreType <RestoreTargetType> -SourceDataStore <DataStoreType> -TargetResourceId <String>
@@ -50,15 +59,6 @@ Initialize-AzDataProtectionRestoreRequest -BackupInstance <BackupInstanceResourc
  [-SecretStoreURI <String>] [-ToPrefixPattern <String[]>] [<CommonParameters>]
 ```
 
-### RestoreAsFiles
-```
-Initialize-AzDataProtectionRestoreRequest -DatasourceType <DatasourceTypes> -FileNamePrefix <String>
- -RestoreLocation <String> -RestoreType <RestoreTargetType> -SourceDataStore <DataStoreType>
- -TargetContainerURI <String> [-RecoveryPoint <String>] [-RehydrationDuration <String>]
- [-RehydrationPriority <String>] [-SecretStoreType <SecretStoreTypes>] [-SecretStoreURI <String>]
- [-TargetResourceIdForRestoreAsFile <String>] [<CommonParameters>]
-```
-
 ## DESCRIPTION
 Initializes Restore Request object for triggering restore on a protected backup instance.
 
@@ -242,7 +242,7 @@ Type: System.String
 Parameter Sets: RestoreAsFiles
 Aliases:
 
-Required: True
+Required: False
 Position: Named
 Default value: None
 Accept pipeline input: False

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

@@ -125,6 +125,37 @@ This command runs in async way using parameter -NoWait.
 Next we fetch the operation in a while loop until it succeeds.
 The last command is used to configure protection for the backup instance.
 
+### Example 5: Configure protection for AzureDatabaseForMySQL
+```powershell
+$vault = Get-AzDataProtectionBackupVault -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName"
+$pol = Get-AzDataProtectionBackupPolicy -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -VaultName "vaultName" -ResourceGroupName "resourceGroupName" | Where-Object { $_.DatasourceType  -match "mysql" }
+$datasourceId = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/rgName/providers/Microsoft.DBforMySQL/flexibleServers/test-mysql"
+$backupInstanceClientObject = Initialize-AzDataProtectionBackupInstance -DatasourceType AzureDatabaseForMySQL -DatasourceLocation $vault.Location -PolicyId $pol[0].Id -DatasourceId $datasourceId
+Set-AzDataProtectionMSIPermission -VaultResourceGroup "resourceGroupName" -VaultName "vaultName" -BackupInstance $backupInstanceClientObject -PermissionsScope ResourceGroup
+$operationResponse = Test-AzDataProtectionBackupInstanceReadiness -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -BackupInstance $backupInstanceClientObject.Property -NoWait
+$operationId = $operationResponse.Target.Split("/")[-1].Split("?")[0]
+While((Get-AzDataProtectionOperationStatus -OperationId $operationId -Location $vault.Location -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx").Status -eq "Inprogress"){
+    Start-Sleep -Seconds 10
+}
+$backupnstanceCreate = New-AzDataProtectionBackupInstance -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -BackupInstance $backupInstanceClientObject
+```
+
+```output
+Name                                                                 BackupInstanceName
+----                                                                 ------------------
+test-mysql-test-mysql-64f7399a-b024-4d61-8f16-c424c5fd2564 test-mysql-test-mysql-64f7399a-b024-4d61-8f16-c424c5fd2564
+```
+
+The first command gets the backup vault.
+The second command get the AzureDatabaseForMySQL policy.
+The third command datasource ARM Id.
+The fourth command initializes the backup instance.
+The fifth command assigns the necessary permissions for configure backup.
+The sixth command validates if the backup instance object is valid for configure protection (validate backup).
+This command runs in async way using parameter -NoWait.
+Next we fetch the operation in a while loop until it succeeds.
+The last command is used to configure protection for the backup instance.
+
 ## PARAMETERS
 
 ### -AsJob

src/DataProtection/DataProtection.Autorest/docs/New-AzDataProtectionBackupPolicy.md

@@ -193,6 +193,39 @@ The second to fifteenth command defines and updates the Operational, vaulted wee
 Next we define a trigger object with schedule time and timzone, set it to 2:30 AM West Europe standard time.
 The last command creates the hybrid AzureBlob policy.
 
+### Example 6: Create policy for AzureDatabaseForPGFlexServer/AzureDatabaseForMySQL
+```powershell
+$defaultPol = Get-AzDataProtectionPolicyTemplate -DatasourceType AzureDatabaseForPGFlexServer
+$lifeCycleVault = New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore VaultStore -SourceRetentionDurationType Days -SourceRetentionDurationCount 10
+Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy $defaultPol -Name Default -LifeCycles $lifeCycleVault -IsDefault $true
+$lifeCycleVault = New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore VaultStore -SourceRetentionDurationType Months -SourceRetentionDurationCount 6 
+Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy $defaultPol -Name Monthly -LifeCycles $lifeCycleVault -IsDefault $false
+$schDates = @(
+(
+    (Get-Date -Year 2024 -Month 03 -Day 04 -Hour 09 -Minute 0 -Second 0)
+),
+(
+    (Get-Date -Year 2024 -Month 03 -Day 05 -Hour 09 -Minute 0 -Second 0)
+))
+$trigger =  New-AzDataProtectionPolicyTriggerScheduleClientObject -ScheduleDays $schDates -IntervalType Weekly -IntervalCount 1
+Edit-AzDataProtectionPolicyTriggerClientObject -Schedule $trigger -Policy $defaultPol
+$tagCriteria = New-AzDataProtectionPolicyTagCriteriaClientObject -MonthsOfYear January -DaysOfMonth 1,5,Last
+Edit-AzDataProtectionPolicyTagClientObject -Policy $defaultPol -Name Monthly -Criteria $tagCriteria
+$pgflexPolicy = New-AzDataProtectionBackupPolicy -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -Name "pgflex-policy" -Policy $defaultPol 
+```
+
+```output
+Name                               Type
+----                               ----
+pgflex-policy       Microsoft.DataProtection/backupVaults/backupPolicies
+```
+
+The first command gets the default policy template for AzureDatabaseForPGFlexServer.
+These steps can also be used for AzureDatabaseForMySQL as is.
+The second to tenth command defines and updates the vaulted daily, monthly lifecycle and tagcriteria.
+Next we define a trigger object with schedule, set it to every Weekly Monday, Tuesday schedule.
+The last command creates the AzureDatabaseForPGFlexServer policy.
+
 ## PARAMETERS
 
 ### -DefaultProfile

src/DataProtection/DataProtection.Autorest/docs/Start-AzDataProtectionBackupInstanceRestore.md

@@ -191,6 +191,25 @@ while($jobstatus -ne "Completed")
 This command command triggers the cross region restore for AzureDatabaseForPostgreSQL.
 For triggering cross region restore to secondary region, use RestoreToSecondaryRegion switch.
 
+### Example 9: Trigger restore as Files for datasource type AzureDatabaseForPGFlexServer, AzureDatabaseForMySQL.
+```powershell
+$instance = Get-AzDataProtectionBackupInstance -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName"  | Where { $_.Name -match "test-pgflex" }
+$rps = Get-AzDataProtectionRecoveryPoint -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -BackupInstanceName $instance.Name
+$targetContainerURI = "https://teststorageaccount.blob.core.windows.net/powershellpgflexrestore"
+$storageAccId = (Get-AzStorageAccount -ResourceGroupName "teststorageaccountRG" -Name "teststorageaccount").Id
+$pgFlexRestoreAsFilesRequest = Initialize-AzDataProtectionRestoreRequest -DatasourceType AzureDatabaseForPGFlexServer -SourceDataStore VaultStore -RestoreLocation $vault.Location -RestoreType RestoreAsFiles -RecoveryPoint $rps[0].Property.RecoveryPointId -TargetContainerURI $targetContainerURI
+Set-AzDataProtectionMSIPermission -VaultResourceGroup "resourceGroupName" -VaultName "vaultName" -PermissionsScope "ResourceGroup" -RestoreRequest $pgFlexRestoreAsFilesRequest -DatasourceType AzureDatabaseForPGFlexServer -SubscriptionId $SubscriptionId -StorageAccountARMId $storageAccId
+$validateRestore = Test-AzDataProtectionBackupInstanceRestore -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -RestoreRequest $pgFlexRestoreAsFilesRequest -Name $instance.BackupInstanceName
+$restoreJob = Start-AzDataProtectionBackupInstanceRestore -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -BackupInstanceName $instance.BackupInstanceName -Parameter $pgFlexRestoreAsFilesRequest
+```
+
+The first, second commands fetch the instance and recovery point for the instance.
+The third and fourthcommand initializes the target container id and target storage account ARM id.
+The fifth command initializes the restore request object for AzureDatabaseForPGFlexServer restore.
+This example also works for datasource type AzureDatabaseForMySQL.
+The sixth command assigns the permissions to the backup vault and other permissions necessary for triggering the restore for AzureDatabaseForPGFlexServer.
+The last command triggers the restore for AzureDatabaseForPGFlexServer.
+
 ## PARAMETERS
 
 ### -AsJob