About This Page
This page is part of the Azure documentation. It contains code examples and configuration instructions for working with Azure services.
Bias Analysis
Bias Types:
⚠️
powershell_heavy
⚠️
windows_first
⚠️
missing_linux_example
⚠️
windows_tools
Summary:
The documentation page demonstrates a strong Windows and PowerShell bias. All command-line examples use Windows PowerShell cmdlets, and there are no equivalent examples for Linux users (e.g., using Azure CLI, Bash, or cross-platform PowerShell Core). The term 'Windows PowerShell' is used explicitly, and the documentation does not mention or provide guidance for Linux-native tools or workflows. The structure and ordering of the content also present Windows/PowerShell methods before platform-neutral or Linux-friendly alternatives.
Recommendations:
- Add equivalent Azure CLI examples for starting and managing runbooks, including parameter passing and job status retrieval.
- Clarify that PowerShell Core (pwsh), which is cross-platform, can also be used, and provide examples where appropriate.
- Avoid using 'Windows PowerShell' exclusively; refer to 'PowerShell' and specify when examples are compatible with both Windows and Linux.
- Include a section or table row for Linux/macOS users, highlighting supported tools and methods (e.g., Azure CLI, REST API, PowerShell Core).
- Ensure that all parameter handling examples are shown in both PowerShell and Azure CLI syntax.
- Review terminology and ordering to avoid presenting Windows-specific tools and workflows before cross-platform or Linux-native options.
Create pull request
Flagged Code Snippets
Workflow Test-Parameters
{
param (
[Parameter(Mandatory=$true)][PSCredential]$credential
)
$credential.UserName
}
Workflow Test-Parameters
{
param (
[Parameter(Mandatory=$true)][object]$user
)
$userObject = $user | ConvertFrom-JSON
if ($userObject.Show) {
foreach ($i in 1..$userObject.RepeatCount) {
$userObject.FirstName
$userObject.LastName
}
}
}
Workflow Test-Parameters
{
param (
[Parameter(Mandatory=$true)][array]$user
)
if ($user[3]) {
foreach ($i in 1..$user[2]) {
$ user[0]
$ user[1]
}
}
}
If the runbook requires parameters, then you must provide them as a [hashtable](/powershell/module/microsoft.powershell.core/about/about_hash_tables). The key of the hashtable must match the parameter name and the value is the parameter value. The following example shows how to start a runbook with two string parameters named FirstName and LastName, an integer named RepeatCount, and a boolean parameter named Show. For more information on parameters, see [Runbook Parameters](#work-with-runbook-parameters).