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)	指定した拡張機能の 1 つ以上のデータ コレクションを照会します。 注: 承認に使用されるトークンは、指定された拡張機能の代わりに発行されている必要があります。
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

パラメーターは、購入操作を評価する必要があるかどうかを表します

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

files 配列で返されるファイルを決定します。 ワイルドカード '*' を指定してすべてのファイルを返すか、コロンで区切られたリストを指定して、特定の資産の種類のファイルを取得します。

戻り値

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

files 配列で返されるファイルを決定します。 ワイルドカード '*' を指定してすべてのファイルを返すか、コロンで区切られたリストを指定して、特定の資産の種類のファイルを取得します。

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)

指定した拡張機能の 1 つ以上のデータ コレクションを照会します。 注: 承認に使用されるトークンは、指定された拡張機能の代わりに発行されている必要があります。

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>