AlertRestClient class

new AlertRestClient(options: IVssRestClientOptions)

المعلمات

يتلقى استدعاء من خط أنابيب التثبيت التلقائي بنتيجة التشغيل. Idempotent: تكرار المكالمات لطلب موجود بالفعل في الحالة النهائية يعيد 200 بدون تغييرات.

function autofixCallback(callbackRequest: AutofixCallbackRequest, project: string, repository: string, alertId: number): Promise<void>

المعلمات

المرتجعات

أنشئ طلب تصحيح تلقائي للتنبيه المحدد.

function createAutofixRequest(project: string, alertId: number, repository: string, ref?: string): Promise<AutofixRequest>

المعلمات

المرتجعات

إنشاء مراجعة قانونية. يؤدي ذلك إلى إنشاء المراجعة القانونية المقترنة بالتنبيه. يتضمن عنوان URL لعنصر عمل المراجعة.

function createLegalReview(project: string, repository: string, alertId: number, ref?: string): Promise<LegalReview>

المعلمات

المرتجعات

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

function deleteAllPipelineAnalyses(project: string, repository: string): Promise<void>

المعلمات

المرتجعات

يقوم بحذف بيانات التحليل لخط أنابيب محدد، وتنظيف تنبيهات الأمان المتقدمة المرتبطة.

function deletePipelineAnalysis(project: string, repository: string, adoPipelineId: number): Promise<void>

المعلمات

المرتجعات

تصدير التنبيهات كملف SARIF واحد

function exportSarif(project: string, repository: string, alertIds: number[], branchName?: string): Promise<any>

المعلمات

المرتجعات

الحصول على تنبيه.

function getAlert(project: string, alertId: number, repository: string, ref?: string, expand?: ExpandOption): Promise<Alert>

المعلمات

المرتجعات

احصل على مثيلات تنبيه على فرع محدد باستخدام @ref. إذا @ref لم يتم توفيرها، فسترجع مثيلات تنبيه على الفرع الافتراضي (إذا كان التنبيه موجودا في الفرع الافتراضي) أو أحدث فرع متأثر.

function getAlertInstances(project: string, alertId: number, repository: string, ref?: string): Promise<AlertAnalysisInstance[]>

المعلمات

المرتجعات

احصل على بيانات وصفية للتنبيه.

function getAlertMetadata(project: string, alertId: number, repository: string): Promise<AlertMetadata>

المعلمات

المرتجعات

احصل على بيانات وصفية للتنبيهات.

function getAlertMetadataBatch(alertMetadataBatchRequest: AlertMetadataBatchRequest, project: string, repository: string): Promise<AlertMetadata[]>

المعلمات

المرتجعات

الحصول على تنبيهات لمستودع

function getAlerts(project: string, repository: string, top?: number, orderBy?: string, criteria?: SearchCriteria, expand?: AlertListExpandOption, continuationToken?: string): Promise<PagedList<Alert>>

المعلمات

المرتجعات

الحصول على تنبيه.

function getAlertSarif(project: string, alertId: number, repository: string, ref?: string, expand?: ExpandOption): Promise<string>

المعلمات

المرتجعات

احصل على التنبيهات عبر معرفات التنبيهات يدعم حاليا جلب التنبيهات السرية فقط.

function getAlertsByIds(request: AlertBatchRequest, project: string, repository: string, includeSensitiveInformation?: boolean): Promise<Alert[]>

المعلمات

المرتجعات

احصل على جميع طلبات التصحيح التلقائي للتنبيه المحدد.

function getAutofixRequestsByAlertId(project: string, alertId: number, repository: string, ref?: string): Promise<AutofixRequest[]>

المعلمات

المرتجعات

إرجاع الفروع التي تم إرسال نتائج التحليل لها.

function getBranches(project: string, repository: string, alertType: AlertType, continuationToken?: string, branchNameContains?: string, top?: number, includePullRequestBranches?: boolean): Promise<Branch[]>

المعلمات

المرتجعات

احصل على تنبيهات حسب معرفاتهم على مستوى المؤسسة. لا يعيد سوى إعادة تشغيل التنبيهات التي يمتلك المستخدم إذنا لعرضها. ترجع فقط تنبيهات خطط SKU التي تم تمكينها.

function getOrgLevelAlertsByIds(alertIds: number[]): Promise<Alert[]>

المعلمات

المرتجعات

الحصول على حالة مهمة معالجة Sarif

function getSarif(sarifId: number): Promise<SarifUploadStatus>

المعلمات

المرتجعات

function getSarifContent(submissionId: number): Promise<any>

المعلمات

المرتجعات

function getUxFilters(project: string, repository: string, alertType: AlertType): Promise<UxFilters>

المعلمات

المرتجعات

احصل على تفاصيل الصلاحية للتنبيه.

function getValidityData(project: string, repository: string, alertId: number): Promise<ValidationRequestInfo>

المعلمات

المرتجعات

بدء عملية التحقق من الصحة لتنبيه معين

function initiateValidation(project: string, repository: string, alertId: number): Promise<AlertValidationRequestStatus>

المعلمات

المرتجعات

تحديث حالة التنبيه

function updateAlert(stateUpdate: AlertStateUpdate, project: string, alertId: number, repository: string): Promise<Alert>

المعلمات

المرتجعات

تنبيه تحديث الدفعة يذكر. الاستخدام الداخلي فقط — يستخدم من قبل أجهزة مسح الإثبات لنقل تنبيهات المسودة التي يولدها الذكاء الاصطناعي إلى تنبيهات نشطة أو مرفوضة. التنبيهات التي تم تمييزها ك Draft (غير محددة) تبقى دون تغيير.

function updateAlertsBatch(request: AlertBatchStateUpdateRequest, project: string, repository: string): Promise<Alert[]>

المعلمات

المرتجعات

تحديث اقترانات بيانات تعريف التنبيه.

function updateAlertsMetadata(alertsMetadata: AlertMetadata[], project: string, repository: string): Promise<AlertMetadataChange[]>

المعلمات

المرتجعات

تحميل ملف Sarif على مستوى المؤسسة

function uploadOrgSarif(content: string): Promise<number>

المعلمات

المرتجعات

تحميل Sarif يحتوي على تنبيهات أمنية

function uploadSarif(content: string, project: string, repository: string, notificationFlag?: String): Promise<number>

المعلمات

المرتجعات

قم بتحميل ملف SARIF إلى GitHub أثناء مسح الشيفرة عبر تطبيق GitOps.

function uploadSarifToGitHub(content: string, project: string, hostname: string, owner: string, repo: string): Promise<string>

المعلمات

المرتجعات