ExtensionManagementRestClient class

Pacchetto:

azure-devops-extension-api

Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST di VSS

Extends

RestClientBase

Costruttori

ExtensionManagementRestClient(IVssRestClientOptions)

Proprietà

RESOURCE_AREA_ID

Metodi

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)	Questa API viene chiamata dalla pagina acquisizione/installazione per ottenere possibili azioni utente come Buy/Request
getAuditLog(string, string)
getDocumentByName(string, string, string, string, string, string)
getDocumentsByName(string, string, string, string, string)
getInstalledExtensionByName(string, string, string[])	Ottenere un'estensione installata dal nome dell'editore e dell'estensione.
getInstalledExtensions(boolean, boolean, string[], boolean)	Elencare le estensioni installate nella raccolta account/progetto.
getPolicies(string)
getRequests()
getStates(boolean, boolean, boolean, boolean)	Elencare le informazioni sullo stato e sulla versione per tutte le estensioni installate.
getToken()
installExtensionByName(string, string, string)	Installare l'estensione specificata nella raccolta account/progetto.
queryCollectionsByName(ExtensionDataCollectionQuery, string, string)	Eseguire una query per una o più raccolte dati per l'estensione specificata. Nota: il token usato per l'autorizzazione deve essere stato rilasciato per conto dell'estensione specificata.
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)	Disinstallare l'estensione specificata dalla raccolta account/progetto.
updateDocumentByName(any, string, string, string, string, string)
updateInstalledExtension(InstalledExtension)	Aggiornare un'estensione installata. In genere questa API viene usata per abilitare o disabilitare un'estensione.

Dettagli costruttore

ExtensionManagementRestClient(IVssRestClientOptions)

new ExtensionManagementRestClient(options: IVssRestClientOptions)

Parametri

options

IVssRestClientOptions

Dettagli proprietà

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valore della proprietà

string

Dettagli metodo

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

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

Parametri

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Restituisce

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>

Parametri

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

documentId

string

Restituisce

Promise<void>

deleteRequest(string, string)

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

Parametri

publisherName

string

extensionName

string

Restituisce

Promise<void>

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

Questa API viene chiamata dalla pagina acquisizione/installazione per ottenere possibili azioni utente come Buy/Request

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

Parametri

itemId

string

Nome completo dell'estensione (<publisher_id>.<>extension_id)

testCommerce

boolean

Parametro per testare l'estensione di anteprima a pagamento senza rendere pubblici i piani di Azure

isFreeOrTrialInstall

boolean

Il parametro rappresenta il flusso di lavoro di installazione o di valutazione (obbligatorio per i flussi di installazione legacy)

isAccountOwner

boolean

Il parametro rappresenta se l'utente è proprietario o PCA di un account

isLinked

boolean

Il parametro rappresenta se l'account è collegato a una sottoscrizione

isConnectedServer

boolean

Parametro che rappresenta se l'operazione Buy deve essere valutata

isBuyOperationValid

boolean

Restituisce

Promise<AcquisitionOptions>

getAuditLog(string, string)

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

Parametri

publisherName

string

extensionName

string

Restituisce

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>

Parametri

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

documentId

string

Restituisce

Promise<any>

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

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

Parametri

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Restituisce

Promise<any[]>

getInstalledExtensionByName(string, string, string[])

Ottenere un'estensione installata dal nome dell'editore e dell'estensione.

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

Parametri

publisherName

string

Nome del server di pubblicazione. Esempio: "fabrikam".

extensionName

string

Nome dell'estensione. Esempio: "ops-tools".

assetTypes

string[]

Determina quali file vengono restituiti nella matrice di file. Specificare il carattere jolly '*' per restituire tutti i file o un elenco delimitato da due punti per recuperare i file con tipi di asset specifici.

Restituisce

Promise<InstalledExtension>

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

Elencare le estensioni installate nella raccolta account/progetto.

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

Parametri

includeDisabledExtensions

boolean

Se true (impostazione predefinita), includere estensioni disabilitate nei risultati.

includeErrors

boolean

Se true, includere estensioni installate con errori.

assetTypes

string[]

Determina quali file vengono restituiti nella matrice di file. Specificare il carattere jolly '*' per restituire tutti i file o un elenco delimitato da due punti per recuperare i file con tipi di asset specifici.

includeInstallationIssues

boolean

Restituisce

Promise<InstalledExtension[]>

getPolicies(string)

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

Parametri

userId

string

Restituisce

Promise<UserExtensionPolicy>

getRequests()

function getRequests(): Promise<RequestedExtension[]>

Restituisce

Promise<RequestedExtension[]>

getStates(boolean, boolean, boolean, boolean)

Elencare le informazioni sullo stato e sulla versione per tutte le estensioni installate.

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

Parametri

includeDisabled

boolean

Se true (impostazione predefinita), includere estensioni disabilitate nei risultati.

includeErrors

boolean

Se true, includere estensioni installate in uno stato di errore nei risultati.

includeInstallationIssues

boolean

forceRefresh

boolean

Restituisce

Promise<ExtensionState[]>

getToken()

function getToken(): Promise<string>

Restituisce

Promise<string>

installExtensionByName(string, string, string)

Installare l'estensione specificata nella raccolta account/progetto.

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

Parametri

publisherName

string

Nome del server di pubblicazione. Esempio: "fabrikam".

extensionName

string

Nome dell'estensione. Esempio: "ops-tools".

version

string

Restituisce

Promise<InstalledExtension>

queryCollectionsByName(ExtensionDataCollectionQuery, string, string)

Eseguire una query per una o più raccolte dati per l'estensione specificata. Nota: il token usato per l'autorizzazione deve essere stato rilasciato per conto dell'estensione specificata.

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

Parametri

collectionQuery

ExtensionDataCollectionQuery

publisherName

string

Nome del server di pubblicazione. Esempio: "fabrikam".

extensionName

string

Nome dell'estensione. Esempio: "ops-tools".

Restituisce

Promise<ExtensionDataCollection[]>

queryExtensions(InstalledExtensionQuery)

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

Parametri

query

InstalledExtensionQuery

Restituisce

Promise<InstalledExtension[]>

registerAuthorization(string, string, string)

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

Parametri

publisherName

string

extensionName

string

registrationId

string

Restituisce

Promise<ExtensionAuthorization>

requestAcquisition(ExtensionAcquisitionRequest)

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

Parametri

acquisitionRequest

ExtensionAcquisitionRequest

Restituisce

Promise<ExtensionAcquisitionRequest>

requestExtension(string, string, string)

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

Parametri

publisherName

string

extensionName

string

requestMessage

string

Restituisce

Promise<RequestedExtension>

resolveAllRequests(string, string, string, ExtensionRequestState)

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

Parametri

rejectMessage

string

publisherName

string

extensionName

string

state

ExtensionRequestState

Restituisce

Promise<number>

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

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

Parametri

rejectMessage

string

publisherName

string

extensionName

string

requesterId

string

state

ExtensionRequestState

Restituisce

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>

Parametri

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Restituisce

Promise<any>

uninstallExtensionByName(string, string, string, string)

Disinstallare l'estensione specificata dalla raccolta account/progetto.

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

Parametri

publisherName

string

Nome del server di pubblicazione. Esempio: "fabrikam".

extensionName

string

Nome dell'estensione. Esempio: "ops-tools".

reason

string

reasonCode

string

Restituisce

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>

Parametri

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Restituisce

Promise<any>

updateInstalledExtension(InstalledExtension)

Aggiornare un'estensione installata. In genere questa API viene usata per abilitare o disabilitare un'estensione.

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

Parametri

extension

InstalledExtension

Restituisce

Promise<InstalledExtension>