ExtensionManagementRestClient class

Pakiet:

azure-devops-extension-api

Klasa podstawowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Extends

RestClientBase

Konstruktory

ExtensionManagementRestClient(IVssRestClientOptions)

Właściwości

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)	Ten interfejs API jest wywoływany przez stronę pozyskiwania/instalowania, aby uzyskać możliwe akcje użytkownika, takie jak Zakup/Żądanie
getAuditLog(string, string)
getDocumentByName(string, string, string, string, string, string)
getDocumentsByName(string, string, string, string, string)
getInstalledExtensionByName(string, string, string[])	Pobierz zainstalowane rozszerzenie według nazwy wydawcy i rozszerzenia.
getInstalledExtensions(boolean, boolean, string[], boolean)	Wyświetl listę zainstalowanych rozszerzeń w kolekcji konta/projektu.
getPolicies(string)
getRequests()
getStates(boolean, boolean, boolean, boolean)	Wyświetl listę informacji o stanie i wersji dla wszystkich zainstalowanych rozszerzeń.
getToken()
installExtensionByName(string, string, string)	Zainstaluj określone rozszerzenie w kolekcji konta/projektu.
queryCollectionsByName(ExtensionDataCollectionQuery, string, string)	Wykonaj zapytanie o co najmniej jedną kolekcję danych dla określonego rozszerzenia. Uwaga: token używany do autoryzacji musi zostać wystawiony w imieniu określonego rozszerzenia.
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)	Odinstaluj określone rozszerzenie z kolekcji konta/projektu.
updateDocumentByName(any, string, string, string, string, string)
updateInstalledExtension(InstalledExtension)	Zaktualizuj zainstalowane rozszerzenie. Zazwyczaj ten interfejs API jest używany do włączania lub wyłączania rozszerzenia.

Szczegóły konstruktora

ExtensionManagementRestClient(IVssRestClientOptions)

new ExtensionManagementRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Szczegóły właściwości

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Wartość właściwości

string

Szczegóły 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

Zwraca

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

Zwraca

Promise<void>

deleteRequest(string, string)

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

Parametry

publisherName

string

extensionName

string

Zwraca

Promise<void>

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

Ten interfejs API jest wywoływany przez stronę pozyskiwania/instalowania, aby uzyskać możliwe akcje użytkownika, takie jak Zakup/Żądanie

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

Parametry

itemId

string

W pełni kwalifikowana nazwa rozszerzenia (<publisher_id>.<>extension_id)

testCommerce

boolean

Parametr do testowania płatnego rozszerzenia w wersji zapoznawczej bez udostępniania planów platformy Azure

isFreeOrTrialInstall

boolean

Parametr reprezentuje przepływ pracy instalacji lub wersji próbnej (wymagany dla starszych przepływów instalacji)

isAccountOwner

boolean

Parametr reprezentuje, czy użytkownik jest właścicielem, czy pcA konta

isLinked

boolean

Parametr reprezentuje, czy konto jest połączone z subskrypcją

isConnectedServer

boolean

Parametr reprezentuje, czy należy ocenić operację Buy

isBuyOperationValid

boolean

Zwraca

Promise<AcquisitionOptions>

getAuditLog(string, string)

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

Parametry

publisherName

string

extensionName

string

Zwraca

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>

Parametry

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

documentId

string

Zwraca

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

Zwraca

Promise<any[]>

getInstalledExtensionByName(string, string, string[])

Pobierz zainstalowane rozszerzenie według nazwy wydawcy i rozszerzenia.

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

Parametry

publisherName

string

Nazwa wydawcy. Przykład: "fabrikam".

extensionName

string

Nazwa rozszerzenia. Przykład: "ops-tools".

assetTypes

string[]

Określa, które pliki są zwracane w tablicy plików. Podaj symbol wieloznaczny "*", aby zwrócić wszystkie pliki lub rozdzielaną dwukropkiem listę, aby pobrać pliki z określonymi typami zasobów.

Zwraca

Promise<InstalledExtension>

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

Wyświetl listę zainstalowanych rozszerzeń w kolekcji konta/projektu.

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

Parametry

includeDisabledExtensions

boolean

Jeśli wartość true (wartość domyślna), uwzględnij wyłączone rozszerzenia w wynikach.

includeErrors

boolean

Jeśli to prawda, dołącz zainstalowane rozszerzenia z błędami.

assetTypes

string[]

Określa, które pliki są zwracane w tablicy plików. Podaj symbol wieloznaczny "*", aby zwrócić wszystkie pliki lub rozdzielaną dwukropkiem listę, aby pobrać pliki z określonymi typami zasobów.

includeInstallationIssues

boolean

Zwraca

Promise<InstalledExtension[]>

getPolicies(string)

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

Parametry

userId

string

Zwraca

Promise<UserExtensionPolicy>

getRequests()

function getRequests(): Promise<RequestedExtension[]>

Zwraca

Promise<RequestedExtension[]>

getStates(boolean, boolean, boolean, boolean)

Wyświetl listę informacji o stanie i wersji dla wszystkich zainstalowanych rozszerzeń.

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

Parametry

includeDisabled

boolean

Jeśli wartość true (wartość domyślna), uwzględnij wyłączone rozszerzenia w wynikach.

includeErrors

boolean

Jeśli wartość true, dołącz zainstalowane rozszerzenia w stanie błędu w wynikach.

includeInstallationIssues

boolean

forceRefresh

boolean

Zwraca

Promise<ExtensionState[]>

getToken()

function getToken(): Promise<string>

Zwraca

Promise<string>

installExtensionByName(string, string, string)

Zainstaluj określone rozszerzenie w kolekcji konta/projektu.

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

Parametry

publisherName

string

Nazwa wydawcy. Przykład: "fabrikam".

extensionName

string

Nazwa rozszerzenia. Przykład: "ops-tools".

version

string

Zwraca

Promise<InstalledExtension>

queryCollectionsByName(ExtensionDataCollectionQuery, string, string)

Wykonaj zapytanie o co najmniej jedną kolekcję danych dla określonego rozszerzenia. Uwaga: token używany do autoryzacji musi zostać wystawiony w imieniu określonego rozszerzenia.

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

Parametry

collectionQuery

ExtensionDataCollectionQuery

publisherName

string

Nazwa wydawcy. Przykład: "fabrikam".

extensionName

string

Nazwa rozszerzenia. Przykład: "ops-tools".

Zwraca

Promise<ExtensionDataCollection[]>

queryExtensions(InstalledExtensionQuery)

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

Parametry

query

InstalledExtensionQuery

Zwraca

Promise<InstalledExtension[]>

registerAuthorization(string, string, string)

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

Parametry

publisherName

string

extensionName

string

registrationId

string

Zwraca

Promise<ExtensionAuthorization>

requestAcquisition(ExtensionAcquisitionRequest)

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

Parametry

acquisitionRequest

ExtensionAcquisitionRequest

Zwraca

Promise<ExtensionAcquisitionRequest>

requestExtension(string, string, string)

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

Parametry

publisherName

string

extensionName

string

requestMessage

string

Zwraca

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

Zwraca

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

Zwraca

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

Zwraca

Promise<any>

uninstallExtensionByName(string, string, string, string)

Odinstaluj określone rozszerzenie z kolekcji konta/projektu.

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

Parametry

publisherName

string

Nazwa wydawcy. Przykład: "fabrikam".

extensionName

string

Nazwa rozszerzenia. Przykład: "ops-tools".

reason

string

reasonCode

string

Zwraca

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

Zwraca

Promise<any>

updateInstalledExtension(InstalledExtension)

Zaktualizuj zainstalowane rozszerzenie. Zazwyczaj ten interfejs API jest używany do włączania lub wyłączania rozszerzenia.

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

Parametry

extension

InstalledExtension

Zwraca

Promise<InstalledExtension>