ManagementRestClient class

الحزمة:

azure-devops-extension-api

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

يمتد

RestClientBase

المنشئون

ManagementRestClient(IVssRestClientOptions)

الأساليب

createBillingSnapshot2(MeterUsageForPlan, Plan)	أثناء حساب الفوترة متعددة المؤسسات في وحدة المقياس الأساسي (EUS21)، يتم استخدام واجهة برمجة التطبيقات هذه لإنشاء لقطة فوترة لمؤسسة معينة. ستستدعي وحدة المقياس الأساسية واجهة برمجة التطبيقات هذه لكل مؤسسة في وحدات scsle مختلفة لإنشاء لقطة فوترة. سيتم تخزين البيانات في قاعدة بيانات القسم الخاص بالمؤسسة -> جدول لقطة الفوترة. هذا مطلوب لأن العملاء سوف يجلبون بيانات الفوترة من قاعدة بيانات القسم الخاص بالمؤسسة الخاصة بهم.
getBillableCommitterDetails2(Plan, Date)	احصل على جميع تفاصيل الالتزامات القابلة للفوترة، بما في ذلك تلك غير المتطابقة مع VSID.
getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)	تقدير الدفعات التي ستتم إضافتها إلى استخدام العميل إذا تم تمكين الأمان المتقدم لهذا المستودع.
getEstimatedBillablePushersDetailsForOrg2(Plan)	تقدير الدفعات التي ستتم إضافتها إلى استخدام العميل إذا تم تمكين الأمان المتقدم لهذه المؤسسة.
getEstimatedBillablePushersDetailsForProject2(string, Plan)	تقدير الدفعات التي ستتم إضافتها إلى استخدام العميل إذا تم تمكين الأمان المتقدم لهذا المشروع.
getLastMeterUsage2(Plan)
getMeterUsage2(Plan, Date)	استخدم الملتزمين عند حساب معلومات الفوترة.
getOrgEnablementStatus2(boolean)	الحصول على الحالة الحالية للأمان المتقدم للمؤسسة
getProjectEnablementStatus2(string, boolean)	الحصول على الحالة الحالية للأمان المتقدم لمشروع
getRepoEnablementStatus2(string, string, boolean)	يحدد ما إذا كان أمان التعليمات البرمجية والحماية السرية وميزاتها ممكنة للمستودع.
updateOrgEnablementStatus2(OrgEnablementSettings)	تحديث حالة الأمان المتقدم للمؤسسة
updateProjectEnablementStatus2(ProjectEnablementSettings, string)	تحديث حالة الأمان المتقدم للمشروع
updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)	قم بتحديث حالة التمكين ل Code Security و Secret Protection ، جنبا إلى جنب مع الميزات الخاصة بهما ، لمستودع معين.

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

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

المعلمات

options

IVssRestClientOptions

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

createBillingSnapshot2(MeterUsageForPlan, Plan)

أثناء حساب الفوترة متعددة المؤسسات في وحدة المقياس الأساسي (EUS21)، يتم استخدام واجهة برمجة التطبيقات هذه لإنشاء لقطة فوترة لمؤسسة معينة. ستستدعي وحدة المقياس الأساسية واجهة برمجة التطبيقات هذه لكل مؤسسة في وحدات scsle مختلفة لإنشاء لقطة فوترة. سيتم تخزين البيانات في قاعدة بيانات القسم الخاص بالمؤسسة -> جدول لقطة الفوترة. هذا مطلوب لأن العملاء سوف يجلبون بيانات الفوترة من قاعدة بيانات القسم الخاص بالمؤسسة الخاصة بهم.

function createBillingSnapshot2(meterUsage: MeterUsageForPlan, plan: Plan): Promise<void>

المعلمات

meterUsage

MeterUsageForPlan

plan

Plan

المرتجعات

Promise<void>

getBillableCommitterDetails2(Plan, Date)

احصل على جميع تفاصيل الالتزامات القابلة للفوترة، بما في ذلك تلك غير المتطابقة مع VSID.

function getBillableCommitterDetails2(plan: Plan, billingDate?: Date): Promise<BillableCommitterDetails[]>

المعلمات

plan

Plan

خطة الاستعلام. الخطط المدعومة: CodeSecurity وSecretProtection. هذه معلمة إلزامية.

billingDate

Date

تاريخ الاستعلام، أو إذا لم يتم توفيره، اليوم

المرتجعات

Promise<BillableCommitterDetails[]>

getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)

تقدير الدفعات التي ستتم إضافتها إلى استخدام العميل إذا تم تمكين الأمان المتقدم لهذا المستودع.

function getEstimatedBillableCommittersDetailsForRepo2(project: string, repository: string, plan?: Plan): Promise<MeterUsageEstimate>

المعلمات

project

string

معرف المشروع أو اسم المشروع

repository

string

اسم المستودع أو معرفه

plan

Plan

خطة الاستعلام.

المرتجعات

Promise<MeterUsageEstimate>

getEstimatedBillablePushersDetailsForOrg2(Plan)

تقدير الدفعات التي ستتم إضافتها إلى استخدام العميل إذا تم تمكين الأمان المتقدم لهذه المؤسسة.

function getEstimatedBillablePushersDetailsForOrg2(plan?: Plan): Promise<MeterUsageEstimate>

المعلمات

plan

Plan

خطة الاستعلام.

المرتجعات

Promise<MeterUsageEstimate>

getEstimatedBillablePushersDetailsForProject2(string, Plan)

تقدير الدفعات التي ستتم إضافتها إلى استخدام العميل إذا تم تمكين الأمان المتقدم لهذا المشروع.

function getEstimatedBillablePushersDetailsForProject2(project: string, plan?: Plan): Promise<MeterUsageEstimate>

المعلمات

project

string

معرف المشروع أو اسم المشروع

plan

Plan

المرتجعات

Promise<MeterUsageEstimate>

getLastMeterUsage2(Plan)

function getLastMeterUsage2(plan: Plan): Promise<MeterUsageForPlan>

المعلمات

plan

Plan

المرتجعات

Promise<MeterUsageForPlan>

getMeterUsage2(Plan, Date)

استخدم الملتزمين عند حساب معلومات الفوترة.

function getMeterUsage2(plan: Plan, billingDate?: Date): Promise<MeterUsageForPlan>

المعلمات

plan

Plan

خطة الاستعلام. الخطط المدعومة: CodeSecurity وSecretProtection. هذه معلمة إلزامية.

billingDate

Date

تاريخ الاستعلام، أو إذا لم يتم توفيره، اليوم

المرتجعات

Promise<MeterUsageForPlan>

getOrgEnablementStatus2(boolean)

الحصول على الحالة الحالية للأمان المتقدم للمؤسسة

function getOrgEnablementStatus2(includeAllProperties?: boolean): Promise<OrgEnablementSettings>

المعلمات

includeAllProperties

boolean

عندما يكون صحيحا، حدد أيضا ما إذا كانت الدفعات محظورة إذا كانت تحتوي على أسرار

المرتجعات

Promise<OrgEnablementSettings>

getProjectEnablementStatus2(string, boolean)

الحصول على الحالة الحالية للأمان المتقدم لمشروع

function getProjectEnablementStatus2(project: string, includeAllProperties?: boolean): Promise<ProjectEnablementSettings>

المعلمات

project

string

معرف المشروع أو اسم المشروع

includeAllProperties

boolean

عندما يكون صحيحا، حدد أيضا ما إذا كانت الدفعات محظورة إذا كانت تحتوي على أسرار

المرتجعات

Promise<ProjectEnablementSettings>

getRepoEnablementStatus2(string, string, boolean)

يحدد ما إذا كان أمان التعليمات البرمجية والحماية السرية وميزاتها ممكنة للمستودع.

function getRepoEnablementStatus2(project: string, repository: string, includeAllProperties?: boolean): Promise<RepoEnablementSettings>

المعلمات

project

string

معرف المشروع أو اسم المشروع

repository

string

اسم المستودع أو معرفه

includeAllProperties

boolean

عندما يكون صحيحا، سيحدد أيضا ما إذا كانت الدفعات محظورة عند الكشف عن الأسرار

المرتجعات

Promise<RepoEnablementSettings>

updateOrgEnablementStatus2(OrgEnablementSettings)

تحديث حالة الأمان المتقدم للمؤسسة

function updateOrgEnablementStatus2(orgEnablementSettings: OrgEnablementSettings): Promise<void>

المعلمات

orgEnablementSettings

OrgEnablementSettings

الحالة الجديدة

المرتجعات

Promise<void>

updateProjectEnablementStatus2(ProjectEnablementSettings, string)

تحديث حالة الأمان المتقدم للمشروع

function updateProjectEnablementStatus2(projectEnablementSettings: ProjectEnablementSettings, project: string): Promise<void>

المعلمات

projectEnablementSettings

ProjectEnablementSettings

الحالة الجديدة

project

string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<void>

updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)

قم بتحديث حالة التمكين ل Code Security و Secret Protection ، جنبا إلى جنب مع الميزات الخاصة بهما ، لمستودع معين.

function updateRepoAdvSecEnablementStatus2(repoEnablementSettings: RepoEnablementSettings, project: string, repository: string): Promise<void>

المعلمات

repoEnablementSettings

RepoEnablementSettings

الوضع الجديد

project

string

معرف المشروع أو اسم المشروع

repository

string

اسم المستودع أو معرفه

المرتجعات

Promise<void>