ExtensionManagementRestClient class

Paket:

azure-devops-extension-api

VSS REST api'lerine istekte bulunmak için kullanılması gereken (türetilen) temel sınıf

Extends

RestClientBase

Oluşturucular

ExtensionManagementRestClient(IVssRestClientOptions)

Özellikler

RESOURCE_AREA_ID

Yöntemler

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)	Bu API, Satın Al/İstek gibi olası kullanıcı eylemlerini almak için alım/yükleme sayfası tarafından çağrılır
getAuditLog(string, string)
getAuthorization(string, string, string)
getDocumentByName(string, string, string, string, string, string)
getDocumentsByName(string, string, string, string, string)
getInstalledExtensionByName(string, string, string[])	Yüklü bir uzantıyı yayımcısına ve uzantı adına göre alın.
getInstalledExtensions(boolean, boolean, string[], boolean)	Hesap / proje koleksiyonunda yüklü uzantıları listeleyin.
getPolicies(string)
getRequests()
getStates(boolean, boolean, boolean, boolean)	Yüklü tüm uzantılar için durum ve sürüm bilgilerini listeleyin.
getToken()
installExtensionByName(string, string, string)	Belirtilen uzantıyı hesap / proje koleksiyonuna yükleyin.
queryCollectionsByName(ExtensionDataCollectionQuery, string, string)	Belirtilen uzantı için bir veya daha fazla veri koleksiyonu sorgusu. Not: Yetkilendirme için kullanılan belirteç, belirtilen uzantı adına verilmiş olmalıdır.
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)	Belirtilen uzantıyı hesaptan / proje koleksiyonundan kaldırın.
updateDocumentByName(any, string, string, string, string, string)
updateInstalledExtension(InstalledExtension)	Yüklü bir uzantıyı güncelleyin. Genellikle bu API, bir uzantıyı etkinleştirmek veya devre dışı bırakmak için kullanılır.

Oluşturucu Ayrıntıları

ExtensionManagementRestClient(IVssRestClientOptions)

new ExtensionManagementRestClient(options: IVssRestClientOptions)

Parametreler

options

IVssRestClientOptions

Özellik Ayrıntıları

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Özellik Değeri

string

Yöntem Ayrıntıları

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

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

Parametreler

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Döndürülenler

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>

Parametreler

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

documentId

string

Döndürülenler

Promise<void>

deleteRequest(string, string)

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

Parametreler

publisherName

string

extensionName

string

Döndürülenler

Promise<void>

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

Bu API, Satın Al/İstek gibi olası kullanıcı eylemlerini almak için alım/yükleme sayfası tarafından çağrılır

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

Parametreler

itemId

string

Uzantının tam adı (<publisher_id>.<extension_id>)

testCommerce

boolean

Azure planlarını herkese açık hale getirmeden ücretli önizleme uzantısını test etme parametresi

isFreeOrTrialInstall

boolean

Parametre, yükleme veya deneme iş akışını temsil eder (eski yükleme akışları için gereklidir)

isAccountOwner

boolean

Parametre, kullanıcının bir hesabın sahibi mi yoksa PCA'sı mı olduğunu temsil eder

isLinked

boolean

Parametre, hesabın bir aboneliğe bağlı olup olmadığını gösterir

isConnectedServer

boolean

Parametre, Satın alma işleminin değerlendirilip değerlendirilmeyeceğini temsil eder

isBuyOperationValid

boolean

Döndürülenler

Promise<AcquisitionOptions>

getAuditLog(string, string)

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

Parametreler

publisherName

string

extensionName

string

Döndürülenler

Promise<ExtensionAuditLog>

getAuthorization(string, string, string)

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

Parametreler

publisherName

string

extensionName

string

registrationId

string

Döndürülenler

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>

Parametreler

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

documentId

string

Döndürülenler

Promise<any>

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

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

Parametreler

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Döndürülenler

Promise<any[]>

getInstalledExtensionByName(string, string, string[])

Yüklü bir uzantıyı yayımcısına ve uzantı adına göre alın.

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

Parametreler

publisherName

string

Yayıncının adı. Örnek: "fabrikam".

extensionName

string

Uzantının adı. Örnek: "ops-tools".

assetTypes

string[]

files dizisinde hangi dosyaların döndürüleceğini belirler. Tüm dosyaları döndürmek için '*' joker karakterini veya belirli varlık türlerine sahip dosyaları almak için iki nokta üst üste ile ayrılmış bir liste sağlayın.

Döndürülenler

Promise<InstalledExtension>

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

Hesap / proje koleksiyonunda yüklü uzantıları listeleyin.

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

Parametreler

includeDisabledExtensions

boolean

Doğruysa (varsayılan), sonuçlara devre dışı bırakılmış uzantıları dahil edin.

includeErrors

boolean

Doğruysa, hatalı yüklü uzantıları dahil edin.

assetTypes

string[]

files dizisinde hangi dosyaların döndürüleceğini belirler. Tüm dosyaları döndürmek için '*' joker karakterini veya belirli varlık türlerine sahip dosyaları almak için iki nokta üst üste ile ayrılmış bir liste sağlayın.

includeInstallationIssues

boolean

Döndürülenler

Promise<InstalledExtension[]>

getPolicies(string)

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

Parametreler

userId

string

Döndürülenler

Promise<UserExtensionPolicy>

getRequests()

function getRequests(): Promise<RequestedExtension[]>

Döndürülenler

Promise<RequestedExtension[]>

getStates(boolean, boolean, boolean, boolean)

Yüklü tüm uzantılar için durum ve sürüm bilgilerini listeleyin.

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

Parametreler

includeDisabled

boolean

Doğruysa (varsayılan), sonuçlara devre dışı bırakılmış uzantıları dahil edin.

includeErrors

boolean

Doğruysa, sonuçlara bir hata durumunda yüklü uzantıları dahil edin.

includeInstallationIssues

boolean

forceRefresh

boolean

Döndürülenler

Promise<ExtensionState[]>

getToken()

function getToken(): Promise<string>

Döndürülenler

Promise<string>

installExtensionByName(string, string, string)

Belirtilen uzantıyı hesap / proje koleksiyonuna yükleyin.

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

Parametreler

publisherName

string

Yayıncının adı. Örnek: "fabrikam".

extensionName

string

Uzantının adı. Örnek: "ops-tools".

version

string

Döndürülenler

Promise<InstalledExtension>

queryCollectionsByName(ExtensionDataCollectionQuery, string, string)

Belirtilen uzantı için bir veya daha fazla veri koleksiyonu sorgusu. Not: Yetkilendirme için kullanılan belirteç, belirtilen uzantı adına verilmiş olmalıdır.

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

Parametreler

collectionQuery

ExtensionDataCollectionQuery

publisherName

string

Yayıncının adı. Örnek: "fabrikam".

extensionName

string

Uzantının adı. Örnek: "ops-tools".

Döndürülenler

Promise<ExtensionDataCollection[]>

queryExtensions(InstalledExtensionQuery)

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

Parametreler

query

InstalledExtensionQuery

Döndürülenler

Promise<InstalledExtension[]>

registerAuthorization(string, string, string)

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

Parametreler

publisherName

string

extensionName

string

registrationId

string

Döndürülenler

Promise<ExtensionAuthorization>

requestAcquisition(ExtensionAcquisitionRequest)

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

Parametreler

acquisitionRequest

ExtensionAcquisitionRequest

Döndürülenler

Promise<ExtensionAcquisitionRequest>

requestExtension(string, string, string)

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

Parametreler

publisherName

string

extensionName

string

requestMessage

string

Döndürülenler

Promise<RequestedExtension>

resolveAllRequests(string, string, string, ExtensionRequestState)

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

Parametreler

rejectMessage

string

publisherName

string

extensionName

string

state

ExtensionRequestState

Döndürülenler

Promise<number>

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

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

Parametreler

rejectMessage

string

publisherName

string

extensionName

string

requesterId

string

state

ExtensionRequestState

Döndürülenler

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>

Parametreler

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Döndürülenler

Promise<any>

uninstallExtensionByName(string, string, string, string)

Belirtilen uzantıyı hesaptan / proje koleksiyonundan kaldırın.

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

Parametreler

publisherName

string

Yayıncının adı. Örnek: "fabrikam".

extensionName

string

Uzantının adı. Örnek: "ops-tools".

reason

string

reasonCode

string

Döndürülenler

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>

Parametreler

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Döndürülenler

Promise<any>

updateInstalledExtension(InstalledExtension)

Yüklü bir uzantıyı güncelleyin. Genellikle bu API, bir uzantıyı etkinleştirmek veya devre dışı bırakmak için kullanılır.

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

Parametreler

extension

InstalledExtension

Döndürülenler

Promise<InstalledExtension>