PipelinesRestClient class
الفئة الأساسية التي يجب استخدامها (مشتقة من) لتقديم طلبات إلى VSS REST apis
- يمتد
الأساليب
| create |
إنشاء البنية الأساسية لبرنامج ربط العمليات التجارية. |
| get |
الحصول على بيانات اصطناعية معينة من تشغيل البنية الأساسية لبرنامج ربط العمليات التجارية |
| get |
الحصول على سجل معين من تشغيل البنية الأساسية لبرنامج ربط العمليات التجارية |
| get |
الحصول على البنية الأساسية لبرنامج ربط العمليات التجارية، اختياريا في الإصدار المحدد |
| get |
يحصل على تشغيل لمسار معين. |
| list |
احصل على قائمة بالسجلات من تشغيل البنية الأساسية لبرنامج ربط العمليات التجارية. |
| list |
احصل على قائمة بالبنية الأساسية لبرنامج ربط العمليات التجارية. |
| list |
الحصول على أفضل 10000 تشغيل لمسار معين. |
| preview(Run |
وضع قيد التشغيل الجاف للبنية الأساسية لبرنامج ربط العمليات التجارية وإرجاع كائن يحتوي على yaml النهائي. |
| run |
تشغيل البنية الأساسية لبرنامج ربط العمليات التجارية. |
تفاصيل المنشئ
PipelinesRestClient(IVssRestClientOptions)
تفاصيل الأسلوب
createPipeline(CreatePipelineParameters, string)
إنشاء البنية الأساسية لبرنامج ربط العمليات التجارية.
function createPipeline(inputParameters: CreatePipelineParameters, project: string): Promise<Pipeline>المعلمات
- inputParameters
- CreatePipelineParameters
معلمات الإدخال.
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<Pipeline>
getArtifact(string, number, number, string, GetArtifactExpandOptions)
الحصول على بيانات اصطناعية معينة من تشغيل البنية الأساسية لبرنامج ربط العمليات التجارية
function getArtifact(project: string, pipelineId: number, runId: number, artifactName: string, expand?: GetArtifactExpandOptions): Promise<Artifact>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- pipelineId
-
number
معرف البنية الأساسية لبرنامج ربط العمليات التجارية.
- runId
-
number
معرف تشغيل هذا المسار.
- artifactName
-
string
اسم البيانات الاصطناعية.
- expand
- GetArtifactExpandOptions
توسيع الخيارات. الافتراضي هو بلا.
المرتجعات
Promise<Artifact>
getLog(string, number, number, number, GetLogExpandOptions)
الحصول على سجل معين من تشغيل البنية الأساسية لبرنامج ربط العمليات التجارية
function getLog(project: string, pipelineId: number, runId: number, logId: number, expand?: GetLogExpandOptions): Promise<Log>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- pipelineId
-
number
معرف البنية الأساسية لبرنامج ربط العمليات التجارية.
- runId
-
number
معرف تشغيل هذا المسار.
- logId
-
number
معرف السجل.
- expand
- GetLogExpandOptions
توسيع الخيارات. الافتراضي هو بلا.
المرتجعات
Promise<Log>
getPipeline(string, number, number)
الحصول على البنية الأساسية لبرنامج ربط العمليات التجارية، اختياريا في الإصدار المحدد
function getPipeline(project: string, pipelineId: number, pipelineVersion?: number): Promise<Pipeline>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- pipelineId
-
number
معرف البنية الأساسية لبرنامج ربط العمليات التجارية
- pipelineVersion
-
number
إصدار البنية الأساسية لبرنامج ربط العمليات التجارية
المرتجعات
Promise<Pipeline>
getRun(string, number, number)
يحصل على تشغيل لمسار معين.
function getRun(project: string, pipelineId: number, runId: number): Promise<Run>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- pipelineId
-
number
معرف البنية الأساسية لبرنامج ربط العمليات التجارية
- runId
-
number
معرف التشغيل
المرتجعات
Promise<Run>
listLogs(string, number, number, GetLogExpandOptions)
احصل على قائمة بالسجلات من تشغيل البنية الأساسية لبرنامج ربط العمليات التجارية.
function listLogs(project: string, pipelineId: number, runId: number, expand?: GetLogExpandOptions): Promise<LogCollection>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- pipelineId
-
number
معرف البنية الأساسية لبرنامج ربط العمليات التجارية.
- runId
-
number
معرف تشغيل هذا المسار.
- expand
- GetLogExpandOptions
توسيع الخيارات. الافتراضي هو بلا.
المرتجعات
Promise<LogCollection>
listPipelines(string, string, number, string)
احصل على قائمة بالبنية الأساسية لبرنامج ربط العمليات التجارية.
function listPipelines(project: string, orderBy?: string, top?: number, continuationToken?: string): Promise<Pipeline[]>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- orderBy
-
string
تعبير فرز. الإعدادات الافتراضية ل "الاسم asc"
- top
-
number
الحد الأقصى لعدد المسارات التي يجب إرجاعها
- continuationToken
-
string
رمز متابعة مميز من طلب سابق، لاسترداد الصفحة التالية من النتائج
المرتجعات
Promise<Pipeline[]>
listRuns(string, number)
الحصول على أفضل 10000 تشغيل لمسار معين.
function listRuns(project: string, pipelineId: number): Promise<Run[]>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- pipelineId
-
number
معرف البنية الأساسية لبرنامج ربط العمليات التجارية
المرتجعات
Promise<Run[]>
preview(RunPipelineParameters, string, number, number)
وضع قيد التشغيل الجاف للبنية الأساسية لبرنامج ربط العمليات التجارية وإرجاع كائن يحتوي على yaml النهائي.
function preview(runParameters: RunPipelineParameters, project: string, pipelineId: number, pipelineVersion?: number): Promise<PreviewRun>المعلمات
- runParameters
- RunPipelineParameters
معلمات إضافية اختيارية لهذا التشغيل.
- project
-
string
معرف المشروع أو اسم المشروع
- pipelineId
-
number
معرف البنية الأساسية لبرنامج ربط العمليات التجارية.
- pipelineVersion
-
number
إصدار البنية الأساسية لبرنامج ربط العمليات التجارية.
المرتجعات
Promise<PreviewRun>
runPipeline(RunPipelineParameters, string, number, number)
تشغيل البنية الأساسية لبرنامج ربط العمليات التجارية.
function runPipeline(runParameters: RunPipelineParameters, project: string, pipelineId: number, pipelineVersion?: number): Promise<Run>المعلمات
- runParameters
- RunPipelineParameters
معلمات إضافية اختيارية لهذا التشغيل.
- project
-
string
معرف المشروع أو اسم المشروع
- pipelineId
-
number
معرف البنية الأساسية لبرنامج ربط العمليات التجارية.
- pipelineVersion
-
number
إصدار البنية الأساسية لبرنامج ربط العمليات التجارية.
المرتجعات
Promise<Run>