Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

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 --id
 --name
 [--acquire-policy-token]
 [--change-reference]
 [--detect {false, true}]
 [--org --organization]
 [--project]
 [--secret {false, true}]
 [--value]

Required Parameters

--group-id --id

Id of the variable group.

--name

Name of the variable.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--detect

Automatically detect organization.

Property Value
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.

Property Value
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.

az pipelines variable-group variable delete

Delete a variable from variable group.

az pipelines variable-group variable delete --group-id --id
 --name
 [--acquire-policy-token]
 [--change-reference]
 [--detect {false, true}]
 [--org --organization]
 [--project]
 [--yes]

Required Parameters

--group-id --id

Id of the variable group.

--name

Name of the variable.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--detect

Automatically detect organization.

Property Value
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.

Property Value
Default value: False

az pipelines variable-group variable list

List the variables in a variable group.

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

Required Parameters

--group-id --id

Id of the variable group.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--detect

Automatically detect organization.

Property Value
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.

az pipelines variable-group variable update

Update a variable in a variable group.

az pipelines variable-group variable update --group-id --id
 --name
 [--acquire-policy-token]
 [--change-reference]
 [--detect {false, true}]
 [--new-name]
 [--org --organization]
 [--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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--detect

Automatically detect organization.

Property Value
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.

Property Value
Default value: False
Accepted values: false, true
--secret

If the value of the variable is a secret.

Property Value
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.

Feedback

Was this page helpful?