ExtensionManagementRestClient class

Csomag:

azure-devops-extension-api

Alaposztály, amelyet a VSS REST API-k kéréseinek igényléséhez (származtatásából) kell használni

Extends

RestClientBase

Konstruktorok

ExtensionManagementRestClient(IVssRestClientOptions)

Tulajdonságok

RESOURCE_AREA_ID

Metódusok

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)	Ezt az API-t beszerzési/telepítési oldal hívja meg, hogy lekérje az olyan lehetséges felhasználói műveleteket, mint a Vásárlás/Kérés
getAuditLog(string, string)
getAuthorization(string, string, string)
getDocumentByName(string, string, string, string, string, string)
getDocumentsByName(string, string, string, string, string)
getInstalledExtensionByName(string, string, string[])	Szerezze be a telepített bővítményt a közzétevő és a bővítmény neve alapján.
getInstalledExtensions(boolean, boolean, string[], boolean)	A fiók/ projektgyűjtemény telepített bővítményeinek listázása.
getPolicies(string)
getRequests()
getStates(boolean, boolean, boolean, boolean)	Az összes telepített bővítmény állapot- és verzióinformációinak listázása.
getToken()
installExtensionByName(string, string, string)	Telepítse a megadott bővítményt a fiókba/ projektgyűjteménybe.
queryCollectionsByName(ExtensionDataCollectionQuery, string, string)	A megadott bővítmény egy vagy több adatgyűjtésének lekérdezése. Megjegyzés: az engedélyezéshez használt jogkivonatot a megadott bővítmény nevében kell kibocsátania.
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)	Távolítsa el a megadott bővítményt a fiókból/ projektgyűjteményből.
updateDocumentByName(any, string, string, string, string, string)
updateInstalledExtension(InstalledExtension)	Frissítsen egy telepített bővítményt. Ez az API általában egy bővítmény engedélyezésére vagy letiltására szolgál.

Konstruktor adatai

ExtensionManagementRestClient(IVssRestClientOptions)

new ExtensionManagementRestClient(options: IVssRestClientOptions)

Paraméterek

options

IVssRestClientOptions

Tulajdonság adatai

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Tulajdonság értéke

string

Metódus adatai

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

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

Paraméterek

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Válaszok

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éterek

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

documentId

string

Válaszok

Promise<void>

deleteRequest(string, string)

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

Paraméterek

publisherName

string

extensionName

string

Válaszok

Promise<void>

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

Ezt az API-t beszerzési/telepítési oldal hívja meg, hogy lekérje az olyan lehetséges felhasználói műveleteket, mint a Vásárlás/Kérés

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

Paraméterek

itemId

string

A bővítmény teljes neve (<publisher_id>.<extension_id>)

testCommerce

boolean

Fizetős előzetes verziós bővítmény tesztelésére vonatkozó paraméter az Azure-csomagok nyilvánossá tétele nélkül

isFreeOrTrialInstall

boolean

A paraméter a telepítési vagy próbaverziós munkafolyamatot jelöli (az örökölt telepítési folyamatokhoz szükséges)

isAccountOwner

boolean

A paraméter azt jelzi, hogy a felhasználó egy fiók tulajdonosa vagy PCA-je

isLinked

boolean

A paraméter azt jelzi, hogy a fiók társítva van-e előfizetéssel

isConnectedServer

boolean

A paraméter azt jelzi, hogy a Vásárlás műveletet ki kell-e értékelni

isBuyOperationValid

boolean

Válaszok

Promise<AcquisitionOptions>

getAuditLog(string, string)

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

Paraméterek

publisherName

string

extensionName

string

Válaszok

Promise<ExtensionAuditLog>

getAuthorization(string, string, string)

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

Paraméterek

publisherName

string

extensionName

string

registrationId

string

Válaszok

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éterek

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

documentId

string

Válaszok

Promise<any>

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

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

Paraméterek

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Válaszok

Promise<any[]>

getInstalledExtensionByName(string, string, string[])

Szerezze be a telepített bővítményt a közzétevő és a bővítmény neve alapján.

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

Paraméterek

publisherName

string

A közzétevő neve. Példa: "fabrikam".

extensionName

string

A bővítmény neve. Példa: "ops-tools".

assetTypes

string[]

Meghatározza, hogy mely fájlok lesznek visszaadva a fájltömbben. Adja meg a "*" helyettesítő karaktert az összes fájl visszaadásához, vagy egy kettősponttal elválasztott listát az adott objektumtípusú fájlok lekéréséhez.

Válaszok

Promise<InstalledExtension>

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

A fiók/ projektgyűjtemény telepített bővítményeinek listázása.

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

Paraméterek

includeDisabledExtensions

boolean

Ha igaz (az alapértelmezett), akkor a letiltott bővítményeket is belefoglalja az eredményekbe.

includeErrors

boolean

Ha igaz, vegye fel a telepített bővítményeket hibákkal.

assetTypes

string[]

Meghatározza, hogy mely fájlok lesznek visszaadva a fájltömbben. Adja meg a "*" helyettesítő karaktert az összes fájl visszaadásához, vagy egy kettősponttal elválasztott listát az adott objektumtípusú fájlok lekéréséhez.

includeInstallationIssues

boolean

Válaszok

Promise<InstalledExtension[]>

getPolicies(string)

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

Paraméterek

userId

string

Válaszok

Promise<UserExtensionPolicy>

getRequests()

function getRequests(): Promise<RequestedExtension[]>

Válaszok

Promise<RequestedExtension[]>

getStates(boolean, boolean, boolean, boolean)

Az összes telepített bővítmény állapot- és verzióinformációinak listázása.

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

Paraméterek

includeDisabled

boolean

Ha igaz (az alapértelmezett), akkor a letiltott bővítményeket is belefoglalja az eredményekbe.

includeErrors

boolean

Ha igaz, a telepített bővítmények hibaállapotba kerülnek az eredményekben.

includeInstallationIssues

boolean

forceRefresh

boolean

Válaszok

Promise<ExtensionState[]>

getToken()

function getToken(): Promise<string>

Válaszok

Promise<string>

installExtensionByName(string, string, string)

Telepítse a megadott bővítményt a fiókba/ projektgyűjteménybe.

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

Paraméterek

publisherName

string

A közzétevő neve. Példa: "fabrikam".

extensionName

string

A bővítmény neve. Példa: "ops-tools".

version

string

Válaszok

Promise<InstalledExtension>

queryCollectionsByName(ExtensionDataCollectionQuery, string, string)

A megadott bővítmény egy vagy több adatgyűjtésének lekérdezése. Megjegyzés: az engedélyezéshez használt jogkivonatot a megadott bővítmény nevében kell kibocsátania.

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

Paraméterek

collectionQuery

ExtensionDataCollectionQuery

publisherName

string

A közzétevő neve. Példa: "fabrikam".

extensionName

string

A bővítmény neve. Példa: "ops-tools".

Válaszok

Promise<ExtensionDataCollection[]>

queryExtensions(InstalledExtensionQuery)

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

Paraméterek

query

InstalledExtensionQuery

Válaszok

Promise<InstalledExtension[]>

registerAuthorization(string, string, string)

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

Paraméterek

publisherName

string

extensionName

string

registrationId

string

Válaszok

Promise<ExtensionAuthorization>

requestAcquisition(ExtensionAcquisitionRequest)

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

Paraméterek

acquisitionRequest

ExtensionAcquisitionRequest

Válaszok

Promise<ExtensionAcquisitionRequest>

requestExtension(string, string, string)

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

Paraméterek

publisherName

string

extensionName

string

requestMessage

string

Válaszok

Promise<RequestedExtension>

resolveAllRequests(string, string, string, ExtensionRequestState)

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

Paraméterek

rejectMessage

string

publisherName

string

extensionName

string

state

ExtensionRequestState

Válaszok

Promise<number>

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

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

Paraméterek

rejectMessage

string

publisherName

string

extensionName

string

requesterId

string

state

ExtensionRequestState

Válaszok

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éterek

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Válaszok

Promise<any>

uninstallExtensionByName(string, string, string, string)

Távolítsa el a megadott bővítményt a fiókból/ projektgyűjteményből.

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

Paraméterek

publisherName

string

A közzétevő neve. Példa: "fabrikam".

extensionName

string

A bővítmény neve. Példa: "ops-tools".

reason

string

reasonCode

string

Válaszok

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éterek

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Válaszok

Promise<any>

updateInstalledExtension(InstalledExtension)

Frissítsen egy telepített bővítményt. Ez az API általában egy bővítmény engedélyezésére vagy letiltására szolgál.

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

Paraméterek

extension

InstalledExtension

Válaszok

Promise<InstalledExtension>