Skip to content

Commit f3a2390

Browse files
hiagahiaga
authored
Modifying the HelpText for AzRecoveryServiceBackup cmdlets (#12271)
* Modifying the HelpText for AzRecoveryServiceBackup cmdlets * resolve breaking errors * Adding AzureWorkload in validation and minor changes * removing AzureSQL from help text and validation set * adding BreakingChangeIssues.csv
1 parent 598cef5 commit f3a2390

File tree

46 files changed

+255
-186
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+255
-186
lines changed

‎src/RecoveryServices/RecoveryServices.Backup/Cmdlets/Container/GetAzureRmRecoveryServicesBackupContainer.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public class GetAzureRmRecoveryServicesBackupContainer : RSBackupVaultCmdletBase
4141
[Parameter(Mandatory = false, Position = 2,
4242
HelpMessage = ParamHelpMsgs.Container.BackupManagementType)]
4343
[ValidateNotNullOrEmpty]
44-
[ValidateSet("AzureVM", "MARS", "AzureSQL", "AzureStorage")]
44+
[ValidateSet("AzureVM", "MARS", "AzureStorage", "AzureWorkload")]
4545
public string BackupManagementType { get; set; }
4646

4747
/// <summary>

‎src/RecoveryServices/RecoveryServices.Backup/Cmdlets/Container/RegisterAzureRmRecoveryServicesBackupContainer.cs

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,16 @@ public class RegisterAzureRmRecoveryServicesBackupContainer
3535
internal const string RegisterParamSet = "Register";
3636
internal const string ReRegisterParamSet = "ReRegister";
3737

38+
/// <summary>
39+
/// List of supported BackupManagementTypes for this cmdlet. Used in help text creation.
40+
/// </summary>
41+
private const string validBackupManagementTypes = "AzureWorkload";
42+
43+
/// <summary>
44+
/// List of supported WorkloadTypes for this cmdlet. Used in help text creation.
45+
/// </summary>
46+
private const string validWorkloadTypes = "MSSQL";
47+
3848
/// <summary>
3949
/// Azure Vm Id.
4050
/// </summary>
@@ -55,7 +65,7 @@ public class RegisterAzureRmRecoveryServicesBackupContainer
5565
/// The backup management type of the container(s) to be fetched.
5666
/// </summary>
5767
[Parameter(Mandatory = true, Position = 1,
58-
HelpMessage = ParamHelpMsgs.Container.BackupManagementType)]
68+
HelpMessage = ParamHelpMsgs.Common.BackupManagementType + validBackupManagementTypes)]
5969
[ValidateNotNullOrEmpty]
6070
[ValidateSet("AzureWorkload")]
6171
public Models.BackupManagementType BackupManagementType { get; set; }
@@ -64,7 +74,7 @@ public class RegisterAzureRmRecoveryServicesBackupContainer
6474
/// Workload type of the item to be returned.
6575
/// </summary>
6676
[Parameter(Mandatory = true, Position = 2,
67-
HelpMessage = ParamHelpMsgs.Common.WorkloadType)]
77+
HelpMessage = ParamHelpMsgs.Common.WorkloadType + validWorkloadTypes)]
6878
[ValidateNotNullOrEmpty]
6979
public Models.WorkloadType WorkloadType { get; set; }
7080

‎src/RecoveryServices/RecoveryServices.Backup/Cmdlets/Item/DisableAzureRmRecoveryServicesBackupAutoProtection.cs

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,16 @@ namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets
2929
[Cmdlet("Disable", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "RecoveryServicesBackupAutoProtection", SupportsShouldProcess = true), OutputType(typeof(bool))]
3030
public class DisableAzureRmRecoveryServicesBackupAutoProtection : RSBackupVaultCmdletBase
3131
{
32+
/// <summary>
33+
/// List of supported BackupManagementTypes for this cmdlet. Used in help text creation.
34+
/// </summary>
35+
private const string validBackupManagementTypes = "AzureWorkload";
36+
37+
/// <summary>
38+
/// List of supported WorkloadTypes for this cmdlet. Used in help text creation.
39+
/// </summary>
40+
private const string validWorkloadTypes = "MSSQL";
41+
3242
/// <summary>
3343
/// Name of the Azure VM whose representative item needs to be protected.
3444
/// </summary>
@@ -39,14 +49,14 @@ public class DisableAzureRmRecoveryServicesBackupAutoProtection : RSBackupVaultC
3949
/// <summary>
4050
/// Backup management type of the items to be returned.
4151
/// </summary>
42-
[Parameter(Mandatory = true, Position = 1, HelpMessage = ParamHelpMsgs.Common.BackupManagementType)]
52+
[Parameter(Mandatory = true, Position = 1, HelpMessage = ParamHelpMsgs.Common.BackupManagementType + validBackupManagementTypes)]
4353
[ValidateNotNullOrEmpty]
4454
public Models.BackupManagementType BackupManagementType { get; set; }
4555

4656
/// <summary>
4757
/// Backup management type of the items to be returned.
4858
/// </summary>
49-
[Parameter(Mandatory = true, Position = 2, HelpMessage = ParamHelpMsgs.Common.WorkloadType)]
59+
[Parameter(Mandatory = true, Position = 2, HelpMessage = ParamHelpMsgs.Common.WorkloadType + validWorkloadTypes)]
5060
[ValidateNotNullOrEmpty]
5161
public Models.WorkloadType WorkloadType { get; set; }
5262

‎src/RecoveryServices/RecoveryServices.Backup/Cmdlets/Item/EnableAzureRmRecoveryServicesBackupAutoProtection.cs

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,16 @@ namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets
2929
[Cmdlet("Enable", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "RecoveryServicesBackupAutoProtection", SupportsShouldProcess = true), OutputType(typeof(bool))]
3030
public class EnableAzureRmRecoveryServicesBackupAutoProtection : RSBackupVaultCmdletBase
3131
{
32+
/// <summary>
33+
/// List of supported BackupManagementTypes for this cmdlet. Used in help text creation.
34+
/// </summary>
35+
private const string validBackupManagementTypes = "MAB, AzureWorkload, AzureVM";
36+
37+
/// <summary>
38+
/// List of supported WorkloadTypes for this cmdlet. Used in help text creation.
39+
/// </summary>
40+
private const string validWorkloadTypes = "AzureVM, WindowsServer, MSSQL";
41+
3242
/// <summary>
3343
/// Item that needs to be auto protected
3444
/// </summary>
@@ -40,14 +50,14 @@ public class EnableAzureRmRecoveryServicesBackupAutoProtection : RSBackupVaultCm
4050
/// <summary>
4151
/// Backup management type of the items to be returned.
4252
/// </summary>
43-
[Parameter(Mandatory = true, Position = 1, HelpMessage = ParamHelpMsgs.Common.BackupManagementType)]
53+
[Parameter(Mandatory = true, Position = 1, HelpMessage = ParamHelpMsgs.Common.BackupManagementType + validBackupManagementTypes)]
4454
[ValidateNotNullOrEmpty]
4555
public Models.BackupManagementType BackupManagementType { get; set; }
4656

4757
/// <summary>
4858
/// Backup management type of the items to be returned.
4959
/// </summary>
50-
[Parameter(Mandatory = true, Position = 2, HelpMessage = ParamHelpMsgs.Common.WorkloadType)]
60+
[Parameter(Mandatory = true, Position = 2, HelpMessage = ParamHelpMsgs.Common.WorkloadType + validWorkloadTypes)]
5161
[ValidateNotNullOrEmpty]
5262
public Models.WorkloadType WorkloadType { get; set; }
5363

‎src/RecoveryServices/RecoveryServices.Backup/Cmdlets/Item/GetAzureRMRecoveryServicesBackupProtectableItem.cs

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,16 @@ namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets
3131
[Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "RecoveryServicesBackupProtectableItem",
3232
DefaultParameterSetName = NoFilterParamSet), OutputType(typeof(ProtectableItemBase))]
3333
public class GetAzureRmRecoveryServicesBackupProtectableItem : RSBackupVaultCmdletBase
34-
{
34+
{
3535
internal const string NoFilterParamSet = "NoFilterParamSet";
3636
internal const string FilterParamSet = "FilterParamSet";
3737
internal const string IdParamSet = "IdParamSet";
3838

39+
/// <summary>
40+
/// List of supported WorkloadTypes for this cmdlet. Used in help text creation.
41+
/// </summary>
42+
private const string validWorkloadTypes = "AzureVM, WindowsServer, AzureFiles, MSSQL";
43+
3944
[Parameter(Mandatory = false, Position = 0, ParameterSetName = NoFilterParamSet,
4045
HelpMessage = ParamHelpMsgs.Item.Container, ValueFromPipelineByPropertyName = true)]
4146
[Parameter(Mandatory = false, Position = 0, ParameterSetName = FilterParamSet,
@@ -49,9 +54,9 @@ public class GetAzureRmRecoveryServicesBackupProtectableItem : RSBackupVaultCmdl
4954
public string ParentID { get; set; }
5055

5156
[Parameter(Mandatory = true, Position = 1, ParameterSetName = NoFilterParamSet,
52-
HelpMessage = ParamHelpMsgs.Common.WorkloadType)]
57+
HelpMessage = ParamHelpMsgs.Common.WorkloadType + validWorkloadTypes)]
5358
[Parameter(Mandatory = true, Position = 1, ParameterSetName = FilterParamSet,
54-
HelpMessage = ParamHelpMsgs.Common.WorkloadType)]
59+
HelpMessage = ParamHelpMsgs.Common.WorkloadType + validWorkloadTypes)]
5560
[ValidateNotNullOrEmpty]
5661
public Models.WorkloadType WorkloadType { get; set; }
5762

‎src/RecoveryServices/RecoveryServices.Backup/Cmdlets/Item/GetAzureRmRecoveryServicesBackupItem.cs

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,16 @@ public class GetAzureRmRecoveryServicesBackupItem : RSBackupVaultCmdletBase
3232
internal const string GetItemsForVaultParamSet = "GetItemsForVault";
3333
internal const string GetItemsForPolicyParamSet = "GetItemsForPolicy";
3434

35+
/// <summary>
36+
/// List of supported BackupManagementTypes for this cmdlet. Used in help text creation.
37+
/// </summary>
38+
private const string validBackupManagementTypes = "AzureVM, MAB, AzureStorage, AzureWorkload";
39+
40+
/// <summary>
41+
/// List of supported WorkloadTypes for this cmdlet. Used in help text creation.
42+
/// </summary>
43+
private const string validWorkloadTypes = "AzureVM, AzureFiles, MSSQL";
44+
3545
/// <summary>
3646
/// When this option is specified, only those items which belong to this container will be returned.
3747
/// </summary>
@@ -47,7 +57,7 @@ public class GetAzureRmRecoveryServicesBackupItem : RSBackupVaultCmdletBase
4757
/// <summary>
4858
/// Backup management type of the items to be returned.
4959
/// </summary>
50-
[Parameter(Mandatory = true, Position = 1, HelpMessage = ParamHelpMsgs.Common.BackupManagementType,
60+
[Parameter(Mandatory = true, Position = 1, HelpMessage = ParamHelpMsgs.Common.BackupManagementType + validBackupManagementTypes,
5161
ParameterSetName = GetItemsForVaultParamSet)]
5262
[ValidateNotNullOrEmpty]
5363
public BackupManagementType BackupManagementType { get; set; }
@@ -84,9 +94,9 @@ public class GetAzureRmRecoveryServicesBackupItem : RSBackupVaultCmdletBase
8494
/// <summary>
8595
/// Workload type of the item to be returned.
8696
/// </summary>
87-
[Parameter(Mandatory = true, Position = 5, HelpMessage = ParamHelpMsgs.Common.WorkloadType,
97+
[Parameter(Mandatory = true, Position = 5, HelpMessage = ParamHelpMsgs.Common.WorkloadType + validWorkloadTypes,
8898
ParameterSetName = GetItemsForVaultParamSet)]
89-
[Parameter(Mandatory = true, Position = 5, HelpMessage = ParamHelpMsgs.Common.WorkloadType,
99+
[Parameter(Mandatory = true, Position = 5, HelpMessage = ParamHelpMsgs.Common.WorkloadType + validWorkloadTypes,
90100
ParameterSetName = GetItemsForContainerParamSet)]
91101
[ValidateNotNullOrEmpty]
92102
public WorkloadType WorkloadType { get; set; }

‎src/RecoveryServices/RecoveryServices.Backup/Cmdlets/Item/InitializeAzureRmRecoveryServicesBackupProtectableItem.cs

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,11 @@ namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets
3131
OutputType(typeof(ContainerBase))]
3232
public class InitializeAzureRmRecoveryServicesBackupProtectableItem : RSBackupVaultCmdletBase
3333
{
34+
/// <summary>
35+
/// List of supported WorkloadTypes for this cmdlet. Used in help text creation.
36+
/// </summary>
37+
private const string validWorkloadTypes = "AzureVM, WindowsServer, AzureFiles, MSSQL";
38+
3439
/// <summary>
3540
/// Container base
3641
/// </summary>
@@ -43,14 +48,14 @@ public class InitializeAzureRmRecoveryServicesBackupProtectableItem : RSBackupVa
4348
/// Workload type of the item to be returned.
4449
/// </summary>
4550
[Parameter(Mandatory = true, Position = 1,
46-
HelpMessage = ParamHelpMsgs.Common.WorkloadType)]
51+
HelpMessage = ParamHelpMsgs.Common.WorkloadType + validWorkloadTypes )]
4752
[ValidateNotNullOrEmpty]
4853
public Models.WorkloadType WorkloadType { get; set; }
4954

5055
/// <summary>
5156
/// Return the container to be deleted
5257
/// </summary>
53-
[Parameter(Mandatory = false, HelpMessage = "Return the container to be deleted.")]
58+
[Parameter(Mandatory = false, HelpMessage = ParamHelpMsgs.ProtectableItem.ItemContainer)]
5459
public SwitchParameter PassThru { get; set; }
5560

5661
public override void ExecuteCmdlet()

‎src/RecoveryServices/RecoveryServices.Backup/Cmdlets/Item/UndoAzureRmRecoveryServicesBackupItemDeletion.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public class UndoAzureRmRecoveryServicesBackupItemDeletion : RSBackupVaultCmdlet
3030
/// <summary>
3131
/// The protected item which needs to be rehydrated
3232
/// </summary>
33-
[Parameter(Position = 1, Mandatory = true, HelpMessage = ParamHelpMsgs.Item.ProtectedItem,
33+
[Parameter(Position = 1, Mandatory = true, HelpMessage = ParamHelpMsgs.Item.ReprotectItem,
3434
ValueFromPipeline = true)]
3535
[ValidateNotNullOrEmpty]
3636
public ItemBase Item { get; set; }

‎src/RecoveryServices/RecoveryServices.Backup/Cmdlets/Jobs/GetAzureRmRecoveryServicesBackupJob.cs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,11 @@ namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets
2929
[Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "RecoveryServicesBackupJob"), OutputType(typeof(JobBase))]
3030
public class GetAzureRmRecoveryServicesBackupJob : RSBackupVaultCmdletBase
3131
{
32+
/// <summary>
33+
/// List of supported BackupManagementTypes for this cmdlet. Used in help text creation.
34+
/// </summary>
35+
private const string validBackupManagementTypes = "AzureVM, AzureStorage, AzureWorkload";
36+
3237
/// <summary>
3338
/// Filter value for status of job.
3439
/// </summary>
@@ -74,7 +79,7 @@ public class GetAzureRmRecoveryServicesBackupJob : RSBackupVaultCmdletBase
7479
/// <summary>
7580
/// Filter value for backup management type of job.
7681
/// </summary>
77-
[Parameter(Mandatory = false, HelpMessage = ParamHelpMsgs.Job.BackupManagementTypeFilter)]
82+
[Parameter(Mandatory = false, HelpMessage = ParamHelpMsgs.Common.BackupManagementType + validBackupManagementTypes)]
7883
[ValidateNotNullOrEmpty]
7984
public BackupManagementType? BackupManagementType { get; set; }
8085

‎src/RecoveryServices/RecoveryServices.Backup/Cmdlets/ProtectionPolicy/GetAzureRmRecoveryServicesBackupProtectionPolicy.cs

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,16 @@ public class GetAzureRmRecoveryServicesBackupProtectionPolicy : RSBackupVaultCmd
3636
protected const string NoParamSet = "NoParamSet";
3737
protected const string WorkloadBackupMangementTypeParamSet = "WorkloadBackupManagementTypeParamSet";
3838

39+
/// <summary>
40+
/// List of supported BackupManagementTypes for this cmdlet. Used in help text creation.
41+
/// </summary>
42+
private const string validBackupManagementTypes = "AzureVM, AzureStorage, AzureWorkload ";
43+
44+
/// <summary>
45+
/// List of supported WorkloadTypes for this cmdlet. Used in help text creation.
46+
/// </summary>
47+
private const string validWorkloadTypes = "AzureVM, AzureFiles, MSSQL";
48+
3949
/// <summary>
4050
/// Name of the policy to be fetched.
4151
/// </summary>
@@ -48,17 +58,17 @@ public class GetAzureRmRecoveryServicesBackupProtectionPolicy : RSBackupVaultCmd
4858
/// Workload type of the policy to be fetched
4959
/// </summary>
5060
[Parameter(ParameterSetName = WorkloadParamSet, Position = 2,
51-
Mandatory = true, HelpMessage = ParamHelpMsgs.Common.WorkloadType)]
61+
Mandatory = true, HelpMessage = ParamHelpMsgs.Common.WorkloadType + validWorkloadTypes)]
5262
[Parameter(ParameterSetName = WorkloadBackupMangementTypeParamSet, Position = 2,
53-
Mandatory = true, HelpMessage = ParamHelpMsgs.Common.WorkloadType)]
63+
Mandatory = true, HelpMessage = ParamHelpMsgs.Common.WorkloadType + validWorkloadTypes)]
5464
[ValidateNotNullOrEmpty]
5565
public WorkloadType? WorkloadType { get; set; }
5666

5767
/// <summary>
5868
/// Backup management type of the policy to be fetched
5969
/// </summary>
6070
[Parameter(ParameterSetName = WorkloadBackupMangementTypeParamSet, Position = 3,
61-
Mandatory = true, HelpMessage = ParamHelpMsgs.Common.BackupManagementType)]
71+
Mandatory = true, HelpMessage = ParamHelpMsgs.Common.BackupManagementType + validBackupManagementTypes)]
6272
[ValidateNotNullOrEmpty]
6373
public BackupManagementType? BackupManagementType { get; set; }
6474

‎src/RecoveryServices/RecoveryServices.Backup/Cmdlets/ProtectionPolicy/GetAzureRmRecoveryServicesBackupRetentionPolicyObject.cs

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,19 +27,29 @@ namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets
2727
[Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "RecoveryServicesBackupRetentionPolicyObject"),OutputType(typeof(RetentionPolicyBase))]
2828
public class GetAzureRmRecoveryServicesBackupRetentionPolicyObject : RecoveryServicesBackupCmdletBase
2929
{
30+
/// <summary>
31+
/// List of supported BackupManagementTypes for this cmdlet. Used in help text creation.
32+
/// </summary>
33+
private const string validBackupManagementTypes = "AzureVM, AzureWorkload, AzureStorage";
34+
35+
/// <summary>
36+
/// List of supported WorkloadTypes for this cmdlet. Used in help text creation.
37+
/// </summary>
38+
private const string validWorkloadTypes = "AzureVM, AzureFiles, MSSQL";
39+
3040
/// <summary>
3141
/// Workload type of the policy to be created.
3242
/// </summary>
3343
[Parameter(Mandatory = true, Position = 0,
34-
HelpMessage = ParamHelpMsgs.Common.WorkloadType)]
44+
HelpMessage = ParamHelpMsgs.Common.WorkloadType + validWorkloadTypes)]
3545
[ValidateNotNullOrEmpty]
3646
public WorkloadType WorkloadType { get; set; }
3747

3848
/// <summary>
3949
/// Backup management type of the policy to be created.
4050
/// </summary>
4151
[Parameter(Mandatory = false, Position = 1,
42-
HelpMessage = ParamHelpMsgs.Common.BackupManagementType)]
52+
HelpMessage = ParamHelpMsgs.Common.BackupManagementType + validBackupManagementTypes)]
4353
[ValidateNotNullOrEmpty]
4454
public BackupManagementType? BackupManagementType { get; set; }
4555

‎src/RecoveryServices/RecoveryServices.Backup/Cmdlets/ProtectionPolicy/GetAzureRmRecoveryServicesBackupSchedulePolicyObject.cs

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,19 +27,29 @@ namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets
2727
[Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "RecoveryServicesBackupSchedulePolicyObject"),OutputType(typeof(SchedulePolicyBase))]
2828
public class GetAzureRmRecoveryServicesBackupSchedulePolicyObject : RecoveryServicesBackupCmdletBase
2929
{
30+
/// <summary>
31+
/// List of supported BackupManagementTypes for this cmdlet. Used in help text creation.
32+
/// </summary>
33+
private const string validBackupManagementTypes = "AzureVM, AzureWorkload, AzureStorage";
34+
35+
/// <summary>
36+
/// List of supported WorkloadTypes for this cmdlet. Used in help text creation.
37+
/// </summary>
38+
private const string validWorkloadTypes = "AzureVM, MSSQL, AzureFiles";
39+
3040
/// <summary>
3141
/// Workload type of the policy to be created.
3242
/// </summary>
3343
[Parameter(Mandatory = true, Position = 0,
34-
HelpMessage = ParamHelpMsgs.Common.WorkloadType)]
44+
HelpMessage = ParamHelpMsgs.Common.WorkloadType + validWorkloadTypes)]
3545
[ValidateNotNullOrEmpty]
3646
public WorkloadType WorkloadType { get; set; }
3747

3848
/// <summary>
3949
/// Backup management type of the policy to be created.
4050
/// </summary>
4151
[Parameter(Mandatory = false, Position = 1,
42-
HelpMessage = ParamHelpMsgs.Common.BackupManagementType)]
52+
HelpMessage = ParamHelpMsgs.Common.BackupManagementType + validBackupManagementTypes)]
4353
[ValidateNotNullOrEmpty]
4454
public BackupManagementType? BackupManagementType { get; set; }
4555

0 commit comments

Comments
 (0)