CoreRestClient class

Paquet:

azure-devops-extension-api

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des API REST VSS

Extends

RestClientBase

Constructeurs

CoreRestClient(IVssRestClientOptions)

Propriétés

RESOURCE_AREA_ID

Méthodes

createConnectedService(WebApiConnectedServiceDetails, string)
createIdentityMru(IdentityData, string)
createOrUpdateProxy(Proxy)
createTeam(WebApiTeam, string)	Créez une équipe dans un projet d’équipe.
deleteIdentityMru(IdentityData, string)
deleteProxy(string, string)
deleteTeam(string, string)	Supprimer une équipe.
getAllTeams(boolean, number, number, boolean)	Obtenez une liste de toutes les équipes.
getConnectedServiceDetails(string, string)
getConnectedServices(string, ConnectedServiceKind)
getIdentityMru(string)
getProcessById(string)	Obtenir un processus par ID.
getProcesses()	Obtenez une liste des processus.
getProject(string, boolean, boolean)	Obtenir le projet avec l’ID ou le nom spécifié, y compris éventuellement les fonctionnalités.
getProjectCollection(string)	Obtenir la collection de projets avec l’ID ou le nom spécifié.
getProjectCollections(number, number)	Obtenez des références de collection de projets pour cette application.
getProjectHistoryEntries(number)	Obtient l’historique des modifications apportées au projet.
getProjectProperties(string, string[])	Obtenez une collection de propriétés de projet d’équipe.
getProjects(any, number, number, number, boolean)	Récupérez tous les projets de l’organisation auxquels l’utilisateur authentifié a accès.
getProjectsProperties(string[], string[])	Obtenez une collection de propriétés de projet d’équipe pour plusieurs projets.
getProjectTeamsByCategory(string, boolean, number, number)	Obtient la liste des équipes lisibles par l’utilisateur dans un projet et des équipes dont l’utilisateur est membre (exclu de la liste lisible).
getProxies(string)
getTeam(string, string, boolean)	Obtenez une équipe spécifique.
getTeamMembersWithExtendedProperties(string, string, number, number)	Obtenez une liste des membres d’une équipe spécifique.
getTeams(string, boolean, number, number, boolean)	Obtenez une liste des équipes.
queueCreateProject(TeamProject)	Met en file d’attente un projet à créer. Utilisez GetOperation pour vérifier régulièrement l’état de la création de projet.
queueDeleteProject(string)	Met en file d’attente un projet à supprimer. Utilisez GetOperation pour vérifier régulièrement l’état du projet de suppression.
removeProjectAvatar(string)	Supprime l’avatar du projet.
setProjectAvatar(ProjectAvatar, string)	Définit l’avatar du projet.
setProjectProperties(string, JsonPatchDocument)	Créez, mettez à jour et supprimez les propriétés d’un projet d’équipe.
updateIdentityMru(IdentityData, string)
updateProject(TeamProject, string)	Mettez à jour le nom, l’abréviation, la description d’un projet existant ou restaurez un projet.
updateTeam(WebApiTeam, string, string)	Mettre à jour le nom et/ou la description d’une équipe.

Détails du constructeur

CoreRestClient(IVssRestClientOptions)

new CoreRestClient(options: IVssRestClientOptions)

Paramètres

options

IVssRestClientOptions

Détails de la propriété

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valeur de propriété

string

Détails de la méthode

createConnectedService(WebApiConnectedServiceDetails, string)

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

Paramètres

connectedServiceCreationData

WebApiConnectedServiceDetails

projectId

string

Retours

Promise<WebApiConnectedService>

createIdentityMru(IdentityData, string)

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

Paramètres

mruData

IdentityData

mruName

string

Retours

Promise<void>

createOrUpdateProxy(Proxy)

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

Paramètres

proxy

Proxy

Retours

Promise<Proxy>

createTeam(WebApiTeam, string)

Créez une équipe dans un projet d’équipe.

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

Paramètres

team

WebApiTeam

Les données de l’équipe utilisées pour créer l’équipe.

projectId

string

Nom ou ID (GUID) du projet d’équipe dans lequel créer l’équipe.

Retours

Promise<WebApiTeam>

deleteIdentityMru(IdentityData, string)

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

Paramètres

mruData

IdentityData

mruName

string

Retours

Promise<void>

deleteProxy(string, string)

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

Paramètres

proxyUrl

string

site

string

Retours

Promise<void>

deleteTeam(string, string)

Supprimer une équipe.

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

Paramètres

projectId

string

Nom ou ID (GUID) du projet d’équipe contenant l’équipe à supprimer.

teamId

string

Nom ou ID de l’équipe à supprimer.

Retours

Promise<void>

getAllTeams(boolean, number, number, boolean)

Obtenez une liste de toutes les équipes.

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

Paramètres

mine

boolean

Si true, renvoie toutes les équipes demandant que l’utilisateur est membre. Sinon, renvoyez tous les utilisateurs de l’équipe en lecture.

top

number

Nombre maximal d’équipes à retourner.

skip

number

Nombre d’équipes à ignorer.

expandIdentity

boolean

Valeur indiquant s’il faut ou non développer les informations d’identité dans l’objet WebApiTeam résultant.

Retours

Promise<WebApiTeam[]>

getConnectedServiceDetails(string, string)

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

Paramètres

projectId

string

name

string

Retours

Promise<WebApiConnectedServiceDetails>

getConnectedServices(string, ConnectedServiceKind)

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

Paramètres

projectId

string

kind

ConnectedServiceKind

Retours

Promise<WebApiConnectedService[]>

getIdentityMru(string)

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

Paramètres

mruName

string

Retours

Promise<IdentityRef[]>

getProcessById(string)

Obtenir un processus par ID.

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

Paramètres

processId

string

ID d’un processus.

Retours

Promise<Process>

getProcesses()

Obtenez une liste des processus.

function getProcesses(): Promise<Process[]>

Retours

Promise<Process[]>

getProject(string, boolean, boolean)

Obtenir le projet avec l’ID ou le nom spécifié, y compris éventuellement les fonctionnalités.

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

Paramètres

projectId

string

includeCapabilities

boolean

Inclure des fonctionnalités (telles que le contrôle de code source) dans le résultat du projet d’équipe (par défaut : false).

includeHistory

boolean

Effectuez une recherche dans des projets renommés (qui avaient un tel nom dans le passé).

Retours

Promise<TeamProject>

getProjectCollection(string)

Obtenir la collection de projets avec l’ID ou le nom spécifié.

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

Paramètres

collectionId

string

Retours

Promise<TeamProjectCollection>

getProjectCollections(number, number)

Obtenez des références de collection de projets pour cette application.

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

Paramètres

top

number

skip

number

Retours

Promise<TeamProjectCollectionReference[]>

getProjectHistoryEntries(number)

Obtient l’historique des modifications apportées au projet.

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

Paramètres

minRevision

number

Numéro de révision minimum à renvoyer dans l’historique.

Retours

Promise<ProjectInfo[]>

getProjectProperties(string, string[])

Obtenez une collection de propriétés de projet d’équipe.

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

Paramètres

projectId

string

L’ID du projet d’équipe.

keys

string[]

Chaîne de noms de propriétés de projet d’équipe séparés par des virgules. Les caractères génériques (« ? » et « * ») sont pris en charge. Si aucune clé n’est spécifiée, toutes les propriétés seront renvoyées.

Retours

Promise<ProjectProperty[]>

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

Récupérez tous les projets de l’organisation auxquels l’utilisateur authentifié a accès.

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

Paramètres

stateFilter

any

Filtrez sur les projets d’équipe dans un état de projet d’équipe spécifique (par défaut : WellFormed).

top

number

skip

number

continuationToken

number

Pointeur qui indique combien de projets ont déjà été récupérés.

getDefaultTeamImageUrl

boolean

Retours

Promise<PagedList<TeamProjectReference>>

getProjectsProperties(string[], string[])

Obtenez une collection de propriétés de projet d’équipe pour plusieurs projets.

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

Paramètres

projectIds

string[]

Une chaîne d’ID de projet d’équipe délimitée par des virgules

properties

string[]

Retours

Promise<ProjectProperties[]>

getProjectTeamsByCategory(string, boolean, number, number)

Obtient la liste des équipes lisibles par l’utilisateur dans un projet et des équipes dont l’utilisateur est membre (exclu de la liste lisible).

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

Paramètres

projectId

string

Nom ou ID (GUID) du projet d’équipe contenant les équipes à récupérer.

expandIdentity

boolean

Valeur indiquant s’il faut ou non développer les informations d’identité dans l’objet WebApiTeam résultant.

top

number

Nombre maximal d’équipes à retourner.

skip

number

Nombre d’équipes à ignorer.

Retours

Promise<CategorizedWebApiTeams>

getProxies(string)

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

Paramètres

proxyUrl

string

Retours

Promise<Proxy[]>

getTeam(string, string, boolean)

Obtenez une équipe spécifique.

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

Paramètres

projectId

string

Nom ou ID (GUID) du projet d’équipe contenant l’équipe.

teamId

string

Nom ou ID (GUID) de l’équipe.

expandIdentity

boolean

Valeur indiquant s’il faut ou non développer les informations d’identité dans l’objet WebApiTeam résultant.

Retours

Promise<WebApiTeam>

getTeamMembersWithExtendedProperties(string, string, number, number)

Obtenez une liste des membres d’une équipe spécifique.

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

Paramètres

projectId

string

Nom ou ID (GUID) du projet d’équipe auquel l’équipe appartient.

teamId

string

Nom ou ID (GUID) de l’équipe.

top

number

skip

number

Retours

Promise<TeamMember[]>

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

Obtenez une liste des équipes.

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

Paramètres

projectId

string

mine

boolean

Si true, renvoyez toutes les équipes qui demandent l’utilisateur est membre, sinon renvoyez toutes les équipes dont l’utilisateur dispose d’un accès en lecture.

top

number

Nombre maximal d’équipes à retourner.

skip

number

Nombre d’équipes à ignorer.

expandIdentity

boolean

Valeur indiquant s’il faut ou non développer les informations d’identité dans l’objet WebApiTeam résultant.

Retours

Promise<WebApiTeam[]>

queueCreateProject(TeamProject)

Met en file d’attente un projet à créer. Utilisez GetOperation pour vérifier régulièrement l’état de la création de projet.

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

Paramètres

projectToCreate

TeamProject

Le projet à créer.

Retours

Promise<OperationReference>

queueDeleteProject(string)

Met en file d’attente un projet à supprimer. Utilisez GetOperation pour vérifier régulièrement l’état du projet de suppression.

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

Paramètres

projectId

string

L’identifiant du projet à supprimer.

Retours

Promise<OperationReference>

removeProjectAvatar(string)

Supprime l’avatar du projet.

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

Paramètres

projectId

string

L’ID ou le nom du projet.

Retours

Promise<void>

setProjectAvatar(ProjectAvatar, string)

Définit l’avatar du projet.

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

Paramètres

avatarBlob

ProjectAvatar

L’objet de données blob d’avatar à télécharger.

projectId

string

L’ID ou le nom du projet.

Retours

Promise<void>

setProjectProperties(string, JsonPatchDocument)

Créez, mettez à jour et supprimez les propriétés d’un projet d’équipe.

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

Paramètres

projectId

string

L’ID du projet d’équipe.

patchDocument

JsonPatchDocument

Document JSON Patch qui représente un tableau d’opérations de propriété. Voir la RFC 6902 pour plus de détails sur le correctif JSON. Les verbes d’opération acceptés sont Add et Remove, où Add est utilisé pour la création et la mise à jour des propriétés. Le chemin d’accès se compose d’une barre oblique et d’un nom de propriété.

Retours

Promise<void>

updateIdentityMru(IdentityData, string)

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

Paramètres

mruData

IdentityData

mruName

string

Retours

Promise<void>

updateProject(TeamProject, string)

Mettez à jour le nom, l’abréviation, la description d’un projet existant ou restaurez un projet.

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

Paramètres

projectUpdate

TeamProject

Les mises à jour du projet. L’état doit être défini sur wellFormed pour restaurer le projet.

projectId

string

L’identifiant du projet à mettre à jour.

Retours

Promise<OperationReference>

updateTeam(WebApiTeam, string, string)

Mettre à jour le nom et/ou la description d’une équipe.

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

Paramètres

teamData

WebApiTeam

projectId

string

Nom ou ID (GUID) du projet d’équipe contenant l’équipe à mettre à jour.

teamId

string

Le nom de l’ID de l’équipe à mettre à jour.

Retours

Promise<WebApiTeam>