az pipelines variable
Manage pipeline variables.
Commands
az pipelines variable create |
Add a variable to a pipeline. |
az pipelines variable delete |
Delete a variable from pipeline. |
az pipelines variable list |
List the variables in a pipeline. |
az pipelines variable update |
Update a variable in a pipeline. |
az pipelines variable create
Add a variable to a pipeline.
az pipelines variable create --name
[--allow-override {false, true}]
[--detect {false, true}]
[--org]
[--pipeline-id]
[--pipeline-name]
[--project]
[--secret {false, true}]
[--subscription]
[--value]
Required Parameters
Name of the variable.
Optional Parameters
Indicates whether the value can be set at queue time.
Automatically detect organization.
Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.
Id of the pipeline.
Name of the pipeline. Ignored if --pipeline-id parameter is supplied.
Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.
Indicates whether the variable's value is a secret.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Value of the variable. For secret variables, if --value parameter is not given, it will be picked from environment variable prefixed with AZURE_DEVOPS_EXT_PIPELINE_VAR_ or user will be prompted to enter it via standard input. e.g. A variable named MySecret
can be input using environment variable AZURE_DEVOPS_EXT_PIPELINE_VAR_MySecret.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az pipelines variable delete
Delete a variable from pipeline.
az pipelines variable delete --name
[--detect {false, true}]
[--org]
[--pipeline-id]
[--pipeline-name]
[--project]
[--subscription]
[--yes]
Required Parameters
Name of the variable to delete.
Optional Parameters
Automatically detect organization.
Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.
Id of the pipeline.
Name of the pipeline.
Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az pipelines variable list
List the variables in a pipeline.
az pipelines variable list [--detect {false, true}]
[--org]
[--pipeline-id]
[--pipeline-name]
[--project]
[--query-examples]
[--subscription]
Optional Parameters
Automatically detect organization.
Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.
Id of the pipeline.
Name of the pipeline. Ignored if --pipeline-id parameter is supplied.
Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.
Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az pipelines variable update
Update a variable in a pipeline.
az pipelines variable update --name
[--allow-override {false, true}]
[--detect {false, true}]
[--new-name]
[--org]
[--pipeline-id]
[--pipeline-name]
[--project]
[--prompt-value {false, true}]
[--secret {false, true}]
[--subscription]
[--value]
Required Parameters
Name of the variable.
Optional Parameters
Indicates whether the value can be set at queue time.
Automatically detect organization.
New name of the variable.
Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.
Id of the pipeline.
Name of the pipeline. Ignored if --pipeline-id parameter is supplied.
Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.
Set it to True to update the value of a secret variable using environment variable or prompt via standard input.
If the value of the variable is a secret.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
New value of the variable. For secret variables, use --prompt-value parameter, to be prompted to enter it via standard input. For non-interactive consoles it can be picked from environment variable prefixed with AZURE_DEVOPS_EXT_PIPELINE_VAR_ e.g. A variable nameed MySecret
can be input using environment variable AZURE_DEVOPS_EXT_PIPELINE_VAR_MySecret.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.