Update Get-AzRecoveryServicesBackupRecoveryPoint.md and Restore-AzRecoveryServicesBackupItem.md

Author: Andrii_Bilousko

src/RecoveryServices/RecoveryServices/ChangeLog.md

@@ -24,6 +24,8 @@
 * Update 'Wait-AzRecoveryServicesBackupJob.md'
 * Update 'Set-AzRecoveryServicesVaultContext.md'
 * Update 'Get-AzRecoveryServicesBackupItem.md'
+* Update 'Get-AzRecoveryServicesBackupRecoveryPoint.md'
+* Update 'Restore-AzRecoveryServicesBackupItem.md'
 * Updated service call for Unregistering container for Azure File Share
 
 ## Version 1.4.2

src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupRecoveryPoint.md

@@ -9,43 +9,50 @@ schema: 2.0.0
 # Get-AzRecoveryServicesBackupRecoveryPoint
 
 ## SYNOPSIS
+
 Gets the recovery points for a backed up item.
 
 ## SYNTAX
 
 ### NoFilterParameterSet (Default)
+
 ```
 Get-AzRecoveryServicesBackupRecoveryPoint [-Item] <ItemBase> [-VaultId <String>]
  [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
 ```
 
 ### DateTimeFilter
+
 ```
 Get-AzRecoveryServicesBackupRecoveryPoint [[-StartDate] <DateTime>] [[-EndDate] <DateTime>] [-Item] <ItemBase>
  [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
 ```
 
 ### RecoveryPointId
+
 ```
 Get-AzRecoveryServicesBackupRecoveryPoint [-Item] <ItemBase> [-RecoveryPointId] <String>
  [[-KeyFileDownloadLocation] <String>] [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>]
  [<CommonParameters>]
 ```
 
 ## DESCRIPTION
+
 The **Get-AzRecoveryServicesBackupRecoveryPoint** cmdlet gets the recovery points for a backed up Azure Backup item.
 After an item has been backed up, an **AzureRmRecoveryServicesBackupRecoveryPoint** object has one or more recovery points.
-Set the vault context by using the Set-AzRecoveryServicesVaultContext cmdlet before you use the current cmdlet.
+Set the vault context by using the -VaultId parameter.
 
 ## EXAMPLES
 
 ### Example 1: Get recovery points from the last week for an item
-```
-PS C:\> $StartDate = (Get-Date).AddDays(-7) 
-PS C:\> $EndDate = Get-Date 
-PS C:\> $Container = Get-AzRecoveryServicesBackupContainer -ContainerType AzureVM -Status Registered -Name "V2VM"
-PS C:\> $BackupItem = Get-AzRecoveryServicesBackupItem -ContainerType AzureVM -WorkloadType AzureVM 
-PS C:\> $RP = Get-AzRecoveryServicesBackupRecoveryPoint -Item $BackupItem -StartDate $Startdate.ToUniversalTime() -EndDate $Enddate.ToUniversalTime()
+
+```powershell
+PS C:\> $vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName"
+PS C:\> $StartDate = (Get-Date).AddDays(-7)
+PS C:\> $EndDate = Get-Date
+PS C:\> $Container = Get-AzRecoveryServicesBackupContainer -ContainerType AzureVM -Status Registered -Name "V2VM" -VaultId $vault.ID
+PS C:\> $BackupItem = Get-AzRecoveryServicesBackupItem -ContainerType AzureVM -WorkloadType AzureVM -VaultId $vault.ID
+PS C:\> $RP = Get-AzRecoveryServicesBackupRecoveryPoint -Item $BackupItem -StartDate $Startdate.ToUniversalTime() -EndDate $Enddate.ToUniversalTime() -VaultId $vault.ID
 ```
 
 The first command gets the date from seven days ago, and then stores it in the $StartDate variable.
@@ -57,6 +64,7 @@ The last command gets an array of recovery points for the item in $BackupItem, a
 ## PARAMETERS
 
 ### -DefaultProfile
+
 The credentials, account, tenant, and subscription used for communication with azure.
 
 ```yaml
@@ -72,6 +80,7 @@ Accept wildcard characters: False
 ```
 
 ### -EndDate
+
 Specifies the end of the date range.
 
 ```yaml
@@ -87,8 +96,9 @@ Accept wildcard characters: False
 ```
 
 ### -Item
+
 Specifies the item for which this cmdlet gets recovery points.
-To obtain an **AzureRmRecoveryServicesBackupItem** object, use the Get-AzRecoveryServicesBackupItem cmdlet.
+To obtain an **AzureRmRecoveryServicesBackupItem** object, use the **Get-AzRecoveryServicesBackupItem** cmdlet.
 
 ```yaml
 Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase
@@ -103,6 +113,7 @@ Accept wildcard characters: False
 ```
 
 ### -KeyFileDownloadLocation
+
 Specifies the location to download the input file to restore the KeyVault key for an encrypted virtual machine.
 
 ```yaml
@@ -118,6 +129,7 @@ Accept wildcard characters: False
 ```
 
 ### -RecoveryPointId
+
 Specifies the recovery point ID.
 
 ```yaml
@@ -133,6 +145,7 @@ Accept wildcard characters: False
 ```
 
 ### -StartDate
+
 Specifies the start of the date range.
 
 ```yaml
@@ -148,6 +161,7 @@ Accept wildcard characters: False
 ```
 
 ### -VaultId
+
 ARM ID of the Recovery Services Vault.
 
 ```yaml
@@ -162,8 +176,9 @@ Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
 ```
 
-### CommonParameters
-This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
+### -CommonParameters
+
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
 
 ## INPUTS
 
@@ -182,5 +197,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 [Get-AzRecoveryServicesBackupContainer](./Get-AzRecoveryServicesBackupContainer.md)
 
 [Get-AzRecoveryServicesBackupItem](./Get-AzRecoveryServicesBackupItem.md)
-
-

src/RecoveryServices/RecoveryServices/help/Restore-AzRecoveryServicesBackupItem.md

@@ -9,11 +9,13 @@ schema: 2.0.0
 # Restore-AzRecoveryServicesBackupItem
 
 ## SYNOPSIS
+
 Restores the data and configuration for a Backup item to a recovery point.
 
 ## SYNTAX
 
 ### AzureVMParameterSet (Default)
+
 ```
 Restore-AzRecoveryServicesBackupItem [-VaultLocation <String>] [-RecoveryPoint] <RecoveryPointBase>
  [-StorageAccountName] <String> [-StorageAccountResourceGroupName] <String>
@@ -22,6 +24,7 @@ Restore-AzRecoveryServicesBackupItem [-VaultLocation <String>] [-RecoveryPoint]
 ```
 
 ### AzureFileParameterSet
+
 ```
 Restore-AzRecoveryServicesBackupItem [-VaultLocation <String>] [-RecoveryPoint] <RecoveryPointBase>
  -ResolveConflict <RestoreFSResolveConflictOption> [-SourceFilePath <String>]
@@ -31,29 +34,35 @@ Restore-AzRecoveryServicesBackupItem [-VaultLocation <String>] [-RecoveryPoint]
 ```
 
 ### AzureWorkloadParameterSet
+
 ```
 Restore-AzRecoveryServicesBackupItem [-VaultLocation <String>] [-WLRecoveryConfig] <RecoveryConfigBase>
  [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
+
 The **Restore-AzRecoveryServicesBackupItem** cmdlet restores the data and configuration for an Azure Backup item to a specified recovery point.
 This cmdlet starts the restore from the Recovery Services vault to customer's storage account.
 The restore operation does not restore the full virtual machine.
 It restores the disk data and configuration information.
 After the restore operation is finished, you must create the virtual machine and start it.
-Set the vault context by using the Set-AzRecoveryServicesVaultContext cmdlet before you use the current cmdlet.
+Set the vault context by using the -VaultId parameter.
+
+Note: To successfully execute this cmdlet in addition to -VaultId parameter -VaultLocation parameter should be used as well.
 
 ## EXAMPLES
 
 ### Example 1: Restore an item to a recovery point
-```
-PS C:\>$Container = Get-AzRecoveryServicesBackupContainer -ContainerType AzureVM -Status Registered -Name "V2VM"
-PS C:\> $BackupItem = Get-AzRecoveryServicesBackupItem -ContainerType AzureVM -WorkloadType AzureVM 
-PS C:\> $StartDate = (Get-Date).AddDays(-7) 
+
+```powershell
+PS C:\> $vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName"
+PS C:\>$Container = Get-AzRecoveryServicesBackupContainer -ContainerType AzureVM -Status Registered -Name "V2VM" -VaultId $vault.ID
+PS C:\> $BackupItem = Get-AzRecoveryServicesBackupItem -ContainerType AzureVM -WorkloadType AzureVM -VaultId $vault.ID
+PS C:\> $StartDate = (Get-Date).AddDays(-7)
 PS C:\> $EndDate = Get-Date
-PS C:\> $RP = Get-AzRecoveryServicesBackupRecoveryPoint -Item $BackupItem -StartDate $StartDate.ToUniversalTime() -EndDate $EndDate.ToUniversalTime() 
-PS C:\> $RestoreJob = Restore-AzRecoveryServicesBackupItem -RecoveryPoint $RP[0] -StorageAccountName "DestAccount" -StorageAccountResourceGroupName "DestRG"
+PS C:\> $RP = Get-AzRecoveryServicesBackupRecoveryPoint -Item $BackupItem -StartDate $StartDate.ToUniversalTime() -EndDate $EndDate.ToUniversalTime() -VaultId $vault.ID
+PS C:\> $RestoreJob = Restore-AzRecoveryServicesBackupItem -RecoveryPoint $RP[0] -StorageAccountName "DestAccount" -StorageAccountResourceGroupName "DestRG" -VaultId $vault.ID -VaultLocation $vault.Location
     WorkloadName    Operation       Status          StartTime              EndTime
     ------------    ---------       ------          ---------              -------
     V2VM            Restore         InProgress      26-Apr-16 1:14:01 PM   01-Jan-01 12:00:00 AM
@@ -70,6 +79,7 @@ The last command restores the disks to the target storage account DestAccount in
 ## PARAMETERS
 
 ### -DefaultProfile
+
 The credentials, account, tenant, and subscription used for communication with azure.
 
 ```yaml
@@ -85,8 +95,9 @@ Accept wildcard characters: False
 ```
 
 ### -RecoveryPoint
+
 Specifies the recovery point to which to restore the virtual machine.
-To obtain an **AzureRmRecoveryServicesBackupRecoveryPoint** object, use the Get-AzRecoveryServicesBackupRecoveryPoint cmdlet.
+To obtain an **AzureRmRecoveryServicesBackupRecoveryPoint** object, use the **Get-AzRecoveryServicesBackupRecoveryPoint** cmdlet.
 
 ```yaml
 Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase
@@ -101,7 +112,12 @@ Accept wildcard characters: False
 ```
 
 ### -ResolveConflict
+
 In case the restored item also exists in the destination, use this to indicate whether to overwrite or not.
+The acceptable values for this parameter are:
+
+- Overwrite
+- Skip
 
 ```yaml
 Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RestoreFSResolveConflictOption
@@ -117,6 +133,7 @@ Accept wildcard characters: False
 ```
 
 ### -SourceFilePath
+
 Used for a particular item restore from a file share. The path of the item to be restored within the file share.
 
 ```yaml
@@ -132,7 +149,12 @@ Accept wildcard characters: False
 ```
 
 ### -SourceFileType
-Used for a particular item restore from a file share. The path of the item to be restored within the file share.
+
+Used for a particular item restore from a file share. The type of the item to be restored within the file share.
+The acceptable values for this parameter are:
+
+- File
+- Directory
 
 ```yaml
 Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.SourceFileType]
@@ -148,6 +170,7 @@ Accept wildcard characters: False
 ```
 
 ### -StorageAccountName
+
 Specifies the name of the target Storage account in your subscription.
 As a part of the restore process, this cmdlet stores the disks and the configuration information in this Storage account.
 
@@ -164,6 +187,7 @@ Accept wildcard characters: False
 ```
 
 ### -StorageAccountResourceGroupName
+
 Specifies the name of the resource group that contains the target Storage account in your subscription.
 As a part of the restore process, this cmdlet stores the disks and the configuration information in this Storage account.
 
@@ -180,6 +204,7 @@ Accept wildcard characters: False
 ```
 
 ### -TargetFileShareName
+
 The File Share to which the file share has to be restored to.
 
 ```yaml
@@ -195,7 +220,8 @@ Accept wildcard characters: False
 ```
 
 ### -TargetFolder
-The folder under which the file share has to be restored to within the targetFileShareName.Leave the variable empty to restore under root folder.
+
+The folder under which the file share has to be restored to within the TargetFileShareName. If the backed-up content is to be restored to a root folder, give the target folder values as an empty string.
 
 ```yaml
 Type: System.String
@@ -210,6 +236,7 @@ Accept wildcard characters: False
 ```
 
 ### -TargetResourceGroupName
+
 The resource group to which the managed disks are restored. Applicable to backup of VM with managed disks
 
 ```yaml
@@ -225,6 +252,7 @@ Accept wildcard characters: False
 ```
 
 ### -TargetStorageAccountName
+
 The storage account to which the file share has to be restored to.
 
 ```yaml
@@ -240,6 +268,7 @@ Accept wildcard characters: False
 ```
 
 ### -UseOriginalStorageAccount
+
 Use this switch if the disks from the recovery point are to be restored to their original storage accounts.
 
 ```yaml
@@ -255,6 +284,7 @@ Accept wildcard characters: False
 ```
 
 ### -VaultId
+
 ARM ID of the Recovery Services Vault.
 
 ```yaml
@@ -270,6 +300,7 @@ Accept wildcard characters: False
 ```
 
 ### -VaultLocation
+
 Location of the Recovery Services Vault.
 
 ```yaml
@@ -285,6 +316,7 @@ Accept wildcard characters: False
 ```
 
 ### -WLRecoveryConfig
+
 Recovery config
 
 ```yaml
@@ -300,6 +332,7 @@ Accept wildcard characters: False
 ```
 
 ### -Confirm
+
 Prompts you for confirmation before running the cmdlet.
 
 ```yaml
@@ -315,6 +348,7 @@ Accept wildcard characters: False
 ```
 
 ### -WhatIf
+
 Shows what would happen if the cmdlet runs. The cmdlet is not run.
 
 ```yaml
@@ -329,8 +363,9 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### CommonParameters
-This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
+### -CommonParameters
+
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
 
 ## INPUTS
 
@@ -351,5 +386,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 [Get-AzRecoveryServicesBackupItem](./Get-AzRecoveryServicesBackupItem.md)
 
 [Get-AzRecoveryServicesBackupRecoveryPoint](./Get-AzRecoveryServicesBackupRecoveryPoint.md)
-
-