Document Details

Enable Api Analysis Linting
Home / Scan #47 / Enable Api Analysis Linting
Sad Tux - Windows bias detected
This page contains Windows bias

About This Page

This page is part of the Azure documentation. It contains code examples and configuration instructions for working with Azure services.
GitHub View on GitHub 📚 View on Microsoft Learn

Bias Analysis

Detected Bias Types
windows_first
powershell_heavy
Summary
The documentation generally provides both Bash and PowerShell syntax for Azure CLI commands, but PowerShell examples are consistently presented immediately after Bash, and sometimes with explicit 'PowerShell syntax' labels. There are no Linux-specific tools or workflows mentioned, but the documentation does state that Azure CLI commands can be run in either PowerShell or Bash. No examples are exclusive to Windows or PowerShell, but the repeated explicit inclusion of PowerShell syntax and the order of presentation (Bash first, then PowerShell) may suggest a slight Windows-first or PowerShell-heavy bias.
Recommendations
  • Ensure that all command examples are provided for both Bash and PowerShell, as currently done.
  • Consider alternating the order of Bash and PowerShell examples, or presenting them in parallel tabs, to avoid implying a default preference.
  • Explicitly mention Linux and macOS compatibility in the prerequisites and command sections, not just Bash.
  • Include screenshots or references to Linux/macOS environments where appropriate, not only Azure Portal (which is OS-agnostic but often associated with Windows workflows).
  • If any troubleshooting or environment setup steps differ for Linux/macOS, provide those details alongside Windows instructions.
GitHub Create Pull Request

Scan History

Date Scan Status Result
2026-02-19 00:00 #398 in_progress Clean Clean
2026-02-18 00:00 #394 in_progress Clean Clean
2026-02-17 00:00 #390 in_progress Clean Clean
2026-02-16 00:00 #386 in_progress Biased Biased
2026-02-15 00:00 #382 in_progress Biased Biased
2026-02-14 00:00 #378 in_progress Biased Biased
2026-02-13 00:00 #374 in_progress Clean Clean
2026-02-12 00:00 #370 in_progress Clean Clean
2026-02-11 00:00 #366 in_progress Clean Clean
2026-02-10 00:00 #362 completed Biased Biased
2026-02-09 00:00 #358 completed Biased Biased
2026-02-08 00:00 #354 completed Biased Biased
2026-02-05 00:00 #342 completed Clean Clean
2026-02-04 00:00 #338 completed Clean Clean
2026-02-03 00:00 #334 completed Clean Clean
2026-02-02 00:00 #330 completed Clean Clean
2026-02-01 00:00 #326 completed Clean Clean
2026-01-31 00:00 #322 completed Clean Clean
2026-01-30 00:00 #318 completed Biased Biased
2026-01-14 00:00 #250 in_progress Biased Biased
2026-01-13 00:00 #246 completed Biased Biased
2026-01-12 00:00 #243 cancelled Biased Biased
2026-01-11 00:00 #240 completed Biased Biased
2026-01-10 00:00 #237 completed Biased Biased
2026-01-09 00:34 #234 completed Biased Biased
2026-01-08 00:53 #231 completed Clean Clean
2026-01-08 00:00 #228 cancelled Clean Clean
2026-01-06 18:15 #225 cancelled Clean Clean
2025-09-16 00:00 #113 completed Biased Biased
2025-09-12 00:00 #109 completed Biased Biased
2025-08-12 00:00 #78 cancelled Biased Biased
2025-07-13 21:25 #47 cancelled Biased Biased
2025-07-13 21:17 #46 cancelled Clean Clean
2025-07-13 20:48 #44 cancelled Clean Clean
2025-07-13 20:32 #43 cancelled Biased Biased
2025-07-09 13:09 #3 cancelled Clean Clean
2025-07-08 04:23 #2 cancelled Biased Biased

Flagged Code Snippets

---

### Step 3. Configure event subscription in your API center

Now create an event subscription in your API center to trigger the function app when an API definition file is uploaded or updated. The following steps show how to create the event subscription using the Azure portal or the Azure CLI.


#### [Portal](#tab/portal)

1. In the [Azure portal](https://portal.azure.com), navigate to your API center and select **Events**.
1. On the **Get started** tab, select **Azure Function**.
1. On the **Create Event Subscription** page, do the following:
    1. Enter a descriptive **Name** for the event subscription, and select **Event Grid Schema**.
    1. In **Topic details**, enter a **System topic name** of your choice.
    1. In **Event Types**, select the following events:
        * **API definition added**
        * **API definition updated**
    1. In **Endpoint Details**, select **Azure Function > Configure an endpoint**.
    1. On the **Select Azure Function** page, select the function app and the *apicenter-linter* function that you configured. Click **Confirm selection**.
    1. Select **Create**.

         :::image type="content" source="media/enable-api-analysis-linting/create-event-subscription.png" alt-text="Screenshot of creating the event subscription in the portal.":::
1. Select the **Event subscriptions** tab and select **Refresh**. Confirm that the **Provisioning state** of the event subscription is **Succeeded**.

    :::image type="content" source="media/enable-api-analysis-linting/event-subscription-provisioning-state.png" alt-text="Screenshot of the state of the event subscription in the portal.":::


#### [Azure CLI](#tab/cli)

1. Get the resource ID of your API center. Substitute `<apic-name>` and `<resource-group-name>` with your API center name and resource group name.