ReleaseRestClient class

الحزمة:: azure-devops-extension-api

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

يمتد: RestClientBase

المنشئون

ReleaseRestClient(IVssRestClientOptions)

الخصائص

الأساليب

addDefinitionTag(string, number, string)	إضافة علامة إلى تعريف
addDefinitionTags(string[], string, number)	إضافة علامات متعددة إلى تعريف
addReleaseTag(string, number, string)	إضافة علامة إلى معرف الإصدار
addReleaseTags(string[], string, number)	إضافة علامة إلى إصدار
createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)	إنشاء قالب بيئة تعريف
createFavorites(FavoriteItem[], string, string, string)
createFolder(Folder, string, string)	إنشاء مجلد جديد.
createRelease(ReleaseStartMetadata, string)	إنشاء إصدار.
createReleaseDefinition(ReleaseDefinition, string)	إنشاء تعريف إصدار
deleteDefinitionEnvironmentTemplate(string, string)	حذف قالب بيئة تعريف
deleteDefinitionTag(string, number, string)	حذف علامة من تعريف
deleteFavorites(string, string, string, string)
deleteFolder(string, string)	حذف مجلد تعريف لاسم مجلد معين ومساره وكل تعريفاته الموجودة.
deleteRelease(string, number, string)	حذف مبدئي لإصدار
deleteReleaseDefinition(string, number, string, boolean)	حذف تعريف إصدار.
deleteReleaseTag(string, number, string)	حذف علامة من إصدار
getAgentArtifactDefinitions(string, number)	إرجاع تفاصيل البيانات الاصطناعية التي يتطلبها عامل التشغيل التلقائي
getApproval(string, number, boolean)	الحصول على موافقة.
getApprovalHistory(string, number)	الحصول على محفوظات الموافقة.
getApprovals(string, string, ApprovalStatus, number[], ApprovalType, number, number, ReleaseQueryOrder, boolean)	الحصول على قائمة بالموافقات
getArtifactTypeDefinitions(string)
getArtifactVersions(string, number)
getArtifactVersionsForSources(Artifact[], string)
getAutoTriggerIssues(string, string, string, string)
getDefinitionEnvironments(string, string, string[])
getDefinitionEnvironmentTemplate(string, string)	الحصول على قالب بيئة تعريف
getDefinitionRevision(string, number, number)	الحصول على تعريف الإصدار لتعريف معين ومراجعته
getDefinitionTags(string, number)	الحصول على علامات تعريف
getDeploymentBadge(string, number, number, string)	يحصل على شارة تشير إلى حالة أحدث عملية نشر لبيئة ما.
getDeployments(string, number, number, string, Date, Date, DeploymentStatus, DeploymentOperationStatus, boolean, ReleaseQueryOrder, number, number, string, Date, Date, string)	الحصول على قائمة عمليات التوزيع
getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)
getFavorites(string, string, string)
getFolders(string, string, FolderPathQueryOrder)	الحصول على المجلدات.
getGateLog(string, number, number, number, number)	الحصول على سجلات البوابة
getInputValues(InputValuesQuery, string)
getIssues(string, number, string)
getLog(string, number, number, number, number)	الحصول على السجلات
getLogs(string, number)	الحصول على سجلات لمعرف الإصدار.
getManualIntervention(string, number, number)	الحصول على التدخل اليدوي لإصدار معين ومعرف التدخل اليدوي.
getManualInterventions(string, number)	سرد جميع التدخلات اليدوية لإصدار معين.
getMetrics(string, Date)
getOrgPipelineReleaseSettings()	الحصول على إعدادات إصدار البنية الأساسية لبرنامج ربط العمليات التجارية ل Org
getPipelineReleaseSettings(string)	الحصول على إعدادات إصدار البنية الأساسية لبرنامج ربط العمليات التجارية
getRelease(string, number, ApprovalFilters, string[], SingleReleaseExpands, number, boolean)	الحصول على إصدار
getReleaseChanges(string, number, number, number, string)
getReleaseDefinition(string, number, string[], boolean)	الحصول على تعريف الإصدار.
getReleaseDefinitionHistory(string, number)	الحصول على محفوظات المراجعة لتعريف الإصدار
getReleaseDefinitionRevision(string, number, number)	الحصول على تعريف الإصدار لمراجعة معينة.
getReleaseDefinitions(string, string, ReleaseDefinitionExpands, string, string, number, string, ReleaseDefinitionQueryOrder, string, boolean, string[], string[], string[], boolean, boolean)	احصل على قائمة بتعريفات الإصدار.
getReleaseDefinitionSummary(string, number, number, boolean, number[])	الحصول على ملخص الإصدار لمعرف تعريف معين.
getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)	احصل على بيئة إصدار.
getReleaseHistory(string, number)
getReleaseProjects(string, string)
getReleaseRevision(string, number, number)	الحصول على إصدار لرقم مراجعة معين.
getReleases(string, number, number, string, string, ReleaseStatus, number, Date, Date, ReleaseQueryOrder, number, number, ReleaseExpands, string, string, string, string, boolean, string[], string[], number[], string)	الحصول على قائمة الإصدارات
getReleaseSettings(string)	الحصول على إعدادات الإصدار
getReleaseTags(string, number)	الحصول على علامات الإصدار
getReleaseTaskAttachmentContent(string, number, number, number, string, string, string, string, string)	الحصول على مرفق مهمة الإصدار.
getReleaseTaskAttachments(string, number, number, number, string, string)	الحصول على مرفقات مهمة الإصدار.
getReleaseWorkItemsRefs(string, number, number, number, string)
getSourceBranches(string, number)
getSummaryMailSections(string, number)
getTags(string)
getTaskAttachmentContent(string, number, number, number, string, string, string, string)	الحصول على مرفق مهمة.
getTaskAttachments(string, number, number, number, string, string)	الحصول على مرفقات المهمة.
getTaskLog(string, number, number, number, number, number, number)	الحصول على سجل مهام الإصدار كملف نص عادي.
getTaskLog2(string, number, number, number, string, number, number, number)	الحصول على سجل مهام الإصدار كملف نص عادي.
getTasks(string, number, number, number)
getTasks2(string, number, number, number, string)
getTasksForTaskGroup(string, number, number, number)
listDefinitionEnvironmentTemplates(string, boolean)	الحصول على قائمة بقوالب بيئة التعريف
sendSummaryMail(MailMessage, string, number)
undeleteRelease(string, number, string)	إلغاء حذف إصدار محذوف مبدئيا.
undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)	إلغاء حذف تعريف إصدار.
undeleteReleaseDefinitionEnvironmentTemplate(string, string)	إلغاء حذف قالب بيئة تعريف الإصدار.
updateFolder(Folder, string, string)	تحديث مجلد موجود في مسار موجود معين.
updateGates(GateUpdateMetadata, string, number)	تحديث بوابة النشر.
updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)	تحديث التدخل اليدوي.
updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)	تحديث إعدادات إصدار البنية الأساسية لبرنامج ربط العمليات التجارية ل Org
updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)	تحديث إعدادات إصدار البنية الأساسية لبرنامج ربط العمليات التجارية
updateRelease(Release, string, number)	تحديث كائن إصدار كامل.
updateReleaseApproval(ReleaseApproval, string, number)	تحديث حالة الموافقة
updateReleaseApprovals(ReleaseApproval[], string)
updateReleaseDefinition(ReleaseDefinition, string, boolean)	تحديث تعريف الإصدار.
updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)	تحديث حالة بيئة الإصدار
updateReleaseResource(ReleaseUpdateMetadata, string, number)	تحديث بعض خصائص الإصدار.
updateReleaseSettings(ReleaseSettings, string)	تحديث إعدادات الإصدار

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

ReleaseRestClient(IVssRestClientOptions)

new ReleaseRestClient(options: IVssRestClientOptions)

المعلمات

options: IVssRestClientOptions

تفاصيل الخاصية

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

قيمة الخاصية

string

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

addDefinitionTag(string, number, string)

إضافة علامة إلى تعريف

function addDefinitionTag(project: string, releaseDefinitionId: number, tag: string): Promise<string[]>

المعلمات

project: string

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

releaseDefinitionId: number

tag: string

المرتجعات

Promise<string[]>

addDefinitionTags(string[], string, number)

إضافة علامات متعددة إلى تعريف

function addDefinitionTags(tags: string[], project: string, releaseDefinitionId: number): Promise<string[]>

المعلمات

tags: string[]

project: string

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

releaseDefinitionId: number

المرتجعات

Promise<string[]>

addReleaseTag(string, number, string)

إضافة علامة إلى معرف الإصدار

function addReleaseTag(project: string, releaseId: number, tag: string): Promise<string[]>

المعلمات

project: string

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

releaseId: number

tag: string

المرتجعات

Promise<string[]>

addReleaseTags(string[], string, number)

إضافة علامة إلى إصدار

function addReleaseTags(tags: string[], project: string, releaseId: number): Promise<string[]>

المعلمات

tags: string[]

project: string

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

releaseId: number

المرتجعات

Promise<string[]>

createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)

إنشاء قالب بيئة تعريف

function createDefinitionEnvironmentTemplate(template: ReleaseDefinitionEnvironmentTemplate, project: string): Promise<ReleaseDefinitionEnvironmentTemplate>

المعلمات

template: ReleaseDefinitionEnvironmentTemplate

قالب بيئة التعريف المراد إنشاؤه

project: string

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

المرتجعات

Promise<ReleaseDefinitionEnvironmentTemplate>

createFavorites(FavoriteItem[], string, string, string)

function createFavorites(favoriteItems: FavoriteItem[], project: string, scope: string, identityId?: string): Promise<FavoriteItem[]>

المعلمات

favoriteItems: FavoriteItem[]

project: string

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

scope: string

identityId: string

المرتجعات

Promise<FavoriteItem[]>

createFolder(Folder, string, string)

إنشاء مجلد جديد.

function createFolder(folder: Folder, project: string, path?: string): Promise<Folder>

المعلمات

folder: Folder

مجلد.

project: string

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

path: string

مسار المجلد.

المرتجعات

Promise<Folder>

createRelease(ReleaseStartMetadata, string)

إنشاء إصدار.

function createRelease(releaseStartMetadata: ReleaseStartMetadata, project: string): Promise<Release>

المعلمات

releaseStartMetadata: ReleaseStartMetadata

بيانات التعريف لإنشاء إصدار.

project: string

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

المرتجعات

Promise<Release>

createReleaseDefinition(ReleaseDefinition, string)

إنشاء تعريف إصدار

function createReleaseDefinition(releaseDefinition: ReleaseDefinition, project: string): Promise<ReleaseDefinition>

المعلمات

releaseDefinition: ReleaseDefinition

كائن تعريف الإصدار المراد إنشاؤه.

project: string

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

المرتجعات

Promise<ReleaseDefinition>

deleteDefinitionEnvironmentTemplate(string, string)

حذف قالب بيئة تعريف

function deleteDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<void>

المعلمات

project: string

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

templateId: string

معرف قالب بيئة التعريف

المرتجعات

Promise<void>

deleteDefinitionTag(string, number, string)

حذف علامة من تعريف

function deleteDefinitionTag(project: string, releaseDefinitionId: number, tag: string): Promise<string[]>

المعلمات

project: string

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

releaseDefinitionId: number

tag: string

المرتجعات

Promise<string[]>

deleteFavorites(string, string, string, string)

function deleteFavorites(project: string, scope: string, identityId?: string, favoriteItemIds?: string): Promise<void>

المعلمات

project: string

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

scope: string

identityId: string

favoriteItemIds: string

المرتجعات

Promise<void>

deleteFolder(string, string)

حذف مجلد تعريف لاسم مجلد معين ومساره وكل تعريفاته الموجودة.

function deleteFolder(project: string, path: string): Promise<void>

المعلمات

project: string

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

path: string

مسار المجلد المراد حذفه.

المرتجعات

Promise<void>

deleteRelease(string, number, string)

حذف مبدئي لإصدار

function deleteRelease(project: string, releaseId: number, comment?: string): Promise<void>

المعلمات

project: string

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

releaseId: number

معرف الإصدار.

comment: string

تعليق لحذف إصدار.

المرتجعات

Promise<void>

deleteReleaseDefinition(string, number, string, boolean)

حذف تعريف إصدار.

function deleteReleaseDefinition(project: string, definitionId: number, comment?: string, forceDelete?: boolean): Promise<void>

المعلمات

project: string

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

definitionId: number

معرف تعريف الإصدار.

comment: string

تعليق لحذف تعريف الإصدار.

forceDelete: boolean

'صحيح' لإلغاء أي عمليات نشر إصدار قيد التقدم تلقائيا والمضي قدما في حذف تعريف الإصدار . الافتراضي هو "خطأ".

المرتجعات

Promise<void>

deleteReleaseTag(string, number, string)

حذف علامة من إصدار

function deleteReleaseTag(project: string, releaseId: number, tag: string): Promise<string[]>

المعلمات

project: string

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

releaseId: number

tag: string

المرتجعات

Promise<string[]>

getAgentArtifactDefinitions(string, number)

إرجاع تفاصيل البيانات الاصطناعية التي يتطلبها عامل التشغيل التلقائي

function getAgentArtifactDefinitions(project: string, releaseId: number): Promise<AgentArtifactDefinition[]>

المعلمات

project: string

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

releaseId: number

المرتجعات

Promise<AgentArtifactDefinition[]>

getApproval(string, number, boolean)

الحصول على موافقة.

function getApproval(project: string, approvalId: number, includeHistory?: boolean): Promise<ReleaseApproval>

المعلمات

project: string

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

approvalId: number

معرف الموافقة.

includeHistory: boolean

'صحيح' لتضمين تاريخ الموافقة. الافتراضي هو "خطأ".

المرتجعات

Promise<ReleaseApproval>

getApprovalHistory(string, number)

الحصول على محفوظات الموافقة.

function getApprovalHistory(project: string, approvalStepId: number): Promise<ReleaseApproval>

المعلمات

project: string

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

approvalStepId: number

معرف الموافقة.

المرتجعات

Promise<ReleaseApproval>

getApprovals(string, string, ApprovalStatus, number[], ApprovalType, number, number, ReleaseQueryOrder, boolean)

الحصول على قائمة بالموافقات

function getApprovals(project: string, assignedToFilter?: string, statusFilter?: ApprovalStatus, releaseIdsFilter?: number[], typeFilter?: ApprovalType, top?: number, continuationToken?: number, queryOrder?: ReleaseQueryOrder, includeMyGroupApprovals?: boolean): Promise<PagedList<ReleaseApproval>>

المعلمات

project: string

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

assignedToFilter: string

الموافقات المعينة لهذا المستخدم.

statusFilter: ApprovalStatus

الموافقات بهذه الحالة. الافتراضي هو "معلق".

releaseIdsFilter: number[]

الموافقات على معرف (معرفات) الإصدار المذكورة في عامل التصفية. يمكن ذكر إصدارات متعددة عن طريق فصلها ب '،' على سبيل المثال releaseIdsFilter=1,2,3,4.

typeFilter: ApprovalType

الموافقة بهذا النوع.

top: number

عدد الموافقات التي يجب الحصول عليها. الافتراضي هو 50.

continuationToken: number

يحصل على الموافقات بعد توفير رمز المتابعة المميز.

queryOrder: ReleaseQueryOrder

يحصل على النتائج بالترتيب المحدد للموافقات التي تم إنشاؤها. الافتراضي هو "تنازلي".

includeMyGroupApprovals: boolean

"صحيح" لتضمين موافقات مجموعتي. الافتراضي هو "خطأ".

المرتجعات

Promise<PagedList<ReleaseApproval>>

getArtifactTypeDefinitions(string)

function getArtifactTypeDefinitions(project: string): Promise<ArtifactTypeDefinition[]>

المعلمات

project: string

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

المرتجعات

Promise<ArtifactTypeDefinition[]>

getArtifactVersions(string, number)

function getArtifactVersions(project: string, releaseDefinitionId: number): Promise<ArtifactVersionQueryResult>

المعلمات

project: string

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

releaseDefinitionId: number

المرتجعات

Promise<ArtifactVersionQueryResult>

getArtifactVersionsForSources(Artifact[], string)

function getArtifactVersionsForSources(artifacts: Artifact[], project: string): Promise<ArtifactVersionQueryResult>

المعلمات

artifacts: Artifact[]

project: string

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

المرتجعات

Promise<ArtifactVersionQueryResult>

getAutoTriggerIssues(string, string, string, string)

function getAutoTriggerIssues(artifactType: string, sourceId: string, artifactVersionId: string, project?: string): Promise<AutoTriggerIssue[]>

المعلمات

artifactType: string

sourceId: string

artifactVersionId: string

project: string

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

المرتجعات

Promise<AutoTriggerIssue[]>

getDefinitionEnvironments(string, string, string[])

function getDefinitionEnvironments(project: string, taskGroupId?: string, propertyFilters?: string[]): Promise<DefinitionEnvironmentReference[]>

المعلمات

project: string

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

taskGroupId: string

propertyFilters: string[]

المرتجعات

Promise<DefinitionEnvironmentReference[]>

getDefinitionEnvironmentTemplate(string, string)

الحصول على قالب بيئة تعريف

function getDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<ReleaseDefinitionEnvironmentTemplate>

المعلمات

project: string

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

templateId: string

معرف قالب بيئة التعريف

المرتجعات

Promise<ReleaseDefinitionEnvironmentTemplate>

getDefinitionRevision(string, number, number)

الحصول على تعريف الإصدار لتعريف معين ومراجعته

function getDefinitionRevision(project: string, definitionId: number, revision: number): Promise<string>

المعلمات

project: string

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

definitionId: number

معرف التعريف.

revision: number

معرف المراجعة.

المرتجعات

Promise<string>

getDefinitionTags(string, number)

الحصول على علامات تعريف

function getDefinitionTags(project: string, releaseDefinitionId: number): Promise<string[]>

المعلمات

project: string

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

releaseDefinitionId: number

المرتجعات

Promise<string[]>

getDeploymentBadge(string, number, number, string)

يحصل على شارة تشير إلى حالة أحدث عملية نشر لبيئة ما.

function getDeploymentBadge(projectId: string, releaseDefinitionId: number, environmentId: number, branchName?: string): Promise<string>

المعلمات

projectId: string

معرف المشروع.

releaseDefinitionId: number

معرف تعريف الإصدار.

environmentId: number

معرف البيئة.

branchName: string

اسم الفرع.

المرتجعات

Promise<string>

getDeployments(string, number, number, string, Date, Date, DeploymentStatus, DeploymentOperationStatus, boolean, ReleaseQueryOrder, number, number, string, Date, Date, string)

الحصول على قائمة عمليات التوزيع

function getDeployments(project: string, definitionId?: number, definitionEnvironmentId?: number, createdBy?: string, minModifiedTime?: Date, maxModifiedTime?: Date, deploymentStatus?: DeploymentStatus, operationStatus?: DeploymentOperationStatus, latestAttemptsOnly?: boolean, queryOrder?: ReleaseQueryOrder, top?: number, continuationToken?: number, createdFor?: string, minStartedTime?: Date, maxStartedTime?: Date, sourceBranch?: string): Promise<PagedList<Deployment>>

المعلمات

project: string

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

definitionId: number

سرد عمليات التوزيع لمعرف تعريف معين.

definitionEnvironmentId: number

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

createdBy: string

سرد عمليات التوزيع التي يتم إنشاء عمليات التوزيع لها كهوية محددة.

minModifiedTime: Date

سرد عمليات التوزيع مع وقت >LastModified = minModifiedTime.

maxModifiedTime: Date

سرد عمليات التوزيع مع وقت <LastModified = maxModifiedTime.

deploymentStatus: DeploymentStatus

سرد عمليات التوزيع بحالة نشر معينة. الافتراضي هو "الكل".

operationStatus: DeploymentOperationStatus

سرد عمليات التوزيع بحالة عملية معينة. الافتراضي هو "الكل".

latestAttemptsOnly: boolean

'صحيح' لتضمين عمليات النشر مع أحدث محاولة فقط. الافتراضي هو "خطأ".

queryOrder: ReleaseQueryOrder

سرد عمليات التوزيع بترتيب استعلام معين. الافتراضي هو "تنازلي".

top: number

سرد عمليات التوزيع مع أعلى معين. الأعلى الافتراضي هو '50' وأقصى أعلى هو '100'.

continuationToken: number

سرد عمليات التوزيع باستخدام معرف >النشر = continuationToken.

createdFor: string

سرد عمليات التوزيع التي يتم طلب عمليات التوزيع لها كهوية محددة.

minStartedTime: Date

سرد عمليات التوزيع باستخدام وقت >StartedOn = minStartedTime.

maxStartedTime: Date

سرد عمليات التوزيع باستخدام وقت <StartedOn = maxStartedTime.

sourceBranch: string

سرد عمليات التوزيع التي تم نشرها من اسم فرع معين.

المرتجعات

Promise<PagedList<Deployment>>

getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)

function getDeploymentsForMultipleEnvironments(queryParameters: DeploymentQueryParameters, project: string): Promise<Deployment[]>

المعلمات

queryParameters: DeploymentQueryParameters

project: string

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

المرتجعات

Promise<Deployment[]>

getFavorites(string, string, string)

function getFavorites(project: string, scope: string, identityId?: string): Promise<FavoriteItem[]>

المعلمات

project: string

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

scope: string

identityId: string

المرتجعات

Promise<FavoriteItem[]>

getFolders(string, string, FolderPathQueryOrder)

الحصول على المجلدات.

function getFolders(project: string, path?: string, queryOrder?: FolderPathQueryOrder): Promise<Folder[]>

المعلمات

project: string

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

path: string

مسار المجلد.

queryOrder: FolderPathQueryOrder

الحصول على النتائج بالترتيب المحدد. الافتراضي هو "بلا".

المرتجعات

Promise<Folder[]>

getGateLog(string, number, number, number, number)

الحصول على سجلات البوابة

function getGateLog(project: string, releaseId: number, environmentId: number, gateId: number, taskId: number): Promise<string>

المعلمات

project: string

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

releaseId: number

معرف الإصدار.

environmentId: number

معرف بيئة الإصدار.

gateId: number

معرف البوابة.

taskId: number

معرف ReleaseTask للسجل.

المرتجعات

Promise<string>

getInputValues(InputValuesQuery, string)

function getInputValues(query: InputValuesQuery, project: string): Promise<InputValuesQuery>

المعلمات

query: InputValuesQuery

project: string

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

المرتجعات

Promise<InputValuesQuery>

getIssues(string, number, string)

function getIssues(project: string, buildId: number, sourceId?: string): Promise<AutoTriggerIssue[]>

المعلمات

project: string

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

buildId: number

sourceId: string

المرتجعات

Promise<AutoTriggerIssue[]>

getLog(string, number, number, number, number)

الحصول على السجلات

function getLog(project: string, releaseId: number, environmentId: number, taskId: number, attemptId?: number): Promise<string>

المعلمات

project: string

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

releaseId: number

معرف الإصدار.

environmentId: number

معرف بيئة الإصدار.

taskId: number

معرف ReleaseTask للسجل.

attemptId: number

معرف المحاولة.

المرتجعات

Promise<string>

getLogs(string, number)

الحصول على سجلات لمعرف الإصدار.

function getLogs(project: string, releaseId: number): Promise<ArrayBuffer>

المعلمات

project: string

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

releaseId: number

معرف الإصدار.

المرتجعات

Promise<ArrayBuffer>

getManualIntervention(string, number, number)

الحصول على التدخل اليدوي لإصدار معين ومعرف التدخل اليدوي.

function getManualIntervention(project: string, releaseId: number, manualInterventionId: number): Promise<ManualIntervention>

المعلمات

project: string

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

releaseId: number

معرف الإصدار.

manualInterventionId: number

معرف التدخل اليدوي.

المرتجعات

Promise<ManualIntervention>

getManualInterventions(string, number)

سرد جميع التدخلات اليدوية لإصدار معين.

function getManualInterventions(project: string, releaseId: number): Promise<ManualIntervention[]>

المعلمات

project: string

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

releaseId: number

معرف الإصدار.

المرتجعات

Promise<ManualIntervention[]>

getMetrics(string, Date)

function getMetrics(project: string, minMetricsTime?: Date): Promise<Metric[]>

المعلمات

project: string

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

minMetricsTime: Date

المرتجعات

Promise<Metric[]>

getOrgPipelineReleaseSettings()

الحصول على إعدادات إصدار البنية الأساسية لبرنامج ربط العمليات التجارية ل Org

function getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>

المرتجعات

Promise<OrgPipelineReleaseSettings>

getPipelineReleaseSettings(string)

الحصول على إعدادات إصدار البنية الأساسية لبرنامج ربط العمليات التجارية

function getPipelineReleaseSettings(project: string): Promise<ProjectPipelineReleaseSettings>

المعلمات

project: string

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

المرتجعات

Promise<ProjectPipelineReleaseSettings>

getRelease(string, number, ApprovalFilters, string[], SingleReleaseExpands, number, boolean)

الحصول على إصدار

function getRelease(project: string, releaseId: number, approvalFilters?: ApprovalFilters, propertyFilters?: string[], expand?: SingleReleaseExpands, topGateRecords?: number, includeDisabledDefinitions?: boolean): Promise<Release>

المعلمات

project: string

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

releaseId: number

معرف الإصدار.

approvalFilters: ApprovalFilters

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

propertyFilters: string[]

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

expand: SingleReleaseExpands

خاصية يجب توسيعها في الإصدار.

topGateRecords: number

عدد سجلات بوابة الإصدار التي يجب الحصول عليها. الافتراضي هو 5.

includeDisabledDefinitions: boolean

تضمين تعريفات معطلة (إذا تم تعيينها إلى خطأ إرجاع "خطأ"، يكون الافتراضي هو "صحيح")

المرتجعات

Promise<Release>

getReleaseChanges(string, number, number, number, string)

function getReleaseChanges(project: string, releaseId: number, baseReleaseId?: number, top?: number, artifactAlias?: string): Promise<Change[]>

المعلمات

project: string

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

releaseId: number

baseReleaseId: number

top: number

artifactAlias: string

المرتجعات

Promise<Change[]>

getReleaseDefinition(string, number, string[], boolean)

الحصول على تعريف الإصدار.

function getReleaseDefinition(project: string, definitionId: number, propertyFilters?: string[], includeDisabled?: boolean): Promise<ReleaseDefinition>

المعلمات

project: string

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

definitionId: number

معرف تعريف الإصدار.

propertyFilters: string[]

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

includeDisabled: boolean

علامة منطقية لتضمين تعريفات معطلة.

المرتجعات

Promise<ReleaseDefinition>

getReleaseDefinitionHistory(string, number)

الحصول على محفوظات المراجعة لتعريف الإصدار

function getReleaseDefinitionHistory(project: string, definitionId: number): Promise<ReleaseDefinitionRevision[]>

المعلمات

project: string

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

definitionId: number

معرف التعريف.

المرتجعات

Promise<ReleaseDefinitionRevision[]>

getReleaseDefinitionRevision(string, number, number)

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

function getReleaseDefinitionRevision(project: string, definitionId: number, revision: number): Promise<string>

المعلمات

project: string

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

definitionId: number

معرف تعريف الإصدار.

revision: number

رقم مراجعة تعريف الإصدار.

المرتجعات

Promise<string>

getReleaseDefinitions(string, string, ReleaseDefinitionExpands, string, string, number, string, ReleaseDefinitionQueryOrder, string, boolean, string[], string[], string[], boolean, boolean)

احصل على قائمة بتعريفات الإصدار.

function getReleaseDefinitions(project: string, searchText?: string, expand?: ReleaseDefinitionExpands, artifactType?: string, artifactSourceId?: string, top?: number, continuationToken?: string, queryOrder?: ReleaseDefinitionQueryOrder, path?: string, isExactNameMatch?: boolean, tagFilter?: string[], propertyFilters?: string[], definitionIdFilter?: string[], isDeleted?: boolean, searchTextContainsFolderName?: boolean): Promise<PagedList<ReleaseDefinition>>

المعلمات

project: string

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

searchText: string

احصل على تعريفات الإصدار بأسماء تحتوي على searchText.

expand: ReleaseDefinitionExpands

الخصائص التي يجب توسيعها في قائمة تعريفات الإصدار.

artifactType: string

سيتم إرجاع تعريفات الإصدار مع artifactType المحدد. يمكن أن تكون القيم Build و Jenkins و GitHub و Nuget و Team Build (خارجي) و ExternalTFSBuild و Git و TFVC و ExternalTfsXamlBuild.

artifactSourceId: string

سيتم إرجاع تعريفات الإصدار مع artifactSourceId المحدد. على سبيل المثال، بالنسبة للإنشاء سيكون {projectGuid}:{BuildDefinitionId}، بالنسبة إلى Jenkins سيكون {JenkinsConnectionId}:{JenkinsDefinitionId}، بالنسبة إلى TfsOnPrem سيكون {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. بالنسبة إلى البيانات الاصطناعية لجهة خارجية مثل TeamCity، BitBucket، يمكنك الرجوع إلى "uniqueSourceIdentifier" داخل vss-extension.json في https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.

top: number

عدد تعريفات الإصدار التي يجب الحصول عليها.

continuationToken: string

يحصل على تعريفات الإصدار بعد توفير رمز المتابعة المميز.

queryOrder: ReleaseDefinitionQueryOrder

الحصول على النتائج بالترتيب المحدد. الافتراضي هو "IdAscending".

path: string

يحصل على تعريفات الإصدار ضمن المسار المحدد.

isExactNameMatch: boolean

'صحيح' للحصول على تعريفات الإصدار مع تطابق تام كما هو محدد في searchText. الافتراضي هو "خطأ".

tagFilter: string[]

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

propertyFilters: string[]

قائمة محددة بفاصلة من الخصائص الموسعة المراد استردادها. إذا تم تعيينها، فستحتوي تعريفات الإصدار التي تم إرجاعها على قيم لمعرفات الخصائص المحددة (إذا كانت موجودة). إذا لم يتم تعيينها، فلن يتم تضمين الخصائص. لاحظ أن هذا لن يقوم بتصفية أي تعريف إصدار من النتائج بغض النظر عما إذا كان يحتوي على مجموعة خصائص أم لا.

definitionIdFilter: string[]

قائمة محددة بفاصلة من تعريفات الإصدار لاستردادها.

isDeleted: boolean

"صحيح" للحصول على تعريفات الإصدار التي تم حذفها. الافتراضي هو "خطأ"

searchTextContainsFolderName: boolean

'صحيح' للحصول على تعريفات الإصدار ضمن المجلد الذي يحمل الاسم كما هو محدد في searchText. الافتراضي هو "خطأ".

المرتجعات

Promise<PagedList<ReleaseDefinition>>

getReleaseDefinitionSummary(string, number, number, boolean, number[])

الحصول على ملخص الإصدار لمعرف تعريف معين.

function getReleaseDefinitionSummary(project: string, definitionId: number, releaseCount: number, includeArtifact?: boolean, definitionEnvironmentIdsFilter?: number[]): Promise<ReleaseDefinitionSummary>

المعلمات

project: string

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

definitionId: number

معرف التعريف للحصول على ملخص الإصدار.

releaseCount: number

عدد الإصدارات التي سيتم تضمينها في الملخص.

includeArtifact: boolean

تضمين تفاصيل البيانات الاصطناعية. الافتراضي هو "خطأ".

definitionEnvironmentIdsFilter: number[]

المرتجعات

Promise<ReleaseDefinitionSummary>

getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)

احصل على بيئة إصدار.

function getReleaseEnvironment(project: string, releaseId: number, environmentId: number, expand?: ReleaseEnvironmentExpands): Promise<ReleaseEnvironment>

المعلمات

project: string

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

releaseId: number

معرف الإصدار.

environmentId: number

معرف بيئة الإصدار.

expand: ReleaseEnvironmentExpands

خاصية يجب توسيعها في البيئة.

المرتجعات

Promise<ReleaseEnvironment>

getReleaseHistory(string, number)

function getReleaseHistory(project: string, releaseId: number): Promise<ReleaseRevision[]>

المعلمات

project: string

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

releaseId: number

المرتجعات

Promise<ReleaseRevision[]>

getReleaseProjects(string, string)

function getReleaseProjects(artifactType: string, artifactSourceId: string): Promise<ProjectReference[]>

المعلمات

artifactType: string

artifactSourceId: string

المرتجعات

Promise<ProjectReference[]>

getReleaseRevision(string, number, number)

الحصول على إصدار لرقم مراجعة معين.

function getReleaseRevision(project: string, releaseId: number, definitionSnapshotRevision: number): Promise<string>

المعلمات

project: string

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

releaseId: number

معرف الإصدار.

definitionSnapshotRevision: number

رقم مراجعة لقطة التعريف.

المرتجعات

Promise<string>

getReleases(string, number, number, string, string, ReleaseStatus, number, Date, Date, ReleaseQueryOrder, number, number, ReleaseExpands, string, string, string, string, boolean, string[], string[], number[], string)

الحصول على قائمة الإصدارات

function getReleases(project?: string, definitionId?: number, definitionEnvironmentId?: number, searchText?: string, createdBy?: string, statusFilter?: ReleaseStatus, environmentStatusFilter?: number, minCreatedTime?: Date, maxCreatedTime?: Date, queryOrder?: ReleaseQueryOrder, top?: number, continuationToken?: number, expand?: ReleaseExpands, artifactTypeId?: string, sourceId?: string, artifactVersionId?: string, sourceBranchFilter?: string, isDeleted?: boolean, tagFilter?: string[], propertyFilters?: string[], releaseIdFilter?: number[], path?: string): Promise<Release[]>

المعلمات

project: string

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

definitionId: number

الإصدارات من معرف تعريف الإصدار هذا.

definitionEnvironmentId: number

searchText: string

إصدارات بأسماء تحتوي على searchText.

createdBy: string

الإصدارات التي أنشأها هذا المستخدم.

statusFilter: ReleaseStatus

الإصدارات التي لها هذه الحالة.

environmentStatusFilter: number

minCreatedTime: Date

الإصدارات التي تم إنشاؤها بعد هذا الوقت.

maxCreatedTime: Date

الإصدارات التي تم إنشاؤها قبل هذا الوقت.

queryOrder: ReleaseQueryOrder

الحصول على النتائج بالترتيب المحدد لتاريخ الإنشاء للإصدارات. الافتراضي هو تنازلي.

top: number

عدد الإصدارات التي يجب الحصول عليها. الافتراضي هو 50.

continuationToken: number

يحصل على الإصدارات بعد توفير رمز المتابعة المميز.

expand: ReleaseExpands

الخاصية التي يجب توسيعها في قائمة الإصدارات.

artifactTypeId: string

سيتم إرجاع الإصدارات مع artifactTypeId المحدد. يمكن أن تكون القيم Build و Jenkins و GitHub و Nuget و Team Build (خارجي) و ExternalTFSBuild و Git و TFVC و ExternalTfsXamlBuild.

sourceId: string

المعرف الفريد للبيانات الاصطناعية المستخدمة. على سبيل المثال، بالنسبة للإنشاء سيكون {projectGuid}:{BuildDefinitionId}، بالنسبة إلى Jenkins سيكون {JenkinsConnectionId}:{JenkinsDefinitionId}، بالنسبة إلى TfsOnPrem سيكون {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. بالنسبة إلى البيانات الاصطناعية لجهة خارجية مثل TeamCity، BitBucket، يمكنك الرجوع إلى "uniqueSourceIdentifier" داخل vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.

artifactVersionId: string

سيتم إرجاع الإصدارات مع artifactVersionId المحدد. على سبيل المثال، في حالة Build artifactType، يكون buildId.

sourceBranchFilter: string

سيتم إرجاع الإصدارات ذات المصدر المحددBranchFilter (لا يجب استخدامها مع environmentStatusFilter).

isDeleted: boolean

الحصول على الإصدارات المحذوفة مبدئيا، إذا كانت صحيحة.

tagFilter: string[]

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

propertyFilters: string[]

قائمة محددة بفاصلة من الخصائص الموسعة المراد استردادها. إذا تم تعيينها، فستحتوي الإصدارات التي تم إرجاعها على قيم لمعرفات الخصائص المحددة (إذا كانت موجودة). إذا لم يتم تعيينها، فلن يتم تضمين الخصائص. لاحظ أن هذا لن يقوم بتصفية أي إصدار من النتائج بغض النظر عما إذا كان لديه مجموعة خصائص أم لا.

releaseIdFilter: number[]

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

path: string

سيتم إرجاع الإصدارات ضمن مسار المجلد هذا

المرتجعات

Promise<Release[]>

getReleaseSettings(string)

الحصول على إعدادات الإصدار

function getReleaseSettings(project: string): Promise<ReleaseSettings>

المعلمات

project: string

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

المرتجعات

Promise<ReleaseSettings>

getReleaseTags(string, number)

الحصول على علامات الإصدار

function getReleaseTags(project: string, releaseId: number): Promise<string[]>

المعلمات

project: string

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

releaseId: number

المرتجعات

Promise<string[]>

getReleaseTaskAttachmentContent(string, number, number, number, string, string, string, string, string)

الحصول على مرفق مهمة الإصدار.

function getReleaseTaskAttachmentContent(project: string, releaseId: number, environmentId: number, attemptId: number, planId: string, timelineId: string, recordId: string, type: string, name: string): Promise<ArrayBuffer>

المعلمات

project: string

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

releaseId: number

معرف الإصدار.

environmentId: number

معرف بيئة الإصدار.

attemptId: number

محاولة عدد التوزيع.

planId: string

معرف الخطة لمرحلة التوزيع.

timelineId: string

معرف المخطط الزمني للمهمة.

recordId: string

تسجيل معرف المرفق.

type: string

نوع المرفق.

name: string

اسم المرفق.

المرتجعات

Promise<ArrayBuffer>

getReleaseTaskAttachments(string, number, number, number, string, string)

الحصول على مرفقات مهمة الإصدار.

function getReleaseTaskAttachments(project: string, releaseId: number, environmentId: number, attemptId: number, planId: string, type: string): Promise<ReleaseTaskAttachment[]>

المعلمات

project: string

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

releaseId: number

معرف الإصدار.

environmentId: number

معرف بيئة الإصدار.

attemptId: number

محاولة عدد التوزيع.

planId: string

معرف الخطة لمرحلة التوزيع.

type: string

نوع المرفق.

المرتجعات

Promise<ReleaseTaskAttachment[]>

getReleaseWorkItemsRefs(string, number, number, number, string)

function getReleaseWorkItemsRefs(project: string, releaseId: number, baseReleaseId?: number, top?: number, artifactAlias?: string): Promise<ReleaseWorkItemRef[]>

المعلمات

project: string

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

releaseId: number

baseReleaseId: number

top: number

artifactAlias: string

المرتجعات

Promise<ReleaseWorkItemRef[]>

getSourceBranches(string, number)

function getSourceBranches(project: string, definitionId: number): Promise<string[]>

المعلمات

project: string

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

definitionId: number

المرتجعات

Promise<string[]>

getSummaryMailSections(string, number)

function getSummaryMailSections(project: string, releaseId: number): Promise<SummaryMailSection[]>

المعلمات

project: string

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

releaseId: number

المرتجعات

Promise<SummaryMailSection[]>

getTags(string)

function getTags(project: string): Promise<string[]>

المعلمات

project: string

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

المرتجعات

Promise<string[]>

getTaskAttachmentContent(string, number, number, number, string, string, string, string)

الحصول على مرفق مهمة.

function getTaskAttachmentContent(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, recordId: string, type: string, name: string): Promise<ArrayBuffer>

المعلمات

project: string

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

releaseId: number

معرف الإصدار.

environmentId: number

معرف بيئة الإصدار.

attemptId: number

محاولة عدد التوزيع.

timelineId: string

معرف المخطط الزمني للمهمة.

recordId: string

تسجيل معرف المرفق.

type: string

نوع المرفق.

name: string

اسم المرفق.

المرتجعات

Promise<ArrayBuffer>

getTaskAttachments(string, number, number, number, string, string)

الحصول على مرفقات المهمة.

function getTaskAttachments(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, type: string): Promise<ReleaseTaskAttachment[]>

المعلمات

project: string

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

releaseId: number

معرف الإصدار.

environmentId: number

معرف بيئة الإصدار.

attemptId: number

محاولة عدد التوزيع.

timelineId: string

معرف المخطط الزمني للمهمة.

type: string

نوع المرفق.

المرتجعات

Promise<ReleaseTaskAttachment[]>

getTaskLog(string, number, number, number, number, number, number)

الحصول على سجل مهام الإصدار كملف نص عادي.

function getTaskLog(project: string, releaseId: number, environmentId: number, releaseDeployPhaseId: number, taskId: number, startLine?: number, endLine?: number): Promise<string>

المعلمات

project: string

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

releaseId: number

معرف الإصدار.

environmentId: number

معرف بيئة الإصدار.

releaseDeployPhaseId: number

معرف مرحلة نشر الإصدار.

taskId: number

معرف ReleaseTask للسجل.

startLine: number

رقم سطر البدء للسجلات

endLine: number

رقم سطر النهاية للسجلات

المرتجعات

Promise<string>

getTaskLog2(string, number, number, number, string, number, number, number)

الحصول على سجل مهام الإصدار كملف نص عادي.

function getTaskLog2(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, taskId: number, startLine?: number, endLine?: number): Promise<string>

المعلمات

project: string

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

releaseId: number

معرف الإصدار.

environmentId: number

معرف بيئة الإصدار.

attemptId: number

timelineId: string

taskId: number

معرف ReleaseTask للسجل.

startLine: number

رقم سطر البدء للسجلات

endLine: number

رقم سطر النهاية للسجلات

المرتجعات

Promise<string>

getTasks(string, number, number, number)

function getTasks(project: string, releaseId: number, environmentId: number, attemptId?: number): Promise<ReleaseTask[]>

المعلمات

project: string

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

releaseId: number

environmentId: number

attemptId: number

المرتجعات

Promise<ReleaseTask[]>

getTasks2(string, number, number, number, string)

function getTasks2(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string): Promise<ReleaseTask[]>

المعلمات

project: string

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

releaseId: number

environmentId: number

attemptId: number

timelineId: string

المرتجعات

Promise<ReleaseTask[]>

getTasksForTaskGroup(string, number, number, number)

function getTasksForTaskGroup(project: string, releaseId: number, environmentId: number, releaseDeployPhaseId: number): Promise<ReleaseTask[]>

المعلمات

project: string

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

releaseId: number

environmentId: number

releaseDeployPhaseId: number

المرتجعات

Promise<ReleaseTask[]>

listDefinitionEnvironmentTemplates(string, boolean)

الحصول على قائمة بقوالب بيئة التعريف

function listDefinitionEnvironmentTemplates(project: string, isDeleted?: boolean): Promise<ReleaseDefinitionEnvironmentTemplate[]>

المعلمات

project: string

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

isDeleted: boolean

"صحيح" للحصول على قوالب بيئة التعريف التي تم حذفها. الافتراضي هو "خطأ"

المرتجعات

Promise<ReleaseDefinitionEnvironmentTemplate[]>

sendSummaryMail(MailMessage, string, number)

function sendSummaryMail(mailMessage: MailMessage, project: string, releaseId: number): Promise<void>

المعلمات

mailMessage: MailMessage

project: string

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

releaseId: number

المرتجعات

Promise<void>

undeleteRelease(string, number, string)

إلغاء حذف إصدار محذوف مبدئيا.

function undeleteRelease(project: string, releaseId: number, comment: string): Promise<void>

المعلمات

project: string

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

releaseId: number

معرف الإصدار الذي سيتم إلغاء حذفه.

comment: string

أي تعليق لإلغاء حذفه.

المرتجعات

Promise<void>

undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)

إلغاء حذف تعريف إصدار.

function undeleteReleaseDefinition(releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter, project: string, definitionId: number): Promise<ReleaseDefinition>

المعلمات

releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter

كائن لإلغاء حذف تعريف الإصدار.

project: string

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

definitionId: number

معرف تعريف الإصدار الذي سيتم إلغاء حذفه

المرتجعات

Promise<ReleaseDefinition>

undeleteReleaseDefinitionEnvironmentTemplate(string, string)

إلغاء حذف قالب بيئة تعريف الإصدار.

function undeleteReleaseDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<ReleaseDefinitionEnvironmentTemplate>

المعلمات

project: string

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

templateId: string

معرف قالب بيئة التعريف المراد إلغاء حذفه

المرتجعات

Promise<ReleaseDefinitionEnvironmentTemplate>

updateFolder(Folder, string, string)

تحديث مجلد موجود في مسار موجود معين.

function updateFolder(folder: Folder, project: string, path: string): Promise<Folder>

المعلمات

folder: Folder

مجلد.

project: string

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

path: string

مسار المجلد المراد تحديثه.

المرتجعات

Promise<Folder>

updateGates(GateUpdateMetadata, string, number)

تحديث بوابة النشر.

function updateGates(gateUpdateMetadata: GateUpdateMetadata, project: string, gateStepId: number): Promise<ReleaseGates>

المعلمات

gateUpdateMetadata: GateUpdateMetadata

بيانات التعريف لتصحيح بوابات الإصدار.

project: string

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

gateStepId: number

معرف خطوة البوابة.

المرتجعات

Promise<ReleaseGates>

updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)

تحديث التدخل اليدوي.

function updateManualIntervention(manualInterventionUpdateMetadata: ManualInterventionUpdateMetadata, project: string, releaseId: number, manualInterventionId: number): Promise<ManualIntervention>

المعلمات

manualInterventionUpdateMetadata: ManualInterventionUpdateMetadata

بيانات التعريف لتحديث التدخل اليدوي.

project: string

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

releaseId: number

معرف الإصدار.

manualInterventionId: number

معرف التدخل اليدوي.

المرتجعات

Promise<ManualIntervention>

updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)

تحديث إعدادات إصدار البنية الأساسية لبرنامج ربط العمليات التجارية ل Org

function updateOrgPipelineReleaseSettings(newSettings: OrgPipelineReleaseSettingsUpdateParameters): Promise<OrgPipelineReleaseSettings>

المعلمات

newSettings: OrgPipelineReleaseSettingsUpdateParameters

المرتجعات

Promise<OrgPipelineReleaseSettings>

updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)

تحديث إعدادات إصدار البنية الأساسية لبرنامج ربط العمليات التجارية

function updatePipelineReleaseSettings(newSettings: ProjectPipelineReleaseSettingsUpdateParameters, project: string): Promise<ProjectPipelineReleaseSettings>

المعلمات

newSettings: ProjectPipelineReleaseSettingsUpdateParameters

project: string

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

المرتجعات

Promise<ProjectPipelineReleaseSettings>

updateRelease(Release, string, number)

تحديث كائن إصدار كامل.

function updateRelease(release: Release, project: string, releaseId: number): Promise<Release>

المعلمات

release: Release

إصدار كائن للتحديث.

project: string

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

releaseId: number

معرف الإصدار المراد تحديثه.

المرتجعات

Promise<Release>

updateReleaseApproval(ReleaseApproval, string, number)

تحديث حالة الموافقة

function updateReleaseApproval(approval: ReleaseApproval, project: string, approvalId: number): Promise<ReleaseApproval>

المعلمات

approval: ReleaseApproval

كائن ReleaseApproval له الحالة والموافق والتعليقات.

project: string

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

approvalId: number

معرف الموافقة.

المرتجعات

Promise<ReleaseApproval>

updateReleaseApprovals(ReleaseApproval[], string)

function updateReleaseApprovals(approvals: ReleaseApproval[], project: string): Promise<ReleaseApproval[]>

المعلمات

approvals: ReleaseApproval[]

project: string

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

المرتجعات

Promise<ReleaseApproval[]>

updateReleaseDefinition(ReleaseDefinition, string, boolean)

تحديث تعريف الإصدار.

function updateReleaseDefinition(releaseDefinition: ReleaseDefinition, project: string, skipTasksValidation?: boolean): Promise<ReleaseDefinition>

المعلمات

releaseDefinition: ReleaseDefinition

إصدار كائن تعريف للتحديث.

project: string

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

skipTasksValidation: boolean

تخطي العلامة المنطقية للتحقق من صحة المهمة

المرتجعات

Promise<ReleaseDefinition>

updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)

تحديث حالة بيئة الإصدار

function updateReleaseEnvironment(environmentUpdateData: ReleaseEnvironmentUpdateMetadata, project: string, releaseId: number, environmentId: number): Promise<ReleaseEnvironment>

المعلمات

environmentUpdateData: ReleaseEnvironmentUpdateMetadata

بيانات تعريف تحديث البيئة.

project: string

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

releaseId: number

معرف الإصدار.

environmentId: number

معرف بيئة الإصدار.

المرتجعات

Promise<ReleaseEnvironment>

updateReleaseResource(ReleaseUpdateMetadata, string, number)

تحديث بعض خصائص الإصدار.

function updateReleaseResource(releaseUpdateMetadata: ReleaseUpdateMetadata, project: string, releaseId: number): Promise<Release>

المعلمات

releaseUpdateMetadata: ReleaseUpdateMetadata

خصائص الإصدار المراد تحديثها.

project: string

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

releaseId: number

معرف الإصدار المراد تحديثه.

المرتجعات

Promise<Release>

updateReleaseSettings(ReleaseSettings, string)

تحديث إعدادات الإصدار

function updateReleaseSettings(releaseSettings: ReleaseSettings, project: string): Promise<ReleaseSettings>

المعلمات

releaseSettings: ReleaseSettings

project: string

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

المرتجعات

Promise<ReleaseSettings>

الملاحظات

هل كانت هذه الصفحة مفيدة؟

مشاركة عبر

ReleaseRestClient class

المنشئون

الخصائص

الأساليب

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

ReleaseRestClient(IVssRestClientOptions)

المعلمات

تفاصيل الخاصية

RESOURCE_AREA_ID

قيمة الخاصية

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

addDefinitionTag(string, number, string)

المعلمات

المرتجعات

addDefinitionTags(string[], string, number)

المعلمات

المرتجعات

addReleaseTag(string, number, string)

المعلمات

المرتجعات

addReleaseTags(string[], string, number)

المعلمات

المرتجعات

createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)

المعلمات

المرتجعات

createFavorites(FavoriteItem[], string, string, string)

المعلمات

المرتجعات

createFolder(Folder, string, string)

المعلمات

المرتجعات

createRelease(ReleaseStartMetadata, string)

المعلمات

المرتجعات

createReleaseDefinition(ReleaseDefinition, string)

المعلمات

المرتجعات

deleteDefinitionEnvironmentTemplate(string, string)

المعلمات

المرتجعات

deleteDefinitionTag(string, number, string)

المعلمات

المرتجعات

deleteFavorites(string, string, string, string)

المعلمات

المرتجعات

deleteFolder(string, string)

المعلمات

المرتجعات

deleteRelease(string, number, string)

المعلمات

المرتجعات

deleteReleaseDefinition(string, number, string, boolean)

المعلمات

المرتجعات

deleteReleaseTag(string, number, string)

المعلمات

المرتجعات

getAgentArtifactDefinitions(string, number)

المعلمات

المرتجعات

getApproval(string, number, boolean)

المعلمات

المرتجعات

getApprovalHistory(string, number)

المعلمات

المرتجعات

getApprovals(string, string, ApprovalStatus, number[], ApprovalType, number, number, ReleaseQueryOrder, boolean)

المعلمات

المرتجعات

getArtifactTypeDefinitions(string)

المعلمات

المرتجعات

getArtifactVersions(string, number)

المعلمات

المرتجعات

getArtifactVersionsForSources(Artifact[], string)

المعلمات