Share via


Teams - Update

Aktualisieren sie den Namen und/oder die Beschreibung eines Teams.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
organization
path True

string

Der Name der Azure DevOps-Organisation.

projectId
path True

string

Der Name oder die ID (GUID) des Teamprojekts, das das zu aktualisierende Team enthält.

teamId
path True

string

Der Name der ID des zu aktualisierenden Teams.

api-version
query True

string

Version der zu verwendenden API. Dies sollte auf "7.1-preview.3" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name Typ Beschreibung
description

string

Teambeschreibung

id

string

Team (Identitäts-)GUID. Eine Team Foundation-ID.

identity

Identity

Teamidentität.

identityUrl

string

Identitäts-REST-API-URL an dieses Team

name

string

Teamname

projectId

string

projectName

string

url

string

Team-REST-API-URL

Antworten

Name Typ Beschreibung
200 OK

WebApiTeam

Erfolgreicher Vorgang

Sicherheit

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 Beschreibung
vso.project_write Gewährt die Möglichkeit, Projekte und Teams zu lesen und zu aktualisieren.

Beispiele

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

{
  "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"
}

Definitionen

Name Beschreibung
Identity
IdentityDescriptor

Ein Identitätsdeskriptor ist ein Wrapper für den Identitätstyp (Windows-SID, Passport) zusammen mit einem eindeutigen Bezeichner wie sid oder PUID.

PropertiesCollection

Die -Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüssel-Wert-Paaren dar. Werte aller primitiven Typen (jeder Typ mit einem TypeCode != TypeCode.Object) außer für DBNull werden akzeptiert. Werte des Typs Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als String umgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.

WebApiTeam

Identity

Name Typ Beschreibung
customDisplayName

string

Der benutzerdefinierte Anzeigename für die Identität (falls vorhanden). Wenn Sie diese Eigenschaft auf eine leere Zeichenfolge festlegen, wird der vorhandene benutzerdefinierte Anzeigename gelöscht. Das Festlegen dieser Eigenschaft auf NULL wirkt sich nicht auf den vorhandenen persistenten Wert aus (da NULL-Werte nicht über die Verbindung oder an die Datenbank gesendet werden).

descriptor

IdentityDescriptor

Ein Identitätsdeskriptor ist ein Wrapper für den Identitätstyp (Windows-SID, Passport) zusammen mit einem eindeutigen Bezeichner wie sid oder PUID.

id

string

Identitäts-ID. Auch als Speicherschlüssel oder VSID bezeichnet

isActive

boolean

True, wenn die Identität in einer Beliebigen Azure Devops-Gruppe im organization.

isContainer

boolean

True, wenn die Identität eine Gruppe ist.

masterId

string

memberIds

string[]

ID der Mitglieder der Identität (nur Gruppen).

memberOf

IdentityDescriptor[]

Ein Identitätsdeskriptor ist ein Wrapper für den Identitätstyp (Windows-SID, Passport) zusammen mit einem eindeutigen Bezeichner wie sid oder PUID.

members

IdentityDescriptor[]

Ein Identitätsdeskriptor ist ein Wrapper für den Identitätstyp (Windows-SID, Passport) zusammen mit einem eindeutigen Bezeichner wie sid oder PUID.

metaTypeId

integer

properties

PropertiesCollection

Die -Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüssel-Wert-Paaren dar. Werte aller primitiven Typen (jeder Typ mit einem TypeCode != TypeCode.Object) außer für DBNull werden akzeptiert. Werte des Typs Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als String umgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.

providerDisplayName

string

Der Anzeigename für die Identität, wie vom Quellidentitätsanbieter angegeben.

resourceVersion

integer

socialDescriptor

string

subjectDescriptor

string

Betreffdeskriptor einer Graph-Entität.

uniqueUserId

integer

IdentityDescriptor

Ein Identitätsdeskriptor ist ein Wrapper für den Identitätstyp (Windows-SID, Passport) zusammen mit einem eindeutigen Bezeichner wie sid oder PUID.

Name Typ Beschreibung
identifier

string

Der eindeutige Bezeichner für diese Identität mit maximal 256 Zeichen, der beibehalten wird.

identityType

string

Typ des Deskriptors (z. B. Windows, Passport usw.).

PropertiesCollection

Die -Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüssel-Wert-Paaren dar. Werte aller primitiven Typen (jeder Typ mit einem TypeCode != TypeCode.Object) außer für DBNull werden akzeptiert. Werte des Typs Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als String umgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.

Name Typ Beschreibung
count

integer

Die Anzahl der Eigenschaften in der Auflistung.

item

object

keys

string[]

Der Satz von Schlüsseln in der Auflistung.

values

string[]

Der Satz von Werten in der Auflistung.

WebApiTeam

Name Typ Beschreibung
description

string

Teambeschreibung

id

string

Team (Identitäts-)GUID. Eine Team Foundation-ID.

identity

Identity

Teamidentität.

identityUrl

string

Identitäts-REST-API-URL an dieses Team

name

string

Teamname

projectId

string

projectName

string

url

string

Team-REST-API-URL