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>