Skip to content

Commit 8fe9488

Browse files
authored
Merge pull request #96 from microsoft/automated-documentation-update-20966189146
Automated documentation update
2 parents f3d7fb7 + 2180e2e commit 8fe9488

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

src/artifacts-helper/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Configures Codespace to authenticate with Azure Artifact feeds
2424
| npxAlias | Create alias for npx | boolean | true |
2525
| rushAlias | Create alias for rush | boolean | true |
2626
| pnpmAlias | Create alias for pnpm | boolean | true |
27+
| azAlias | Create alias for az (Azure CLI) | boolean | true |
2728
| 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 |
2829
| 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 |
2930
| python | Install Python keyring helper for pip | boolean | false |
@@ -35,8 +36,12 @@ Configures Codespace to authenticate with Azure Artifact feeds
3536
- `ms-codespaces-tools.ado-codespaces-auth`
3637

3738
This installs [Azure Artifacts Credential Provider](https://github.com/microsoft/artifacts-credprovider)
38-
and optionally configures shims which shadow `dotnet`, `nuget`, `npm`, `yarn`, `rush`, and `pnpm`.
39-
These dynamically sets an authentication token for pulling artifacts from a feed before running the command.
39+
and optionally configures shims which shadow `dotnet`, `nuget`, `npm`, `yarn`, `rush`, `pnpm`, and `az`.
40+
These dynamically set an authentication token for pulling artifacts from a feed before running the command.
41+
42+
The `az` shim specifically intercepts `az account get-access-token` requests and uses the `azure-auth-helper`
43+
to acquire tokens via the ado-codespaces-auth VS Code extension. This enables `DefaultAzureCredential`'s
44+
`AzureCliCredential` to work in Codespaces without requiring `az login`.
4045

4146
For `npm`, `yarn`, `rush`, and `pnpm` this requires that your `~/.npmrc` file is configured to use the ${ARTIFACTS_ACCESSTOKEN}
4247
environment variable for the `authToken`. A helper script has been added that you can use to write your `~/.npmrc`

0 commit comments

Comments
 (0)