CoreRestClient class

Csomag:

azure-devops-extension-api

Alaposztály, amelyet a VSS REST API-k kéréseinek igényléséhez (származtatásából) kell használni

Extends

RestClientBase

Konstruktorok

CoreRestClient(IVssRestClientOptions)

Tulajdonságok

RESOURCE_AREA_ID

Metódusok

createConnectedService(WebApiConnectedServiceDetails, string)
createIdentityMru(IdentityData, string)
createOrUpdateProxy(Proxy)
createTeam(WebApiTeam, string)	Hozzon létre egy csapatot egy csapatprojektben.
deleteIdentityMru(IdentityData, string)
deleteProxy(string, string)
deleteTeam(string, string)	Csapat törlése.
getAllTeams(boolean, number, number, boolean)	Szerezze be az összes csapat listáját.
getConnectedServiceDetails(string, string)
getConnectedServices(string, ConnectedServiceKind)
getIdentityMru(string)
getProcessById(string)	Folyamat lekérése azonosító alapján.
getProcesses()	Folyamatok listájának lekérése.
getProject(string, boolean, boolean)	Projekt lekérése a megadott azonosítóval vagy névvel, opcionálisan a képességekkel együtt.
getProjectCollection(string)	Projektgyűjtemény lekérése a megadott azonosítóval vagy névvel.
getProjectCollections(number, number)	Projektgyűjtemény-hivatkozások lekérése ehhez az alkalmazáshoz.
getProjectHistoryEntries(number)	Lekéri a projekt változásainak előzményeit.
getProjectProperties(string, string[])	Csapatprojekt-tulajdonságok gyűjteményének lekérése.
getProjects(any, number, number, number, boolean)	Szerezze be a szervezet összes olyan projektjét, amelyhez a hitelesített felhasználó hozzáfér.
getProjectsProperties(string[], string[])	Csapatprojekt-tulajdonságok gyűjteményének lekérése több projekthez.
getProjectTeamsByCategory(string, boolean, number, number)	Lekéri a felhasználó által olvasható csapatok listáját egy projektben, és a csapatok felhasználója (kizárva az olvasható listából).
getProxies(string)
getTeam(string, string, boolean)	Szerezzen be egy adott csapatot.
getTeamMembersWithExtendedProperties(string, string, number, number)	Szerezze be egy adott csapat tagjainak listáját.
getTeams(string, boolean, number, number, boolean)	Szerezze be a csapatok listáját.
queueCreateProject(TeamProject)	Várólista egy létrehozandó projekt. A GetOperation használatával rendszeres időközönként ellenőrizze a projekt létrehozásának állapotát.
queueDeleteProject(string)	Várólista egy törölendő projektet. A GetOperation használatával rendszeresen ellenőrizheti a projekt törlési állapotát.
removeProjectAvatar(string)	Eltávolítja a projekt avatarját.
setProjectAvatar(ProjectAvatar, string)	Beállítja a projekt avatarját.
setProjectProperties(string, JsonPatchDocument)	Csapatprojekt-tulajdonságok létrehozása, frissítése és törlése.
updateIdentityMru(IdentityData, string)
updateProject(TeamProject, string)	Meglévő projekt nevének, rövidítésének, leírásának frissítése vagy visszaállítása.
updateTeam(WebApiTeam, string, string)	Frissítse a csapat nevét és/vagy leírását.

Konstruktor adatai

CoreRestClient(IVssRestClientOptions)

new CoreRestClient(options: IVssRestClientOptions)

Paraméterek

options

IVssRestClientOptions

Tulajdonság adatai

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Tulajdonság értéke

string

Metódus adatai

createConnectedService(WebApiConnectedServiceDetails, string)

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

Paraméterek

connectedServiceCreationData

WebApiConnectedServiceDetails

projectId

string

Válaszok

Promise<WebApiConnectedService>

createIdentityMru(IdentityData, string)

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

Paraméterek

mruData

IdentityData

mruName

string

Válaszok

Promise<void>

createOrUpdateProxy(Proxy)

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

Paraméterek

proxy

Proxy

Válaszok

Promise<Proxy>

createTeam(WebApiTeam, string)

Hozzon létre egy csapatot egy csapatprojektben.

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

Paraméterek

team

WebApiTeam

A csapat létrehozásához használt csapatadatok.

projectId

string

Annak a csapatprojektnek a neve vagy azonosítója (GUID), amelyben létre kell hozni a csapatot.

Válaszok

Promise<WebApiTeam>

deleteIdentityMru(IdentityData, string)

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

Paraméterek

mruData

IdentityData

mruName

string

Válaszok

Promise<void>

deleteProxy(string, string)

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

Paraméterek

proxyUrl

string

site

string

Válaszok

Promise<void>

deleteTeam(string, string)

Csapat törlése.

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

Paraméterek

projectId

string

A törölni kívánt csapatot tartalmazó csapatprojekt neve vagy azonosítója (GUID).

teamId

string

A törölni kívánt csapat neve vagy azonosítója.

Válaszok

Promise<void>

getAllTeams(boolean, number, number, boolean)

Szerezze be az összes csapat listáját.

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

Paraméterek

mine

boolean

Ha igaz, akkor adja vissza az összes csapatot, amely a felhasználó tagja. Ellenkező esetben az összes csapatfelhasználó olvasási hozzáféréssel rendelkezik.

top

number

A visszaküldött csapatok maximális száma.

skip

number

Kihagyandó csapatok száma.

expandIdentity

boolean

Egy érték, amely azt jelzi, hogy ki kell-e bontani az identitásadatokat az eredmény WebApiTeam objektumában.

Válaszok

Promise<WebApiTeam[]>

getConnectedServiceDetails(string, string)

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

Paraméterek

projectId

string

name

string

Válaszok

Promise<WebApiConnectedServiceDetails>

getConnectedServices(string, ConnectedServiceKind)

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

Paraméterek

projectId

string

kind

ConnectedServiceKind

Válaszok

Promise<WebApiConnectedService[]>

getIdentityMru(string)

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

Paraméterek

mruName

string

Válaszok

Promise<IdentityRef[]>

getProcessById(string)

Folyamat lekérése azonosító alapján.

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

Paraméterek

processId

string

Egy folyamat azonosítója.

Válaszok

Promise<Process>

getProcesses()

Folyamatok listájának lekérése.

function getProcesses(): Promise<Process[]>

Válaszok

Promise<Process[]>

getProject(string, boolean, boolean)

Projekt lekérése a megadott azonosítóval vagy névvel, opcionálisan a képességekkel együtt.

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

Paraméterek

projectId

string

includeCapabilities

boolean

Adjon hozzá képességeket (például verziókövetést) a csapatprojekt eredményéhez (alapértelmezett: hamis).

includeHistory

boolean

Keressen az átnevezett projektekben (amelyeknek korábban ilyen neve volt).

Válaszok

Promise<TeamProject>

getProjectCollection(string)

Projektgyűjtemény lekérése a megadott azonosítóval vagy névvel.

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

Paraméterek

collectionId

string

Válaszok

Promise<TeamProjectCollection>

getProjectCollections(number, number)

Projektgyűjtemény-hivatkozások lekérése ehhez az alkalmazáshoz.

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

Paraméterek

top

number

skip

number

Válaszok

Promise<TeamProjectCollectionReference[]>

getProjectHistoryEntries(number)

Lekéri a projekt változásainak előzményeit.

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

Paraméterek

minRevision

number

Az előzményekben visszaadandó minimális változatszám.

Válaszok

Promise<ProjectInfo[]>

getProjectProperties(string, string[])

Csapatprojekt-tulajdonságok gyűjteményének lekérése.

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

Paraméterek

projectId

string

A csapatprojekt azonosítója.

keys

string[]

A csapatprojekt tulajdonságneveinek vesszővel tagolt karakterlánca. A helyettesítő karakterek ("?" és "*") támogatottak. Ha nincs megadva kulcs, a rendszer az összes tulajdonságot visszaadja.

Válaszok

Promise<ProjectProperty[]>

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

Szerezze be a szervezet összes olyan projektjét, amelyhez a hitelesített felhasználó hozzáfér.

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

Paraméterek

stateFilter

any

Szűrés egy adott csapatprojekt-állapotban lévő csapatprojektekre (alapértelmezett: WellFormed).

top

number

skip

number

continuationToken

number

Mutató, amely megmutatja, hogy hány projektet töltöttek be.

getDefaultTeamImageUrl

boolean

Válaszok

Promise<PagedList<TeamProjectReference>>

getProjectsProperties(string[], string[])

Csapatprojekt-tulajdonságok gyűjteményének lekérése több projekthez.

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

Paraméterek

projectIds

string[]

Vesszővel tagolt csapatprojekt-azonosítók sztringje

properties

string[]

Válaszok

Promise<ProjectProperties[]>

getProjectTeamsByCategory(string, boolean, number, number)

Lekéri a felhasználó által olvasható csapatok listáját egy projektben, és a csapatok felhasználója (kizárva az olvasható listából).

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

Paraméterek

projectId

string

A lekérni kívánt csapatokat tartalmazó csapatprojekt neve vagy azonosítója (GUID).

expandIdentity

boolean

Egy érték, amely azt jelzi, hogy ki kell-e bontani az identitásadatokat az eredmény WebApiTeam objektumában.

top

number

A visszaküldött csapatok maximális száma.

skip

number

Kihagyandó csapatok száma.

Válaszok

Promise<CategorizedWebApiTeams>

getProxies(string)

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

Paraméterek

proxyUrl

string

Válaszok

Promise<Proxy[]>

getTeam(string, string, boolean)

Szerezzen be egy adott csapatot.

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

Paraméterek

projectId

string

A csapatot tartalmazó csapatprojekt neve vagy azonosítója (GUID).

teamId

string

A csapat neve vagy azonosítója (GUID).

expandIdentity

boolean

Egy érték, amely azt jelzi, hogy ki kell-e bontani az identitásadatokat az eredmény WebApiTeam objektumában.

Válaszok

Promise<WebApiTeam>

getTeamMembersWithExtendedProperties(string, string, number, number)

Szerezze be egy adott csapat tagjainak listáját.

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

Paraméterek

projectId

string

Annak a csapatprojektnek a neve vagy azonosítója (GUID), amelyhez a csapat tartozik.

teamId

string

A csapat neve vagy azonosítója (GUID).

top

number

skip

number

Válaszok

Promise<TeamMember[]>

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

Szerezze be a csapatok listáját.

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

Paraméterek

projectId

string

mine

boolean

Ha igaz, akkor az összes lekérdező csapat tagja, ellenkező esetben az összes csapatfelhasználó olvasási hozzáféréssel rendelkezik.

top

number

A visszaküldött csapatok maximális száma.

skip

number

Kihagyandó csapatok száma.

expandIdentity

boolean

Egy érték, amely azt jelzi, hogy ki kell-e bontani az identitásadatokat az eredmény WebApiTeam objektumában.

Válaszok

Promise<WebApiTeam[]>

queueCreateProject(TeamProject)

Várólista egy létrehozandó projekt. A GetOperation használatával rendszeres időközönként ellenőrizze a projekt létrehozásának állapotát.

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

Paraméterek

projectToCreate

TeamProject

A létrehozandó projekt.

Válaszok

Promise<OperationReference>

queueDeleteProject(string)

Várólista egy törölendő projektet. A GetOperation használatával rendszeresen ellenőrizheti a projekt törlési állapotát.

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

Paraméterek

projectId

string

A törölni kívánt projekt projektazonosítója.

Válaszok

Promise<OperationReference>

removeProjectAvatar(string)

Eltávolítja a projekt avatarját.

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

Paraméterek

projectId

string

A projekt azonosítója vagy neve.

Válaszok

Promise<void>

setProjectAvatar(ProjectAvatar, string)

Beállítja a projekt avatarját.

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

Paraméterek

avatarBlob

ProjectAvatar

A feltölteni kívánt avatarblob-adatobjektum.

projectId

string

A projekt azonosítója vagy neve.

Válaszok

Promise<void>

setProjectProperties(string, JsonPatchDocument)

Csapatprojekt-tulajdonságok létrehozása, frissítése és törlése.

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

Paraméterek

projectId

string

A csapatprojekt azonosítója.

patchDocument

JsonPatchDocument

Egy JSON-javítási dokumentum, amely tulajdonságműveletek tömbjét jelöli. A JSON-javítással kapcsolatos további részletekért lásd az RFC 6902-t. Az elfogadott műveleti műveletek a Hozzáadás és az Eltávolítás, ahol a Hozzáadás a tulajdonságok létrehozására és frissítésére is használható. Az elérési út egy perjelből és egy tulajdonságnévből áll.

Válaszok

Promise<void>

updateIdentityMru(IdentityData, string)

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

Paraméterek

mruData

IdentityData

mruName

string

Válaszok

Promise<void>

updateProject(TeamProject, string)

Meglévő projekt nevének, rövidítésének, leírásának frissítése vagy visszaállítása.

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

Paraméterek

projectUpdate

TeamProject

A projekt frissítései. A projekt visszaállításához az állapotot wellForming-ra kell állítani.

projectId

string

A frissíteni kívánt projekt projektazonosítója.

Válaszok

Promise<OperationReference>

updateTeam(WebApiTeam, string, string)

Frissítse a csapat nevét és/vagy leírását.

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

Paraméterek

teamData

WebApiTeam

projectId

string

A frissíteni kívánt csapatot tartalmazó csapatprojekt neve vagy azonosítója (GUID).

teamId

string

A frissíteni kívánt csapat azonosítójának neve.

Válaszok

Promise<WebApiTeam>