ExtensionManagementRestClient class

Paket:

azure-devops-extension-api

Basisklasse, die verwendet werden soll (abgeleitet von), um Anforderungen an VSS-REST-APIs zu stellen

Extends

RestClientBase

Konstruktoren

ExtensionManagementRestClient(IVssRestClientOptions)

Eigenschaften

RESOURCE_AREA_ID

Methoden

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)	Diese API wird von der Akquisitions-/Installationsseite aufgerufen, um mögliche Benutzeraktionen wie Kaufen/Anfordern zu erhalten
getAuditLog(string, string)
getAuthorization(string, string, string)
getDocumentByName(string, string, string, string, string, string)
getDocumentsByName(string, string, string, string, string)
getInstalledExtensionByName(string, string, string[])	Rufen Sie eine installierte Erweiterung anhand des Herausgebers und des Erweiterungsnamens ab.
getInstalledExtensions(boolean, boolean, string[], boolean)	Listen Sie die installierten Erweiterungen in der Konto-/Projektsammlung auf.
getPolicies(string)
getRequests()
getStates(boolean, boolean, boolean, boolean)	Listet Status- und Versionsinformationen für alle installierten Erweiterungen auf.
getToken()
installExtensionByName(string, string, string)	Installieren Sie die angegebene Erweiterung in der Konto-/Projektsammlung.
queryCollectionsByName(ExtensionDataCollectionQuery, string, string)	Abfrage einer oder mehrerer Datensammlungen für die angegebene Erweiterung. Hinweis: Das für die Autorisierung verwendete Token muss im Namen der angegebenen Erweiterung ausgestellt worden sein.
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)	Deinstallieren Sie die angegebene Erweiterung aus der Konto-/Projektsammlung.
updateDocumentByName(any, string, string, string, string, string)
updateInstalledExtension(InstalledExtension)	Aktualisieren Sie eine installierte Erweiterung. In der Regel wird diese API verwendet, um eine Erweiterung zu aktivieren oder zu deaktivieren.

Details zum Konstruktor

ExtensionManagementRestClient(IVssRestClientOptions)

new ExtensionManagementRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Details zur Eigenschaft

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Eigenschaftswert

string

Details zur Methode

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

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

Parameter

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Gibt zurück

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>

Parameter

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

documentId

string

Gibt zurück

Promise<void>

deleteRequest(string, string)

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

Parameter

publisherName

string

extensionName

string

Gibt zurück

Promise<void>

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

Diese API wird von der Akquisitions-/Installationsseite aufgerufen, um mögliche Benutzeraktionen wie Kaufen/Anfordern zu erhalten

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

Parameter

itemId

string

Vollständig qualifizierter Name der Erweiterung (<publisher_id>.<extension_id>)

testCommerce

boolean

Parameter zum Testen der kostenpflichtigen Vorschauerweiterung, ohne Azure-Pläne öffentlich zu machen

isFreeOrTrialInstall

boolean

Der Parameter stellt den Installations- oder Test-Workflow dar (erforderlich für Legacy-Installationsabläufe)

isAccountOwner

boolean

Der Parameter gibt an, ob der Benutzer Eigentümer oder PCA eines Kontos ist

isLinked

boolean

Der Parameter gibt an, ob das Konto mit einem Abonnement verknüpft ist

isConnectedServer

boolean

Der Parameter gibt an, ob der Kaufvorgang ausgewertet werden soll

isBuyOperationValid

boolean

Gibt zurück

Promise<AcquisitionOptions>

getAuditLog(string, string)

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

Parameter

publisherName

string

extensionName

string

Gibt zurück

Promise<ExtensionAuditLog>

getAuthorization(string, string, string)

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

Parameter

publisherName

string

extensionName

string

registrationId

string

Gibt zurück

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>

Parameter

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

documentId

string

Gibt zurück

Promise<any>

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

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

Parameter

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Gibt zurück

Promise<any[]>

getInstalledExtensionByName(string, string, string[])

Rufen Sie eine installierte Erweiterung anhand des Herausgebers und des Erweiterungsnamens ab.

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

Parameter

publisherName

string

Name des Herausgebers. Beispiel: "fabrikam".

extensionName

string

Name der Erweiterung. Beispiel: "ops-tools".

assetTypes

string[]

Bestimmt, welche Dateien im files-Array zurückgegeben werden. Geben Sie den Platzhalter '*' an, um alle Dateien zurückzugeben, oder eine durch Doppelpunkte getrennte Liste, um Dateien mit bestimmten Asset-Typen abzurufen.

Gibt zurück

Promise<InstalledExtension>

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

Listen Sie die installierten Erweiterungen in der Konto-/Projektsammlung auf.

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

Parameter

includeDisabledExtensions

boolean

Wenn true (Standardeinstellung), schließen Sie deaktivierte Erweiterungen in die Ergebnisse ein.

includeErrors

boolean

Wenn true, schließen Sie installierte Erweiterungen mit Fehlern ein.

assetTypes

string[]

Bestimmt, welche Dateien im files-Array zurückgegeben werden. Geben Sie den Platzhalter '*' an, um alle Dateien zurückzugeben, oder eine durch Doppelpunkte getrennte Liste, um Dateien mit bestimmten Asset-Typen abzurufen.

includeInstallationIssues

boolean

Gibt zurück

Promise<InstalledExtension[]>

getPolicies(string)

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

Parameter

userId

string

Gibt zurück

Promise<UserExtensionPolicy>

getRequests()

function getRequests(): Promise<RequestedExtension[]>

Gibt zurück

Promise<RequestedExtension[]>

getStates(boolean, boolean, boolean, boolean)

Listet Status- und Versionsinformationen für alle installierten Erweiterungen auf.

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

Parameter

includeDisabled

boolean

Wenn true (Standardeinstellung), schließen Sie deaktivierte Erweiterungen in die Ergebnisse ein.

includeErrors

boolean

Wenn true, schließen Sie installierte Erweiterungen in einem Fehlerstatus in die Ergebnisse ein.

includeInstallationIssues

boolean

forceRefresh

boolean

Gibt zurück

Promise<ExtensionState[]>

getToken()

function getToken(): Promise<string>

Gibt zurück

Promise<string>

installExtensionByName(string, string, string)

Installieren Sie die angegebene Erweiterung in der Konto-/Projektsammlung.

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

Parameter

publisherName

string

Name des Herausgebers. Beispiel: "fabrikam".

extensionName

string

Name der Erweiterung. Beispiel: "ops-tools".

version

string

Gibt zurück

Promise<InstalledExtension>

queryCollectionsByName(ExtensionDataCollectionQuery, string, string)

Abfrage einer oder mehrerer Datensammlungen für die angegebene Erweiterung. Hinweis: Das für die Autorisierung verwendete Token muss im Namen der angegebenen Erweiterung ausgestellt worden sein.

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

Parameter

collectionQuery

ExtensionDataCollectionQuery

publisherName

string

Name des Herausgebers. Beispiel: "fabrikam".

extensionName

string

Name der Erweiterung. Beispiel: "ops-tools".

Gibt zurück

Promise<ExtensionDataCollection[]>

queryExtensions(InstalledExtensionQuery)

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

Parameter

query

InstalledExtensionQuery

Gibt zurück

Promise<InstalledExtension[]>

registerAuthorization(string, string, string)

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

Parameter

publisherName

string

extensionName

string

registrationId

string

Gibt zurück

Promise<ExtensionAuthorization>

requestAcquisition(ExtensionAcquisitionRequest)

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

Parameter

acquisitionRequest

ExtensionAcquisitionRequest

Gibt zurück

Promise<ExtensionAcquisitionRequest>

requestExtension(string, string, string)

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

Parameter

publisherName

string

extensionName

string

requestMessage

string

Gibt zurück

Promise<RequestedExtension>

resolveAllRequests(string, string, string, ExtensionRequestState)

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

Parameter

rejectMessage

string

publisherName

string

extensionName

string

state

ExtensionRequestState

Gibt zurück

Promise<number>

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

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

Parameter

rejectMessage

string

publisherName

string

extensionName

string

requesterId

string

state

ExtensionRequestState

Gibt zurück

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>

Parameter

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Gibt zurück

Promise<any>

uninstallExtensionByName(string, string, string, string)

Deinstallieren Sie die angegebene Erweiterung aus der Konto-/Projektsammlung.

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

Parameter

publisherName

string

Name des Herausgebers. Beispiel: "fabrikam".

extensionName

string

Name der Erweiterung. Beispiel: "ops-tools".

reason

string

reasonCode

string

Gibt zurück

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>

Parameter

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Gibt zurück

Promise<any>

updateInstalledExtension(InstalledExtension)

Aktualisieren Sie eine installierte Erweiterung. In der Regel wird diese API verwendet, um eine Erweiterung zu aktivieren oder zu deaktivieren.

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

Parameter

extension

InstalledExtension

Gibt zurück

Promise<InstalledExtension>