Add az CLI shim for DefaultAzureCredential support in Codespaces

Author: ansemb

src/artifacts-helper/NOTES.md

@@ -1,6 +1,10 @@
 This installs [Azure Artifacts Credential Provider](https://github.com/microsoft/artifacts-credprovider)
-and optionally configures shims which shadow `dotnet`, `nuget`, `npm`, `yarn`, `rush`, and `pnpm`.
-These dynamically sets an authentication token for pulling artifacts from a feed before running the command.
+and optionally configures shims which shadow `dotnet`, `nuget`, `npm`, `yarn`, `rush`, `pnpm`, and `az`.
+These dynamically set an authentication token for pulling artifacts from a feed before running the command.
+
+The `az` shim specifically intercepts `az account get-access-token` requests and uses the `azure-auth-helper`
+to acquire tokens via the ado-codespaces-auth VS Code extension. This enables `DefaultAzureCredential`'s
+`AzureCliCredential` to work in Codespaces without requiring `az login`.
 
 For `npm`, `yarn`, `rush`, and `pnpm` this requires that your `~/.npmrc` file is configured to use the ${ARTIFACTS_ACCESSTOKEN}
 environment variable for the `authToken`. A helper script has been added that you can use to write your `~/.npmrc`

src/artifacts-helper/README.md

@@ -24,6 +24,7 @@ Configures Codespace to authenticate with Azure Artifact feeds
 | npxAlias | Create alias for npx | boolean | true |
 | rushAlias | Create alias for rush | boolean | true |
 | pnpmAlias | Create alias for pnpm | boolean | true |
+| azAlias | Create alias for az (Azure CLI) | boolean | true |
 | shimDirectory | Directory where the shims will be installed. This must be in $PATH, and needs to be as early as possible in priority for the scripts to override the base executables. | string | /usr/local/share/codespace-shims |
 | targetFiles | Comma separated list of files to write to. Default is '/etc/bash.bashrc,/etc/zsh/zshrc' for root and '~/.bashrc,~/.zshrc' for non-root | string | DEFAULT |
 | python | Install Python keyring helper for pip | boolean | false |
@@ -35,8 +36,12 @@ Configures Codespace to authenticate with Azure Artifact feeds
 - `ms-codespaces-tools.ado-codespaces-auth`
 
 This installs [Azure Artifacts Credential Provider](https://github.com/microsoft/artifacts-credprovider)
-and optionally configures shims which shadow `dotnet`, `nuget`, `npm`, `yarn`, `rush`, and `pnpm`.
-These dynamically sets an authentication token for pulling artifacts from a feed before running the command.
+and optionally configures shims which shadow `dotnet`, `nuget`, `npm`, `yarn`, `rush`, `pnpm`, and `az`.
+These dynamically set an authentication token for pulling artifacts from a feed before running the command.
+
+The `az` shim specifically intercepts `az account get-access-token` requests and uses the `azure-auth-helper`
+to acquire tokens via the ado-codespaces-auth VS Code extension. This enables `DefaultAzureCredential`'s
+`AzureCliCredential` to work in Codespaces without requiring `az login`.
 
 For `npm`, `yarn`, `rush`, and `pnpm` this requires that your `~/.npmrc` file is configured to use the ${ARTIFACTS_ACCESSTOKEN}
 environment variable for the `authToken`. A helper script has been added that you can use to write your `~/.npmrc`

src/artifacts-helper/devcontainer-feature.json

@@ -49,6 +49,11 @@
             "default": true,
             "description": "Create alias for pnpm"
         },
+        "azAlias": {
+            "type": "boolean",
+            "default": true,
+            "description": "Create alias for az (Azure CLI)"
+        },
         "shimDirectory": {
             "type": "string",
             "default": "/usr/local/share/codespace-shims",

src/artifacts-helper/install.sh

@@ -11,6 +11,7 @@ ALIAS_YARN="${YARNALIAS:-"true"}"
 ALIAS_NPX="${NPXALIAS:-"true"}"
 ALIAS_RUSH="${RUSHALIAS:-"true"}"
 ALIAS_PNPM="${PNPMALIAS:-"true"}"
+ALIAS_AZ="${AZALIAS:-"true"}"
 INSTALL_PIP_HELPER="${PYTHON:-"false"}"
 SHIM_DIRECTORY="${SHIMDIRECTORY:-"/usr/local/share/codespace-shims/"}"
 
@@ -39,6 +40,9 @@ if [ "${ALIAS_PNPM}" = "true" ]; then
     ALIASES_ARR+=('pnpm')
     ALIASES_ARR+=('pnpx')
 fi
+if [ "${ALIAS_AZ}" = "true" ]; then
+    ALIASES_ARR+=('az')
+fi
 
 # Source /etc/os-release to get OS info
 . /etc/os-release