Teams - Update

  • リファレンス
Service:
Core
API Version:
7.1-preview.3

チームの名前や説明を更新します。

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

URI パラメーター

名前 / 必須 型 説明
organization
 path True

string

Azure DevOps 組織の名前です。
projectId
 path True

string

更新するチームを含むチーム プロジェクトの名前または ID (GUID)。
teamId
 path True

string

更新するチームの ID の名前。
api-version
 query True

string

使う API のバージョン。 このバージョンの API を使用するには、これを '7.1-preview.3' に設定する必要があります。

要求本文

名前 型 説明
description

string

チームの説明
id

string

チーム (ID) Guid。 Team Foundation ID。
identity

Identity

チーム ID。
identityUrl

string

このチームの ID REST API URL
name

string

チーム名
projectId

string

projectName

string

url

string

Team REST API Url

応答

名前 型 説明
200 OK

WebApiTeam

成功した操作

セキュリティ

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

名前 説明
vso.project_write プロジェクトとチームの読み取りと更新を行う機能を付与します。

例

Sample Request

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

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

Sample Response

Status code:
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

ID 記述子は、ID の種類 (Windows SID、Passport) のラッパーであり、SID や PUID などの一意の識別子です。
PropertiesCollection

クラスは、キーと値のペアのコレクションとしてプロパティ バッグを表します。 を除くすべてのプリミティブ型 (を持つ任意の TypeCode != TypeCode.Object型) の DBNull 値が受け入れられます。 Byte[]、Int32、Double、DateType、String 型の値は、その型を保持し、他のプリミティブは String として再調整されます。 Byte[] は base64 でエンコードされた文字列として必要です。
WebApiTeam

Identity

名前 型 説明
customDisplayName

string

ID のカスタム表示名 (存在する場合)。 このプロパティを空の文字列に設定すると、既存のカスタム表示名がクリアされます。 このプロパティを null に設定しても、既存の永続化された値には影響しません (null 値はネットワーク経由またはデータベースに送信されないため)
descriptor

IdentityDescriptor

ID 記述子は、ID の種類 (Windows SID、Passport) のラッパーであり、SID や PUID などの一意の識別子です。
id

string

ID 識別子。 ストレージ キー (VSID) とも呼ばれます
isActive

boolean

id がorganization内の任意の Azure Devops グループのメンバーシップを持っている場合は True。
isContainer

boolean

True を指定すると、ID がグループになります。
masterId

string

memberIds

string[]

ID のメンバーの ID (グループのみ)。
memberOf

IdentityDescriptor[]

ID 記述子は、ID の種類 (Windows SID、Passport) のラッパーであり、SID や PUID などの一意の識別子です。
members

IdentityDescriptor[]

ID 記述子は、ID の種類 (Windows SID、Passport) のラッパーであり、SID や PUID などの一意の識別子です。
metaTypeId

integer

properties

PropertiesCollection

クラスは、キーと値のペアのコレクションとしてプロパティ バッグを表します。 を除くすべてのプリミティブ型 (を持つ任意の TypeCode != TypeCode.Object型) の DBNull 値が受け入れられます。 Byte[]、Int32、Double、DateType、String 型の値は、その型を保持し、他のプリミティブは String として再調整されます。 Byte[] は base64 でエンコードされた文字列として必要です。
providerDisplayName

string

ソース ID プロバイダーによって指定された ID の表示名。
resourceVersion

integer

socialDescriptor

string

subjectDescriptor

string

Graph エンティティのサブジェクト記述子。
uniqueUserId

integer

IdentityDescriptor

ID 記述子は、ID の種類 (Windows SID、Passport) のラッパーであり、SID や PUID などの一意の識別子です。

名前 型 説明
identifier

string

この ID の一意識別子 。256 文字を超えず、永続化されます。
identityType

string

記述子の種類 (Windows、Passport など)。

PropertiesCollection

クラスは、キーと値のペアのコレクションとしてプロパティ バッグを表します。 を除くすべてのプリミティブ型 (を持つ任意の TypeCode != TypeCode.Object型) の DBNull 値が受け入れられます。 Byte[]、Int32、Double、DateType、String 型の値は、その型を保持し、他のプリミティブは String として再調整されます。 Byte[] は base64 でエンコードされた文字列として必要です。

名前 型 説明
count

integer

コレクション内のプロパティの数。
item

object

keys

string[]

コレクション内のキーのセット。
values

string[]

コレクション内の値のセット。

WebApiTeam

名前 型 説明
description

string

チームの説明
id

string

チーム (ID) Guid。 Team Foundation ID。
identity

Identity

チーム ID。
identityUrl

string

このチームの ID REST API URL
name

string

チーム名
projectId

string

projectName

string

url

string

Team REST API Url