Variablegroups - Get Variable Groups

Reference

Service:: Task Agent

API Version:: 6.0-preview.2

Get variable groups.

GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/variablegroups?api-version=6.0-preview.2

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/variablegroups?groupName={groupName}&actionFilter={actionFilter}&$top={$top}&continuationToken={continuationToken}&queryOrder={queryOrder}&api-version=6.0-preview.2

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
project	path	True	string	Project ID or project name
api-version	query	True	string	Version of the API to use. This should be set to '6.0-preview.2' to use this version of the api.
$top	query		integer int32	Number of variable groups to get.
actionFilter	query		VariableGroupActionFilter	Action filter for the variable group. It specifies the action which can be performed on the variable groups.
continuationToken	query		integer int32	Gets the variable groups after the continuation token provided.
groupName	query		string	Name of variable group.
queryOrder	query		VariableGroupQueryOrder	Gets the results in the defined order. Default is 'IdDescending'.

Responses

Name	Type	Description
200 OK	VariableGroup[]	successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name	Description
vso.variablegroups_read	Grants the ability to read variable groups

Examples

Get variable groups using action filter

Get variable groups using group name filter

Get variable groups using action filter

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/DGDemo/_apis/distributedtask/variablegroups?actionFilter=Use&$top=2&continuationToken=2&queryOrder=IdAscending&api-version=6.0-preview.2

Sample Response

Status code:: 200

{
  "count": 2,
  "value": [
    {
      "variables": {
        "key1": {
          "value": "value1"
        }
      },
      "id": 2,
      "type": "Vsts",
      "name": "TestVariableGroup2",
      "description": "A test variable group",
      "createdBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "createdOn": "2017-12-12T06:35:52.08Z",
      "modifiedBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "modifiedOn": "2017-12-12T06:35:52.08Z"
    },
    {
      "variables": {
        "key1": {
          "value": "value1"
        }
      },
      "id": 3,
      "type": "Vsts",
      "name": "TestVariableGroup3",
      "description": "A test variable group",
      "createdBy": {
        "id": "9acfc89e-2530-636e-8f2f-1940a029363b",
        "displayName": "msft 3",
        "uniqueName": "msft3@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/9acfc89e-2530-636e-8f2f-1940a029363b",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=9acfc89e-2530-636e-8f2f-1940a029363b"
      },
      "createdOn": "2017-12-12T06:35:52.24Z",
      "modifiedBy": {
        "id": "9acfc89e-2530-636e-8f2f-1940a029363b",
        "displayName": "msft 3",
        "uniqueName": "msft3@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/9acfc89e-2530-636e-8f2f-1940a029363b",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=9acfc89e-2530-636e-8f2f-1940a029363b"
      },
      "modifiedOn": "2017-12-12T06:35:52.24Z"
    }
  ]
}

Get variable groups using group name filter

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/DGDemo/_apis/distributedtask/variablegroups?groupName=Test*&queryOrder=IdDescending&api-version=6.0-preview.2

Sample Response

Status code:: 200

{
  "count": 2,
  "value": [
    {
      "variables": {
        "key1": {
          "value": "value1"
        }
      },
      "id": 2,
      "type": "Vsts",
      "name": "TestVariableGroup2",
      "description": "A test variable group",
      "createdBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "createdOn": "2017-12-12T06:35:52.08Z",
      "modifiedBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "modifiedOn": "2017-12-12T06:35:52.08Z"
    },
    {
      "variables": {
        "key1": {
          "value": "value1"
        },
        "key2": {
          "value": null,
          "isSecret": true
        }
      },
      "id": 1,
      "type": "Vsts",
      "name": "TestVariableGroup1",
      "description": "Updated variable group",
      "createdBy": {
        "id": "9acfc89e-2530-636e-8f2f-1940a029363b",
        "displayName": "msft 3",
        "uniqueName": "msft3@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/9acfc89e-2530-636e-8f2f-1940a029363b",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=9acfc89e-2530-636e-8f2f-1940a029363b"
      },
      "createdOn": "2017-12-12T06:35:51.6933333Z",
      "modifiedBy": {
        "id": "9acfc89e-2530-636e-8f2f-1940a029363b",
        "displayName": "msft 3",
        "uniqueName": "msft3@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/9acfc89e-2530-636e-8f2f-1940a029363b",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=9acfc89e-2530-636e-8f2f-1940a029363b"
      },
      "modifiedOn": "2017-12-12T06:35:52.0166667Z"
    }
  ]
}

Definitions

Name	Description
IdentityRef
ProjectReference
ReferenceLinks	The class to represent a collection of REST reference links.
VariableGroup	A variable group is a collection of related variables.
VariableGroupActionFilter	Action filter for the variable group. It specifies the action which can be performed on the variable groups.
VariableGroupProjectReference	A variable group reference is a shallow reference to variable group.
VariableGroupProviderData	Defines provider data of the variable group.
VariableGroupQueryOrder	Gets the results in the defined order. Default is 'IdDescending'.
VariableValue

IdentityRef

Name	Type	Description
_links	ReferenceLinks	This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.
descriptor	string	The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.
directoryAlias	string	Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary
displayName	string	This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.
id	string
imageUrl	string	Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary
inactive	boolean	Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary
isAadIdentity	boolean	Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Deprecated - not in use in most preexisting implementations of ToIdentityRef
uniqueName	string	Deprecated - use Domain+PrincipalName instead
url	string	This url is the full route to the source resource of this graph subject.

ProjectReference

Name	Type	Description
id	string
name	string

ReferenceLinks

The class to represent a collection of REST reference links.

Name	Type	Description
links	object	The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.

VariableGroup

A variable group is a collection of related variables.

Name	Type	Description
createdBy	IdentityRef	Gets or sets the identity who created the variable group.
createdOn	string	Gets or sets the time when variable group was created.
description	string	Gets or sets description of the variable group.
id	integer	Gets or sets id of the variable group.
isShared	boolean	Indicates whether variable group is shared with other projects or not.
modifiedBy	IdentityRef	Gets or sets the identity who modified the variable group.
modifiedOn	string	Gets or sets the time when variable group was modified
name	string	Gets or sets name of the variable group.
providerData	VariableGroupProviderData	Gets or sets provider data.
type	string	Gets or sets type of the variable group.
variableGroupProjectReferences	VariableGroupProjectReference[]	all project references where the variable group is shared with other projects.
variables	<string, VariableValue>	Gets or sets variables contained in the variable group.

VariableGroupActionFilter

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

Name	Type	Description
manage	string
none	string
use	string

VariableGroupProjectReference

A variable group reference is a shallow reference to variable group.

Name	Type	Description
description	string	Gets or sets description of the variable group.
name	string	Gets or sets name of the variable group.
projectReference	ProjectReference	Gets or sets project reference of the variable group.

VariableGroupProviderData

Defines provider data of the variable group.

VariableGroupQueryOrder

Gets the results in the defined order. Default is 'IdDescending'.

Name	Type	Description
idAscending	string	Order by id ascending.
idDescending	string	Order by id descending.

VariableValue

Name	Type	Description
isReadOnly	boolean
isSecret	boolean
value	string

Variablegroups - Get Variable Groups

URI Parameters

Responses

Security

oauth2

Scopes

Examples

Get variable groups using action filter

Sample Request

Sample Response

Get variable groups using group name filter

Sample Request

Sample Response

Definitions

IdentityRef

ProjectReference

ReferenceLinks

VariableGroup

VariableGroupActionFilter

VariableGroupProjectReference

VariableGroupProviderData

VariableGroupQueryOrder

VariableValue

Additional resources