CoreRestClient class

Balíček:

azure-devops-extension-api

Základní třída, která by se měla používat (odvozená z) k vytváření požadavků na rozhraní REST api služby VSS

Extends

RestClientBase

Konstruktory

CoreRestClient(IVssRestClientOptions)

Vlastnosti

RESOURCE_AREA_ID

Metody

createConnectedService(WebApiConnectedServiceDetails, string)
createIdentityMru(IdentityData, string)
createOrUpdateProxy(Proxy)
createTeam(WebApiTeam, string)	Vytvoření týmu v týmovém projektu
deleteIdentityMru(IdentityData, string)
deleteProxy(string, string)
deleteTeam(string, string)	Odstranění týmu
getAllTeams(boolean, number, number, boolean)	Získejte seznam všech týmů.
getConnectedServiceDetails(string, string)
getConnectedServices(string, ConnectedServiceKind)
getIdentityMru(string)
getProcessById(string)	Získejte proces podle ID.
getProcesses()	Získejte seznam procesů.
getProject(string, boolean, boolean)	Získejte projekt se zadaným ID nebo názvem, volitelně včetně možností.
getProjectCollection(string)	Získejte kolekci projektu se zadaným ID nebo názvem.
getProjectCollections(number, number)	Získejte odkazy na kolekci projektů pro tuto aplikaci.
getProjectHistoryEntries(number)	Získá historii změn projektu.
getProjectProperties(string, string[])	Získejte kolekci vlastností týmového projektu.
getProjects(any, number, number, number, boolean)	Získejte všechny projekty v organizaci, ke kterým má ověřený uživatel přístup.
getProjectsProperties(string[], string[])	Získejte kolekci vlastností týmového projektu pro více projektů.
getProjectTeamsByCategory(string, boolean, number, number)	Získá seznam uživatelsky čitelných týmů v projektu a týmy jsou členy (vyloučené ze seznamu pro čtení).
getProxies(string)
getTeam(string, string, boolean)	Získejte konkrétní tým.
getTeamMembersWithExtendedProperties(string, string, number, number)	Získejte seznam členů pro konkrétní tým.
getTeams(string, boolean, number, number, boolean)	Získejte seznam týmů.
queueCreateProject(TeamProject)	Do fronty projekt, který se má vytvořit. Pomocí GetOperation můžete pravidelně kontrolovat stav vytvoření projektu.
queueDeleteProject(string)	Do fronty projekt, který má být odstraněn. Pomocí funkce GetOperation můžete pravidelně kontrolovat stav odstraňovacího projektu.
removeProjectAvatar(string)	Odebere avatara projektu.
setProjectAvatar(ProjectAvatar, string)	Nastaví avatara pro projekt.
setProjectProperties(string, JsonPatchDocument)	Vytváření, aktualizace a odstraňování vlastností týmového projektu
updateIdentityMru(IdentityData, string)
updateProject(TeamProject, string)	Aktualizujte název, zkratku a popis existujícího projektu nebo obnovte projekt.
updateTeam(WebApiTeam, string, string)	Aktualizujte název nebo popis týmu.

Podrobnosti konstruktoru

CoreRestClient(IVssRestClientOptions)

new CoreRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Podrobnosti vlastnosti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Hodnota vlastnosti

string

Podrobnosti metody

createConnectedService(WebApiConnectedServiceDetails, string)

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

Parametry

connectedServiceCreationData

WebApiConnectedServiceDetails

projectId

string

Návraty

Promise<WebApiConnectedService>

createIdentityMru(IdentityData, string)

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

Parametry

mruData

IdentityData

mruName

string

Návraty

Promise<void>

createOrUpdateProxy(Proxy)

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

Parametry

proxy

Proxy

Návraty

Promise<Proxy>

createTeam(WebApiTeam, string)

Vytvoření týmu v týmovém projektu

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

Parametry

team

WebApiTeam

Data týmu použitá k vytvoření týmu

projectId

string

Název nebo ID (GUID) týmového projektu, ve kterém se má tým vytvořit.

Návraty

Promise<WebApiTeam>

deleteIdentityMru(IdentityData, string)

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

Parametry

mruData

IdentityData

mruName

string

Návraty

Promise<void>

deleteProxy(string, string)

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

Parametry

proxyUrl

string

site

string

Návraty

Promise<void>

deleteTeam(string, string)

Odstranění týmu

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

Parametry

projectId

string

Název nebo ID (GUID) týmového projektu obsahujícího tým, který se má odstranit.

teamId

string

Název nebo ID týmu, který chcete odstranit.

Návraty

Promise<void>

getAllTeams(boolean, number, number, boolean)

Získejte seznam všech týmů.

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

Parametry

mine

boolean

Pokud je pravda, vraťte všechny týmy, které požadují, že uživatel je členem. V opačném případě se vrátí všechny týmy, které mají přístup ke čtení.

top

number

Maximální počet týmů, které se mají vrátit.

skip

number

Počet týmů, které se mají přeskočit

expandIdentity

boolean

Hodnota označující, zda chcete rozbalit informace o identitě ve výsledném objektu WebApiTeam.

Návraty

Promise<WebApiTeam[]>

getConnectedServiceDetails(string, string)

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

Parametry

projectId

string

name

string

Návraty

Promise<WebApiConnectedServiceDetails>

getConnectedServices(string, ConnectedServiceKind)

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

Parametry

projectId

string

kind

ConnectedServiceKind

Návraty

Promise<WebApiConnectedService[]>

getIdentityMru(string)

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

Parametry

mruName

string

Návraty

Promise<IdentityRef[]>

getProcessById(string)

Získejte proces podle ID.

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

Parametry

processId

string

ID procesu.

Návraty

Promise<Process>

getProcesses()

Získejte seznam procesů.

function getProcesses(): Promise<Process[]>

Návraty

Promise<Process[]>

getProject(string, boolean, boolean)

Získejte projekt se zadaným ID nebo názvem, volitelně včetně možností.

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

Parametry

projectId

string

includeCapabilities

boolean

Zahrnout funkce (například správu zdrojového kódu) do výsledku týmového projektu (výchozí hodnota: false).

includeHistory

boolean

Hledat v přejmenovaných projektech (které měly takový název v minulosti).

Návraty

Promise<TeamProject>

getProjectCollection(string)

Získejte kolekci projektu se zadaným ID nebo názvem.

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

Parametry

collectionId

string

Návraty

Promise<TeamProjectCollection>

getProjectCollections(number, number)

Získejte odkazy na kolekci projektů pro tuto aplikaci.

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

Parametry

top

number

skip

number

Návraty

Promise<TeamProjectCollectionReference[]>

getProjectHistoryEntries(number)

Získá historii změn projektu.

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

Parametry

minRevision

number

Minimální číslo revize, které se má vrátit v historii.

Návraty

Promise<ProjectInfo[]>

getProjectProperties(string, string[])

Získejte kolekci vlastností týmového projektu.

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

Parametry

projectId

string

ID týmového projektu.

keys

string[]

Řetězec s názvy vlastností týmového projektu s oddělovači. Zástupné znaky ("?" a "*") jsou podporovány. Pokud není zadán žádný klíč, vrátí se všechny vlastnosti.

Návraty

Promise<ProjectProperty[]>

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

Získejte všechny projekty v organizaci, ke kterým má ověřený uživatel přístup.

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

Parametry

stateFilter

any

Filtrujte týmové projekty v konkrétním stavu týmového projektu (výchozí: WellFormed).

top

number

skip

number

continuationToken

number

Ukazatel, který ukazuje, kolik projektů už bylo načteno.

getDefaultTeamImageUrl

boolean

Návraty

Promise<PagedList<TeamProjectReference>>

getProjectsProperties(string[], string[])

Získejte kolekci vlastností týmového projektu pro více projektů.

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

Parametry

projectIds

string[]

Řetězec id týmového projektu s oddělovači

properties

string[]

Návraty

Promise<ProjectProperties[]>

getProjectTeamsByCategory(string, boolean, number, number)

Získá seznam uživatelsky čitelných týmů v projektu a týmy jsou členy (vyloučené ze seznamu pro čtení).

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

Parametry

projectId

string

Název nebo ID (GUID) týmového projektu obsahující týmy, které se mají načíst.

expandIdentity

boolean

Hodnota označující, zda chcete rozbalit informace o identitě ve výsledném objektu WebApiTeam.

top

number

Maximální počet týmů, které se mají vrátit.

skip

number

Počet týmů, které se mají přeskočit

Návraty

Promise<CategorizedWebApiTeams>

getProxies(string)

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

Parametry

proxyUrl

string

Návraty

Promise<Proxy[]>

getTeam(string, string, boolean)

Získejte konkrétní tým.

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

Parametry

projectId

string

Název nebo ID (GUID) týmového projektu obsahujícího tým.

teamId

string

Název nebo ID (GUID) týmu.

expandIdentity

boolean

Hodnota označující, zda chcete rozbalit informace o identitě ve výsledném objektu WebApiTeam.

Návraty

Promise<WebApiTeam>

getTeamMembersWithExtendedProperties(string, string, number, number)

Získejte seznam členů pro konkrétní tým.

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

Parametry

projectId

string

Název nebo ID (GUID) týmového projektu, do který tým patří.

teamId

string

Název nebo ID (GUID) týmu .

top

number

skip

number

Návraty

Promise<TeamMember[]>

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

Získejte seznam týmů.

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

Parametry

projectId

string

mine

boolean

Pokud se hodnota true vrátí, všechny týmy, které požadují uživatele, jsou členy, v opačném případě vraťte všechny týmy, které mají přístup ke čtení.

top

number

Maximální počet týmů, které se mají vrátit.

skip

number

Počet týmů, které se mají přeskočit

expandIdentity

boolean

Hodnota označující, zda chcete rozbalit informace o identitě ve výsledném objektu WebApiTeam.

Návraty

Promise<WebApiTeam[]>

queueCreateProject(TeamProject)

Do fronty projekt, který se má vytvořit. Pomocí GetOperation můžete pravidelně kontrolovat stav vytvoření projektu.

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

Parametry

projectToCreate

TeamProject

Projekt, který chcete vytvořit.

Návraty

Promise<OperationReference>

queueDeleteProject(string)

Do fronty projekt, který má být odstraněn. Pomocí funkce GetOperation můžete pravidelně kontrolovat stav odstraňovacího projektu.

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

Parametry

projectId

string

ID projektu, který chcete odstranit.

Návraty

Promise<OperationReference>

removeProjectAvatar(string)

Odebere avatara projektu.

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

Parametry

projectId

string

ID nebo název projektu.

Návraty

Promise<void>

setProjectAvatar(ProjectAvatar, string)

Nastaví avatara pro projekt.

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

Parametry

avatarBlob

ProjectAvatar

Datový objekt objektu blob avatara, který se má nahrát.

projectId

string

ID nebo název projektu.

Návraty

Promise<void>

setProjectProperties(string, JsonPatchDocument)

Vytváření, aktualizace a odstraňování vlastností týmového projektu

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

Parametry

projectId

string

ID týmového projektu.

patchDocument

JsonPatchDocument

Dokument opravy JSON, který představuje pole operací vlastností. Další podrobnosti o opravě JSON najdete v dokumentu RFC 6902. Akceptované operace jsou Add (Přidat) a Remove (Odebrat), kde Add slouží k vytváření i aktualizaci vlastností. Cesta se skládá z lomítka a názvu vlastnosti.

Návraty

Promise<void>

updateIdentityMru(IdentityData, string)

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

Parametry

mruData

IdentityData

mruName

string

Návraty

Promise<void>

updateProject(TeamProject, string)

Aktualizujte název, zkratku a popis existujícího projektu nebo obnovte projekt.

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

Parametry

projectUpdate

TeamProject

Aktualizace pro projekt. Stav musí být nastaven na wellFormed, aby se projekt obnovil.

projectId

string

ID projektu, který se má aktualizovat.

Návraty

Promise<OperationReference>

updateTeam(WebApiTeam, string, string)

Aktualizujte název nebo popis týmu.

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

Parametry

teamData

WebApiTeam

projectId

string

Název nebo ID (GUID) týmového projektu obsahujícího tým, který se má aktualizovat.

teamId

string

Název ID týmu, který se má aktualizovat.

Návraty

Promise<WebApiTeam>