Teams - Update

服务:

Core

API 版本:

7.1

更新团队的名称和/或说明。

PATCH https://dev.azure.com/{organization}/_apis/projects/{projectId}/teams/{teamId}?api-version=7.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
projectId	path	True	string	包含要更新的团队项目的名称或 ID（GUID）。
teamId	path	True	string	要更新的团队的 ID 的名称。
api-version	query	True	string	要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。

请求正文

名称	类型	说明
description	string	团队说明
id	string (uuid)	团队 （标识） Guid。 Team Foundation ID。
identity	Identity	团队标识。
identityUrl	string	此团队的标识 REST API URL
name	string	团队名称
projectId	string (uuid)
projectName	string
url	string	团队 REST API URL

响应

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

安全性

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.project_write	授予读取和更新项目和团队的能力。

示例

示例请求

HTTP

PATCH https://dev.azure.com/fabrikam/_apis/projects/8e5a3cfb-fed3-46f3-8657-e3b175cd0305/teams/{teamId}?api-version=7.1

{
  "name": "My new team",
  "description": "Description of my team"
}

示例响应

状态代码:

200

{
  "id": "8e8aa4ff-848a-474a-9033-93190137c8e4",
  "name": "My New Team",
  "url": "https://dev.azure.com/fabrikam/_apis/projects/8e5a3cfb-fed3-46f3-8657-e3b175cd0305/teams/8e8aa4ff-848a-474a-9033-93190137c8e4",
  "description": "Description of my team",
  "identityUrl": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8e8aa4ff-848a-474a-9033-93190137c8e4"
}

定义

名称	说明
Identity
IdentityDescriptor	标识描述符是标识类型的包装器（Windows SID、Passport），以及唯一标识符，例如 SID 或 PUID。
PropertiesCollection	类将属性包表示为键值对的集合。 接受除 DBNull 以外的所有基元类型（具有 TypeCode != TypeCode.Object的任何类型）的值。 Byte[]、Int32、Double、DateType 和 String 类型的值将保留其类型，其他基元将重新调整为 String。 Byte[] 应为 base64 编码字符串。
WebApiTeam

Identity

Object

名称	类型	说明
customDisplayName	string	标识的自定义显示名称（如果有）。 将此属性设置为空字符串将清除现有的自定义显示名称。 将此属性设置为 null 不会影响现有的持久化值（因为 null 值不会通过线路或数据库发送）
descriptor	IdentityDescriptor	标识描述符是标识类型的包装器（Windows SID、Passport），以及唯一标识符，例如 SID 或 PUID。
id	string (uuid)	标识标识符。 也称为存储密钥或 VSID
isActive	boolean	如此 如果标识具有组织中任何 Azure Devops 组的成员身份。
isContainer	boolean	如此 如果标识是组。
masterId	string (uuid)
memberIds	string[] (uuid)	标识成员的 ID（仅限组）。
memberOf	IdentityDescriptor[]	标识描述符是标识类型的包装器（Windows SID、Passport），以及唯一标识符，例如 SID 或 PUID。
members	IdentityDescriptor[]	标识描述符是标识类型的包装器（Windows SID、Passport），以及唯一标识符，例如 SID 或 PUID。
metaTypeId	integer (int32)
properties	PropertiesCollection	类将属性包表示为键值对的集合。 接受除 DBNull 以外的所有基元类型（具有 TypeCode != TypeCode.Object的任何类型）的值。 Byte[]、Int32、Double、DateType 和 String 类型的值将保留其类型，其他基元将重新调整为 String。 Byte[] 应为 base64 编码字符串。
providerDisplayName	string	由源标识提供者指定的标识的显示名称。
resourceVersion	integer (int32)
socialDescriptor	string
subjectDescriptor	string	Graph 实体的主题描述符。
uniqueUserId	integer (int32)

IdentityDescriptor

Object

标识描述符是标识类型的包装器（Windows SID、Passport），以及唯一标识符，例如 SID 或 PUID。

名称	类型	说明
identifier	string	此标识的唯一标识符，不超过 256 个字符，这将持久保存。
identityType	string	描述符的类型（例如 Windows、Passport 等）。

PropertiesCollection

Object

类将属性包表示为键值对的集合。 接受除 DBNull 以外的所有基元类型（具有 TypeCode != TypeCode.Object的任何类型）的值。 Byte[]、Int32、Double、DateType 和 String 类型的值将保留其类型，其他基元将重新调整为 String。 Byte[] 应为 base64 编码字符串。

名称	类型	说明
count	integer (int32)	集合中的属性计数。
item	object
keys	string[]	集合中的键集。
values	string[]	集合中的值集。

WebApiTeam

Object

名称	类型	说明
description	string	团队说明
id	string (uuid)	团队 （标识） Guid。 Team Foundation ID。
identity	Identity	团队标识。
identityUrl	string	此团队的标识 REST API URL
name	string	团队名称
projectId	string (uuid)
projectName	string
url	string	团队 REST API URL