CoreRestClient class

Pacchetto:

azure-devops-extension-api

Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST di VSS

Extends

RestClientBase

Costruttori

CoreRestClient(IVssRestClientOptions)

Proprietà

RESOURCE_AREA_ID

Metodi

createConnectedService(WebApiConnectedServiceDetails, string)
createIdentityMru(IdentityData, string)
createOrUpdateProxy(Proxy)
createTeam(WebApiTeam, string)	Creare un team in un progetto team.
deleteIdentityMru(IdentityData, string)
deleteProxy(string, string)
deleteTeam(string, string)	Eliminare un team.
getAllTeams(boolean, number, number, boolean)	Ottenere un elenco di tutti i team.
getConnectedServiceDetails(string, string)
getConnectedServices(string, ConnectedServiceKind)
getIdentityMru(string)
getProcessById(string)	Ottenere un processo in base all'ID.
getProcesses()	Ottenere un elenco di processi.
getProject(string, boolean, boolean)	Ottenere il progetto con l'ID o il nome specificati, incluse facoltativamente le funzionalità.
getProjectCollection(string)	Ottiene la raccolta di progetti con l'ID o il nome specificati.
getProjectCollections(number, number)	Ottenere i riferimenti alla raccolta di progetti per questa applicazione.
getProjectHistoryEntries(number)	Ottiene la cronologia delle modifiche apportate al progetto.
getProjectProperties(string, string[])	Ottenere una raccolta di proprietà del progetto team.
getProjects(any, number, number, number, boolean)	Ottenere tutti i progetti nell'organizzazione a cui l'utente autenticato ha accesso.
getProjectsProperties(string[], string[])	Ottenere una raccolta di proprietà del progetto team per più progetti.
getProjectTeamsByCategory(string, boolean, number, number)	Ottiene l'elenco dei team leggibili dall'utente in un progetto e l'utente di teams è membro di (escluso dall'elenco leggibile).
getProxies(string)
getTeam(string, string, boolean)	Ottenere un team specifico.
getTeamMembersWithExtendedProperties(string, string, number, number)	Ottenere un elenco di membri per un team specifico.
getTeams(string, boolean, number, number, boolean)	Ottenere un elenco di team.
queueCreateProject(TeamProject)	Accoda un progetto da creare. Usare GetOperation per controllare periodicamente lo stato del progetto.
queueDeleteProject(string)	Accoda un progetto da eliminare. Usare GetOperation per controllare periodicamente lo stato del progetto di eliminazione.
removeProjectAvatar(string)	Rimuove l'avatar per il progetto.
setProjectAvatar(ProjectAvatar, string)	Imposta l'avatar per il progetto.
setProjectProperties(string, JsonPatchDocument)	Creare, aggiornare ed eliminare le proprietà del progetto team.
updateIdentityMru(IdentityData, string)
updateProject(TeamProject, string)	Aggiornare il nome, l'abbreviazione, l'abbreviazione, la descrizione o il ripristino di un progetto esistente.
updateTeam(WebApiTeam, string, string)	Aggiornare il nome e/o la descrizione di un team.

Dettagli costruttore

CoreRestClient(IVssRestClientOptions)

new CoreRestClient(options: IVssRestClientOptions)

Parametri

options

IVssRestClientOptions

Dettagli proprietà

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valore della proprietà

string

Dettagli metodo

createConnectedService(WebApiConnectedServiceDetails, string)

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

Parametri

connectedServiceCreationData

WebApiConnectedServiceDetails

projectId

string

Restituisce

Promise<WebApiConnectedService>

createIdentityMru(IdentityData, string)

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

Parametri

mruData

IdentityData

mruName

string

Restituisce

Promise<void>

createOrUpdateProxy(Proxy)

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

Parametri

proxy

Proxy

Restituisce

Promise<Proxy>

createTeam(WebApiTeam, string)

Creare un team in un progetto team.

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

Parametri

team

WebApiTeam

Dati del team usati per creare il team.

projectId

string

Nome o ID (GUID) del progetto team in cui creare il team.

Restituisce

Promise<WebApiTeam>

deleteIdentityMru(IdentityData, string)

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

Parametri

mruData

IdentityData

mruName

string

Restituisce

Promise<void>

deleteProxy(string, string)

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

Parametri

proxyUrl

string

site

string

Restituisce

Promise<void>

deleteTeam(string, string)

Eliminare un team.

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

Parametri

projectId

string

Nome o ID (GUID) del progetto team contenente il team da eliminare.

teamId

string

Nome o ID del team da eliminare.

Restituisce

Promise<void>

getAllTeams(boolean, number, number, boolean)

Ottenere un elenco di tutti i team.

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

Parametri

mine

boolean

Se true, restituire tutti i team che richiedono che l'utente sia membro. In caso contrario, restituire l'accesso in lettura a tutti gli utenti di Teams.

top

number

Numero massimo di team da restituire.

skip

number

Numero di team da ignorare.

expandIdentity

boolean

Valore che indica se espandere o meno le informazioni sull'identità nell'oggetto WebApiTeam risultante.

Restituisce

Promise<WebApiTeam[]>

getConnectedServiceDetails(string, string)

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

Parametri

projectId

string

name

string

Restituisce

Promise<WebApiConnectedServiceDetails>

getConnectedServices(string, ConnectedServiceKind)

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

Parametri

projectId

string

kind

ConnectedServiceKind

Restituisce

Promise<WebApiConnectedService[]>

getIdentityMru(string)

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

Parametri

mruName

string

Restituisce

Promise<IdentityRef[]>

getProcessById(string)

Ottenere un processo in base all'ID.

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

Parametri

processId

string

ID per un processo.

Restituisce

Promise<Process>

getProcesses()

Ottenere un elenco di processi.

function getProcesses(): Promise<Process[]>

Restituisce

Promise<Process[]>

getProject(string, boolean, boolean)

Ottenere il progetto con l'ID o il nome specificati, incluse facoltativamente le funzionalità.

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

Parametri

projectId

string

includeCapabilities

boolean

Includere funzionalità (ad esempio il controllo del codice sorgente) nel risultato del progetto team (impostazione predefinita: false).

includeHistory

boolean

Eseguire ricerche all'interno di progetti rinominati ( che in passato avevano tale nome).

Restituisce

Promise<TeamProject>

getProjectCollection(string)

Ottiene la raccolta di progetti con l'ID o il nome specificati.

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

Parametri

collectionId

string

Restituisce

Promise<TeamProjectCollection>

getProjectCollections(number, number)

Ottenere i riferimenti alla raccolta di progetti per questa applicazione.

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

Parametri

top

number

skip

number

Restituisce

Promise<TeamProjectCollectionReference[]>

getProjectHistoryEntries(number)

Ottiene la cronologia delle modifiche apportate al progetto.

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

Parametri

minRevision

number

Numero di revisione minimo da restituire nella cronologia.

Restituisce

Promise<ProjectInfo[]>

getProjectProperties(string, string[])

Ottenere una raccolta di proprietà del progetto team.

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

Parametri

projectId

string

ID progetto team.

keys

string[]

Stringa delimitata da virgole dei nomi delle proprietà del progetto team. Sono supportati i caratteri jolly ("?" e "*"). Se non viene specificata alcuna chiave, verranno restituite tutte le proprietà.

Restituisce

Promise<ProjectProperty[]>

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

Ottenere tutti i progetti nell'organizzazione a cui l'utente autenticato ha accesso.

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

Parametri

stateFilter

any

Filtrare i progetti team in uno stato specifico del progetto team (impostazione predefinita: WellFormed).

top

number

skip

number

continuationToken

number

Puntatore che mostra il numero di progetti già recuperati.

getDefaultTeamImageUrl

boolean

Restituisce

Promise<PagedList<TeamProjectReference>>

getProjectsProperties(string[], string[])

Ottenere una raccolta di proprietà del progetto team per più progetti.

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

Parametri

projectIds

string[]

Stringa delimitata da virgole di ID progetto team

properties

string[]

Restituisce

Promise<ProjectProperties[]>

getProjectTeamsByCategory(string, boolean, number, number)

Ottiene l'elenco dei team leggibili dall'utente in un progetto e l'utente di teams è membro di (escluso dall'elenco leggibile).

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

Parametri

projectId

string

Nome o ID (GUID) del progetto team contenente i team da recuperare.

expandIdentity

boolean

Valore che indica se espandere o meno le informazioni sull'identità nell'oggetto WebApiTeam risultante.

top

number

Numero massimo di team da restituire.

skip

number

Numero di team da ignorare.

Restituisce

Promise<CategorizedWebApiTeams>

getProxies(string)

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

Parametri

proxyUrl

string

Restituisce

Promise<Proxy[]>

getTeam(string, string, boolean)

Ottenere un team specifico.

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

Parametri

projectId

string

Nome o ID (GUID) del progetto team contenente il team.

teamId

string

Nome o ID (GUID) del team.

expandIdentity

boolean

Valore che indica se espandere o meno le informazioni sull'identità nell'oggetto WebApiTeam risultante.

Restituisce

Promise<WebApiTeam>

getTeamMembersWithExtendedProperties(string, string, number, number)

Ottenere un elenco di membri per un team specifico.

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

Parametri

projectId

string

Nome o ID (GUID) del progetto team a cui appartiene il team.

teamId

string

Nome o ID (GUID) del team.

top

number

skip

number

Restituisce

Promise<TeamMember[]>

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

Ottenere un elenco di team.

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

Parametri

projectId

string

mine

boolean

Se true restituisce tutti i team che richiedono che l'utente sia membro, in caso contrario restituisce l'accesso in lettura a tutti gli utenti di teams.

top

number

Numero massimo di team da restituire.

skip

number

Numero di team da ignorare.

expandIdentity

boolean

Valore che indica se espandere informazioni sull'identità nell'oggetto WebApiTeam risultante.

Restituisce

Promise<WebApiTeam[]>

queueCreateProject(TeamProject)

Accoda un progetto da creare. Usare GetOperation per controllare periodicamente lo stato del progetto.

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

Parametri

projectToCreate

TeamProject

Progetto da creare.

Restituisce

Promise<OperationReference>

queueDeleteProject(string)

Accoda un progetto da eliminare. Usare GetOperation per controllare periodicamente lo stato del progetto di eliminazione.

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

Parametri

projectId

string

ID progetto del progetto da eliminare.

Restituisce

Promise<OperationReference>

removeProjectAvatar(string)

Rimuove l'avatar per il progetto.

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

Parametri

projectId

string

ID o nome del progetto.

Restituisce

Promise<void>

setProjectAvatar(ProjectAvatar, string)

Imposta l'avatar per il progetto.

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

Parametri

avatarBlob

ProjectAvatar

Oggetto dati BLOB avatar da caricare.

projectId

string

ID o nome del progetto.

Restituisce

Promise<void>

setProjectProperties(string, JsonPatchDocument)

Creare, aggiornare ed eliminare le proprietà del progetto team.

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

Parametri

projectId

string

ID progetto team.

patchDocument

JsonPatchDocument

Documento di patch JSON che rappresenta una matrice di operazioni di proprietà. Per altre informazioni su Patch JSON, vedere RFC 6902. I verbi dell'operazione accettati sono Add and Remove, dove Add viene usato per la creazione e l'aggiornamento delle proprietà. Il percorso è costituito da una barra in avanti e da un nome di proprietà.

Restituisce

Promise<void>

updateIdentityMru(IdentityData, string)

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

Parametri

mruData

IdentityData

mruName

string

Restituisce

Promise<void>

updateProject(TeamProject, string)

Aggiornare il nome, l'abbreviazione, l'abbreviazione, la descrizione o il ripristino di un progetto esistente.

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

Parametri

projectUpdate

TeamProject

Aggiornamenti per il progetto. Lo stato deve essere impostato su wellFormed per ripristinare il progetto.

projectId

string

ID progetto del progetto da aggiornare.

Restituisce

Promise<OperationReference>

updateTeam(WebApiTeam, string, string)

Aggiornare il nome e/o la descrizione di un team.

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

Parametri

teamData

WebApiTeam

projectId

string

Nome o ID (GUID) del progetto team contenente il team da aggiornare.

teamId

string

Nome dell'ID del team da aggiornare.

Restituisce

Promise<WebApiTeam>