Variablegroups - Add

服务:

Distributed Task

API 版本:

7.1

添加变量组。

POST https://dev.azure.com/{organization}/_apis/distributedtask/variablegroups?api-version=7.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
api-version	query	True	string	要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。

请求正文

名称	类型	说明
description	string	设置变量组的说明。
name	string	设置变量组的名称。
providerData	VariableGroupProviderData	设置提供程序数据。
type	string	设置变量组的类型。
variableGroupProjectReferences	VariableGroupProjectReference[]	变量组引用是对变量组的浅表引用。
variables	<string,  VariableValue>	设置变量组中包含的变量。

响应

名称	类型	说明
200 OK	VariableGroup	成功作

安全性

oauth2

类型: oauth2
流向: accessCode
授权 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
令牌 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

作用域

名称	说明
vso.variablegroups_manage	授予读取、创建和管理变量组的能力。

定义

名称	说明
IdentityRef
ProjectReference
ReferenceLinks	表示 REST 引用链接集合的类。
VariableGroup	变量组是相关变量的集合。
VariableGroupParameters
VariableGroupProjectReference	变量组引用是对变量组的浅表引用。
VariableGroupProviderData	定义变量组的提供程序数据。
VariableValue	泛型变量的包装类。

IdentityRef

Object

名称	类型	说明
_links	ReferenceLinks	此字段包含有关图形主题的零个或多个有趣的链接。 可以调用这些链接以获取有关此图形主题的其他关系或更详细的信息。
descriptor	string	描述符是在系统运行时引用图形主题的主要方法。 此字段将唯一标识帐户和组织中的同一图形主题。
directoryAlias	string	已弃用 - 可以通过查询 IdentityRef“_links”字典的“self”条目中引用的 Graph 用户来检索
displayName	string	这是图形主题的非唯一显示名称。 若要更改此字段，必须在源提供程序中更改其值。
id	string
imageUrl	string	已弃用 - 在 IdentityRef“_links”字典的“虚拟形象”条目中可用
inactive	boolean	已弃用 - 可以通过查询 GraphUser“_links”字典的“membershipState”条目中引用的 Graph 成员身份状态来检索
isAadIdentity	boolean	已弃用 - 可以从描述符的主题类型推断（Descriptor.IsAadUserType/Descriptor.IsAadGroupType）
isContainer	boolean	已弃用 - 可以从描述符的主题类型推断（描述符.IsGroupType）
isDeletedInOrigin	boolean
profileUrl	string	已弃用 - 不在 ToIdentityRef 的大多数预先存在的实现中使用
uniqueName	string	已弃用 - 请改用 Domain+PrincipalName
url	string	此 URL 是指向此图形主题的源资源的完整路由。

ProjectReference

Object

名称	类型	说明
id	string (uuid)
name	string

ReferenceLinks

Object

表示 REST 引用链接集合的类。

名称	类型	说明
links	object	链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读链接。

VariableGroup

Object

变量组是相关变量的集合。

名称	类型	说明
createdBy	IdentityRef	获取或设置创建变量组的标识。
createdOn	string (date-time)	获取或设置创建变量组的时间。
description	string	获取或设置变量组的说明。
id	integer (int32)	获取或设置变量组的 ID。
isShared	boolean	指示变量组是否与其他项目共享。
modifiedBy	IdentityRef	获取或设置修改变量组的标识。
modifiedOn	string (date-time)	获取或设置修改变量组的时间
name	string	获取或设置变量组的名称。
providerData	VariableGroupProviderData	获取或设置提供程序数据。
type	string	获取或设置变量组的类型。
variableGroupProjectReferences	VariableGroupProjectReference[]	变量组与其他项目共享的所有项目引用。
variables	<string,  VariableValue>	获取或设置变量组中包含的变量。

VariableGroupParameters

Object

名称	类型	说明
description	string	设置变量组的说明。
name	string	设置变量组的名称。
providerData	VariableGroupProviderData	设置提供程序数据。
type	string	设置变量组的类型。
variableGroupProjectReferences	VariableGroupProjectReference[]	变量组引用是对变量组的浅表引用。
variables	<string,  VariableValue>	设置变量组中包含的变量。

VariableGroupProjectReference

Object

变量组引用是对变量组的浅表引用。

名称	类型	说明
description	string	获取或设置变量组的说明。
name	string	获取或设置变量组的名称。
projectReference	ProjectReference	获取或设置变量组的项目引用。

VariableGroupProviderData

Object

定义变量组的提供程序数据。

VariableValue

Object

泛型变量的包装类。

名称	类型	说明
isReadOnly	boolean	指示是否可以在脚本的执行运行时期间更改变量。
isSecret	boolean	指示是否应静态加密变量。
value	string	变量的值。