Skip to content

Commit 31e9b72

Browse files
hiagahiaga
authored
[RecoveryServices.Backup] Making help text changes to Restore-AzRecoveryServicesBackupItem cmdlet (#13523)
* Making help text changes to Restore-AzRecoveryServicesBackupItem cmdlet * resolving Analyze tool error
1 parent 5e526f2 commit 31e9b72

File tree

4 files changed

+144
-101
lines changed

4 files changed

+144
-101
lines changed

‎src/RecoveryServices/RecoveryServices.Backup/Cmdlets/Restore/RestoreAzureRMRecoveryServicesBackupItem.cs

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets
3131
public class RestoreAzureRmRecoveryServicesBackupItem : RSBackupVaultCmdletBase
3232
{
3333
internal const string AzureVMParameterSet = "AzureVMParameterSet";
34-
internal const string AzureVMTargetRGParameterSet = "AzureVMTargetRGParameterSet";
35-
internal const string AzureVMRestoreAsUnmanaged = "AzureVMRestoreAsUnmanaged";
36-
internal const string AzureVMUseOSAParameterSet = "AzureVMUseOSAParameterSet";
37-
internal const string AzureFileParameterSet = "AzureFileParameterSet";
34+
internal const string AzureVMManagedDiskParameterSet = "AzureVMManagedDiskParameterSet";
35+
internal const string AzureVMRestoreManagedAsUnmanaged = "AzureVMRestoreManagedAsUnmanaged";
36+
internal const string AzureVMUnManagedDiskParameterSet = "AzureVMUnManagedDiskParameterSet";
37+
internal const string AzureFileShareParameterSet = "AzureFileShareParameterSet";
3838
internal const string AzureWorkloadParameterSet = "AzureWorkloadParameterSet";
3939

4040
/// <summary>
@@ -52,13 +52,13 @@ public class RestoreAzureRmRecoveryServicesBackupItem : RSBackupVaultCmdletBase
5252
[Parameter(Mandatory = true, ValueFromPipeline = true, Position = 0,
5353
ParameterSetName = AzureVMParameterSet, HelpMessage = ParamHelpMsgs.RestoreDisk.RecoveryPoint)]
5454
[Parameter(Mandatory = true, ValueFromPipeline = true, Position = 0,
55-
ParameterSetName = AzureFileParameterSet, HelpMessage = ParamHelpMsgs.RestoreDisk.RecoveryPoint)]
55+
ParameterSetName = AzureFileShareParameterSet, HelpMessage = ParamHelpMsgs.RestoreDisk.RecoveryPoint)]
5656
[Parameter(Mandatory = true, ValueFromPipeline = true, Position = 0,
57-
ParameterSetName = AzureVMRestoreAsUnmanaged, HelpMessage = ParamHelpMsgs.RestoreDisk.RecoveryPoint)]
57+
ParameterSetName = AzureVMRestoreManagedAsUnmanaged, HelpMessage = ParamHelpMsgs.RestoreDisk.RecoveryPoint)]
5858
[Parameter(Mandatory = true, ValueFromPipeline = true, Position = 0,
59-
ParameterSetName = AzureVMTargetRGParameterSet, HelpMessage = ParamHelpMsgs.RestoreDisk.RecoveryPoint)]
59+
ParameterSetName = AzureVMManagedDiskParameterSet, HelpMessage = ParamHelpMsgs.RestoreDisk.RecoveryPoint)]
6060
[Parameter(Mandatory = true, ValueFromPipeline = true, Position = 0,
61-
ParameterSetName = AzureVMUseOSAParameterSet, HelpMessage = ParamHelpMsgs.RestoreDisk.RecoveryPoint)]
61+
ParameterSetName = AzureVMUnManagedDiskParameterSet, HelpMessage = ParamHelpMsgs.RestoreDisk.RecoveryPoint)]
6262
[ValidateNotNullOrEmpty]
6363
public RecoveryPointBase RecoveryPoint { get; set; }
6464

@@ -75,11 +75,11 @@ public class RestoreAzureRmRecoveryServicesBackupItem : RSBackupVaultCmdletBase
7575
/// </summary>
7676
[Parameter(Mandatory = true, Position = 1, ParameterSetName = AzureVMParameterSet,
7777
HelpMessage = ParamHelpMsgs.RestoreDisk.StorageAccountName)]
78-
[Parameter(Mandatory = true, Position = 1, ParameterSetName = AzureVMTargetRGParameterSet,
78+
[Parameter(Mandatory = true, Position = 1, ParameterSetName = AzureVMManagedDiskParameterSet,
7979
HelpMessage = ParamHelpMsgs.RestoreDisk.StorageAccountName)]
80-
[Parameter(Mandatory = true, Position = 1, ParameterSetName = AzureVMUseOSAParameterSet,
80+
[Parameter(Mandatory = true, Position = 1, ParameterSetName = AzureVMUnManagedDiskParameterSet,
8181
HelpMessage = ParamHelpMsgs.RestoreDisk.StorageAccountName)]
82-
[Parameter(Mandatory = true, Position = 1, ParameterSetName = AzureVMRestoreAsUnmanaged,
82+
[Parameter(Mandatory = true, Position = 1, ParameterSetName = AzureVMRestoreManagedAsUnmanaged,
8383
HelpMessage = ParamHelpMsgs.RestoreDisk.StorageAccountName)]
8484
[ValidateNotNullOrEmpty]
8585
public string StorageAccountName { get; set; }
@@ -89,82 +89,82 @@ public class RestoreAzureRmRecoveryServicesBackupItem : RSBackupVaultCmdletBase
8989
/// </summary>
9090
[Parameter(Mandatory = true, Position = 2, ParameterSetName = AzureVMParameterSet,
9191
HelpMessage = ParamHelpMsgs.RestoreDisk.StorageAccountResourceGroupName)]
92-
[Parameter(Mandatory = true, Position = 2, ParameterSetName = AzureVMUseOSAParameterSet,
92+
[Parameter(Mandatory = true, Position = 2, ParameterSetName = AzureVMUnManagedDiskParameterSet,
9393
HelpMessage = ParamHelpMsgs.RestoreDisk.StorageAccountResourceGroupName)]
94-
[Parameter(Mandatory = true, Position = 2, ParameterSetName = AzureVMTargetRGParameterSet,
94+
[Parameter(Mandatory = true, Position = 2, ParameterSetName = AzureVMManagedDiskParameterSet,
9595
HelpMessage = ParamHelpMsgs.RestoreDisk.StorageAccountResourceGroupName)]
96-
[Parameter(Mandatory = true, Position = 2, ParameterSetName = AzureVMRestoreAsUnmanaged,
96+
[Parameter(Mandatory = true, Position = 2, ParameterSetName = AzureVMRestoreManagedAsUnmanaged,
9797
HelpMessage = ParamHelpMsgs.RestoreDisk.StorageAccountResourceGroupName)]
9898
[ValidateNotNullOrEmpty]
9999
public string StorageAccountResourceGroupName { get; set; }
100100

101101
/// <summary>
102102
/// The resource group to which the managed disks are restored. This parameter is mandatory for backup of VM with managed disks.
103103
/// </summary>
104-
[Parameter(Mandatory = true, Position = 3, ParameterSetName = AzureVMTargetRGParameterSet,
104+
[Parameter(Mandatory = true, Position = 3, ParameterSetName = AzureVMManagedDiskParameterSet,
105105
HelpMessage = ParamHelpMsgs.RestoreVM.TargetResourceGroupName)]
106106
[ValidateNotNullOrEmpty]
107107
public string TargetResourceGroupName { get; set; }
108108

109109
/// <summary>
110110
/// Resolve conflict option
111111
/// </summary>
112-
[Parameter(Mandatory = true, ParameterSetName = AzureFileParameterSet,
112+
[Parameter(Mandatory = true, ParameterSetName = AzureFileShareParameterSet,
113113
HelpMessage = ParamHelpMsgs.RestoreFS.ResolveConflict)]
114114
[ValidateNotNullOrEmpty]
115115
public RestoreFSResolveConflictOption ResolveConflict { get; set; }
116116

117117
/// <summary>
118118
/// Source File Path of the file to be recovered
119119
/// </summary>
120-
[Parameter(Mandatory = false, ParameterSetName = AzureFileParameterSet,
120+
[Parameter(Mandatory = false, ParameterSetName = AzureFileShareParameterSet,
121121
HelpMessage = ParamHelpMsgs.RestoreFS.SourceFilePath)]
122122
[ValidateNotNullOrEmpty]
123123
public string SourceFilePath { get; set; }
124124

125125
/// <summary>
126126
/// Source File Type of the file to be recovered
127127
/// </summary>
128-
[Parameter(Mandatory = false, ParameterSetName = AzureFileParameterSet,
128+
[Parameter(Mandatory = false, ParameterSetName = AzureFileShareParameterSet,
129129
HelpMessage = ParamHelpMsgs.RestoreFS.SourceFilePath)]
130130
[ValidateNotNullOrEmpty]
131131
public SourceFileType? SourceFileType { get; set; }
132132

133133
/// <summary>
134134
/// Target storage account name where the disks need to be recovered
135135
/// </summary>
136-
[Parameter(Mandatory = false, ParameterSetName = AzureFileParameterSet,
136+
[Parameter(Mandatory = false, ParameterSetName = AzureFileShareParameterSet,
137137
HelpMessage = ParamHelpMsgs.RestoreFS.TargetStorageAccountName)]
138138
[ValidateNotNullOrEmpty]
139139
public string TargetStorageAccountName { get; set; }
140140

141141
/// <summary>
142142
/// The target file share name to which the files are restored.
143143
/// </summary>
144-
[Parameter(Mandatory = false, ParameterSetName = AzureFileParameterSet,
144+
[Parameter(Mandatory = false, ParameterSetName = AzureFileShareParameterSet,
145145
HelpMessage = ParamHelpMsgs.RestoreFS.TargetFileShareName)]
146146
[ValidateNotNullOrEmpty]
147147
public string TargetFileShareName { get; set; }
148148

149149
/// <summary>
150150
/// The target folder name to which the files are restored.
151151
/// </summary>
152-
[Parameter(Mandatory = false, ParameterSetName = AzureFileParameterSet,
152+
[Parameter(Mandatory = false, ParameterSetName = AzureFileShareParameterSet,
153153
HelpMessage = ParamHelpMsgs.RestoreFS.TargetFolder)]
154154
[ValidateNotNullOrEmpty]
155155
public string TargetFolder { get; set; }
156156

157157
/// <summary>
158158
/// Array of source file paths to be recovered
159159
/// </summary>
160-
[Parameter(Mandatory = false, ParameterSetName = AzureFileParameterSet,
160+
[Parameter(Mandatory = false, ParameterSetName = AzureFileShareParameterSet,
161161
HelpMessage = ParamHelpMsgs.RestoreFS.MultipleSourceFilePath)]
162162
public string[] MultipleSourceFilePath { get; set; }
163163

164164
/// <summary>
165165
/// Use this switch if the disks from the recovery point are to be restored to their original storage accounts
166166
/// </summary>
167-
[Parameter(Mandatory = true, ParameterSetName = AzureVMUseOSAParameterSet,
167+
[Parameter(Mandatory = true, ParameterSetName = AzureVMUnManagedDiskParameterSet,
168168
HelpMessage = ParamHelpMsgs.RestoreVM.OsaOption)]
169169
public SwitchParameter UseOriginalStorageAccount { get; set; }
170170

@@ -173,11 +173,11 @@ public class RestoreAzureRmRecoveryServicesBackupItem : RSBackupVaultCmdletBase
173173
/// </summary>
174174
[Parameter(Mandatory = false, ParameterSetName = AzureVMParameterSet,
175175
HelpMessage = ParamHelpMsgs.RestoreVM.RestoreOnlyOSDisk)]
176-
[Parameter(Mandatory = false, ParameterSetName = AzureVMTargetRGParameterSet,
176+
[Parameter(Mandatory = false, ParameterSetName = AzureVMManagedDiskParameterSet,
177177
HelpMessage = ParamHelpMsgs.RestoreVM.RestoreOnlyOSDisk)]
178-
[Parameter(Mandatory = false, ParameterSetName = AzureVMRestoreAsUnmanaged,
178+
[Parameter(Mandatory = false, ParameterSetName = AzureVMRestoreManagedAsUnmanaged,
179179
HelpMessage = ParamHelpMsgs.RestoreVM.RestoreOnlyOSDisk)]
180-
[Parameter(Mandatory = false, ParameterSetName = AzureVMUseOSAParameterSet,
180+
[Parameter(Mandatory = false, ParameterSetName = AzureVMUnManagedDiskParameterSet,
181181
HelpMessage = ParamHelpMsgs.RestoreVM.RestoreOnlyOSDisk)]
182182
public SwitchParameter RestoreOnlyOSDisk { get; set; }
183183

@@ -186,18 +186,18 @@ public class RestoreAzureRmRecoveryServicesBackupItem : RSBackupVaultCmdletBase
186186
/// </summary>
187187
[Parameter(Mandatory = false, ParameterSetName = AzureVMParameterSet,
188188
HelpMessage = ParamHelpMsgs.RestoreVM.RestoreDiskList)]
189-
[Parameter(Mandatory = false, ParameterSetName = AzureVMUseOSAParameterSet,
189+
[Parameter(Mandatory = false, ParameterSetName = AzureVMUnManagedDiskParameterSet,
190190
HelpMessage = ParamHelpMsgs.RestoreVM.RestoreDiskList)]
191-
[Parameter(Mandatory = false, ParameterSetName = AzureVMTargetRGParameterSet,
191+
[Parameter(Mandatory = false, ParameterSetName = AzureVMManagedDiskParameterSet,
192192
HelpMessage = ParamHelpMsgs.RestoreVM.RestoreDiskList)]
193-
[Parameter(Mandatory = false, ParameterSetName = AzureVMRestoreAsUnmanaged,
193+
[Parameter(Mandatory = false, ParameterSetName = AzureVMRestoreManagedAsUnmanaged,
194194
HelpMessage = ParamHelpMsgs.RestoreVM.RestoreDiskList)]
195195
public string[] RestoreDiskList { get; set; }
196196

197197
/// <summary>
198198
/// Use this switch to specify to restore as unmanaged disks
199199
/// </summary>
200-
[Parameter(Mandatory = true, ParameterSetName = AzureVMRestoreAsUnmanaged,
200+
[Parameter(Mandatory = true, ParameterSetName = AzureVMRestoreManagedAsUnmanaged,
201201
HelpMessage = ParamHelpMsgs.RestoreVM.RestoreAsUnmanagedDisks)]
202202
public SwitchParameter RestoreAsUnmanagedDisks { get; set; }
203203

‎src/RecoveryServices/RecoveryServices/ChangeLog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
- Additional information about change #1
1919
-->
2020
## Upcoming Release
21+
* Making help text changes to Restore-AzRecoveryServicesBackupItem cmdlet.
2122

2223
## Version 3.0.1
2324
* Specifying policy BackupTime is in UTC.

0 commit comments

Comments
 (0)