ExtensionManagementRestClient class

الحزمة:

azure-devops-extension-api

الفئة الأساسية التي يجب استخدامها (مشتقة من) لتقديم طلبات إلى VSS REST apis

يمتد

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)	يتم استدعاء واجهة برمجة التطبيقات هذه عن طريق صفحة الاستحواذ / التثبيت للحصول على إجراءات المستخدم المحتملة مثل شراء / طلب
getAuditLog(string, string)
getAuthorization(string, 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)	تحديث ملحق مثبت. عادة ما يتم استخدام واجهة برمجة التطبيقات هذه لتمكين ملحق أو تعطيله.

تفاصيل المنشئ

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)

يتم استدعاء واجهة برمجة التطبيقات هذه عن طريق صفحة الاستحواذ / التثبيت للحصول على إجراءات المستخدم المحتملة مثل شراء / طلب

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>

getAuthorization(string, string, string)

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

المعلمات

publisherName

string

extensionName

string

registrationId

string

المرتجعات

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>

المعلمات

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

اسم الملحق. مثال: "أدوات العمليات".

assetTypes

string[]

يحدد الملفات التي يتم إرجاعها في مصفوفة الملفات. قم بتوفير حرف البدل "*" لإرجاع جميع الملفات، أو قائمة مفصولة بنقطتين لاسترداد الملفات بأنواع أصول معينة.

المرتجعات

Promise<InstalledExtension>

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

قم بإدراج الإضافات المثبتة في مجموعة الحسابات / المشروع.

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

المعلمات

includeDisabledExtensions

boolean

إذا كانت صحيحة (الإعداد الافتراضي)، فقم بتضمين الإضافات المعطلة في النتائج.

includeErrors

boolean

إذا كان هذا صحيحا، فقم بتضمين الإضافات المثبتة التي تحتوي على أخطاء.

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

إذا كانت صحيحة (الإعداد الافتراضي)، فقم بتضمين الإضافات المعطلة في النتائج.

includeErrors

boolean

إذا كان هذا صحيحا، فقم بتضمين الملحقات المثبتة في حالة خطأ في النتائج.

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

اسم الملحق. مثال: "أدوات العمليات".

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

اسم الملحق. مثال: "أدوات العمليات".

المرتجعات

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

اسم الملحق. مثال: "أدوات العمليات".

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)

تحديث ملحق مثبت. عادة ما يتم استخدام واجهة برمجة التطبيقات هذه لتمكين ملحق أو تعطيله.

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

المعلمات

extension

InstalledExtension

المرتجعات

Promise<InstalledExtension>