Partager via

ExtensionManagementRestClient class

Colis:
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

S' étend
RestClientBase

Constructeurs

ExtensionManagementRestClient(IVssRestClientOptions)

Propriétés

RESOURCE_AREA_ID

Méthode

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 l’acquisition/la page d’installation pour obtenir des actions utilisateur possibles telles que Buy/Request
getAuditLog(string, string)
getAuthorization(string, 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 serveur de publication 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épertorier 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 le compte/collection de 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 à partir de la collection de comptes/de projets.
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 la 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

Retourne

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

Retourne

Promise<void>

deleteRequest(string, string) 

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

Paramètres

publisherName

string

extensionName

string

Retourne

Promise<void>

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

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

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 de préversion payante sans rendre les plans Azure publics

isFreeOrTrialInstall

boolean

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

isAccountOwner

boolean

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

isLinked

boolean

Paramètre qui indique si le compte est lié à un abonnement

isConnectedServer

boolean

Paramètre qui indique si l’opération Buy doit être évaluée

isBuyOperationValid

boolean

Retourne

Promise<AcquisitionOptions>

getAuditLog(string, string) 

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

Paramètres

publisherName

string

extensionName

string

Retourne

Promise<ExtensionAuditLog>

getAuthorization(string, string, string) 

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

Paramètres

publisherName

string

extensionName

string

registrationId

string

Retourne

Promise<ExtensionAuthorization>

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

Retourne

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

Retourne

Promise<any[]>

getInstalledExtensionByName(string, string, string[])

Obtenez une extension installée par son serveur de publication 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. Indiquez 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.

Retourne

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. Indiquez 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

Retourne

Promise<InstalledExtension[]>

getPolicies(string) 

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

Paramètres

userId

string

Retourne

Promise<UserExtensionPolicy>

getRequests() 

function getRequests(): Promise<RequestedExtension[]>

Retourne

Promise<RequestedExtension[]>

getStates(boolean, boolean, boolean, boolean)

Répertorier 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

Retourne

Promise<ExtensionState[]>

getToken() 

function getToken(): Promise<string>

Retourne

Promise<string>

installExtensionByName(string, string, string)

Installez l’extension spécifiée dans le compte/collection de 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

Retourne

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 ».

Retourne

Promise<ExtensionDataCollection[]>

queryExtensions(InstalledExtensionQuery) 

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

Paramètres

query
InstalledExtensionQuery

Retourne

Promise<InstalledExtension[]>

registerAuthorization(string, string, string) 

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

Paramètres

publisherName

string

extensionName

string

registrationId

string

Retourne

Promise<ExtensionAuthorization>

requestAcquisition(ExtensionAcquisitionRequest) 

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

Paramètres

acquisitionRequest
ExtensionAcquisitionRequest

Retourne

Promise<ExtensionAcquisitionRequest>

requestExtension(string, string, string) 

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

Paramètres

publisherName

string

extensionName

string

requestMessage

string

Retourne

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

Retourne

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

Retourne

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

Retourne

Promise<any>

uninstallExtensionByName(string, string, string, string)

Désinstallez l’extension spécifiée à partir de la collection de comptes/de projets.

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

Retourne

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

Retourne

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

Retourne

Promise<InstalledExtension>