ExtensionManagementRestClient class

套件:

azure-devops-extension-api

應該用來對 VSS REST API 提出要求的基類（衍生自）

Extends

RestClientBase

建構函式

ExtensionManagementRestClient(IVssRestClientOptions)

屬性

RESOURCE_AREA_ID

方法

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)	此 API 是由下載/安裝頁面呼叫，以取得可能的用戶動作，例如購買/要求
getAuditLog(string, string)
getDocumentByName(string, string, string, string, string, string)
getDocumentsByName(string, string, string, string, string)
getInstalledExtensionByName(string, string, string[])	依發行者和延伸模組名稱取得已安裝的延伸模組。
getInstalledExtensions(boolean, boolean, string[], boolean)	列出帳戶/專案集合中已安裝的延伸模組。
getPolicies(string)
getRequests()
getStates(boolean, boolean, boolean, boolean)	列出所有已安裝延伸模組的狀態和版本資訊。
getToken()
installExtensionByName(string, string, string)	將指定的擴充功能安裝到帳戶/專案集合中。
queryCollectionsByName(ExtensionDataCollectionQuery, string, string)	查詢指定延伸模組的一或多個數據集合。 注意：用於授權的令牌必須代表指定的延伸模塊發出。
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)	從帳戶/專案集合卸載指定的延伸模組。
updateDocumentByName(any, string, string, string, string, string)
updateInstalledExtension(InstalledExtension)	更新已安裝的擴充功能。 此 API 通常用來啟用或停用擴充功能。

建構函式詳細資料

ExtensionManagementRestClient(IVssRestClientOptions)

new ExtensionManagementRestClient(options: IVssRestClientOptions)

參數

options

IVssRestClientOptions

屬性詳細資料

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

屬性值

string

方法詳細資料

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

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

參數

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

傳回

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>

參數

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

documentId

string

傳回

Promise<void>

deleteRequest(string, string)

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

參數

publisherName

string

extensionName

string

傳回

Promise<void>

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

此 API 是由下載/安裝頁面呼叫，以取得可能的用戶動作，例如購買/要求

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

參數

itemId

string

擴充功能的完整名稱 （<publisher_id>.<extension_id>）

testCommerce

boolean

測試付費預覽延伸模組的參數，而不公開 Azure 方案

isFreeOrTrialInstall

boolean

參數代表安裝或試用工作流程（需要舊版安裝流程）

isAccountOwner

boolean

參數代表用戶是帳戶的擁有者或 PCA

isLinked

boolean

參數代表帳戶是否與訂用帳戶連結

isConnectedServer

boolean

參數代表是否應該評估 Buy 作業

isBuyOperationValid

boolean

傳回

Promise<AcquisitionOptions>

getAuditLog(string, string)

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

參數

publisherName

string

extensionName

string

傳回

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>

參數

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

documentId

string

傳回

Promise<any>

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

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

參數

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

傳回

Promise<any[]>

getInstalledExtensionByName(string, string, string[])

依發行者和延伸模組名稱取得已安裝的延伸模組。

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

參數

publisherName

string

發行者的名稱。 範例：「fabrikam」。。

extensionName

string

延伸模組的名稱。 範例：「ops-tools」。。

assetTypes

string[]

判斷檔案陣列中傳回的檔案。 提供通配符 『*』 可傳回所有檔案，或傳回冒號分隔清單，以擷取具有特定資產類型的檔案。

傳回

Promise<InstalledExtension>

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

列出帳戶/專案集合中已安裝的延伸模組。

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

參數

includeDisabledExtensions

boolean

如果為 true （預設值），請在結果中包含已停用的延伸模組。

includeErrors

boolean

如果為 true，請包含已安裝的延伸模組並出現錯誤。

assetTypes

string[]

判斷檔案陣列中傳回的檔案。 提供通配符 『*』 可傳回所有檔案，或傳回冒號分隔清單，以擷取具有特定資產類型的檔案。

includeInstallationIssues

boolean

傳回

Promise<InstalledExtension[]>

getPolicies(string)

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

參數

userId

string

傳回

Promise<UserExtensionPolicy>

getRequests()

function getRequests(): Promise<RequestedExtension[]>

傳回

Promise<RequestedExtension[]>

getStates(boolean, boolean, boolean, boolean)

列出所有已安裝延伸模組的狀態和版本資訊。

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

參數

includeDisabled

boolean

如果為 true （預設值），請在結果中包含已停用的延伸模組。

includeErrors

boolean

如果為 true，請在結果中包含已安裝的擴充功能，並處於錯誤狀態。

includeInstallationIssues

boolean

forceRefresh

boolean

傳回

Promise<ExtensionState[]>

getToken()

function getToken(): Promise<string>

傳回

Promise<string>

installExtensionByName(string, string, string)

將指定的擴充功能安裝到帳戶/專案集合中。

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

參數

publisherName

string

發行者的名稱。 範例：「fabrikam」。。

extensionName

string

延伸模組的名稱。 範例：「ops-tools」。。

version

string

傳回

Promise<InstalledExtension>

queryCollectionsByName(ExtensionDataCollectionQuery, string, string)

查詢指定延伸模組的一或多個數據集合。 注意：用於授權的令牌必須代表指定的延伸模塊發出。

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

參數

collectionQuery

ExtensionDataCollectionQuery

publisherName

string

發行者的名稱。 範例：「fabrikam」。。

extensionName

string

延伸模組的名稱。 範例：「ops-tools」。。

傳回

Promise<ExtensionDataCollection[]>

queryExtensions(InstalledExtensionQuery)

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

參數

query

InstalledExtensionQuery

傳回

Promise<InstalledExtension[]>

registerAuthorization(string, string, string)

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

參數

publisherName

string

extensionName

string

registrationId

string

傳回

Promise<ExtensionAuthorization>

requestAcquisition(ExtensionAcquisitionRequest)

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

參數

acquisitionRequest

ExtensionAcquisitionRequest

傳回

Promise<ExtensionAcquisitionRequest>

requestExtension(string, string, string)

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

參數

publisherName

string

extensionName

string

requestMessage

string

傳回

Promise<RequestedExtension>

resolveAllRequests(string, string, string, ExtensionRequestState)

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

參數

rejectMessage

string

publisherName

string

extensionName

string

state

ExtensionRequestState

傳回

Promise<number>

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

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

參數

rejectMessage

string

publisherName

string

extensionName

string

requesterId

string

state

ExtensionRequestState

傳回

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>

參數

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

傳回

Promise<any>

uninstallExtensionByName(string, string, string, string)

從帳戶/專案集合卸載指定的延伸模組。

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

參數

publisherName

string

發行者的名稱。 範例：「fabrikam」。。

extensionName

string

延伸模組的名稱。 範例：「ops-tools」。。

reason

string

reasonCode

string

傳回

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>

參數

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

傳回

Promise<any>

updateInstalledExtension(InstalledExtension)

更新已安裝的擴充功能。 此 API 通常用來啟用或停用擴充功能。

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

參數

extension

InstalledExtension

傳回

Promise<InstalledExtension>