CoreRestClient class

Paket:

azure-devops-extension-api

Basklass som ska användas (härledd från) för att göra begäranden till VSS REST-API:er

Extends

RestClientBase

Konstruktorer

CoreRestClient(IVssRestClientOptions)

Egenskaper

RESOURCE_AREA_ID

Metoder

createConnectedService(WebApiConnectedServiceDetails, string)
createIdentityMru(IdentityData, string)
createOrUpdateProxy(Proxy)
createTeam(WebApiTeam, string)	Skapa ett team i ett teamprojekt.
deleteIdentityMru(IdentityData, string)
deleteProxy(string, string)
deleteTeam(string, string)	Ta bort ett team.
getAllTeams(boolean, number, number, boolean)	Få en lista över alla lag.
getConnectedServiceDetails(string, string)
getConnectedServices(string, ConnectedServiceKind)
getIdentityMru(string)
getProcessById(string)	Hämta en process efter ID.
getProcesses()	Hämta en lista över processer.
getProject(string, boolean, boolean)	Hämta projektet med det angivna ID:t eller namnet, eventuellt inklusive funktioner.
getProjectCollection(string)	Hämta projektsamling med angivet ID eller namn.
getProjectCollections(number, number)	Hämta projektsamlingsreferenser för det här programmet.
getProjectHistoryEntries(number)	Hämtar historiken över ändringar i projektet.
getProjectProperties(string, string[])	Hämta en samling egenskaper för teamprojekt.
getProjects(any, number, number, number, boolean)	Hämta alla projekt i organisationen som den autentiserade användaren har åtkomst till.
getProjectsProperties(string[], string[])	Hämta en samling egenskaper för teamprojekt för flera projekt.
getProjectTeamsByCategory(string, boolean, number, number)	Hämtar en lista över användarläsbara team i ett projekt och team som användaren är medlem i (utesluten från läsbar lista).
getProxies(string)
getTeam(string, string, boolean)	Skaffa ett specifikt team.
getTeamMembersWithExtendedProperties(string, string, number, number)	Hämta en lista över medlemmar för ett visst team.
getTeams(string, boolean, number, number, boolean)	Hämta en lista över lag.
queueCreateProject(TeamProject)	Köar ett projekt som ska skapas. Använd GetOperation för att regelbundet söka efter status för att skapa projekt.
queueDeleteProject(string)	Köar ett projekt som ska tas bort. Använd GetOperation för att regelbundet söka efter status för borttagningsprojekt.
removeProjectAvatar(string)	Tar bort avataren för projektet.
setProjectAvatar(ProjectAvatar, string)	Ställer in avataren för projektet.
setProjectProperties(string, JsonPatchDocument)	Skapa, uppdatera och ta bort egenskaper för teamprojekt.
updateIdentityMru(IdentityData, string)
updateProject(TeamProject, string)	Uppdatera ett befintligt projekts namn, förkortning, beskrivning eller återställ ett projekt.
updateTeam(WebApiTeam, string, string)	Uppdatera ett lags namn och/eller beskrivning.

Konstruktorinformation

CoreRestClient(IVssRestClientOptions)

new CoreRestClient(options: IVssRestClientOptions)

Parametrar

options

IVssRestClientOptions

Egenskapsinformation

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Egenskapsvärde

string

Metodinformation

createConnectedService(WebApiConnectedServiceDetails, string)

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

Parametrar

connectedServiceCreationData

WebApiConnectedServiceDetails

projectId

string

Returer

Promise<WebApiConnectedService>

createIdentityMru(IdentityData, string)

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

Parametrar

mruData

IdentityData

mruName

string

Returer

Promise<void>

createOrUpdateProxy(Proxy)

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

Parametrar

proxy

Proxy

Returer

Promise<Proxy>

createTeam(WebApiTeam, string)

Skapa ett team i ett teamprojekt.

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

Parametrar

team

WebApiTeam

De teamdata som används för att skapa teamet.

projectId

string

Namnet eller ID:t (GUID) för det teamprojekt där teamet ska skapas.

Returer

Promise<WebApiTeam>

deleteIdentityMru(IdentityData, string)

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

Parametrar

mruData

IdentityData

mruName

string

Returer

Promise<void>

deleteProxy(string, string)

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

Parametrar

proxyUrl

string

site

string

Returer

Promise<void>

deleteTeam(string, string)

Ta bort ett team.

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

Parametrar

projectId

string

Namnet eller ID:t (GUID) för det teamprojekt som innehåller det team som ska tas bort.

teamId

string

Namnet eller ID:t för det team som ska tas bort.

Returer

Promise<void>

getAllTeams(boolean, number, number, boolean)

Få en lista över alla lag.

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

Parametrar

mine

boolean

Om det är sant returneras alla team som begär att användaren är medlem. Annars returneras alla teams användare har läsbehörighet.

top

number

Maximalt antal team som ska returneras.

skip

number

Antal team att hoppa över.

expandIdentity

boolean

Ett värde som anger om identitetsinformationen ska expanderas eller inte i det resulterande WebApiTeam-objektet.

Returer

Promise<WebApiTeam[]>

getConnectedServiceDetails(string, string)

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

Parametrar

projectId

string

name

string

Returer

Promise<WebApiConnectedServiceDetails>

getConnectedServices(string, ConnectedServiceKind)

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

Parametrar

projectId

string

kind

ConnectedServiceKind

Returer

Promise<WebApiConnectedService[]>

getIdentityMru(string)

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

Parametrar

mruName

string

Returer

Promise<IdentityRef[]>

getProcessById(string)

Hämta en process efter ID.

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

Parametrar

processId

string

ID för en process.

Returer

Promise<Process>

getProcesses()

Hämta en lista över processer.

function getProcesses(): Promise<Process[]>

Returer

Promise<Process[]>

getProject(string, boolean, boolean)

Hämta projektet med det angivna ID:t eller namnet, eventuellt inklusive funktioner.

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

Parametrar

projectId

string

includeCapabilities

boolean

Inkludera funktioner (till exempel källkontroll) i teamprojektets resultat (standard: falskt).

includeHistory

boolean

Sök i projekt som har bytt namn (som tidigare hade ett sådant namn).

Returer

Promise<TeamProject>

getProjectCollection(string)

Hämta projektsamling med angivet ID eller namn.

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

Parametrar

collectionId

string

Returer

Promise<TeamProjectCollection>

getProjectCollections(number, number)

Hämta projektsamlingsreferenser för det här programmet.

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

Parametrar

top

number

skip

number

Returer

Promise<TeamProjectCollectionReference[]>

getProjectHistoryEntries(number)

Hämtar historiken över ändringar i projektet.

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

Parametrar

minRevision

number

Det minsta revisionsnumret som ska returneras i historiken.

Returer

Promise<ProjectInfo[]>

getProjectProperties(string, string[])

Hämta en samling egenskaper för teamprojekt.

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

Parametrar

projectId

string

Teamets projekt-ID.

keys

string[]

En kommaavgränsad sträng med egenskapsnamn för teamprojekt. Jokertecken ("?" och "*") stöds. Om ingen nyckel anges returneras alla egenskaper.

Returer

Promise<ProjectProperty[]>

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

Hämta alla projekt i organisationen som den autentiserade användaren har åtkomst till.

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

Parametrar

stateFilter

any

Filtrera på teamprojekt i ett specifikt teamprojekttillstånd (standard: WellFormed).

top

number

skip

number

continuationToken

number

Pekare som visar hur många projekt som redan har hämtats.

getDefaultTeamImageUrl

boolean

Returer

Promise<PagedList<TeamProjectReference>>

getProjectsProperties(string[], string[])

Hämta en samling egenskaper för teamprojekt för flera projekt.

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

Parametrar

projectIds

string[]

En kommaavgränsad sträng med teamprojekt-ID:t

properties

string[]

Returer

Promise<ProjectProperties[]>

getProjectTeamsByCategory(string, boolean, number, number)

Hämtar en lista över användarläsbara team i ett projekt och team som användaren är medlem i (utesluten från läsbar lista).

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

Parametrar

projectId

string

Namnet eller ID:t (GUID) för det teamprojekt som innehåller de team som ska hämtas.

expandIdentity

boolean

Ett värde som anger om identitetsinformationen ska expanderas eller inte i det resulterande WebApiTeam-objektet.

top

number

Maximalt antal team som ska returneras.

skip

number

Antal team att hoppa över.

Returer

Promise<CategorizedWebApiTeams>

getProxies(string)

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

Parametrar

proxyUrl

string

Returer

Promise<Proxy[]>

getTeam(string, string, boolean)

Skaffa ett specifikt team.

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

Parametrar

projectId

string

Namnet eller ID:t (GUID) för det teamprojekt som innehåller teamet.

teamId

string

Teamets namn eller ID (GUID).

expandIdentity

boolean

Ett värde som anger om identitetsinformationen ska expanderas eller inte i det resulterande WebApiTeam-objektet.

Returer

Promise<WebApiTeam>

getTeamMembersWithExtendedProperties(string, string, number, number)

Hämta en lista över medlemmar för ett visst team.

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

Parametrar

projectId

string

Namnet eller ID:t (GUID) för det teamprojekt som teamet tillhör.

teamId

string

Teamets namn eller ID (GUID).

top

number

skip

number

Returer

Promise<TeamMember[]>

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

Hämta en lista över lag.

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

Parametrar

projectId

string

mine

boolean

Om true returnerar alla team som begär att användaren är medlem, annars returneras alla team som användaren har läsbehörighet.

top

number

Maximalt antal team som ska returneras.

skip

number

Antal team att hoppa över.

expandIdentity

boolean

Ett värde som anger om identitetsinformationen ska expanderas eller inte i det resulterande WebApiTeam-objektet.

Returer

Promise<WebApiTeam[]>

queueCreateProject(TeamProject)

Köar ett projekt som ska skapas. Använd GetOperation för att regelbundet söka efter status för att skapa projekt.

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

Parametrar

projectToCreate

TeamProject

Projektet som ska skapas.

Returer

Promise<OperationReference>

queueDeleteProject(string)

Köar ett projekt som ska tas bort. Använd GetOperation för att regelbundet söka efter status för borttagningsprojekt.

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

Parametrar

projectId

string

Projekt-ID för det projekt som ska tas bort.

Returer

Promise<OperationReference>

removeProjectAvatar(string)

Tar bort avataren för projektet.

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

Parametrar

projectId

string

ID eller namn på projektet.

Returer

Promise<void>

setProjectAvatar(ProjectAvatar, string)

Ställer in avataren för projektet.

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

Parametrar

avatarBlob

ProjectAvatar

Det avatar blob data-objekt som ska laddas upp.

projectId

string

ID eller namn på projektet.

Returer

Promise<void>

setProjectProperties(string, JsonPatchDocument)

Skapa, uppdatera och ta bort egenskaper för teamprojekt.

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

Parametrar

projectId

string

Teamets projekt-ID.

patchDocument

JsonPatchDocument

Ett JSON Patch-dokument som representerar en matris med egenskapsåtgärder. Se RFC 6902 för mer information om JSON Patch. De godkända åtgärdsverben är Lägg till och Ta bort, där Lägg till används för att både skapa och uppdatera egenskaper. Sökvägen består av ett snedstreck och ett egenskapsnamn.

Returer

Promise<void>

updateIdentityMru(IdentityData, string)

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

Parametrar

mruData

IdentityData

mruName

string

Returer

Promise<void>

updateProject(TeamProject, string)

Uppdatera ett befintligt projekts namn, förkortning, beskrivning eller återställ ett projekt.

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

Parametrar

projectUpdate

TeamProject

Uppdateringarna för projektet. Tillståndet måste anges till wellFormed för att återställa projektet.

projectId

string

Projekt-ID för det projekt som ska uppdateras.

Returer

Promise<OperationReference>

updateTeam(WebApiTeam, string, string)

Uppdatera ett lags namn och/eller beskrivning.

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

Parametrar

teamData

WebApiTeam

projectId

string

Namnet eller ID:t (GUID) för det teamprojekt som innehåller det team som ska uppdateras.

teamId

string

Namnet på ID:t för det team som ska uppdateras.

Returer

Promise<WebApiTeam>