CoreRestClient class
Basisklasse, die verwendet (von abgeleitet) werden soll, um Anforderungen an VSS-REST-APIs zu senden
- Extends
Konstruktoren
| Core |
Eigenschaften
| RESOURCE_AREA_ID |
Methoden
| create |
|
| create |
|
| create |
|
| create |
Erstellen Sie ein Team in einem Teamprojekt. |
| delete |
|
| delete |
|
| delete |
Löschen sie ein Team. |
| get |
Rufen Sie eine Liste aller Teams ab. |
| get |
|
| get |
|
| get |
|
| get |
Abrufen eines Prozesses nach ID. |
| get |
Rufen Sie eine Liste der Prozesse ab. |
| get |
Rufen Sie ein Projekt mit der angegebenen ID oder dem angegebenen Namen ab, optional einschließlich Funktionen. |
| get |
Rufen Sie die Projektsammlung mit der angegebenen ID oder dem angegebenen Namen ab. |
| get |
Rufen Sie Projektsammlungsverweise für diese Anwendung ab. |
| get |
Ruft den Verlauf der Änderungen am Projekt ab. |
| get |
Rufen Sie eine Auflistung von Teamprojekteigenschaften ab. |
| get |
Rufen Sie alle Projekte in der organization ab, auf die der authentifizierte Benutzer Zugriff hat. |
| get |
Rufen Sie eine Auflistung von Teamprojekteigenschaften für mehrere Projekte ab. |
| get |
Ruft eine Liste der benutzerlesbaren Teams in einem Projekt ab, und der Benutzer teams ist Mitglied von (aus der lesbaren Liste ausgeschlossen). |
| get |
|
| get |
Rufen Sie ein bestimmtes Team ab. |
| get |
Rufen Sie eine Liste der Mitglieder für ein bestimmtes Team ab. |
| get |
Rufen Sie eine Liste der Teams ab. |
| queue |
Stellt ein zu erstellende Projekt in die Warteschlange. Verwenden Sie getOperation, um in regelmäßigen Abständen nach projekt erstellen status zu suchen. |
| queue |
Stellt ein zu löschende Projekt in die Warteschlange. Verwenden Sie getOperation, um in regelmäßigen Abständen auf Löschprojekt status zu überprüfen. |
| remove |
Entfernt den Avatar für das Projekt. |
| set |
Legt den Avatar für das Projekt fest. |
| set |
Erstellen, Aktualisieren und Löschen von Teamprojekteigenschaften |
| update |
|
| update |
Aktualisieren Sie den Namen, die Abkürzung, die Beschreibung eines vorhandenen Projekts, oder stellen Sie ein Projekt wieder her. |
| update |
Aktualisieren sie den Namen und/oder die Beschreibung eines Teams. |
Details zum Konstruktor
CoreRestClient(IVssRestClientOptions)
Details zur Eigenschaft
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringEigenschaftswert
string
Details zur Methode
createConnectedService(WebApiConnectedServiceDetails, string)
function createConnectedService(connectedServiceCreationData: WebApiConnectedServiceDetails, projectId: string): Promise<WebApiConnectedService>Parameter
- connectedServiceCreationData
- WebApiConnectedServiceDetails
- projectId
-
string
Gibt zurück
Promise<WebApiConnectedService>
createIdentityMru(IdentityData, string)
function createIdentityMru(mruData: IdentityData, mruName: string): Promise<void>Parameter
- mruData
- IdentityData
- mruName
-
string
Gibt zurück
Promise<void>
createOrUpdateProxy(Proxy)
function createOrUpdateProxy(proxy: Proxy): Promise<Proxy>Parameter
- proxy
- Proxy
Gibt zurück
Promise<Proxy>
createTeam(WebApiTeam, string)
Erstellen Sie ein Team in einem Teamprojekt.
function createTeam(team: WebApiTeam, projectId: string): Promise<WebApiTeam>Parameter
- team
- WebApiTeam
Die Teamdaten, die zum Erstellen des Teams verwendet werden.
- projectId
-
string
Der Name oder die ID (GUID) des Teamprojekts, in dem das Team erstellt werden soll.
Gibt zurück
Promise<WebApiTeam>
deleteIdentityMru(IdentityData, string)
function deleteIdentityMru(mruData: IdentityData, mruName: string): Promise<void>Parameter
- mruData
- IdentityData
- mruName
-
string
Gibt zurück
Promise<void>
deleteProxy(string, string)
function deleteProxy(proxyUrl: string, site?: string): Promise<void>Parameter
- proxyUrl
-
string
- site
-
string
Gibt zurück
Promise<void>
deleteTeam(string, string)
Löschen sie ein Team.
function deleteTeam(projectId: string, teamId: string): Promise<void>Parameter
- projectId
-
string
Der Name oder die ID (GUID) des Teamprojekts, das das zu löschende Team enthält.
- teamId
-
string
Der Name oder die ID des zu löschenden Teams.
Gibt zurück
Promise<void>
getAllTeams(boolean, number, number, boolean)
Rufen Sie eine Liste aller Teams ab.
function getAllTeams(mine?: boolean, top?: number, skip?: number, expandIdentity?: boolean): Promise<WebApiTeam[]>Parameter
- mine
-
boolean
Wenn true, geben Sie alle Teams zurück, die Benutzer als Mitglied anfordern. Andernfalls wird zurückgegeben, dass alle Teams-Benutzer Lesezugriff haben.
- top
-
number
Maximale Anzahl von Teams, die zurückgegeben werden sollen.
- skip
-
number
Anzahl der zu überspringenden Teams.
- expandIdentity
-
boolean
Ein Wert, der angibt, ob Identitätsinformationen im WebApiTeam-Ergebnisobjekt erweitert werden sollen oder nicht.
Gibt zurück
Promise<WebApiTeam[]>
getConnectedServiceDetails(string, string)
function getConnectedServiceDetails(projectId: string, name: string): Promise<WebApiConnectedServiceDetails>Parameter
- projectId
-
string
- name
-
string
Gibt zurück
Promise<WebApiConnectedServiceDetails>
getConnectedServices(string, ConnectedServiceKind)
function getConnectedServices(projectId: string, kind?: ConnectedServiceKind): Promise<WebApiConnectedService[]>Parameter
- projectId
-
string
- kind
- ConnectedServiceKind
Gibt zurück
Promise<WebApiConnectedService[]>
getIdentityMru(string)
function getIdentityMru(mruName: string): Promise<IdentityRef[]>Parameter
- mruName
-
string
Gibt zurück
Promise<IdentityRef[]>
getProcessById(string)
Abrufen eines Prozesses nach ID.
function getProcessById(processId: string): Promise<Process>Parameter
- processId
-
string
ID für einen Prozess.
Gibt zurück
Promise<Process>
getProcesses()
Rufen Sie eine Liste der Prozesse ab.
function getProcesses(): Promise<Process[]>Gibt zurück
Promise<Process[]>
getProject(string, boolean, boolean)
Rufen Sie ein Projekt mit der angegebenen ID oder dem angegebenen Namen ab, optional einschließlich Funktionen.
function getProject(projectId: string, includeCapabilities?: boolean, includeHistory?: boolean): Promise<TeamProject>Parameter
- projectId
-
string
- includeCapabilities
-
boolean
Schließen Sie Funktionen (z. B. Quellcodeverwaltung) in das Teamprojektergebnis ein (Standard: false).
- includeHistory
-
boolean
Suchen Sie in umbenannten Projekten (die in der Vergangenheit einen solchen Namen hatten).
Gibt zurück
Promise<TeamProject>
getProjectCollection(string)
Rufen Sie die Projektsammlung mit der angegebenen ID oder dem angegebenen Namen ab.
function getProjectCollection(collectionId: string): Promise<TeamProjectCollection>Parameter
- collectionId
-
string
Gibt zurück
Promise<TeamProjectCollection>
getProjectCollections(number, number)
Rufen Sie Projektsammlungsverweise für diese Anwendung ab.
function getProjectCollections(top?: number, skip?: number): Promise<TeamProjectCollectionReference[]>Parameter
- top
-
number
- skip
-
number
Gibt zurück
Promise<TeamProjectCollectionReference[]>
getProjectHistoryEntries(number)
Ruft den Verlauf der Änderungen am Projekt ab.
function getProjectHistoryEntries(minRevision?: number): Promise<ProjectInfo[]>Parameter
- minRevision
-
number
Die mindeste Revisionsnummer, die im Verlauf zurückgegeben werden soll.
Gibt zurück
Promise<ProjectInfo[]>
getProjectProperties(string, string[])
Rufen Sie eine Auflistung von Teamprojekteigenschaften ab.
function getProjectProperties(projectId: string, keys?: string[]): Promise<ProjectProperty[]>Parameter
- projectId
-
string
Die Teamprojekt-ID.
- keys
-
string[]
Eine durch Trennzeichen getrennte Zeichenfolge von Teamprojekteigenschaftennamen. Platzhalterzeichen ("?" und "*") werden unterstützt. Wenn kein Schlüssel angegeben ist, werden alle Eigenschaften zurückgegeben.
Gibt zurück
Promise<ProjectProperty[]>
getProjects(any, number, number, number, boolean)
Rufen Sie alle Projekte in der organization ab, auf die der authentifizierte Benutzer Zugriff hat.
function getProjects(stateFilter?: any, top?: number, skip?: number, continuationToken?: number, getDefaultTeamImageUrl?: boolean): Promise<PagedList<TeamProjectReference>>Parameter
- stateFilter
-
any
Filtern Sie nach Teamprojekten in einem bestimmten Teamprojektstatus (Standard: WellFormed).
- top
-
number
- skip
-
number
- continuationToken
-
number
Zeiger, der angibt, wie viele Projekte bereits abgerufen wurden.
- getDefaultTeamImageUrl
-
boolean
Gibt zurück
Promise<PagedList<TeamProjectReference>>
getProjectsProperties(string[], string[])
Rufen Sie eine Auflistung von Teamprojekteigenschaften für mehrere Projekte ab.
function getProjectsProperties(projectIds: string[], properties?: string[]): Promise<ProjectProperties[]>Parameter
- projectIds
-
string[]
Eine durch Trennzeichen getrennte Zeichenfolge von Teamprojekt-IDs
- properties
-
string[]
Gibt zurück
Promise<ProjectProperties[]>
getProjectTeamsByCategory(string, boolean, number, number)
Ruft eine Liste der benutzerlesbaren Teams in einem Projekt ab, und der Benutzer teams ist Mitglied von (aus der lesbaren Liste ausgeschlossen).
function getProjectTeamsByCategory(projectId: string, expandIdentity?: boolean, top?: number, skip?: number): Promise<CategorizedWebApiTeams>Parameter
- projectId
-
string
Der Name oder die ID (GUID) des Teamprojekts, das die abzurufenden Teams enthält.
- expandIdentity
-
boolean
Ein Wert, der angibt, ob Identitätsinformationen im WebApiTeam-Ergebnisobjekt erweitert werden sollen oder nicht.
- top
-
number
Maximale Anzahl von Teams, die zurückgegeben werden sollen.
- skip
-
number
Anzahl der zu überspringenden Teams.
Gibt zurück
Promise<CategorizedWebApiTeams>
getProxies(string)
function getProxies(proxyUrl?: string): Promise<Proxy[]>Parameter
- proxyUrl
-
string
Gibt zurück
Promise<Proxy[]>
getTeam(string, string, boolean)
Rufen Sie ein bestimmtes Team ab.
function getTeam(projectId: string, teamId: string, expandIdentity?: boolean): Promise<WebApiTeam>Parameter
- projectId
-
string
Der Name oder die ID (GUID) des Teamprojekts, das das Team enthält.
- teamId
-
string
Der Name oder die ID (GUID) des Teams.
- expandIdentity
-
boolean
Ein Wert, der angibt, ob Identitätsinformationen im WebApiTeam-Ergebnisobjekt erweitert werden sollen oder nicht.
Gibt zurück
Promise<WebApiTeam>
getTeamMembersWithExtendedProperties(string, string, number, number)
Rufen Sie eine Liste der Mitglieder für ein bestimmtes Team ab.
function getTeamMembersWithExtendedProperties(projectId: string, teamId: string, top?: number, skip?: number): Promise<TeamMember[]>Parameter
- projectId
-
string
Der Name oder die ID (GUID) des Teamprojekts, zu dem das Team gehört.
- teamId
-
string
Der Name oder die ID (GUID) des Teams .
- top
-
number
- skip
-
number
Gibt zurück
Promise<TeamMember[]>
getTeams(string, boolean, number, number, boolean)
Rufen Sie eine Liste der Teams ab.
function getTeams(projectId: string, mine?: boolean, top?: number, skip?: number, expandIdentity?: boolean): Promise<WebApiTeam[]>Parameter
- projectId
-
string
- mine
-
boolean
Wenn true zurückgibt, dass alle Teams, die Benutzer anfordern, Mitglied sind, andernfalls alle Teams-Benutzer über Lesezugriff zurückgeben.
- top
-
number
Maximale Anzahl von Teams, die zurückgegeben werden sollen.
- skip
-
number
Anzahl der zu überspringenden Teams.
- expandIdentity
-
boolean
Ein Wert, der angibt, ob Identitätsinformationen im WebApiTeam-Ergebnisobjekt erweitert werden sollen.
Gibt zurück
Promise<WebApiTeam[]>
queueCreateProject(TeamProject)
Stellt ein zu erstellende Projekt in die Warteschlange. Verwenden Sie getOperation, um in regelmäßigen Abständen nach projekt erstellen status zu suchen.
function queueCreateProject(projectToCreate: TeamProject): Promise<OperationReference>Parameter
- projectToCreate
- TeamProject
Das zu erstellende Projekt.
Gibt zurück
Promise<OperationReference>
queueDeleteProject(string)
Stellt ein zu löschende Projekt in die Warteschlange. Verwenden Sie getOperation, um in regelmäßigen Abständen auf Löschprojekt status zu überprüfen.
function queueDeleteProject(projectId: string): Promise<OperationReference>Parameter
- projectId
-
string
Die Projekt-ID des zu löschenden Projekts.
Gibt zurück
Promise<OperationReference>
removeProjectAvatar(string)
Entfernt den Avatar für das Projekt.
function removeProjectAvatar(projectId: string): Promise<void>Parameter
- projectId
-
string
Die ID oder der Name des Projekts.
Gibt zurück
Promise<void>
setProjectAvatar(ProjectAvatar, string)
Legt den Avatar für das Projekt fest.
function setProjectAvatar(avatarBlob: ProjectAvatar, projectId: string): Promise<void>Parameter
- avatarBlob
- ProjectAvatar
Das hochzuladende Avatar-Blobdatenobjekt.
- projectId
-
string
Die ID oder der Name des Projekts.
Gibt zurück
Promise<void>
setProjectProperties(string, JsonPatchDocument)
Erstellen, Aktualisieren und Löschen von Teamprojekteigenschaften
function setProjectProperties(projectId: string, patchDocument: JsonPatchDocument): Promise<void>Parameter
- projectId
-
string
Die Teamprojekt-ID.
- patchDocument
- JsonPatchDocument
Ein JSON-Patchdokument, das ein Array von Eigenschaftenvorgängen darstellt. Weitere Informationen zum JSON-Patch finden Sie unter RFC 6902. Die akzeptierten Vorgangsverben sind Hinzufügen und Entfernen, wobei Add zum Erstellen und Aktualisieren von Eigenschaften verwendet wird. Der Pfad besteht aus einem Schrägstrich und einem Eigenschaftsnamen.
Gibt zurück
Promise<void>
updateIdentityMru(IdentityData, string)
function updateIdentityMru(mruData: IdentityData, mruName: string): Promise<void>Parameter
- mruData
- IdentityData
- mruName
-
string
Gibt zurück
Promise<void>
updateProject(TeamProject, string)
Aktualisieren Sie den Namen, die Abkürzung, die Beschreibung eines vorhandenen Projekts, oder stellen Sie ein Projekt wieder her.
function updateProject(projectUpdate: TeamProject, projectId: string): Promise<OperationReference>Parameter
- projectUpdate
- TeamProject
Die Updates für das Projekt. Der Zustand muss auf wellFormed festgelegt werden, um das Projekt wiederherzustellen.
- projectId
-
string
Die Projekt-ID des zu aktualisierenden Projekts.
Gibt zurück
Promise<OperationReference>
updateTeam(WebApiTeam, string, string)
Aktualisieren sie den Namen und/oder die Beschreibung eines Teams.
function updateTeam(teamData: WebApiTeam, projectId: string, teamId: string): Promise<WebApiTeam>Parameter
- teamData
- WebApiTeam
- projectId
-
string
Der Name oder die ID (GUID) des Teamprojekts, das das zu aktualisierende Team enthält.
- teamId
-
string
Der Name der ID des zu aktualisierenden Teams.
Gibt zurück
Promise<WebApiTeam>
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für