CoreRestClient class

Csomag:

azure-devops-extension-api

Alaposztály, amelyet a VSS REST API-k kéréseinek igényléséhez (származtatása) 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)	Csapat létrehozása csapatprojektben.
deleteIdentityMru(IdentityData, string)
deleteProxy(string, string)
deleteTeam(string, string)	Csapat törlése.
getAllTeams(boolean, number, number, boolean)	Az összes csapat listájának lekérése.
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)	Kérje le a projektet a megadott azonosítóval vagy névvel, opcionálisan a képességeket is beleértve.
getProjectCollection(string)	Projektgyűjtemény lekérése a megadott azonosítóval vagy névvel.
getProjectCollections(number, number)	Projektgyűjtemény-referenciák lekérése ehhez az alkalmazáshoz.
getProjectHistoryEntries(number)	Lekéri a projekt módosításainak előzményeit.
getProjectProperties(string, string[])	Csoportprojekt-tulajdonságok gyűjteményének lekérése.
getProjects(any, number, number, number, boolean)	Szerezze be a szervezet azon projektjeit, amelyekhez a hitelesített felhasználó hozzáféréssel rendelkezik.
getProjectsProperties(string[], string[])	Csapatprojekt-tulajdonságok gyűjteményének lekérése több projekthez.
getProjectTeamsByCategory(string, boolean, number, number)	Lekéri a projekt felhasználó által olvasható csapatainak listáját, és a teams felhasználó tagja (kivéve az olvasható listából).
getProxies(string)
getTeam(string, string, boolean)	Hozzon létre egy adott csapatot.
getTeamMembersWithExtendedProperties(string, string, number, number)	Egy adott csapat tagjainak listájának lekérése.
getTeams(string, boolean, number, number, boolean)	A csapatok listájának lekérése.
queueCreateProject(TeamProject)	Várólistára helyez egy létrehozandó projektet. 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ólistára helyez egy törölni kívánt projektet. A GetOperation használatával rendszeres időközönként ellenőrizheti a projektállapot törlését.
removeProjectAvatar(string)	Eltávolítja a projekt avatarját.
setProjectAvatar(ProjectAvatar, string)	Beállítja a projekt avatarját.
setProjectProperties(string, JsonPatchDocument)	Csoportprojekt-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 vagy visszaállításának frissítése.
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)

Csapat létrehozása 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 szeretné 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)

Az összes csapat listájának lekérése.

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

Paraméterek

mine

boolean

Ha igaz, akkor adja vissza a felhasználót kérő összes csapatot. Ellenkező esetben adja vissza az összes olyan teams-felhasználót, aki 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 szeretné-e bontani az identitásadatokat az eredményként kapott WebApiTeam objektumban.

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

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)

Kérje le a projektet a megadott azonosítóval vagy névvel, opcionálisan a képességeket is beleértve.

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

Paraméterek

projectId

string

includeCapabilities

boolean

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

includeHistory

boolean

Keressen az átnevezett projekteken belül (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-referenciák 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 módosítá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[])

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

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

Paraméterek

projectId

string

A csapat projektazonosítója.

keys

string[]

Csapatprojektek tulajdonságneveinek vesszővel tagolt sztringje. A helyettesítő karakterek ("?" és "*") támogatottak. Ha nincs megadva kulcs, a rendszer minden tulajdonságot visszaad.

Válaszok

Promise<ProjectProperty[]>

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

Szerezze be a szervezet azon projektjeit, amelyekhez a hitelesített felhasználó hozzáféréssel rendelkezik.

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

Paraméterek

stateFilter

any

Szűrjön a csapatprojektekre egy adott csapatprojekt-állapotban (alapértelmezett: WellFormed).

top

number

skip

number

continuationToken

number

Mutató, amely azt mutatja, hogy hány projekt lett már beolvasva.

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[]

Csapatprojekt-azonosítók vesszővel tagolt sztringje

properties

string[]

Válaszok

Promise<ProjectProperties[]>

getProjectTeamsByCategory(string, boolean, number, number)

Lekéri a projekt felhasználó által olvasható csapatainak listáját, és a teams felhasználó tagja (kivéve 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 csapatprojekt neve vagy azonosítója (GUID).

expandIdentity

boolean

Egy érték, amely azt jelzi, hogy ki szeretné-e bontani az identitásadatokat az eredményként kapott WebApiTeam objektumban.

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)

Hozzon létre 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 szeretné-e bontani az identitásadatokat az eredményként kapott WebApiTeam objektumban.

Válaszok

Promise<WebApiTeam>

getTeamMembersWithExtendedProperties(string, string, number, number)

Egy adott csapat tagjainak listájának lekérése.

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)

A csapatok listájának lekérése.

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

Paraméterek

projectId

string

mine

boolean

Ha igaz, akkor a felhasználót kérő összes csapattagot adja vissza, ellenkező esetben az összes olvasási hozzáféréssel rendelkező teams-felhasználót adja vissza.

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 szeretné-e bontani az identitásadatokat az eredményként kapott WebApiTeam objektumban.

Válaszok

Promise<WebApiTeam[]>

queueCreateProject(TeamProject)

Várólistára helyez egy létrehozandó projektet. 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ólistára helyez egy törölni kívánt projektet. A GetOperation használatával rendszeres időközönként ellenőrizheti a projektállapot törlésé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öltendő avatar blobadat-objektum.

projectId

string

A projekt azonosítója vagy neve.

Válaszok

Promise<void>

setProjectProperties(string, JsonPatchDocument)

Csoportprojekt-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 csapat projektazonosítója.

patchDocument

JsonPatchDocument

JSON Patch-dokumentum, amely tulajdonságműveletek tömbje. A JSON-javításról további információt az RFC 6902-ben talál. Az elfogadott műveleti műveletek a Hozzáadás és eltávolítás, ahol a Hozzáadás a tulajdonságok létrehozására és frissítésére egyaránt 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 vagy visszaállításának frissítése.

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 megfelelően Formázva értékre 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ó csoportprojekt neve vagy azonosítója (GUID).

teamId

string

A frissíteni kívánt csapat azonosítója.

Válaszok

Promise<WebApiTeam>