CoreRestClient class

Pakiet:

azure-devops-extension-api

Klasa bazowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Rozszerzenie

RestClientBase

Konstruktory

CoreRestClient(IVssRestClientOptions)

Właściwości

RESOURCE_AREA_ID

Metody

createConnectedService(WebApiConnectedServiceDetails, string)
createIdentityMru(IdentityData, string)
createOrUpdateProxy(Proxy)
createTeam(WebApiTeam, string)	Tworzenie zespołu w projekcie zespołowym.
deleteIdentityMru(IdentityData, string)
deleteProxy(string, string)
deleteTeam(string, string)	Usuwanie zespołu.
getAllTeams(boolean, number, number, boolean)	Pobierz listę wszystkich drużyn.
getConnectedServiceDetails(string, string)
getConnectedServices(string, ConnectedServiceKind)
getIdentityMru(string)
getProcessById(string)	Pobierz proces według identyfikatora.
getProcesses()	Pobierz listę procesów.
getProject(string, boolean, boolean)	Pobierz projekt o określonym identyfikatorze lub nazwie, opcjonalnie z uwzględnieniem możliwości.
getProjectCollection(string)	Pobierz kolekcję projektów o określonym identyfikatorze lub nazwie.
getProjectCollections(number, number)	Pobierz odwołania do kolekcji projektów dla tej aplikacji.
getProjectHistoryEntries(number)	Pobiera historię zmian w projekcie.
getProjectProperties(string, string[])	Pobierz kolekcję właściwości projektu zespołowego.
getProjects(any, number, number, number, boolean)	Pobierz wszystkie projekty w organizacji, do których uwierzytelniony użytkownik ma dostęp.
getProjectsProperties(string[], string[])	Pobierz kolekcję właściwości projektu zespołowego dla wielu projektów.
getProjectTeamsByCategory(string, boolean, number, number)	Pobiera listę zespołów czytelnych dla użytkownika w projekcie, do których należy użytkownik (wykluczony z listy czytelnych).
getProxies(string)
getTeam(string, string, boolean)	Zdobądź konkretny zespół.
getTeamMembersWithExtendedProperties(string, string, number, number)	Uzyskaj listę członków dla określonego zespołu.
getTeams(string, boolean, number, number, boolean)	Pobierz listę zespołów.
queueCreateProject(TeamProject)	Kolejkuje projekt do utworzenia. Użyj GetOperation , aby okresowo sprawdzać stan tworzenia projektu.
queueDeleteProject(string)	Kolejkuje projekt do kolejki, który ma zostać usunięty. Użyj GetOperation , aby okresowo sprawdzać stan usunięcia projektu.
removeProjectAvatar(string)	Usuwa awatar projektu.
setProjectAvatar(ProjectAvatar, string)	Ustawia awatar dla projektu.
setProjectProperties(string, JsonPatchDocument)	Tworzenie, aktualizowanie i usuwanie właściwości projektu zespołowego.
updateIdentityMru(IdentityData, string)
updateProject(TeamProject, string)	Aktualizowanie nazwy, skrótu, opisu istniejącego projektu lub przywracanie projektu.
updateTeam(WebApiTeam, string, string)	Zaktualizuj nazwę i/lub opis zespołu.

Szczegóły konstruktora

CoreRestClient(IVssRestClientOptions)

new CoreRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Szczegóły właściwości

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Wartość właściwości

string

Szczegóły metody

createConnectedService(WebApiConnectedServiceDetails, string)

function createConnectedService(connectedServiceCreationData: WebApiConnectedServiceDetails, projectId: string): Promise<WebApiConnectedService>

Parametry

connectedServiceCreationData

WebApiConnectedServiceDetails

projectId

string

Zwraca

Promise<WebApiConnectedService>

createIdentityMru(IdentityData, string)

function createIdentityMru(mruData: IdentityData, mruName: string): Promise<void>

Parametry

mruData

IdentityData

mruName

string

Zwraca

Promise<void>

createOrUpdateProxy(Proxy)

function createOrUpdateProxy(proxy: Proxy): Promise<Proxy>

Parametry

proxy

Proxy

Zwraca

Promise<Proxy>

createTeam(WebApiTeam, string)

Tworzenie zespołu w projekcie zespołowym.

function createTeam(team: WebApiTeam, projectId: string): Promise<WebApiTeam>

Parametry

team

WebApiTeam

Dane zespołu użyte do utworzenia zespołu.

projectId

string

Nazwa lub identyfikator (GUID) projektu zespołowego, w którym ma zostać utworzony zespół.

Zwraca

Promise<WebApiTeam>

deleteIdentityMru(IdentityData, string)

function deleteIdentityMru(mruData: IdentityData, mruName: string): Promise<void>

Parametry

mruData

IdentityData

mruName

string

Zwraca

Promise<void>

deleteProxy(string, string)

function deleteProxy(proxyUrl: string, site?: string): Promise<void>

Parametry

proxyUrl

string

site

string

Zwraca

Promise<void>

deleteTeam(string, string)

Usuwanie zespołu.

function deleteTeam(projectId: string, teamId: string): Promise<void>

Parametry

projectId

string

Nazwa lub identyfikator (GUID) projektu zespołowego zawierającego zespół do usunięcia.

teamId

string

Nazwa lub identyfikator zespołu, który ma zostać usunięty.

Zwraca

Promise<void>

getAllTeams(boolean, number, number, boolean)

Pobierz listę wszystkich drużyn.

function getAllTeams(mine?: boolean, top?: number, skip?: number, expandIdentity?: boolean): Promise<WebApiTeam[]>

Parametry

mine

boolean

Jeśli wartość true, zwróć wszystkie zespoły, które żądają, aby użytkownik jest członkiem. W przeciwnym razie zwróć wszystkie zespoły, które mają dostęp do odczytu.

top

number

Maksymalna liczba zespołów, które mogą wrócić.

skip

number

Liczba zespołów do pominięcia.

expandIdentity

boolean

Wartość wskazująca, czy należy rozwinąć informacje o tożsamości w wynikowym obiekcie WebApiTeam.

Zwraca

Promise<WebApiTeam[]>

getConnectedServiceDetails(string, string)

function getConnectedServiceDetails(projectId: string, name: string): Promise<WebApiConnectedServiceDetails>

Parametry

projectId

string

name

string

Zwraca

Promise<WebApiConnectedServiceDetails>

getConnectedServices(string, ConnectedServiceKind)

function getConnectedServices(projectId: string, kind?: ConnectedServiceKind): Promise<WebApiConnectedService[]>

Parametry

projectId

string

kind

ConnectedServiceKind

Zwraca

Promise<WebApiConnectedService[]>

getIdentityMru(string)

function getIdentityMru(mruName: string): Promise<IdentityRef[]>

Parametry

mruName

string

Zwraca

Promise<IdentityRef[]>

getProcessById(string)

Pobierz proces według identyfikatora.

function getProcessById(processId: string): Promise<Process>

Parametry

processId

string

Identyfikator procesu.

Zwraca

Promise<Process>

getProcesses()

Pobierz listę procesów.

function getProcesses(): Promise<Process[]>

Zwraca

Promise<Process[]>

getProject(string, boolean, boolean)

Pobierz projekt o określonym identyfikatorze lub nazwie, opcjonalnie z uwzględnieniem możliwości.

function getProject(projectId: string, includeCapabilities?: boolean, includeHistory?: boolean): Promise<TeamProject>

Parametry

projectId

string

includeCapabilities

boolean

Uwzględnij możliwości (takie jak kontrola źródła) w wyniku projektu zespołowego (domyślnie: false).

includeHistory

boolean

Szukaj w projektach o zmienionych nazwach (które miały taką nazwę w przeszłości).

Zwraca

Promise<TeamProject>

getProjectCollection(string)

Pobierz kolekcję projektów o określonym identyfikatorze lub nazwie.

function getProjectCollection(collectionId: string): Promise<TeamProjectCollection>

Parametry

collectionId

string

Zwraca

Promise<TeamProjectCollection>

getProjectCollections(number, number)

Pobierz odwołania do kolekcji projektów dla tej aplikacji.

function getProjectCollections(top?: number, skip?: number): Promise<TeamProjectCollectionReference[]>

Parametry

top

number

skip

number

Zwraca

Promise<TeamProjectCollectionReference[]>

getProjectHistoryEntries(number)

Pobiera historię zmian w projekcie.

function getProjectHistoryEntries(minRevision?: number): Promise<ProjectInfo[]>

Parametry

minRevision

number

Minimalny numer poprawki do zwrócenia w historii.

Zwraca

Promise<ProjectInfo[]>

getProjectProperties(string, string[])

Pobierz kolekcję właściwości projektu zespołowego.

function getProjectProperties(projectId: string, keys?: string[]): Promise<ProjectProperty[]>

Parametry

projectId

string

Identyfikator projektu zespołowego.

keys

string[]

Rozdzielany przecinkami ciąg nazw właściwości projektu zespołowego. Obsługiwane są symbole wieloznaczne ("?" i "*"). Jeśli klucz nie zostanie określony, zostaną zwrócone wszystkie właściwości.

Zwraca

Promise<ProjectProperty[]>

getProjects(any, number, number, number, boolean)

Pobierz wszystkie projekty w organizacji, do których uwierzytelniony użytkownik ma dostęp.

function getProjects(stateFilter?: any, top?: number, skip?: number, continuationToken?: number, getDefaultTeamImageUrl?: boolean): Promise<PagedList<TeamProjectReference>>

Parametry

stateFilter

any

Filtrowanie projektów zespołowych w określonym stanie projektu zespołowego (domyślnie: WellFormed).

top

number

skip

number

continuationToken

number

Wskaźnik pokazujący, ile projektów zostało już pobranych.

getDefaultTeamImageUrl

boolean

Zwraca

Promise<PagedList<TeamProjectReference>>

getProjectsProperties(string[], string[])

Pobierz kolekcję właściwości projektu zespołowego dla wielu projektów.

function getProjectsProperties(projectIds: string[], properties?: string[]): Promise<ProjectProperties[]>

Parametry

projectIds

string[]

Rozdzielany przecinkami ciąg identyfikatorów projektów zespołowych

properties

string[]

Zwraca

Promise<ProjectProperties[]>

getProjectTeamsByCategory(string, boolean, number, number)

Pobiera listę zespołów czytelnych dla użytkownika w projekcie, do których należy użytkownik (wykluczony z listy czytelnych).

function getProjectTeamsByCategory(projectId: string, expandIdentity?: boolean, top?: number, skip?: number): Promise<CategorizedWebApiTeams>

Parametry

projectId

string

Nazwa lub identyfikator (GUID) projektu zespołowego zawierającego zespoły do pobrania.

expandIdentity

boolean

Wartość wskazująca, czy należy rozwinąć informacje o tożsamości w wynikowym obiekcie WebApiTeam.

top

number

Maksymalna liczba zespołów, które mogą wrócić.

skip

number

Liczba zespołów do pominięcia.

Zwraca

Promise<CategorizedWebApiTeams>

getProxies(string)

function getProxies(proxyUrl?: string): Promise<Proxy[]>

Parametry

proxyUrl

string

Zwraca

Promise<Proxy[]>

getTeam(string, string, boolean)

Zdobądź konkretny zespół.

function getTeam(projectId: string, teamId: string, expandIdentity?: boolean): Promise<WebApiTeam>

Parametry

projectId

string

Nazwa lub identyfikator (GUID) projektu zespołowego zawierającego zespół.

teamId

string

Nazwa lub identyfikator (GUID) zespołu.

expandIdentity

boolean

Wartość wskazująca, czy należy rozwinąć informacje o tożsamości w wynikowym obiekcie WebApiTeam.

Zwraca

Promise<WebApiTeam>

getTeamMembersWithExtendedProperties(string, string, number, number)

Uzyskaj listę członków dla określonego zespołu.

function getTeamMembersWithExtendedProperties(projectId: string, teamId: string, top?: number, skip?: number): Promise<TeamMember[]>

Parametry

projectId

string

Nazwa lub identyfikator (GUID) projektu zespołowego, do którego należy zespół.

teamId

string

Nazwa lub identyfikator (GUID) zespołu.

top

number

skip

number

Zwraca

Promise<TeamMember[]>

getTeams(string, boolean, number, number, boolean)

Pobierz listę zespołów.

function getTeams(projectId: string, mine?: boolean, top?: number, skip?: number, expandIdentity?: boolean): Promise<WebApiTeam[]>

Parametry

projectId

string

mine

boolean

Jeśli wartość true zwróci wszystkie zespoły, które żądają użytkownika, jest członkiem, w przeciwnym razie zwróć wszystkie zespoły, które użytkownik ma dostęp do odczytu.

top

number

Maksymalna liczba zespołów, które mogą wrócić.

skip

number

Liczba zespołów do pominięcia.

expandIdentity

boolean

Wartość wskazująca, czy należy rozwinąć informacje o tożsamości w wynikowym obiekcie WebApiTeam.

Zwraca

Promise<WebApiTeam[]>

queueCreateProject(TeamProject)

Kolejkuje projekt do utworzenia. Użyj GetOperation , aby okresowo sprawdzać stan tworzenia projektu.

function queueCreateProject(projectToCreate: TeamProject): Promise<OperationReference>

Parametry

projectToCreate

TeamProject

Projekt do utworzenia.

Zwraca

Promise<OperationReference>

queueDeleteProject(string)

Kolejkuje projekt do kolejki, który ma zostać usunięty. Użyj GetOperation , aby okresowo sprawdzać stan usunięcia projektu.

function queueDeleteProject(projectId: string): Promise<OperationReference>

Parametry

projectId

string

Identyfikator projektu do usunięcia.

Zwraca

Promise<OperationReference>

removeProjectAvatar(string)

Usuwa awatar projektu.

function removeProjectAvatar(projectId: string): Promise<void>

Parametry

projectId

string

Identyfikator lub nazwa projektu.

Zwraca

Promise<void>

setProjectAvatar(ProjectAvatar, string)

Ustawia awatar dla projektu.

function setProjectAvatar(avatarBlob: ProjectAvatar, projectId: string): Promise<void>

Parametry

avatarBlob

ProjectAvatar

Obiekt danych obiektu blob awatara do przekazania.

projectId

string

Identyfikator lub nazwa projektu.

Zwraca

Promise<void>

setProjectProperties(string, JsonPatchDocument)

Tworzenie, aktualizowanie i usuwanie właściwości projektu zespołowego.

function setProjectProperties(projectId: string, patchDocument: JsonPatchDocument): Promise<void>

Parametry

projectId

string

Identyfikator projektu zespołowego.

patchDocument

JsonPatchDocument

Dokument JSON Patch, który reprezentuje tablicę operacji właściwości. Zobacz RFC 6902, aby uzyskać więcej informacji na temat poprawki JSON. Akceptowane czasowniki operacji to Dodaj i Usuń, gdzie Dodaj jest używane zarówno do tworzenia, jak i aktualizowania właściwości. Ścieżka składa się z ukośnika i nazwy właściwości.

Zwraca

Promise<void>

updateIdentityMru(IdentityData, string)

function updateIdentityMru(mruData: IdentityData, mruName: string): Promise<void>

Parametry

mruData

IdentityData

mruName

string

Zwraca

Promise<void>

updateProject(TeamProject, string)

Aktualizowanie nazwy, skrótu, opisu istniejącego projektu lub przywracanie projektu.

function updateProject(projectUpdate: TeamProject, projectId: string): Promise<OperationReference>

Parametry

projectUpdate

TeamProject

Aktualizacje dla projektu. Stan musi być ustawiony na wellFormed, aby przywrócić projekt.

projectId

string

Identyfikator projektu do zaktualizowania.

Zwraca

Promise<OperationReference>

updateTeam(WebApiTeam, string, string)

Zaktualizuj nazwę i/lub opis zespołu.

function updateTeam(teamData: WebApiTeam, projectId: string, teamId: string): Promise<WebApiTeam>

Parametry

teamData

WebApiTeam

projectId

string

Nazwa lub identyfikator (GUID) projektu zespołowego zawierającego zespół do zaktualizowania.

teamId

string

Nazwa identyfikatora zespołu, który ma zostać zaktualizowany.

Zwraca

Promise<WebApiTeam>