ExtensionManagementRestClient class

Пакет:

azure-devops-extension-api

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

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>