Skip to content

Commit 21b3b91

Browse files
author
dragonfly91
committed
[RS Backup] Fixing 7349803 (documentation fixes) for Recovery Point and Restore in Cmdlet Layer
1 parent 08e83ee commit 21b3b91

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup/Cmdlets/RecoveryPoint/GetAzureRmRecoveryServicesBackupRecoveryPoint.cs

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,30 +24,45 @@
2424

2525
namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets
2626
{
27+
/// <summary>
28+
/// Gets recovery points created for the provided item protected by the recovery services vault
29+
/// </summary>
2730
[Cmdlet(VerbsCommon.Get, "AzureRmRecoveryServicesBackupRecoveryPoint"),
2831
OutputType(typeof(RecoveryPointBase), typeof(IList<RecoveryPointBase>))]
2932
public class GetAzureRmRecoveryServicesBackupRecoveryPoint : RecoveryServicesBackupCmdletBase
3033
{
3134
internal const string DateTimeFilterParameterSet = "DateTimeFilter";
3235
internal const string RecoveryPointIdParameterSet = "RecoveryPointId";
3336

37+
/// <summary>
38+
/// Start time of Time range for which recovery point need to be fetched
39+
/// </summary>
3440
[Parameter(Mandatory = true, ParameterSetName = DateTimeFilterParameterSet,
3541
ValueFromPipeline = false, Position = 0, HelpMessage = ParamHelpMsgs.RecoveryPoint.StartDate)]
3642
[ValidateNotNullOrEmpty]
3743
public DateTime StartDate { get; set; }
3844

45+
/// <summary>
46+
/// End time of Time range for which recovery point need to be fetched
47+
/// </summary>
3948
[Parameter(Mandatory = true, ParameterSetName = DateTimeFilterParameterSet, ValueFromPipeline = false,
4049
Position = 1, HelpMessage = ParamHelpMsgs.RecoveryPoint.EndDate)]
4150
[ValidateNotNullOrEmpty]
4251
public DateTime EndDate { get; set; }
4352

53+
/// <summary>
54+
/// Protected Item object for which recovery point need to be fetched
55+
/// </summary>
4456
[Parameter(Mandatory = true, ParameterSetName = DateTimeFilterParameterSet,
4557
ValueFromPipeline = true, Position = 2, HelpMessage = ParamHelpMsgs.RecoveryPoint.Item)]
4658
[Parameter(Mandatory = true, ParameterSetName = RecoveryPointIdParameterSet,
4759
ValueFromPipeline = true, Position = 0, HelpMessage = ParamHelpMsgs.RecoveryPoint.Item)]
4860
[ValidateNotNullOrEmpty]
4961
public ItemBase Item { get; set; }
5062

63+
/// <summary>
64+
/// Recovery point Id for which detail is needed
65+
/// </summary>
5166
[Parameter(Mandatory = true, ParameterSetName = RecoveryPointIdParameterSet,
5267
ValueFromPipeline = false, Position = 1, HelpMessage = ParamHelpMsgs.RecoveryPoint.RecoveryPointId)]
5368
[ValidateNotNullOrEmpty]

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup/Cmdlets/Restore/RestoreAzureRMRecoveryServicesBackupItem.cs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,19 +30,31 @@
3030

3131
namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets
3232
{
33+
/// <summary>
34+
/// Restores an item using the recovery point provided within the recovery services vault
35+
/// </summary>
3336
[Cmdlet(VerbsData.Restore, "AzureRmRecoveryServicesBackupItem"), OutputType(typeof(JobBase))]
3437
public class RestoreAzureRmRecoveryServicesBackupItem : RecoveryServicesBackupCmdletBase
3538
{
39+
/// <summary>
40+
/// Recovery point of the item to be restored
41+
/// </summary>
3642
[Parameter(Mandatory = true, ValueFromPipeline = true, Position = 0,
3743
HelpMessage = ParamHelpMsgs.RestoreDisk.RecoveryPoint)]
3844
[ValidateNotNullOrEmpty]
3945
public RecoveryPointBase RecoveryPoint { get; set; }
4046

47+
/// <summary>
48+
/// Storage account name where the disks need to be recovered
49+
/// </summary>
4150
[Parameter(Mandatory = true, Position = 1,
4251
HelpMessage = ParamHelpMsgs.RestoreDisk.StorageAccountName)]
4352
[ValidateNotNullOrEmpty]
4453
public string StorageAccountName { get; set; }
4554

55+
/// <summary>
56+
/// Resource group name of Storage account name where the disks need to be recovered
57+
/// </summary>
4658
[Parameter(Mandatory = true, Position = 2,
4759
HelpMessage = ParamHelpMsgs.RestoreDisk.StorageAccountResourceGroupName)]
4860
[ValidateNotNullOrEmpty]

0 commit comments

Comments
 (0)