ReportingRestClient class

الحزمة:

azure-devops-extension-api

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

يمتد

RestClientBase

المنشئون

ReportingRestClient(IVssRestClientOptions)

الأساليب

createAdvancedFilter(AdvancedFilterCreate)	ينشئ فلتر متقدم جديد للمنظمة.
deleteAdvancedFilter(string)	يحذف فلتر متقدم.
getAdvancedFilter(string)	تحصل على فلتر متقدم محدد بمعرفه.
getAlertSummaryForOrg(FilterCriteria)	الحصول على ملخص التنبيه حسب الخطورة للمؤسسة
getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)	احصل على تنبيهات مشتركة للمنظمة
getDependencyComponentNamesForOrg()	احصل على جميع أسماء مكونات التبعية المميزة للمنظمة (المستخدمة في تصفية تجربة المستخدم)
getEnablementSummaryForOrg(EnablementFilterCriteria)	احصل على ملخص التمكين للمنظمة
getProjectsAndReposForOrg()	احصل على جميع المشاريع والمستودعات الخاصة بالمنظمة (المستخدمة في تصفية تجربة المستخدم)
getRuleNamesForOrg(string)	احصل على جميع أسماء قواعد مسح الكود المميزة للمنظمة (المستخدمة في تصفية تجربة المستخدم)
getSecretTypesForOrg()	احصل على جميع أنواع الأسرار المميزة للمنظمة (المستخدمة في تصفية تجربة المستخدم)
getUXComputedFilters()
listAdvancedFilters(boolean, string)	يحصل على جميع الفلاتر المتقدمة للمنظمة.
updateAdvancedFilter(AdvancedFilterUpdate, string)	يحدث فلتر متقدم. يمكن تحديث الاسم فقط.

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

ReportingRestClient(IVssRestClientOptions)

new ReportingRestClient(options: IVssRestClientOptions)

المعلمات

options

IVssRestClientOptions

تفاصيل الأسلوب

createAdvancedFilter(AdvancedFilterCreate)

ينشئ فلتر متقدم جديد للمنظمة.

function createAdvancedFilter(filter: AdvancedFilterCreate): Promise<AdvancedFilter>

المعلمات

filter

AdvancedFilterCreate

الفلتر المتقدم للإنشاء.

المرتجعات

Promise<AdvancedFilter>

deleteAdvancedFilter(string)

يحذف فلتر متقدم.

function deleteAdvancedFilter(filterId: string): Promise<void>

المعلمات

filterId

string

معرف المرشح المتقدم الذي يجب حذفه.

المرتجعات

Promise<void>

getAdvancedFilter(string)

تحصل على فلتر متقدم محدد بمعرفه.

function getAdvancedFilter(filterId: string): Promise<AdvancedFilter>

المعلمات

filterId

string

معرف المرشح المتقدم للاسترجاع.

المرتجعات

Promise<AdvancedFilter>

getAlertSummaryForOrg(FilterCriteria)

الحصول على ملخص التنبيه حسب الخطورة للمؤسسة

function getAlertSummaryForOrg(criteria?: FilterCriteria): Promise<OrgAlertSummary>

المعلمات

criteria

FilterCriteria

خيارات للحد من الملخصات التي تم إرجاعها

المرتجعات

Promise<OrgAlertSummary>

getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)

احصل على تنبيهات مشتركة للمنظمة

function getCombinedAlertsForOrg(criteria?: CombinedAlertFilterCriteria, top?: number, continuationToken?: string): Promise<PagedList<DashboardAlert>>

المعلمات

criteria

CombinedAlertFilterCriteria

خيارات لتصفية التنبيهات المجمعة التي تم إرجاعها

top

number

الحد الأقصى لعدد التنبيهات التي يجب إرجاعها

continuationToken

string

إذا كان هناك تنبيهات أكثر مما يمكن إرجاعه، يتم وضع رمز مميز للمتابعة في عنوان "x-ms-continuationtoken". استخدم هذا الرمز المميز هنا للحصول على الصفحة التالية من التنبيهات

المرتجعات

Promise<PagedList<DashboardAlert>>

getDependencyComponentNamesForOrg()

احصل على جميع أسماء مكونات التبعية المميزة للمنظمة (المستخدمة في تصفية تجربة المستخدم)

function getDependencyComponentNamesForOrg(): Promise<string[]>

المرتجعات

Promise<string[]>

getEnablementSummaryForOrg(EnablementFilterCriteria)

احصل على ملخص التمكين للمنظمة

function getEnablementSummaryForOrg(criteria?: EnablementFilterCriteria): Promise<OrgEnablementSummary>

المعلمات

criteria

EnablementFilterCriteria

خيارات للحد من الملخصات التي تم إرجاعها

المرتجعات

Promise<OrgEnablementSummary>

getProjectsAndReposForOrg()

احصل على جميع المشاريع والمستودعات الخاصة بالمنظمة (المستخدمة في تصفية تجربة المستخدم)

function getProjectsAndReposForOrg(): Promise<ProjectAndRepoInfo[]>

المرتجعات

Promise<ProjectAndRepoInfo[]>

getRuleNamesForOrg(string)

احصل على جميع أسماء قواعد مسح الكود المميزة للمنظمة (المستخدمة في تصفية تجربة المستخدم)

function getRuleNamesForOrg(toolName?: string): Promise<CodeScanningRuleInfo[]>

المعلمات

toolName

string

اسم أداة اختياري لتصفية القواعد بواسطة

المرتجعات

Promise<CodeScanningRuleInfo[]>

getSecretTypesForOrg()

احصل على جميع أنواع الأسرار المميزة للمنظمة (المستخدمة في تصفية تجربة المستخدم)

function getSecretTypesForOrg(): Promise<string[]>

المرتجعات

Promise<string[]>

getUXComputedFilters()

function getUXComputedFilters(): Promise<ReportingUXComputedFilters>

المرتجعات

Promise<ReportingUXComputedFilters>

listAdvancedFilters(boolean, string)

يحصل على جميع الفلاتر المتقدمة للمنظمة.

function listAdvancedFilters(includeDeleted?: boolean, keywords?: string): Promise<AdvancedFilter[]>

المعلمات

includeDeleted

boolean

ما إذا كان يجب تضمين فلاتر محذوفة برمجيا.

keywords

string

مرشح اختياري للبحث عن الفلاتر حسب الاسم (غير حساس للحرف، تطابق جزئي).

المرتجعات

Promise<AdvancedFilter[]>

updateAdvancedFilter(AdvancedFilterUpdate, string)

يحدث فلتر متقدم. يمكن تحديث الاسم فقط.

function updateAdvancedFilter(filter: AdvancedFilterUpdate, filterId: string): Promise<void>

المعلمات

filter

AdvancedFilterUpdate

بيانات التحديث التي تحتوي على الاسم الجديد.

filterId

string

معرف الفلتر المتقدم للتحديث.

المرتجعات

Promise<void>