az pipelines variable-group variable

Note

This reference is part of the azure-devops extension for the Azure CLI (version 2.30.0 or higher). The extension will automatically install the first time you run an az pipelines variable-group variable command. Learn more about extensions.

Manage variables in a variable group.

Commands

Name	Description	Type	Status
az pipelines variable-group variable create	Add a variable to a variable group.	Extension	GA
az pipelines variable-group variable delete	Delete a variable from variable group.	Extension	GA
az pipelines variable-group variable list	List the variables in a variable group.	Extension	GA
az pipelines variable-group variable update	Update a variable in a variable group.	Extension	GA

az pipelines variable-group variable create

Add a variable to a variable group.

az pipelines variable-group variable create --group-id
                                            --name
                                            [--detect {false, true}]
                                            [--org]
                                            [--project]
                                            [--secret {false, true}]
                                            [--value]

Required Parameters

--group-id --id

Id of the variable group.

--name

Name of the variable.

Optional Parameters

--detect

Automatically detect organization.

Accepted values: false, true

--org --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/.

--project -p

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.

--secret

If the value of the variable is a secret.

Accepted values: false, true

--value

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. PersonalAccessToken can be input using environment variable AZURE_DEVOPS_EXT_PIPELINE_VAR_PersonalAccessToken.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az pipelines variable-group variable delete

Delete a variable from variable group.

az pipelines variable-group variable delete --group-id
                                            --name
                                            [--detect {false, true}]
                                            [--org]
                                            [--project]
                                            [--yes]

Required Parameters

--group-id --id

Id of the variable group.

--name

Name of the variable.

Optional Parameters

--detect

Automatically detect organization.

Accepted values: false, true

--org --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/.

--project -p

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.

--yes -y

Do not prompt for confirmation.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az pipelines variable-group variable list

List the variables in a variable group.

az pipelines variable-group variable list --group-id
                                          [--detect {false, true}]
                                          [--org]
                                          [--project]

Required Parameters

--group-id --id

Id of the variable group.

Optional Parameters

--detect

Automatically detect organization.

Accepted values: false, true

--org --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/.

--project -p

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.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az pipelines variable-group variable update

Update a variable in a variable group.

az pipelines variable-group variable update --group-id
                                            --name
                                            [--detect {false, true}]
                                            [--new-name]
                                            [--org]
                                            [--project]
                                            [--prompt-value {false, true}]
                                            [--secret {false, true}]
                                            [--value]

Required Parameters

--group-id --id

Id of the variable group.

--name

Name of the variable.

Optional Parameters

--detect

Automatically detect organization.

Accepted values: false, true

--new-name

New name of the variable.

--org --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/.

--project -p

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.

--prompt-value

Set it to True to update the value of a secret variable using environment variable or prompt via standard input.

Accepted values: false, true

Default value: False

--secret

If the value of the variable is a secret.

Accepted values: false, true

--value

New 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. PersonalAccessToken can be input using environment variable AZURE_DEVOPS_EXT_PIPELINE_VAR_PersonalAccessToken.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.