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

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 command. Learn more about extensions.

Manage variable groups.

Commands

Name Description Type Status
az pipelines variable-group create

Create a variable group.

 Extension GA
az pipelines variable-group delete

Delete a variable group.

 Extension GA
az pipelines variable-group list

List variable groups.

 Extension GA
az pipelines variable-group show

Show variable group details.

 Extension GA
az pipelines variable-group update

Update a variable group.

 Extension GA
az pipelines variable-group variable

Manage variables in a variable group.

 Extension GA
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 create

Create a variable group.

az pipelines variable-group create --name
 --variables
 [--acquire-policy-token]
 [--authorize {false, true}]
 [--change-reference]
 [--description]
 [--detect {false, true}]
 [--org --organization]
 [--project]

Required Parameters

--name

Name of the variable group.

--variables

Variables in format key=value space separated pairs. Secret variables should be managed using az pipelines variable-group variable commands.

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
--authorize

Whether the variable group should be accessible by all pipelines.

Property Value
Accepted values: false, true
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--description

Description of the variable group.

--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 delete

Delete a variable group.

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

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.

--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 list

List variable groups.

az pipelines variable-group list [--action --action-filter {manage, none, use}]
 [--continuation-token]
 [--detect {false, true}]
 [--group-name]
 [--org --organization]
 [--project]
 [--query-order {Asc, Desc}]
 [--top]

Optional Parameters

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

--action --action-filter

Action filter for the variable group. It specifies the action which can be performed on the variable groups.

Property Value
Accepted values: manage, none, use
--continuation-token

Gets the variable groups after the continuation token provided.

--detect

Automatically detect organization.

Property Value
Accepted values: false, true
--group-name

Name of the variable group. Wildcards are accepted. e.g. var_group*.

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

--query-order

Gets the results in the defined order.

Property Value
Default value: Desc
Accepted values: Asc, Desc
--top

Number of variable groups to get.

az pipelines variable-group show

Show variable group details.

az pipelines variable-group show --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 update

Update a variable group.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--authorize

Whether the variable group should be accessible by all pipelines.

Property Value
Accepted values: false, true
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--description

New description of the variable group.

--detect

Automatically detect organization.

Property Value
Accepted values: false, true
--name

New name of the variable group.

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

Feedback

Was this page helpful?