Automation Dsc Diagnostics - 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

Summary

The documentation page demonstrates a strong Windows and PowerShell bias. All command-line examples are provided exclusively in PowerShell, with no mention of Bash, Azure CLI, or Linux-native tooling. The prerequisites and setup steps assume the use of the Az PowerShell module, and there is no guidance for users on Linux or macOS platforms. The documentation does not acknowledge or provide alternatives for non-Windows environments, despite Azure Automation State Configuration supporting Linux nodes in the past.

Recommendations

Provide equivalent Azure CLI examples for all PowerShell commands, as Azure CLI is cross-platform and commonly used on Linux and macOS.
Explicitly state platform compatibility for each step and tool, and mention any limitations or deprecations for Linux support.
Include a section or callout for Linux/macOS users, outlining any differences in setup or usage.
Reference Bash or shell scripting alternatives where applicable, especially for authentication and resource management.
Clarify the current and future support status for Linux nodes in Azure Automation State Configuration, given the included retirement announcement.

Create Pull Request

Scan History

Date	Scan	Status	Result
2025-07-12 23:44	#41	cancelled	Biased
2025-07-12 00:58	#8	cancelled	Clean
2025-07-10 05:06	#7	processing	Clean
2025-07-09 23:22	#6	cancelled	Clean

Flagged Code Snippets

   # Sign in to your Azure subscription
   $sub = Get-AzSubscription -ErrorAction SilentlyContinue
   if (-not($sub)) {
       Connect-AzAccount
   }
   # If you have multiple subscriptions, set the one to use
   # Select-AzSubscription -SubscriptionId "<SUBSCRIPTIONID>"

   $setAzDiagnosticSettingSplat = @{
       ResourceId = $AutomationResourceId
       WorkspaceId = $WorkspaceResourceId
       Enabled = $true
       Category = 'DscNodeStatus'
   }
   Set-AzDiagnosticSetting @setAzDiagnosticSettingSplat

   $automationAccount = "automationAccount"
   $law = "workspaceName"

   # Find the ResourceId for the Automation account
   $AutomationResourceId = (Get-AzResource -ResourceType 'Microsoft.Automation/automationAccounts' |
      Where-Object {$_.Name -eq $automationAccount}).ResourceId

    # Find the ResourceId for the Log Analytics workspace
    $WorkspaceResourceId = (Get-AzResource `
        -ResourceType 'Microsoft.OperationalInsights/workspaces' |
        WHERE {$_.Name -eq $law}).ResourceId

   $setAzDiagnosticSettingSplat = @{
       ResourceId = $AutomationResourceId
       WorkspaceId = $WorkspaceResourceId
       Enabled = $false
       Category = 'DscNodeStatus'
   }
   Set-AzDiagnosticSetting @setAzDiagnosticSettingSplat

AzureDiagnostics
| where Category == "DscNodeStatus"
| where OperationName contains "DSCNodeStatusData"
| where ResultType != "Compliant"