ExtensionManagementRestClient class

Pakket:

azure-devops-extension-api

Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen voor VSS REST API's

Extends

RestClientBase

Constructors

ExtensionManagementRestClient(IVssRestClientOptions)

Eigenschappen

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)	Deze API wordt aangeroepen door de pagina voor het verkrijgen/installeren van mogelijke gebruikersacties, zoals Kopen/Aanvragen
getAuditLog(string, string)
getDocumentByName(string, string, string, string, string, string)
getDocumentsByName(string, string, string, string, string)
getInstalledExtensionByName(string, string, string[])	Haal een geïnstalleerde extensie op op basis van de uitgever en extensienaam.
getInstalledExtensions(boolean, boolean, string[], boolean)	Vermeld de geïnstalleerde extensies in de account-/projectverzameling.
getPolicies(string)
getRequests()
getStates(boolean, boolean, boolean, boolean)	Geef status- en versie-informatie weer voor alle geïnstalleerde extensies.
getToken()
installExtensionByName(string, string, string)	Installeer de opgegeven extensie in de account-/projectverzameling.
queryCollectionsByName(ExtensionDataCollectionQuery, string, string)	Query's uitvoeren op een of meer gegevensverzamelingen voor de opgegeven extensie. Opmerking: het token dat voor autorisatie wordt gebruikt, moet zijn uitgegeven namens de opgegeven extensie.
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)	Verwijder de opgegeven extensie uit de account-/projectverzameling.
updateDocumentByName(any, string, string, string, string, string)
updateInstalledExtension(InstalledExtension)	Een geïnstalleerde extensie bijwerken. Deze API wordt doorgaans gebruikt om een extensie in of uit te schakelen.

Constructordetails

ExtensionManagementRestClient(IVssRestClientOptions)

new ExtensionManagementRestClient(options: IVssRestClientOptions)

Parameters

options

IVssRestClientOptions

Eigenschapdetails

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Waarde van eigenschap

string

Methodedetails

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

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

Parameters

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Retouren

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>

Parameters

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

documentId

string

Retouren

Promise<void>

deleteRequest(string, string)

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

Parameters

publisherName

string

extensionName

string

Retouren

Promise<void>

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

Deze API wordt aangeroepen door de pagina voor het verkrijgen/installeren van mogelijke gebruikersacties, zoals Kopen/Aanvragen

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

Parameters

itemId

string

Volledig gekwalificeerde naam van extensie (<publisher_id>.<>extension_id)

testCommerce

boolean

Parameter voor het testen van de betaalde preview-extensie zonder Azure-abonnementen openbaar te maken

isFreeOrTrialInstall

boolean

Parameter vertegenwoordigt de werkstroom voor installatie of proefversie (vereist voor verouderde installatiestromen)

isAccountOwner

boolean

Parameter geeft aan of de gebruiker eigenaar of PCA van een account is

isLinked

boolean

Parameter geeft aan of het account is gekoppeld aan een abonnement

isConnectedServer

boolean

Parameter geeft aan of de koopbewerking moet worden geëvalueerd

isBuyOperationValid

boolean

Retouren

Promise<AcquisitionOptions>

getAuditLog(string, string)

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

Parameters

publisherName

string

extensionName

string

Retouren

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>

Parameters

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

documentId

string

Retouren

Promise<any>

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

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

Parameters

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Retouren

Promise<any[]>

getInstalledExtensionByName(string, string, string[])

Haal een geïnstalleerde extensie op op basis van de uitgever en extensienaam.

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

Parameters

publisherName

string

Naam van de uitgever. Voorbeeld: 'fabrikam'.

extensionName

string

Naam van de extensie. Voorbeeld: 'ops-tools'.

assetTypes

string[]

Bepaalt welke bestanden worden geretourneerd in de bestandsmatrix. Geef het jokerteken '*' op om alle bestanden te retourneren, of geef een door dubbele punt gescheiden lijst op om bestanden met specifieke assettypen op te halen.

Retouren

Promise<InstalledExtension>

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

Vermeld de geïnstalleerde extensies in de account-/projectverzameling.

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

Parameters

includeDisabledExtensions

boolean

Indien waar (de standaardinstelling), neemt u uitgeschakelde extensies op in de resultaten.

includeErrors

boolean

Als dit waar is, voegt u geïnstalleerde extensies met fouten toe.

assetTypes

string[]

Bepaalt welke bestanden worden geretourneerd in de bestandsmatrix. Geef het jokerteken '*' op om alle bestanden te retourneren, of geef een door dubbele punt gescheiden lijst op om bestanden met specifieke assettypen op te halen.

includeInstallationIssues

boolean

Retouren

Promise<InstalledExtension[]>

getPolicies(string)

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

Parameters

userId

string

Retouren

Promise<UserExtensionPolicy>

getRequests()

function getRequests(): Promise<RequestedExtension[]>

Retouren

Promise<RequestedExtension[]>

getStates(boolean, boolean, boolean, boolean)

Geef status- en versie-informatie weer voor alle geïnstalleerde extensies.

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

Parameters

includeDisabled

boolean

Indien waar (de standaardinstelling), neemt u uitgeschakelde extensies op in de resultaten.

includeErrors

boolean

Als dit waar is, neemt u geïnstalleerde extensies met een foutstatus op in de resultaten.

includeInstallationIssues

boolean

forceRefresh

boolean

Retouren

Promise<ExtensionState[]>

getToken()

function getToken(): Promise<string>

Retouren

Promise<string>

installExtensionByName(string, string, string)

Installeer de opgegeven extensie in de account-/projectverzameling.

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

Parameters

publisherName

string

Naam van de uitgever. Voorbeeld: 'fabrikam'.

extensionName

string

Naam van de extensie. Voorbeeld: 'ops-tools'.

version

string

Retouren

Promise<InstalledExtension>

queryCollectionsByName(ExtensionDataCollectionQuery, string, string)

Query's uitvoeren op een of meer gegevensverzamelingen voor de opgegeven extensie. Opmerking: het token dat voor autorisatie wordt gebruikt, moet zijn uitgegeven namens de opgegeven extensie.

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

Parameters

collectionQuery

ExtensionDataCollectionQuery

publisherName

string

Naam van de uitgever. Voorbeeld: 'fabrikam'.

extensionName

string

Naam van de extensie. Voorbeeld: 'ops-tools'.

Retouren

Promise<ExtensionDataCollection[]>

queryExtensions(InstalledExtensionQuery)

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

Parameters

query

InstalledExtensionQuery

Retouren

Promise<InstalledExtension[]>

registerAuthorization(string, string, string)

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

Parameters

publisherName

string

extensionName

string

registrationId

string

Retouren

Promise<ExtensionAuthorization>

requestAcquisition(ExtensionAcquisitionRequest)

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

Parameters

acquisitionRequest

ExtensionAcquisitionRequest

Retouren

Promise<ExtensionAcquisitionRequest>

requestExtension(string, string, string)

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

Parameters

publisherName

string

extensionName

string

requestMessage

string

Retouren

Promise<RequestedExtension>

resolveAllRequests(string, string, string, ExtensionRequestState)

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

Parameters

rejectMessage

string

publisherName

string

extensionName

string

state

ExtensionRequestState

Retouren

Promise<number>

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

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

Parameters

rejectMessage

string

publisherName

string

extensionName

string

requesterId

string

state

ExtensionRequestState

Retouren

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>

Parameters

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Retouren

Promise<any>

uninstallExtensionByName(string, string, string, string)

Verwijder de opgegeven extensie uit de account-/projectverzameling.

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

Parameters

publisherName

string

Naam van de uitgever. Voorbeeld: 'fabrikam'.

extensionName

string

Naam van de extensie. Voorbeeld: 'ops-tools'.

reason

string

reasonCode

string

Retouren

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>

Parameters

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Retouren

Promise<any>

updateInstalledExtension(InstalledExtension)

Een geïnstalleerde extensie bijwerken. Deze API wordt doorgaans gebruikt om een extensie in of uit te schakelen.

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

Parameters

extension

InstalledExtension

Retouren

Promise<InstalledExtension>