Skip to content

Commit 5099f15

Browse files
{AzureMaintenance} fixes #19193 PreTask and PostTask detailed description and a minor code bug (#20539)
* {AzureMaintenance} fixes #19193 PreTask and PostTask detailed description fixes #19193 This PR provides a detailed description for PreTask and PostTask parameters. * Update MaintenanceConfigurationCreateOrUpdateMethod.cs * Update MaintenanceConfigurationCreateOrUpdateMethod.cs My suggestion makes compilation failure. Revert the change Co-authored-by: Dingmeng Xue <[email protected]>
1 parent 8cbfb9d commit 5099f15

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

src/Maintenance/Maintenance/MaintenanceConfiguration/MaintenanceConfigurationCreateOrUpdateMethod.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -269,12 +269,12 @@ public override void ExecuteCmdlet()
269269

270270
[Parameter(
271271
Mandatory = false,
272-
HelpMessage = "List of tasks executed before schedule. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}]")]
272+
HelpMessage = "List of tasks executed before schedule. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}]. This parameter is used to specify a command or script that should be run before the maintenance tasks are performed. This can be used to perform any necessary preparations or cleanup actions before the maintenance tasks are run. This parameter accepts a string value that specifies the command or script to be run. The command or script can be specified as a simple string or as an array of strings. If an array of strings is specified, each element in the array will be treated as a separate command or script.")]
273273
public string PreTask { get; set; }
274274

275275
[Parameter(
276276
Mandatory = false,
277-
HelpMessage = "List of tasks executed after schedule. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}]")]
277+
HelpMessage = "List of tasks executed after schedule. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}]. This parameter is used to specify a command or script that should be run after the maintenance tasks are performed. This can be used to perform any necessary follow-up actions after the maintenance tasks are completed. This parameter accepts a string value that specifies the command or script to be run. The command or script can be specified as a simple string or as an array of strings. If an array of strings is specified, each element in the array will be treated as a separate command or script.")]
278278
public string PostTask { get; set; }
279279

280280
[Parameter(

src/Maintenance/Maintenance/help/New-AzMaintenanceConfiguration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ Accept wildcard characters: False
236236
```
237237
238238
### -PreTask
239-
List of tasks executed before schedule. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}]
239+
List of tasks executed before schedule. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}]. This parameter is used to specify a command or script that should be run before the maintenance tasks are performed. This can be used to perform any necessary preparations or cleanup actions before the maintenance tasks are run. This parameter accepts a string value that specifies the command or script to be run. The command or script can be specified as a simple string or as an array of strings. If an array of strings is specified, each element in the array will be treated as a separate command or script.
240240
241241
```yaml
242242
Type: string
@@ -251,7 +251,7 @@ Accept wildcard characters: False
251251
```
252252
253253
### -PostTask
254-
List of tasks executed after schedule. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}]
254+
List of tasks executed after schedule. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}]. This parameter is used to specify a command or script that should be run after the maintenance tasks are performed. This can be used to perform any necessary follow-up actions after the maintenance tasks are completed. This parameter accepts a string value that specifies the command or script to be run. The command or script can be specified as a simple string or as an array of strings. If an array of strings is specified, each element in the array will be treated as a separate command or script.
255255
256256
```yaml
257257
Type: string

0 commit comments

Comments
 (0)