Skip to content

Commit 26156e3

Browse files
authored
Merge pull request #6187 from Azure/maddieclayton-patch-2
Update azure-powershell-design-guidelines.md for AsJob
2 parents c187a4b + 93fab11 commit 26156e3

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

documentation/development-docs/azure-powershell-design-guidelines.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,6 +269,8 @@ $job | Wait-Job
269269
$subcriptions = $job | Receive-Job
270270
````
271271

272+
To set a custom job name, please use [SetBackgroupJobDescription(string name)](https://github.com/Azure/azure-powershell/blob/preview/src/Common/Commands.Common/AzurePSCmdlet.cs#L761). The default job description is: "Long Running Operation for '{cmdlet name}' on resource '{resource name}'"
273+
272274
## Argument Completers
273275

274276
PowerShell uses Argument Completers to provide tab completion for users. At the moment, Azure PowerShell has two specific argument completers that should be applied to relevant parameters, and one generic argument completer that can be used to tab complete with a given list of values.
@@ -307,4 +309,4 @@ using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
307309
[Parameter(Mandatory = false, HelpMessage = "The tiers of the plan")]
308310
[PSArgumentCompleter("Basic", "Premium", "Elite")]
309311
public string Tier { get; set; }
310-
```
312+
```

0 commit comments

Comments
 (0)