-
Notifications
You must be signed in to change notification settings - Fork 194
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document existing environment variables #4321
base: main
Are you sure you want to change the base?
Conversation
For tools that are auto-acquired by `azd`, you are able to configure the following environment variables to use a different version of the tool installed on the machine: | ||
|
||
- `AZD_BICEP_TOOL_PATH`: The Bicep tool override path. The direct path to `bicep` or `bicep.exe`. | ||
- `AZD_GH_CLI_TOOL_PATH`: The `gh` tool override path. The direct path to `gh` or `gh.exe`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we standardize on AZD_<tool invocation name>_TOOL_PATH
? GH_CLI
is the outlier currently.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that makes sense - will make this easier for us to programmatically generalize in the future.
related: #589 |
Azure Dev CLI Install InstructionsInstall scriptsMacOS/Linux
bash:
pwsh:
WindowsPowerShell install
MSI install
Standalone Binary
MSI
Documentationlearn.microsoft.com documentationtitle: Azure Developer CLI reference
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added things that came to mind.
Thank you for starting this
@@ -13,6 +13,10 @@ The strategy to ask `azd` to `toggle` between modes is: | |||
- Disable _all_ experimental features: `azd config unset alpha.all` or `azd config set alpha.all off` | |||
- Disable _specific_ experimental feature: `azd config unset alpha.featureName` or `azd config set alpha.featureName off` | |||
|
|||
In CI, the on/off mode can be configured using environment variables with the following scheme: | |||
|
|||
- `AZD_ALPHA_ENABLE_<name>`: where `<name>` is the name of the feature, with dot `.` characters replaced by underscore `_` characters. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we mention if casing matter?
@@ -0,0 +1,19 @@ | |||
# Environment Variables | |||
|
|||
Environment variables that can be used to configure `azd` behavior. For environment variables that accept a boolean, the values `1, t, T, TRUE, true, True` are accepted as "true"; the values: `0, f, F, FALSE, false, False` are all accepted as "false". |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we mention if users can set these variables per azd-environment or not?
@@ -0,0 +1,19 @@ | |||
# Environment Variables |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
with expandableString, some of the fields from azure.yaml supports references to system env vars. Should we add a section about it and if it requires a prefix or anything? @wbreza
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any expandable string could reference system, shell or azd env vars. Are you thinking of something specific that we should be calling out?
- `AZD_IN_CLOUDSHELL`: If true, `azd` runs with cloud-shell specific behavior. | ||
- `AZD_SKIP_UPDATE_CHECK`: If true, skips the out-of-date update check output that is typically printed at the end of the command. | ||
|
||
For tools that are auto-acquired by `azd`, you are able to configure the following environment variables to use a different version of the tool installed on the machine: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we want to add a section for Aspire? We would mention how to use the ENV VARS for debugging (setting manifest path, for example). And how parameters are automatically mapped to values like AZURE_<PARAM_NAME>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another convention we have is for mapping ENV VARS to bicep input parameters. Like AZURE_PRINCIPAL_ID. Do we want a section for that?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It should be a separate doc, it's captured publicly in here. I can rename this to cli-environment-variables
Document existing environment variables in a markdown file.
Contributes to #4320