Skip to content

Commit 8f5306b

Browse files
author
dragonfly91
committed
Scrubbing help text
1 parent fabe186 commit 8f5306b

File tree

2 files changed

+120
-75
lines changed

2 files changed

+120
-75
lines changed

src/ResourceManager/AzureBackup/Commands.AzureBackup/AzureBackupCmdletHelpMessage.cs

Lines changed: 119 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -16,84 +16,129 @@ namespace Microsoft.Azure.Commands.AzureBackup.Cmdlets
1616
{
1717
internal static class AzureBackupCmdletHelpMessage
1818
{
19-
public const string Vault = "The vault details";
20-
public const string ResourceGroupName = "The ResourceGroup name.";
21-
public const string ResourceName = "The Resource name.";
22-
public const string Location = "The resource location.";
23-
public const string TargetLocation = "The directory where the credentials file will be saved. This must be an absolute path.";
24-
public const string StorageType = "The vault back-end storage type.";
25-
public const string ManagedResourceName = "The resource name of the resource being managed by the Azure Backup service (ex: resource name of the VM).";
26-
public const string ManagedResourceGroupName = "The resource group name of the resource being managed by the Azure Backup service (ex: resource group name of the VM).";
27-
public const string ContainerRegistrationStatus = "The container registration status.";
28-
public const string ContainerType = "The container type.";
29-
public const string AzureBackupContainer = "Azure Backup Container for Azure Backup Item.";
30-
31-
public const string PolicyName = "The protection policy name.";
19+
/* Unidentified strings - not scrubbed */
3220
public const string ResourceTags = "A hash table which represents resource tags.";
33-
public const string ContainerId = "The container ID.";
34-
35-
public const string JobFilterJobIdHelpMessage = "The job ID to filter jobs";
36-
public const string JobFilterJobHelpMessage = "The job for filtering";
37-
public const string JobFilterStartTimeHelpMessage = "The start time of query range";
38-
public const string JobFilterEndTimeHelpMessage = "The end time of query range";
39-
public const string JobFilterOperationHelpMessage = "The operation for filtering jos";
40-
public const string JobFilterStatusHelpMessage = "The status for filtering jobs";
41-
public const string JobFitlerVaultHelpMessage = "The vault of which jobs have to be filtered";
42-
public const string JobFilterTypeHelpMessage = "The type of workload whose jobs have to be filtered";
43-
44-
public const string JobDetailsFilterJobIdHelpMessage = "The job ID to get details";
45-
public const string JobDetailsFilterVaultHelpMessage = "The vault of which job details should be fetched";
46-
public const string JobDetailsFilterJobHelpMessage = "The job whose full details should be fetched";
47-
48-
public const string StopJobFilterJobIdHelpMessage = "The job ID to stop job";
49-
public const string StopJobFilterVaultHelpMessage = "The vault of which a job has to be stopped";
50-
public const string StopJobFilterJobHelpMessage = "The job which should be stopped";
51-
52-
public const string WaitJobFilterJobIdHelpMessage = "The job ID to stop job";
53-
public const string WaitJobFilterVaultHelpMessage = "The vault of which a job has to be stopped";
54-
public const string WaitJobFilterJobHelpMessage = "The job which should be stopped";
55-
public const string WaitJobFilterTimeoutHelpMessage = "Maximum number of seconds for which cmdlet should wait before job(s) complete running.";
56-
21+
public const string ContainerId = "A unique identifier for the Azure Backup container object.";
5722
public const string VirtualMachine = "Virtual Machine.";
23+
public const string BackupType = "Type of backup.";
24+
public const string RetentionType = "Unit of retention for the recovery point.";
25+
public const string RententionDuration = "Specifies how long a recovery point will be retained, for a given RetentionType.";
26+
27+
/* Get-AzureRMBackupVault */
28+
public const string ResourceGroupName = "The ResourceGroup in which the Azure resource is placed.";
29+
public const string ResourceName = "The name of the Azure resource.";
30+
31+
/* New-AzureRMBackupVault */
32+
//public const string ResourceGroupName
33+
//public const string ResourceName
34+
public const string Location = "The Azure region where the Backup vault is located.";
35+
public const string StorageType = "The storage redundancy for the backup data stored in the vault. The currently supported storage redundancy options are Locally Redundant Storage (LRS) and Geo-Redundant Storage (GRS).";
36+
37+
/* Set-AzureRMBackupVault */
38+
//public const string Vault
39+
//public const string StorageType
40+
41+
/* Get-AzureRMBackupVaultCredentials */
42+
//public const string Vault
43+
public const string TargetLocation = "The directory where the vault credentials file will be saved. This must be specified as an absolute path.";
44+
45+
/* Get-AzureRMBackupContainer */
46+
public const string ManagedResourceName = "The name of the resource being managed by the Azure Backup service (for example: resource name of the VM).";
47+
public const string ManagedResourceGroupName = "The ResourceGroup of the resource being managed by the Azure Backup service (for example: ResourceGroup name of the VM).";
48+
public const string ContainerRegistrationStatus = "The registration status of the Azure Backup container.";
49+
public const string ContainerType = "The type of the Azure Backup container. This can be a Windows Server, an Azure IaaS VM, or a Data Protection Manager server.";
50+
//public const string Vault
51+
52+
/* Get-AzureRMBackupItem */
53+
public const string AzureBackupContainer = "The Azure Backup container object which is the parent resource for the Azure Backup Item. The container can be a Windows Server, an Azure IaaS VM, or a Data Protection Manager server.";
5854
public const string ProtectionStatus = "Protection Status of the azure backup item.";
59-
public const string AzureBackUpItem = "Azure BackUp Item.";
60-
public const string RecoveryPointId = "Recovery Point Id.";
61-
public const string StorageAccountName = "Storage Account Name.";
62-
public const string AzureBackUpRecoveryPoint = "Recovery Point.";
63-
public const string Type = "Type of Azure Backup Item.";
6455
public const string Status = "Status of Azure Backup Item";
65-
public const string AzureBackupItem = "Azure Backup Item for enabling protection";
66-
public const string RemoveProtectionOption = "Remove Protection Option";
67-
public const string Reason = "Reson for removing protection";
68-
public const string Comments = "Comments for for removing protection";
69-
public const string WorkloadType = "Workload type for which the policy is defined.";
70-
public const string BackupType = "Type of backup.";
71-
public const string DailyScheduleType = "Switch parameter for daily backup schedule.";
72-
public const string WeeklyScheduleType = "Switch parameter for weekly backup schedule.";
73-
public const string ScheduleRunDays = "Days of week for running backup, required for weekly schedule.";
56+
public const string Type = "Type of Azure Backup Item.";
57+
58+
/* Enable-AzureRMBackupProtection */
59+
public const string AzureBackupItemEnable = "The Azure Backup item that is being enabled for protection.";
60+
public const string PolicyObject = "The Protection Policy object that contains all the scheduling information for backup and retention. This policy will be associated with the backup item provided as input.";
61+
62+
/* Enable-AzureRMBackupContainerReregistration */
63+
public const string AzureBackupContainerToReregister = "The Azure Backup container to be unregistered. For this commandlet, the container cannot be of type AzureVM. Use the Get-AzureRMBackupContainer to get a list of containers.";
64+
65+
/* Disable-AzureRMBackupProtection */
66+
public const string RemoveProtectionOption = "If this option is used, all the backup data for this item will also be deleted and restoring data will not be possible.";
67+
public const string AzureBackupItemDisable = "Azure Backup item for which the protection is being disabled.";
68+
public const string Reason = "User-specified reason for removing protection.";
69+
public const string Comments = "User-specified comments provided at the time of removing protection.";
70+
71+
/* Get-AzureRMBackupJob */
72+
public const string JobFilterJobIdHelpMessage = "The unique identifier is used as a filtering criterion. It provides details to fetch the latest information about a job.";
73+
public const string JobFilterJobHelpMessage = "The job object is used as a filtering criterion. It provides details to fetch the latest information about a job.";
74+
public const string JobFilterStartTimeHelpMessage = "For the time range that is used as a filtering critetion, this parameter provides the starting boundary.";
75+
public const string JobFilterEndTimeHelpMessage = "For the time range that is used as a filtering critetion, this parameter provides the ending boundary.";
76+
public const string JobFilterOperationHelpMessage = "The operation name of the job is used as a filtering criterion.";
77+
public const string JobFilterStatusHelpMessage = "The status of the job is used as a filtering criterion.";
78+
public const string JobFitlerVaultHelpMessage = "The Azure Backup vault which is the parent of the jobs being queried. This is needed only when the -Job parameter is not being used.";
79+
public const string JobFilterTypeHelpMessage = "The type of workload is used as a filtering criterion.";
80+
81+
/* Get-AzureRMBackupJobDetails */
82+
public const string JobDetailsFilterJobIdHelpMessage = "The unique identifier for the job whose full details are being requested";
83+
public const string JobDetailsFilterVaultHelpMessage = "The Azure Backup vault which is the parent resource of the job";
84+
public const string JobDetailsFilterJobHelpMessage = "The object that represents the job whose full details are being requested";
85+
86+
/* Stop-AzureRMBackupJob */
87+
public const string StopJobFilterJobIdHelpMessage = "The unique identifier for the job that needs to be stopped";
88+
public const string StopJobFilterVaultHelpMessage = "The Azure Backup vault which is the parent resource of the job";
89+
public const string StopJobFilterJobHelpMessage = "The object that represents the job that needs be stopped";
90+
91+
/* Wait-AzureRMBackupJob */
92+
public const string WaitJobFilterJobIdHelpMessage = "The unique identifier for the job on which the commandlet will wait for completion";
93+
public const string WaitJobFilterVaultHelpMessage = "The Azure Backup vault which is the parent resource of the job";
94+
public const string WaitJobFilterJobHelpMessage = "The object that represents the job on which the commandlet will wait for completion";
95+
public const string WaitJobFilterTimeoutHelpMessage = "If the commandlet should not wait infinitely for the job to finish, then this timeout value needs to be specified. The parameter specifies the maximum number of seconds for which the commandlet should wait before returning.";
96+
97+
/* Register-AzureRMBackupContainer */
98+
public const string VMName = "The name of the Azure VM that will be registered with the service.";
99+
public const string ServiceName = "The Cloud Service name of Azure VM";
100+
public const string RGName = "The ResourceGroup name of Azure VM";
101+
public const string Vault = "The Azure Backup vault object which is the parent resource.";
102+
103+
/* Unregister-AzureRMBackupContainer */
104+
public const string AzureBackupContainerToUnregister = "The Azure Backup container to be unregistered. This can be a Windows Server, an Azure IaaS VM, or a Data Protection Manager server. Use the Get-AzureRMBackupContainer to get a list of containers.";
105+
106+
/* New-AzureRMBackupProtectionPolicy */
107+
public const string PolicyName = "The name of the Azure Backup protection policy. The name of the policy should be unique within a backup vault";
108+
public const string WorkloadType = "Workload type for which the protection policy is defined.";
109+
public const string DailyScheduleType = "Switch parameter to choose a daily backup schedule.";
110+
public const string WeeklyScheduleType = "Switch parameter to choose a weekly backup schedule.";
111+
public const string ScheduleRunDays = "Days of week on which the backup will be triggered. Required when specifying a weekly backup schedule.";
74112
public const string ScheduleRunTimes = "Times of day in UTC for running backup.";
75-
public const string RetentionType = "Unit of retention for the recovery point.";
76-
public const string RententionDuration = "Duration of retention for the recovery point in units specified by RetentionType.";
77-
public const string PolicyNewName = "Policy new name";
78-
public const string AzureBackupPolicy = "Azure Backup protection policy";
79-
public const string VMName = "Azure VM name to be register";
80-
public const string ServiceName = "Cloud service name of Azure VM to be register";
81-
public const string RGName = "Resource Group name of Azure VM to be register";
82-
public const string AzureBackupContainerToUnregister = "Azure Backup Container tobe unregister.";
83-
84-
public const string RetentionPolicyList = "List of Retention Policies to be associated with protection policy.";
85-
public const string DailyRetention = "Switch param for Daily Retention";
86-
public const string WeeklyRetention = "Switch param for Daily Retention";
87-
public const string MonthlyRetentionInDailyFormat = "Switch param for MonthlyRetentionInDailyFormat";
88-
public const string MonthlyRetentionInWeeklyFormat = "Switch param for MonthlyRetentionInWeeklyFormat";
89-
public const string YearlyRetentionInDailyFormat = "Switch param for YearlyRetentionInDailyFormat";
90-
public const string YearlyRetentionInWeeklyFormat = "Switch param for YearlyRetentionInWeeklyFormat";
91-
public const string DaysOfWeek = "List of Days of Week";
92-
public const string DaysOfMonth = "List of Days of Month";
93-
public const string WeekNumber = "List of Week Numbers of the month";
94-
public const string MonthsOfYear = "List of Months of the year";
95-
public const string Retention = "Retention duration value";
96-
97-
public const string PolicyObject = "Policy object for enabling protection";
113+
public const string RetentionPolicyList = "List of Retention Policies to be associated with protection policy. You can use a combination of Daily, Weekly, Monthly, and Yearly retention policies but not more than 1 of each.";
114+
public const string PolicyVault = "The Azure Backup vault which is the parent resource for the protection policy.";
115+
116+
/* Set-AzureRMBackupProtectionPolicy */
117+
public const string PolicyNewName = "The new name to be given to this policy. Note that the policy name is unique to a backup vault and you need to ensure that you pick a name that does not conflict with existing names.";
118+
public const string AzureBackupPolicy = "Azure Backup protection policy object that contains the complete policy information.";
119+
120+
/* New-AzureRMBackupRetentionPolicyObject */
121+
public const string DailyRetention = "Switch paramater to signal that this policy is being used for Daily Retention";
122+
public const string WeeklyRetention = "Switch parameter to signal that this policy is being used for Weekly Retention";
123+
public const string MonthlyRetentionInDailyFormat = "Allows the user to specify the Monthly retention policy based on specific days of the month";
124+
public const string MonthlyRetentionInWeeklyFormat = "Allows the user to specify the Monthly retention policy based on specific weeks of the month";
125+
public const string YearlyRetentionInDailyFormat = "Allows the user to specify the Yearly retention policy based on specific days of the year";
126+
public const string YearlyRetentionInWeeklyFormat = "Allows the user to specify the Yearly retention policy based on specific weeks of the year";
127+
public const string DaysOfWeek = "Specifies the days of the week that will be used in the policy";
128+
public const string DaysOfMonth = "Specifies the days of the month that will be used in the policy";
129+
public const string WeekNumber = "Specifies the week number of the month that will be used in the policy";
130+
public const string MonthsOfYear = "Specifies the months of the year that will be used in the policy";
131+
public const string Retention = "Specifies the duration of the retention policy";
132+
133+
/* Backup-AzureRMBackupItem */
134+
public const string AzureBackupItem = "The Azure Backup item that is being configured for backup.";
135+
136+
/* Get-AzureRMBackupRecoveryPoint */
137+
public const string AzureBackupItemGet = "The Azure Backup item for which the recovery points are being fetched.";
138+
public const string RecoveryPointId = "The unique identifier for the recovery point that is being fetched.";
139+
140+
/* Restore-AzureRMBackupItem */
141+
public const string AzureBackUpRecoveryPoint = "The PowerShell object that refers to the recovery point. Use Get-AzureRMBackupRecoveryPoint to get the PowerShell object to be used as input to this commandlet.";
142+
public const string StorageAccountName = "The destination storage account where the restored disks and config information will be stored.";
98143
}
99144
}

src/ResourceManager/AzureBackup/Commands.AzureBackup/AzureBackupDSCmdletBase.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ namespace Microsoft.Azure.Commands.AzureBackup.Cmdlets
2929
{
3030
public abstract class AzureRMBackupDSCmdletBase : AzureBackupCmdletBase
3131
{
32-
[Parameter(Position = 0, Mandatory = true, HelpMessage = AzureBackupCmdletHelpMessage.AzureBackUpItem, ValueFromPipeline = true)]
32+
[Parameter(Position = 0, Mandatory = true, HelpMessage = AzureBackupCmdletHelpMessage.AzureBackupItem, ValueFromPipeline = true)]
3333
[ValidateNotNullOrEmpty]
3434
public AzureRMBackupItem Item { get; set; }
3535

0 commit comments

Comments
 (0)