az config set -h | in-line help showing Bash-only example with no indication of environment

[dbradish-microsoft]

Describe the bug

The command az config set -h instructions our customers to use az find "az config set" to search our AI knowledge base for examples. However, this syntax example doesn't run in PowerShell, only Bash.

With quotes in PowerShell -->

Without quotes in PowerShell -->

With quotes in Bash -->

Request to engineering

Please change the instructions to To search AI knowledge base for examples, in Bash run: az find "az config set"

Although we would like to assume in all our conceptual docs and reference examples that customers are running Bash, they simply are not. We are addressing this in our conceptual content by having environment-specific code block tags. (Even if 95% of them will say Azure CLI with Bash we have gained clarity for our 25% of Azure CLI with PowerShell code blocks). In-line help does not have this distinction capability, so we need to specify an environment when we provide in-line command examples.

Related command

az config set

Errors

The command example fails in PowerShell with double quotes, single quotes and no quotes.

Issue script & Debug output

.

Expected behavior

The equivalent Bash output.

Environment Summary

{
"azure-cli": "2.66.0",
"azure-cli-core": "2.66.0",
"azure-cli-telemetry": "1.1.0",
"extensions": {
"alias": "0.5.2"
}
}

Additional context

No response

[azure-client-tools-bot-prd]

Hi @dbradish-microsoft,

2.66.0 is not the latest Azure CLI(2.68.0).

If you haven't already attempted to do so, please upgrade to the latest Azure CLI version by following https://learn.microsoft.com/en-us/cli/azure/update-azure-cli.

[yonzhan]

Thank you for opening this issue, we will look into it.