Partager via

ExtensionManagementRestClient class

  • Référence
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

ExtensionManagementRestClient(IVssRestClientOptions)

Propriétés

RESOURCE_AREA_ID

Méthodes

createDocumentByName(any, string, string, string, string, string)
deleteDocumentByName(string, string, string, string, string, string)
deleteRequest(string, string)
getAcquisitionOptions(string, boolean, boolean, boolean, boolean, boolean, boolean)

Cette API est appelée par la page d’acquisition/installation pour obtenir des actions utilisateur possibles telles que Acheter/Demander
getAuditLog(string, string)
getDocumentByName(string, string, string, string, string, string)
getDocumentsByName(string, string, string, string, string)
getInstalledExtensionByName(string, string, string[])

Obtenez une extension installée par son éditeur et son nom d’extension.
getInstalledExtensions(boolean, boolean, string[], boolean)

Répertoriez les extensions installées dans la collection de comptes/projets.
getPolicies(string)
getRequests()
getStates(boolean, boolean, boolean, boolean)

Répertoriez les informations d’état et de version pour toutes les extensions installées.
getToken()
installExtensionByName(string, string, string)

Installez l’extension spécifiée dans la collection de comptes/projets.
queryCollectionsByName(ExtensionDataCollectionQuery, string, string)

Recherchez une ou plusieurs collections de données pour l’extension spécifiée. Remarque : le jeton utilisé pour l’autorisation doit avoir été émis pour le compte de l’extension spécifiée.
queryExtensions(InstalledExtensionQuery)
registerAuthorization(string, string, string)
requestAcquisition(ExtensionAcquisitionRequest)
requestExtension(string, string, string)
resolveAllRequests(string, string, string, ExtensionRequestState)
resolveRequest(string, string, string, string, ExtensionRequestState)
setDocumentByName(any, string, string, string, string, string)
uninstallExtensionByName(string, string, string, string)

Désinstallez l’extension spécifiée de la collection compte/projet.
updateDocumentByName(any, string, string, string, string, string)
updateInstalledExtension(InstalledExtension)

Mettez à jour une extension installée. En règle générale, cette API est utilisée pour activer ou désactiver une extension.

Détails du constructeur

ExtensionManagementRestClient(IVssRestClientOptions) 

new ExtensionManagementRestClient(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

createDocumentByName(any, string, string, string, string, string) 

function createDocumentByName(doc: any, publisherName: string, extensionName: string, scopeType: string, scopeValue: string, collectionName: string): Promise<any>

Paramètres

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Retours

Promise<any>

deleteDocumentByName(string, string, string, string, string, string) 

function deleteDocumentByName(publisherName: string, extensionName: string, scopeType: string, scopeValue: string, collectionName: string, documentId: string): Promise<void>

Paramètres

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

documentId

string

Retours

Promise<void>

deleteRequest(string, string) 

function deleteRequest(publisherName: string, extensionName: string): Promise<void>

Paramètres

publisherName

string

extensionName

string

Retours

Promise<void>

getAcquisitionOptions(string, boolean, boolean, boolean, boolean, boolean, boolean)

Cette API est appelée par la page d’acquisition/installation pour obtenir des actions utilisateur possibles telles que Acheter/Demander

function getAcquisitionOptions(itemId: string, testCommerce?: boolean, isFreeOrTrialInstall?: boolean, isAccountOwner?: boolean, isLinked?: boolean, isConnectedServer?: boolean, isBuyOperationValid?: boolean): Promise<AcquisitionOptions>

Paramètres

itemId

string

Nom complet de l’extension (<publisher_id>.<>extension_id)

testCommerce

boolean

Paramètre pour tester l’extension en préversion payante sans rendre les plans Azure publics

isFreeOrTrialInstall

boolean

Le paramètre représente le flux de travail d’installation ou d’évaluation (requis pour les flux d’installation hérités)

isAccountOwner

boolean

Le paramètre indique si l’utilisateur est propriétaire ou PCA d’un compte

isLinked

boolean

Le paramètre indique si le compte est lié à un abonnement

isConnectedServer

boolean

Le paramètre indique si l’opération Buy doit être évaluée

isBuyOperationValid

boolean

Retours

Promise<AcquisitionOptions>

getAuditLog(string, string) 

function getAuditLog(publisherName: string, extensionName: string): Promise<ExtensionAuditLog>

Paramètres

publisherName

string

extensionName

string

Retours

Promise<ExtensionAuditLog>

getDocumentByName(string, string, string, string, string, string) 

function getDocumentByName(publisherName: string, extensionName: string, scopeType: string, scopeValue: string, collectionName: string, documentId: string): Promise<any>

Paramètres

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

documentId

string

Retours

Promise<any>

getDocumentsByName(string, string, string, string, string) 

function getDocumentsByName(publisherName: string, extensionName: string, scopeType: string, scopeValue: string, collectionName: string): Promise<any[]>

Paramètres

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Retours

Promise<any[]>

getInstalledExtensionByName(string, string, string[])

Obtenez une extension installée par son éditeur et son nom d’extension.

function getInstalledExtensionByName(publisherName: string, extensionName: string, assetTypes?: string[]): Promise<InstalledExtension>

Paramètres

publisherName

string

Nom de l’éditeur. Exemple : « fabrikam ».

extensionName

string

Nom de l’extension. Exemple : « ops-tools ».

assetTypes

string[]

Détermine les fichiers retournés dans le tableau de fichiers. Fournissez le caractère générique « * » pour renvoyer tous les fichiers, ou une liste séparée par deux-points pour récupérer des fichiers avec des types de ressources spécifiques.

Retours

Promise<InstalledExtension>

getInstalledExtensions(boolean, boolean, string[], boolean)

Répertoriez les extensions installées dans la collection de comptes/projets.

function getInstalledExtensions(includeDisabledExtensions?: boolean, includeErrors?: boolean, assetTypes?: string[], includeInstallationIssues?: boolean): Promise<InstalledExtension[]>

Paramètres

includeDisabledExtensions

boolean

Si la valeur est true (valeur par défaut), incluez les extensions désactivées dans les résultats.

includeErrors

boolean

Si la valeur est true, incluez les extensions installées avec des erreurs.

assetTypes

string[]

Détermine les fichiers retournés dans le tableau de fichiers. Fournissez le caractère générique « * » pour renvoyer tous les fichiers, ou une liste séparée par deux-points pour récupérer des fichiers avec des types de ressources spécifiques.

includeInstallationIssues

boolean

Retours

Promise<InstalledExtension[]>

getPolicies(string) 

function getPolicies(userId: string): Promise<UserExtensionPolicy>

Paramètres

userId

string

Retours

Promise<UserExtensionPolicy>

getRequests() 

function getRequests(): Promise<RequestedExtension[]>

Retours

Promise<RequestedExtension[]>

getStates(boolean, boolean, boolean, boolean)

Répertoriez les informations d’état et de version pour toutes les extensions installées.

function getStates(includeDisabled?: boolean, includeErrors?: boolean, includeInstallationIssues?: boolean, forceRefresh?: boolean): Promise<ExtensionState[]>

Paramètres

includeDisabled

boolean

Si la valeur est true (valeur par défaut), incluez les extensions désactivées dans les résultats.

includeErrors

boolean

Si la valeur est true, incluez les extensions installées dans un état d’erreur dans les résultats.

includeInstallationIssues

boolean

forceRefresh

boolean

Retours

Promise<ExtensionState[]>

getToken() 

function getToken(): Promise<string>

Retours

Promise<string>

installExtensionByName(string, string, string)

Installez l’extension spécifiée dans la collection de comptes/projets.

function installExtensionByName(publisherName: string, extensionName: string, version?: string): Promise<InstalledExtension>

Paramètres

publisherName

string

Nom de l’éditeur. Exemple : « fabrikam ».

extensionName

string

Nom de l’extension. Exemple : « ops-tools ».

version

string

Retours

Promise<InstalledExtension>

queryCollectionsByName(ExtensionDataCollectionQuery, string, string)

Recherchez une ou plusieurs collections de données pour l’extension spécifiée. Remarque : le jeton utilisé pour l’autorisation doit avoir été émis pour le compte de l’extension spécifiée.

function queryCollectionsByName(collectionQuery: ExtensionDataCollectionQuery, publisherName: string, extensionName: string): Promise<ExtensionDataCollection[]>

Paramètres

collectionQuery
ExtensionDataCollectionQuery
publisherName

string

Nom de l’éditeur. Exemple : « fabrikam ».

extensionName

string

Nom de l’extension. Exemple : « ops-tools ».

Retours

Promise<ExtensionDataCollection[]>

queryExtensions(InstalledExtensionQuery) 

function queryExtensions(query: InstalledExtensionQuery): Promise<InstalledExtension[]>

Paramètres

query
InstalledExtensionQuery

Retours

Promise<InstalledExtension[]>

registerAuthorization(string, string, string) 

function registerAuthorization(publisherName: string, extensionName: string, registrationId: string): Promise<ExtensionAuthorization>

Paramètres

publisherName

string

extensionName

string

registrationId

string

Retours

Promise<ExtensionAuthorization>

requestAcquisition(ExtensionAcquisitionRequest) 

function requestAcquisition(acquisitionRequest: ExtensionAcquisitionRequest): Promise<ExtensionAcquisitionRequest>

Paramètres

acquisitionRequest
ExtensionAcquisitionRequest

Retours

Promise<ExtensionAcquisitionRequest>

requestExtension(string, string, string) 

function requestExtension(publisherName: string, extensionName: string, requestMessage: string): Promise<RequestedExtension>

Paramètres

publisherName

string

extensionName

string

requestMessage

string

Retours

Promise<RequestedExtension>

resolveAllRequests(string, string, string, ExtensionRequestState) 

function resolveAllRequests(rejectMessage: string, publisherName: string, extensionName: string, state: ExtensionRequestState): Promise<number>

Paramètres

rejectMessage

string

publisherName

string

extensionName

string

state
ExtensionRequestState

Retours

Promise<number>

resolveRequest(string, string, string, string, ExtensionRequestState) 

function resolveRequest(rejectMessage: string, publisherName: string, extensionName: string, requesterId: string, state: ExtensionRequestState): Promise<number>

Paramètres

rejectMessage

string

publisherName

string

extensionName

string

requesterId

string

state
ExtensionRequestState

Retours

Promise<number>

setDocumentByName(any, string, string, string, string, string) 

function setDocumentByName(doc: any, publisherName: string, extensionName: string, scopeType: string, scopeValue: string, collectionName: string): Promise<any>

Paramètres

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Retours

Promise<any>

uninstallExtensionByName(string, string, string, string)

Désinstallez l’extension spécifiée de la collection compte/projet.

function uninstallExtensionByName(publisherName: string, extensionName: string, reason?: string, reasonCode?: string): Promise<void>

Paramètres

publisherName

string

Nom de l’éditeur. Exemple : « fabrikam ».

extensionName

string

Nom de l’extension. Exemple : « ops-tools ».

reason

string

reasonCode

string

Retours

Promise<void>

updateDocumentByName(any, string, string, string, string, string) 

function updateDocumentByName(doc: any, publisherName: string, extensionName: string, scopeType: string, scopeValue: string, collectionName: string): Promise<any>

Paramètres

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Retours

Promise<any>

updateInstalledExtension(InstalledExtension)

Mettez à jour une extension installée. En règle générale, cette API est utilisée pour activer ou désactiver une extension.

function updateInstalledExtension(extension: InstalledExtension): Promise<InstalledExtension>

Paramètres

extension
InstalledExtension

Retours

Promise<InstalledExtension>