ExtensionManagementRestClient class

Balíček:

azure-devops-extension-api

Základní třída, která by se měla použít (odvozená) k provádění požadavků na rozhraní REST API služby VSS

Extends

RestClientBase

Konstruktory

ExtensionManagementRestClient(IVssRestClientOptions)

Vlastnosti

RESOURCE_AREA_ID

Metody

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)	Toto rozhraní API se volá na stránce získání/instalace, která umožňuje získat možné akce uživatelů, jako je nákup nebo žádost.
getAuditLog(string, string)
getAuthorization(string, string, string)
getDocumentByName(string, string, string, string, string, string)
getDocumentsByName(string, string, string, string, string)
getInstalledExtensionByName(string, string, string[])	Získejte nainstalované rozšíření podle názvu vydavatele a rozšíření.
getInstalledExtensions(boolean, boolean, string[], boolean)	Uveďte nainstalovaná rozšíření v kolekci účtů nebo projektů.
getPolicies(string)
getRequests()
getStates(boolean, boolean, boolean, boolean)	Uveďte informace o stavu a verzi pro všechna nainstalovaná rozšíření.
getToken()
installExtensionByName(string, string, string)	Nainstalujte zadané rozšíření do kolekce účtů nebo projektů.
queryCollectionsByName(ExtensionDataCollectionQuery, string, string)	Zadejte dotaz na jednu nebo více kolekcí dat pro zadané rozšíření. Poznámka: Token použitý k autorizaci musí být vystaven jménem zadaného rozšíření.
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)	Odinstalujte zadané rozšíření z kolekce účtů nebo projektů.
updateDocumentByName(any, string, string, string, string, string)
updateInstalledExtension(InstalledExtension)	Aktualizace nainstalovaného rozšíření Obvykle se toto rozhraní API používá k povolení nebo zakázání rozšíření.

Podrobnosti konstruktoru

ExtensionManagementRestClient(IVssRestClientOptions)

new ExtensionManagementRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Podrobnosti vlastnosti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Hodnota vlastnosti

string

Podrobnosti metody

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

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

Parametry

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Návraty

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>

Parametry

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

documentId

string

Návraty

Promise<void>

deleteRequest(string, string)

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

Parametry

publisherName

string

extensionName

string

Návraty

Promise<void>

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

Toto rozhraní API se volá na stránce získání/instalace, která umožňuje získat možné akce uživatelů, jako je nákup nebo žádost.

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

Parametry

itemId

string

Plně kvalifikovaný název přípony (<publisher_id>.<extension_id>)

testCommerce

boolean

Parametr pro testování placeného rozšíření Preview bez zpřístupnění plánů Azure

isFreeOrTrialInstall

boolean

Parametr představuje pracovní postup instalace nebo zkušební verze (vyžaduje se pro starší verze toků instalace).

isAccountOwner

boolean

Parametr představuje, jestli je uživatel vlastníkem nebo PCA účtu.

isLinked

boolean

Parametr představuje, jestli je účet propojený s předplatným.

isConnectedServer

boolean

Parametr představuje, jestli má být vyhodnocena operace Koupit.

isBuyOperationValid

boolean

Návraty

Promise<AcquisitionOptions>

getAuditLog(string, string)

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

Parametry

publisherName

string

extensionName

string

Návraty

Promise<ExtensionAuditLog>

getAuthorization(string, string, string)

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

Parametry

publisherName

string

extensionName

string

registrationId

string

Návraty

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>

Parametry

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

documentId

string

Návraty

Promise<any>

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

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

Parametry

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Návraty

Promise<any[]>

getInstalledExtensionByName(string, string, string[])

Získejte nainstalované rozšíření podle názvu vydavatele a rozšíření.

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

Parametry

publisherName

string

Název vydavatele. Příklad: "fabrikam".

extensionName

string

Název rozšíření. Příklad: "ops-tools".

assetTypes

string[]

Určuje, které soubory se vrátí v poli souborů. Zadejte zástupný znak *, který vrátí všechny soubory, nebo dvojtečka oddělený seznam pro načtení souborů s určitými typy prostředků.

Návraty

Promise<InstalledExtension>

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

Uveďte nainstalovaná rozšíření v kolekci účtů nebo projektů.

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

Parametry

includeDisabledExtensions

boolean

Pokud je hodnota true (výchozí), zahrňte do výsledků zakázaná rozšíření.

includeErrors

boolean

Pokud je pravda, zahrňte nainstalovaná rozšíření s chybami.

assetTypes

string[]

Určuje, které soubory se vrátí v poli souborů. Zadejte zástupný znak *, který vrátí všechny soubory, nebo dvojtečka oddělený seznam pro načtení souborů s určitými typy prostředků.

includeInstallationIssues

boolean

Návraty

Promise<InstalledExtension[]>

getPolicies(string)

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

Parametry

userId

string

Návraty

Promise<UserExtensionPolicy>

getRequests()

function getRequests(): Promise<RequestedExtension[]>

Návraty

Promise<RequestedExtension[]>

getStates(boolean, boolean, boolean, boolean)

Uveďte informace o stavu a verzi pro všechna nainstalovaná rozšíření.

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

Parametry

includeDisabled

boolean

Pokud je hodnota true (výchozí), zahrňte do výsledků zakázaná rozšíření.

includeErrors

boolean

Pokud je pravda, zahrňte do výsledků nainstalovaná rozšíření do chybového stavu.

includeInstallationIssues

boolean

forceRefresh

boolean

Návraty

Promise<ExtensionState[]>

getToken()

function getToken(): Promise<string>

Návraty

Promise<string>

installExtensionByName(string, string, string)

Nainstalujte zadané rozšíření do kolekce účtů nebo projektů.

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

Parametry

publisherName

string

Název vydavatele. Příklad: "fabrikam".

extensionName

string

Název rozšíření. Příklad: "ops-tools".

version

string

Návraty

Promise<InstalledExtension>

queryCollectionsByName(ExtensionDataCollectionQuery, string, string)

Zadejte dotaz na jednu nebo více kolekcí dat pro zadané rozšíření. Poznámka: Token použitý k autorizaci musí být vystaven jménem zadaného rozšíření.

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

Parametry

collectionQuery

ExtensionDataCollectionQuery

publisherName

string

Název vydavatele. Příklad: "fabrikam".

extensionName

string

Název rozšíření. Příklad: "ops-tools".

Návraty

Promise<ExtensionDataCollection[]>

queryExtensions(InstalledExtensionQuery)

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

Parametry

query

InstalledExtensionQuery

Návraty

Promise<InstalledExtension[]>

registerAuthorization(string, string, string)

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

Parametry

publisherName

string

extensionName

string

registrationId

string

Návraty

Promise<ExtensionAuthorization>

requestAcquisition(ExtensionAcquisitionRequest)

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

Parametry

acquisitionRequest

ExtensionAcquisitionRequest

Návraty

Promise<ExtensionAcquisitionRequest>

requestExtension(string, string, string)

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

Parametry

publisherName

string

extensionName

string

requestMessage

string

Návraty

Promise<RequestedExtension>

resolveAllRequests(string, string, string, ExtensionRequestState)

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

Parametry

rejectMessage

string

publisherName

string

extensionName

string

state

ExtensionRequestState

Návraty

Promise<number>

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

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

Parametry

rejectMessage

string

publisherName

string

extensionName

string

requesterId

string

state

ExtensionRequestState

Návraty

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>

Parametry

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Návraty

Promise<any>

uninstallExtensionByName(string, string, string, string)

Odinstalujte zadané rozšíření z kolekce účtů nebo projektů.

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

Parametry

publisherName

string

Název vydavatele. Příklad: "fabrikam".

extensionName

string

Název rozšíření. Příklad: "ops-tools".

reason

string

reasonCode

string

Návraty

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>

Parametry

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Návraty

Promise<any>

updateInstalledExtension(InstalledExtension)

Aktualizace nainstalovaného rozšíření Obvykle se toto rozhraní API používá k povolení nebo zakázání rozšíření.

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

Parametry

extension

InstalledExtension

Návraty

Promise<InstalledExtension>