Start Runbooks - Document Details

About This Page

This page is part of the Azure documentation. It contains code examples and configuration instructions for working with Azure services.

View on GitHub 📚 View on Microsoft Learn

Bias Analysis

Detected 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

Scan History

Date	Scan	Status	Result
2026-01-14 00:00	#250	in_progress	Biased
2026-01-13 00:00	#246	completed	Biased
2026-01-12 00:00	#243	cancelled	Biased
2026-01-11 00:00	#240	completed	Biased
2026-01-10 00:00	#237	completed	Biased
2026-01-09 00:34	#234	completed	Biased
2026-01-08 00:53	#231	completed	Clean
2026-01-06 18:15	#225	cancelled	Clean
2025-08-17 00:01	#83	cancelled	Clean
2025-07-13 21:37	#48	completed	Biased
2025-07-09 13:09	#3	cancelled	Clean
2025-07-08 04:23	#2	cancelled	Biased

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).