ExtensionManagementRestClient class

Pacchetto:

azure-devops-extension-api

Classe di base da usare (derivata da) per effettuare richieste alle API REST 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 di acquisizione/installazione per ottenere possibili azioni dell'utente come Acquista/Richiedi
getAuditLog(string, string)
getAuthorization(string, string, string)
getDocumentByName(string, string, string, string, string, string)
getDocumentsByName(string, string, string, string, string)
getInstalledExtensionByName(string, string, string[])	Ottieni un'estensione installata in base all'autore e al nome dell'estensione.
getInstalledExtensions(boolean, boolean, string[], boolean)	Elenca le estensioni installate nella raccolta account/progetto.
getPolicies(string)
getRequests()
getStates(boolean, boolean, boolean, boolean)	Elenca le informazioni sullo stato e sulla versione di tutte le estensioni installate.
getToken()
installExtensionByName(string, string, string)	Installa l'estensione specificata nella raccolta di account/progetti.
queryCollectionsByName(ExtensionDataCollectionQuery, string, string)	Eseguire una query per una o più raccolte di dati per l'estensione specificata. Nota: il token utilizzato per l'autorizzazione deve essere stato emesso 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)	Disinstalla l'estensione specificata dalla raccolta di account/progetti.
updateDocumentByName(any, string, string, string, string, string)
updateInstalledExtension(InstalledExtension)	Aggiornare un'estensione installata. In genere questa API viene utilizzata 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 di acquisizione/installazione per ottenere possibili azioni dell'utente come Acquista/Richiedi

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

Parametri

itemId

string

Nome completo dell'interno (<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 prova (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

Il parametro rappresenta se l'operazione di acquisto 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>

getAuthorization(string, string, string)

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

Parametri

publisherName

string

extensionName

string

registrationId

string

Restituisce

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>

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[])

Ottieni un'estensione installata in base all'autore e al nome dell'estensione.

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

Parametri

publisherName

string

Nome dell'editore. Esempio: "fabrikam".

extensionName

string

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

assetTypes

string[]

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

Restituisce

Promise<InstalledExtension>

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

Elenca 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 le estensioni disabilitate nei risultati.

includeErrors

boolean

Se true, includere le estensioni installate con errori.

assetTypes

string[]

Determina quali file vengono restituiti nella matrice di file. Fornisci il carattere jolly '*' per restituire tutti i file o un elenco separato da due punti per recuperare i file con tipi di risorse 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)

Elenca le informazioni sullo stato e sulla versione di tutte le estensioni installate.

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

Parametri

includeDisabled

boolean

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

includeErrors

boolean

Se true, includere le 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)

Installa l'estensione specificata nella raccolta di account/progetti.

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

Parametri

publisherName

string

Nome dell'editore. 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 di dati per l'estensione specificata. Nota: il token utilizzato per l'autorizzazione deve essere stato emesso per conto dell'estensione specificata.

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

Parametri

collectionQuery

ExtensionDataCollectionQuery

publisherName

string

Nome dell'editore. 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)

Disinstalla l'estensione specificata dalla raccolta di account/progetti.

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

Parametri

publisherName

string

Nome dell'editore. 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 utilizzata per abilitare o disabilitare un'estensione.

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

Parametri

extension

InstalledExtension

Restituisce

Promise<InstalledExtension>