ReleaseRestClient class
Kelas dasar yang harus digunakan (berasal dari) untuk membuat permintaan ke VSS REST api
- Memperluas
Konstruktor
| Release |
Properti
| RESOURCE_AREA_ID |
Metode
Detail Konstruktor
ReleaseRestClient(IVssRestClientOptions)
Detail Properti
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringNilai Properti
string
Detail Metode
addDefinitionTag(string, number, string)
Menambahkan tag ke definisi
function addDefinitionTag(project: string, releaseDefinitionId: number, tag: string): Promise<string[]>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseDefinitionId
-
number
- tag
-
string
Mengembalikan
Promise<string[]>
addDefinitionTags(string[], string, number)
Menambahkan beberapa tag ke definisi
function addDefinitionTags(tags: string[], project: string, releaseDefinitionId: number): Promise<string[]>Parameter
- tags
-
string[]
- project
-
string
ID proyek atau nama proyek
- releaseDefinitionId
-
number
Mengembalikan
Promise<string[]>
addReleaseTag(string, number, string)
Menambahkan tag ke releaseId
function addReleaseTag(project: string, releaseId: number, tag: string): Promise<string[]>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
- tag
-
string
Mengembalikan
Promise<string[]>
addReleaseTags(string[], string, number)
Menambahkan tag ke rilis
function addReleaseTags(tags: string[], project: string, releaseId: number): Promise<string[]>Parameter
- tags
-
string[]
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Mengembalikan
Promise<string[]>
createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)
Membuat templat lingkungan definisi
function createDefinitionEnvironmentTemplate(template: ReleaseDefinitionEnvironmentTemplate, project: string): Promise<ReleaseDefinitionEnvironmentTemplate>Parameter
- template
- ReleaseDefinitionEnvironmentTemplate
Templat lingkungan definisi untuk dibuat
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<ReleaseDefinitionEnvironmentTemplate>
createFavorites(FavoriteItem[], string, string, string)
function createFavorites(favoriteItems: FavoriteItem[], project: string, scope: string, identityId?: string): Promise<FavoriteItem[]>Parameter
- favoriteItems
- project
-
string
ID proyek atau nama proyek
- scope
-
string
- identityId
-
string
Mengembalikan
Promise<FavoriteItem[]>
createFolder(Folder, string, string)
createRelease(ReleaseStartMetadata, string)
Buat rilis.
function createRelease(releaseStartMetadata: ReleaseStartMetadata, project: string): Promise<Release>Parameter
- releaseStartMetadata
- ReleaseStartMetadata
Metadata untuk membuat rilis.
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<Release>
createReleaseDefinition(ReleaseDefinition, string)
Membuat definisi rilis
function createReleaseDefinition(releaseDefinition: ReleaseDefinition, project: string): Promise<ReleaseDefinition>Parameter
- releaseDefinition
- ReleaseDefinition
objek definisi rilis untuk dibuat.
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<ReleaseDefinition>
deleteDefinitionEnvironmentTemplate(string, string)
Menghapus templat lingkungan definisi
function deleteDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<void>Parameter
- project
-
string
ID proyek atau nama proyek
- templateId
-
string
Id templat lingkungan definisi
Mengembalikan
Promise<void>
deleteDefinitionTag(string, number, string)
Menghapus tag dari definisi
function deleteDefinitionTag(project: string, releaseDefinitionId: number, tag: string): Promise<string[]>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseDefinitionId
-
number
- tag
-
string
Mengembalikan
Promise<string[]>
deleteFavorites(string, string, string, string)
function deleteFavorites(project: string, scope: string, identityId?: string, favoriteItemIds?: string): Promise<void>Parameter
- project
-
string
ID proyek atau nama proyek
- scope
-
string
- identityId
-
string
- favoriteItemIds
-
string
Mengembalikan
Promise<void>
deleteFolder(string, string)
Menghapus folder definisi untuk nama folder dan jalur yang diberikan dan semua definisi yang ada.
function deleteFolder(project: string, path: string): Promise<void>Parameter
- project
-
string
ID proyek atau nama proyek
- path
-
string
Jalur folder yang akan dihapus.
Mengembalikan
Promise<void>
deleteRelease(string, number, string)
Penghapusan sementara rilis
function deleteRelease(project: string, releaseId: number, comment?: string): Promise<void>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Id rilis.
- comment
-
string
Komentar untuk menghapus rilis.
Mengembalikan
Promise<void>
deleteReleaseDefinition(string, number, string, boolean)
Menghapus definisi rilis.
function deleteReleaseDefinition(project: string, definitionId: number, comment?: string, forceDelete?: boolean): Promise<void>Parameter
- project
-
string
ID proyek atau nama proyek
- definitionId
-
number
Id definisi rilis.
- comment
-
string
Komentar untuk menghapus definisi rilis.
- forceDelete
-
boolean
'true' untuk secara otomatis membatalkan penyebaran rilis yang sedang berlangsung dan melanjutkan penghapusan definisi rilis . Defaultnya adalah 'false'.
Mengembalikan
Promise<void>
deleteReleaseTag(string, number, string)
Menghapus tag dari rilis
function deleteReleaseTag(project: string, releaseId: number, tag: string): Promise<string[]>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
- tag
-
string
Mengembalikan
Promise<string[]>
getAgentArtifactDefinitions(string, number)
Mengembalikan detail artefak yang diperlukan agen otomatisasi
function getAgentArtifactDefinitions(project: string, releaseId: number): Promise<AgentArtifactDefinition[]>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Mengembalikan
Promise<AgentArtifactDefinition[]>
getApproval(string, number, boolean)
Dapatkan persetujuan.
function getApproval(project: string, approvalId: number, includeHistory?: boolean): Promise<ReleaseApproval>Parameter
- project
-
string
ID proyek atau nama proyek
- approvalId
-
number
Id persetujuan.
- includeHistory
-
boolean
'true' untuk menyertakan riwayat persetujuan. Defaultnya adalah 'false'.
Mengembalikan
Promise<ReleaseApproval>
getApprovalHistory(string, number)
Dapatkan riwayat persetujuan.
function getApprovalHistory(project: string, approvalStepId: number): Promise<ReleaseApproval>Parameter
- project
-
string
ID proyek atau nama proyek
- approvalStepId
-
number
Id persetujuan.
Mengembalikan
Promise<ReleaseApproval>
getApprovals(string, string, ApprovalStatus, number[], ApprovalType, number, number, ReleaseQueryOrder, boolean)
Mendapatkan daftar persetujuan
function getApprovals(project: string, assignedToFilter?: string, statusFilter?: ApprovalStatus, releaseIdsFilter?: number[], typeFilter?: ApprovalType, top?: number, continuationToken?: number, queryOrder?: ReleaseQueryOrder, includeMyGroupApprovals?: boolean): Promise<PagedList<ReleaseApproval>>Parameter
- project
-
string
ID proyek atau nama proyek
- assignedToFilter
-
string
Persetujuan yang ditetapkan untuk pengguna ini.
- statusFilter
- ApprovalStatus
Persetujuan dengan status ini. Defaultnya adalah 'tertunda'.
- releaseIdsFilter
-
number[]
Persetujuan untuk id rilis yang disebutkan dalam filter. Beberapa rilis dapat disebutkan dengan memisahkannya dengan ',' misalnya releaseIdsFilter=1,2,3,4.
- typeFilter
- ApprovalType
Persetujuan dengan jenis ini.
- top
-
number
Jumlah persetujuan yang akan didapatkan. Defaultnya adalah 50.
- continuationToken
-
number
Mendapatkan persetujuan setelah token kelanjutan disediakan.
- queryOrder
- ReleaseQueryOrder
Mendapatkan hasil dalam urutan persetujuan yang dibuat yang ditentukan. Defaultnya adalah 'turun'.
- includeMyGroupApprovals
-
boolean
'true' untuk menyertakan persetujuan grup saya. Defaultnya adalah 'false'.
Mengembalikan
Promise<PagedList<ReleaseApproval>>
getArtifactTypeDefinitions(string)
function getArtifactTypeDefinitions(project: string): Promise<ArtifactTypeDefinition[]>Parameter
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<ArtifactTypeDefinition[]>
getArtifactVersions(string, number)
function getArtifactVersions(project: string, releaseDefinitionId: number): Promise<ArtifactVersionQueryResult>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseDefinitionId
-
number
Mengembalikan
Promise<ArtifactVersionQueryResult>
getArtifactVersionsForSources(Artifact[], string)
function getArtifactVersionsForSources(artifacts: Artifact[], project: string): Promise<ArtifactVersionQueryResult>Parameter
- artifacts
-
Artifact[]
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<ArtifactVersionQueryResult>
getAutoTriggerIssues(string, string, string, string)
function getAutoTriggerIssues(artifactType: string, sourceId: string, artifactVersionId: string, project?: string): Promise<AutoTriggerIssue[]>Parameter
- artifactType
-
string
- sourceId
-
string
- artifactVersionId
-
string
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<AutoTriggerIssue[]>
getDefinitionEnvironments(string, string, string[])
function getDefinitionEnvironments(project: string, taskGroupId?: string, propertyFilters?: string[]): Promise<DefinitionEnvironmentReference[]>Parameter
- project
-
string
ID proyek atau nama proyek
- taskGroupId
-
string
- propertyFilters
-
string[]
Mengembalikan
Promise<DefinitionEnvironmentReference[]>
getDefinitionEnvironmentTemplate(string, string)
Mendapatkan templat lingkungan definisi
function getDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<ReleaseDefinitionEnvironmentTemplate>Parameter
- project
-
string
ID proyek atau nama proyek
- templateId
-
string
Id templat lingkungan definisi
Mengembalikan
Promise<ReleaseDefinitionEnvironmentTemplate>
getDefinitionRevision(string, number, number)
Mendapatkan definisi rilis untuk definitionId dan revisi tertentu
function getDefinitionRevision(project: string, definitionId: number, revision: number): Promise<string>Parameter
- project
-
string
ID proyek atau nama proyek
- definitionId
-
number
Id definisi.
- revision
-
number
Id revisi.
Mengembalikan
Promise<string>
getDefinitionTags(string, number)
Mendapatkan tag untuk definisi
function getDefinitionTags(project: string, releaseDefinitionId: number): Promise<string[]>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseDefinitionId
-
number
Mengembalikan
Promise<string[]>
getDeploymentBadge(string, number, number, string)
Mendapatkan lencana yang menunjukkan status penyebaran terbaru untuk lingkungan.
function getDeploymentBadge(projectId: string, releaseDefinitionId: number, environmentId: number, branchName?: string): Promise<string>Parameter
- projectId
-
string
ID Proyek.
- releaseDefinitionId
-
number
ID Definisi Rilis.
- environmentId
-
number
ID Lingkungan.
- branchName
-
string
Nama cabang.
Mengembalikan
Promise<string>
getDeployments(string, number, number, string, Date, Date, DeploymentStatus, DeploymentOperationStatus, boolean, ReleaseQueryOrder, number, number, string, Date, Date, string)
Mendapatkan daftar penyebaran
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>>Parameter
- project
-
string
ID proyek atau nama proyek
- definitionId
-
number
Mencantumkan penyebaran untuk id definisi tertentu.
- definitionEnvironmentId
-
number
Mencantumkan penyebaran untuk id lingkungan definisi tertentu.
- createdBy
-
string
Cantumkan penyebaran yang penyebarannya dibuat sebagai identitas yang ditentukan.
- minModifiedTime
-
Date
Cantumkan penyebaran dengan waktu LastModified >= minModifiedTime.
- maxModifiedTime
-
Date
Cantumkan penyebaran dengan waktu LastModified <= maxModifiedTime.
- deploymentStatus
- DeploymentStatus
Cantumkan penyebaran dengan status penyebaran yang diberikan. Defaultnya adalah 'Semua'.
- operationStatus
- DeploymentOperationStatus
Mencantumkan penyebaran dengan status operasi yang diberikan. Defaultnya adalah 'Semua'.
- latestAttemptsOnly
-
boolean
'true' untuk menyertakan penyebaran dengan upaya terbaru saja. Defaultnya adalah 'false'.
- queryOrder
- ReleaseQueryOrder
Mencantumkan penyebaran dengan urutan kueri yang diberikan. Defaultnya adalah 'Turun'.
- top
-
number
Cantumkan penyebaran dengan bagian atas tertentu. Top default adalah '50' dan Max top adalah '100'.
- continuationToken
-
number
Cantumkan penyebaran dengan id penyebaran >= continuationToken.
- createdFor
-
string
Cantumkan penyebaran yang penyebarannya diminta sebagai identitas yang ditentukan.
- minStartedTime
-
Date
Cantumkan penyebaran dengan waktu StartedOn >= minStartedTime.
- maxStartedTime
-
Date
Cantumkan penyebaran dengan waktu StartedOn <= maxStartedTime.
- sourceBranch
-
string
Cantumkan penyebaran yang disebarkan dari nama cabang tertentu.
Mengembalikan
Promise<PagedList<Deployment>>
getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)
function getDeploymentsForMultipleEnvironments(queryParameters: DeploymentQueryParameters, project: string): Promise<Deployment[]>Parameter
- queryParameters
- DeploymentQueryParameters
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<Deployment[]>
getFavorites(string, string, string)
function getFavorites(project: string, scope: string, identityId?: string): Promise<FavoriteItem[]>Parameter
- project
-
string
ID proyek atau nama proyek
- scope
-
string
- identityId
-
string
Mengembalikan
Promise<FavoriteItem[]>
getFolders(string, string, FolderPathQueryOrder)
Mendapatkan folder.
function getFolders(project: string, path?: string, queryOrder?: FolderPathQueryOrder): Promise<Folder[]>Parameter
- project
-
string
ID proyek atau nama proyek
- path
-
string
Jalur folder.
- queryOrder
- FolderPathQueryOrder
Mendapatkan hasil dalam urutan yang ditentukan. Defaultnya adalah 'Tidak Ada'.
Mengembalikan
Promise<Folder[]>
getGateLog(string, number, number, number, number)
Mendapatkan log gerbang
function getGateLog(project: string, releaseId: number, environmentId: number, gateId: number, taskId: number): Promise<string>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Id rilis.
- environmentId
-
number
Id lingkungan rilis.
- gateId
-
number
Id gerbang.
- taskId
-
number
Id ReleaseTask untuk log.
Mengembalikan
Promise<string>
getInputValues(InputValuesQuery, string)
function getInputValues(query: InputValuesQuery, project: string): Promise<InputValuesQuery>Parameter
- query
- InputValuesQuery
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<InputValuesQuery>
getIssues(string, number, string)
function getIssues(project: string, buildId: number, sourceId?: string): Promise<AutoTriggerIssue[]>Parameter
- project
-
string
ID proyek atau nama proyek
- buildId
-
number
- sourceId
-
string
Mengembalikan
Promise<AutoTriggerIssue[]>
getLog(string, number, number, number, number)
Mendapatkan log
function getLog(project: string, releaseId: number, environmentId: number, taskId: number, attemptId?: number): Promise<string>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Id rilis.
- environmentId
-
number
Id lingkungan rilis.
- taskId
-
number
Id ReleaseTask untuk log.
- attemptId
-
number
Id dari upaya.
Mengembalikan
Promise<string>
getLogs(string, number)
Dapatkan log untuk ID rilis.
function getLogs(project: string, releaseId: number): Promise<ArrayBuffer>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Id rilis.
Mengembalikan
Promise<ArrayBuffer>
getManualIntervention(string, number, number)
Dapatkan intervensi manual untuk id rilis dan intervensi manual tertentu.
function getManualIntervention(project: string, releaseId: number, manualInterventionId: number): Promise<ManualIntervention>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Id rilis.
- manualInterventionId
-
number
Id intervensi manual.
Mengembalikan
Promise<ManualIntervention>
getManualInterventions(string, number)
Mencantumkan semua intervensi manual untuk rilis tertentu.
function getManualInterventions(project: string, releaseId: number): Promise<ManualIntervention[]>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Id rilis.
Mengembalikan
Promise<ManualIntervention[]>
getMetrics(string, Date)
function getMetrics(project: string, minMetricsTime?: Date): Promise<Metric[]>Parameter
- project
-
string
ID proyek atau nama proyek
- minMetricsTime
-
Date
Mengembalikan
Promise<Metric[]>
getOrgPipelineReleaseSettings()
Mendapatkan pengaturan rilis alur Org
function getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>Mengembalikan
Promise<OrgPipelineReleaseSettings>
getPipelineReleaseSettings(string)
Mendapatkan pengaturan rilis alur
function getPipelineReleaseSettings(project: string): Promise<ProjectPipelineReleaseSettings>Parameter
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<ProjectPipelineReleaseSettings>
getRelease(string, number, ApprovalFilters, string[], SingleReleaseExpands, number, boolean)
Dapatkan Rilis
function getRelease(project: string, releaseId: number, approvalFilters?: ApprovalFilters, propertyFilters?: string[], expand?: SingleReleaseExpands, topGateRecords?: number, includeDisabledDefinitions?: boolean): Promise<Release>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Id rilis.
- approvalFilters
- ApprovalFilters
Filter yang akan memungkinkan pengambilan langkah-langkah persetujuan secara selektif berdasarkan apakah itu otomatis, atau manual. Ini juga akan memutuskan apakah kita harus mengambil rekam jepret pra dan pasca persetujuan. Asumsikan Semua secara default
- propertyFilters
-
string[]
Daftar properti yang diperluas yang dibatasi koma yang akan diambil. Jika diatur, Rilis yang dikembalikan akan berisi nilai untuk Id properti yang ditentukan (jika ada). Jika tidak diatur, properti tidak akan disertakan.
- expand
- SingleReleaseExpands
Properti yang harus diperluas dalam rilis.
- topGateRecords
-
number
Jumlah rekaman gerbang rilis yang akan didapatkan. Defaultnya adalah 5.
- includeDisabledDefinitions
-
boolean
Sertakan definisi yang dinonaktifkan (jika diatur ke 'false' mengembalikan kesalahan, defaultnya adalah 'true')
Mengembalikan
Promise<Release>
getReleaseChanges(string, number, number, number, string)
function getReleaseChanges(project: string, releaseId: number, baseReleaseId?: number, top?: number, artifactAlias?: string): Promise<Change[]>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
- baseReleaseId
-
number
- top
-
number
- artifactAlias
-
string
Mengembalikan
Promise<Change[]>
getReleaseDefinition(string, number, string[], boolean)
Dapatkan definisi rilis.
function getReleaseDefinition(project: string, definitionId: number, propertyFilters?: string[], includeDisabled?: boolean): Promise<ReleaseDefinition>Parameter
- project
-
string
ID proyek atau nama proyek
- definitionId
-
number
Id definisi rilis.
- propertyFilters
-
string[]
Daftar properti yang diperluas yang dibatasi koma yang akan diambil. Jika diatur, Definisi Rilis yang dikembalikan akan berisi nilai untuk Id properti yang ditentukan (jika ada). Jika tidak diatur, properti tidak akan disertakan.
- includeDisabled
-
boolean
Bendera Boolean untuk menyertakan definisi yang dinonaktifkan.
Mengembalikan
Promise<ReleaseDefinition>
getReleaseDefinitionHistory(string, number)
Mendapatkan riwayat revisi untuk definisi rilis
function getReleaseDefinitionHistory(project: string, definitionId: number): Promise<ReleaseDefinitionRevision[]>Parameter
- project
-
string
ID proyek atau nama proyek
- definitionId
-
number
Id definisi.
Mengembalikan
Promise<ReleaseDefinitionRevision[]>
getReleaseDefinitionRevision(string, number, number)
Dapatkan definisi rilis dari revisi tertentu.
function getReleaseDefinitionRevision(project: string, definitionId: number, revision: number): Promise<string>Parameter
- project
-
string
ID proyek atau nama proyek
- definitionId
-
number
Id definisi rilis.
- revision
-
number
Nomor revisi definisi rilis.
Mengembalikan
Promise<string>
getReleaseDefinitions(string, string, ReleaseDefinitionExpands, string, string, number, string, ReleaseDefinitionQueryOrder, string, boolean, string[], string[], string[], boolean, boolean)
Dapatkan daftar definisi rilis.
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>>Parameter
- project
-
string
ID proyek atau nama proyek
- searchText
-
string
Dapatkan definisi rilis dengan nama yang berisi searchText.
- expand
- ReleaseDefinitionExpands
Properti yang harus diperluas dalam daftar definisi Rilis.
- artifactType
-
string
Definisi rilis dengan artifactType yang diberikan akan dikembalikan. Nilai dapat berupa Build, Jenkins, GitHub, Nuget, Team Build (eksternal), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.
- artifactSourceId
-
string
Definisi rilis dengan artifactSourceId yang diberikan akan dikembalikan. misalnya untuk build, itu adalah {projectGuid}:{BuildDefinitionId}, untuk Jenkins, itu adalah {JenkinsConnectionId}:{JenkinsDefinitionId}, untuk TfsOnPrem, itu adalah {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. Untuk artefak pihak ketiga misalnya TeamCity, BitBucket Anda dapat merujuk 'uniqueSourceIdentifier' di dalam vss-extension.json di https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.
- top
-
number
Jumlah definisi rilis yang akan didapatkan.
- continuationToken
-
string
Mendapatkan definisi rilis setelah token kelanjutan disediakan.
- queryOrder
- ReleaseDefinitionQueryOrder
Mendapatkan hasil dalam urutan yang ditentukan. Defaultnya adalah 'IdAscending'.
- path
-
string
Mendapatkan definisi rilis di bawah jalur yang ditentukan.
- isExactNameMatch
-
boolean
'true'untuk mendapatkan definisi rilis dengan kecocokan persis seperti yang ditentukan dalam searchText. Defaultnya adalah 'false'.
- tagFilter
-
string[]
Daftar tag yang dibatasi koma. Hanya definisi rilis dengan tag ini yang akan dikembalikan.
- propertyFilters
-
string[]
Daftar properti yang diperluas yang dibatasi koma yang akan diambil. Jika diatur, Definisi Rilis yang dikembalikan akan berisi nilai untuk Id properti yang ditentukan (jika ada). Jika tidak diatur, properti tidak akan disertakan. Perhatikan bahwa ini tidak akan memfilter Definisi Rilis apa pun dari hasil terlepas dari apakah memiliki kumpulan properti atau tidak.
- definitionIdFilter
-
string[]
Daftar definisi rilis yang dibatasi koma untuk diambil.
- isDeleted
-
boolean
'true' untuk mendapatkan definisi rilis yang telah dihapus. Defaultnya adalah 'false'
- searchTextContainsFolderName
-
boolean
'true' untuk mendapatkan definisi rilis di bawah folder dengan nama seperti yang ditentukan dalam searchText. Defaultnya adalah 'false'.
Mengembalikan
Promise<PagedList<ReleaseDefinition>>
getReleaseDefinitionSummary(string, number, number, boolean, number[])
Dapatkan ringkasan rilis id definisi tertentu.
function getReleaseDefinitionSummary(project: string, definitionId: number, releaseCount: number, includeArtifact?: boolean, definitionEnvironmentIdsFilter?: number[]): Promise<ReleaseDefinitionSummary>Parameter
- project
-
string
ID proyek atau nama proyek
- definitionId
-
number
Id definisi untuk mendapatkan ringkasan rilis.
- releaseCount
-
number
Jumlah rilis yang akan disertakan dalam ringkasan.
- includeArtifact
-
boolean
Sertakan detail artefak. Defaultnya adalah 'false'.
- definitionEnvironmentIdsFilter
-
number[]
Mengembalikan
Promise<ReleaseDefinitionSummary>
getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)
Dapatkan lingkungan rilis.
function getReleaseEnvironment(project: string, releaseId: number, environmentId: number, expand?: ReleaseEnvironmentExpands): Promise<ReleaseEnvironment>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Id rilis.
- environmentId
-
number
Id lingkungan rilis.
- expand
- ReleaseEnvironmentExpands
Properti yang harus diperluas di lingkungan.
Mengembalikan
Promise<ReleaseEnvironment>
getReleaseHistory(string, number)
function getReleaseHistory(project: string, releaseId: number): Promise<ReleaseRevision[]>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Mengembalikan
Promise<ReleaseRevision[]>
getReleaseProjects(string, string)
function getReleaseProjects(artifactType: string, artifactSourceId: string): Promise<ProjectReference[]>Parameter
- artifactType
-
string
- artifactSourceId
-
string
Mengembalikan
Promise<ProjectReference[]>
getReleaseRevision(string, number, number)
Dapatkan rilis untuk nomor revisi tertentu.
function getReleaseRevision(project: string, releaseId: number, definitionSnapshotRevision: number): Promise<string>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Id rilis.
- definitionSnapshotRevision
-
number
Nomor revisi revisi rekam jepret definisi.
Mengembalikan
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)
Mendapatkan daftar rilis
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[]>Parameter
- project
-
string
ID proyek atau nama proyek
- definitionId
-
number
Rilis dari ID definisi rilis ini.
- definitionEnvironmentId
-
number
- searchText
-
string
Rilis dengan nama yang berisi searchText.
- createdBy
-
string
Rilis yang dibuat oleh pengguna ini.
- statusFilter
- ReleaseStatus
Rilis yang memiliki status ini.
- environmentStatusFilter
-
number
- minCreatedTime
-
Date
Rilis yang dibuat setelah waktu ini.
- maxCreatedTime
-
Date
Rilis yang dibuat sebelum waktu ini.
- queryOrder
- ReleaseQueryOrder
Mendapatkan hasil dalam urutan tanggal yang dibuat yang ditentukan untuk rilis. Defaultnya adalah turun.
- top
-
number
Jumlah rilis yang akan didapatkan. Defaultnya adalah 50.
- continuationToken
-
number
Mendapatkan rilis setelah token kelanjutan disediakan.
- expand
- ReleaseExpands
Properti yang harus diperluas dalam daftar rilis.
- artifactTypeId
-
string
Rilis dengan artifactTypeId yang diberikan akan dikembalikan. Nilai dapat berupa Build, Jenkins, GitHub, Nuget, Team Build (eksternal), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.
- sourceId
-
string
Pengidentifikasi unik artefak yang digunakan. misalnya untuk build, itu adalah {projectGuid}:{BuildDefinitionId}, untuk Jenkins, itu adalah {JenkinsConnectionId}:{JenkinsDefinitionId}, untuk TfsOnPrem, itu adalah {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. Untuk artefak pihak ketiga misalnya TeamCity, BitBucket Anda dapat merujuk 'uniqueSourceIdentifier' di dalam vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.
- artifactVersionId
-
string
Rilis dengan artifactVersionId yang diberikan akan dikembalikan. Misalnya dalam kasus Build artifactType, itu adalah buildId.
- sourceBranchFilter
-
string
Rilis dengan sourceBranchFilter yang diberikan akan dikembalikan (Tidak digunakan dengan environmentStatusFilter).
- isDeleted
-
boolean
Mendapatkan rilis yang dihapus sementara, jika benar.
- tagFilter
-
string[]
Daftar tag yang dibatasi koma. Hanya rilis dengan tag ini yang akan dikembalikan.
- propertyFilters
-
string[]
Daftar properti yang diperluas yang dibatasi koma yang akan diambil. Jika diatur, Rilis yang dikembalikan akan berisi nilai untuk Id properti yang ditentukan (jika ada). Jika tidak diatur, properti tidak akan disertakan. Perhatikan bahwa ini tidak akan memfilter Rilis apa pun dari hasil terlepas dari apakah rilis tersebut memiliki kumpulan properti atau tidak.
- releaseIdFilter
-
number[]
Daftar Id rilis yang dibatasi koma. Hanya rilis dengan Id ini yang akan dikembalikan.
- path
-
string
Rilis di bawah jalur folder ini akan dikembalikan
Mengembalikan
Promise<Release[]>
getReleaseSettings(string)
Mendapatkan pengaturan rilis
function getReleaseSettings(project: string): Promise<ReleaseSettings>Parameter
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<ReleaseSettings>
getReleaseTags(string, number)
Mendapatkan tag untuk rilis
function getReleaseTags(project: string, releaseId: number): Promise<string[]>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Mengembalikan
Promise<string[]>
getReleaseTaskAttachmentContent(string, number, number, number, string, string, string, string, string)
Dapatkan lampiran tugas rilis.
function getReleaseTaskAttachmentContent(project: string, releaseId: number, environmentId: number, attemptId: number, planId: string, timelineId: string, recordId: string, type: string, name: string): Promise<ArrayBuffer>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Id rilis.
- environmentId
-
number
Id lingkungan rilis.
- attemptId
-
number
Jumlah upaya penyebaran.
- planId
-
string
Id Paket fase penyebaran.
- timelineId
-
string
Id Garis Waktu tugas.
- recordId
-
string
Id rekaman lampiran.
- type
-
string
Jenis lampiran.
- name
-
string
Nama lampiran.
Mengembalikan
Promise<ArrayBuffer>
getReleaseTaskAttachments(string, number, number, number, string, string)
Dapatkan lampiran tugas rilis.
function getReleaseTaskAttachments(project: string, releaseId: number, environmentId: number, attemptId: number, planId: string, type: string): Promise<ReleaseTaskAttachment[]>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Id rilis.
- environmentId
-
number
Id lingkungan rilis.
- attemptId
-
number
Jumlah upaya penyebaran.
- planId
-
string
Id Paket fase penyebaran.
- type
-
string
Jenis lampiran.
Mengembalikan
Promise<ReleaseTaskAttachment[]>
getReleaseWorkItemsRefs(string, number, number, number, string)
function getReleaseWorkItemsRefs(project: string, releaseId: number, baseReleaseId?: number, top?: number, artifactAlias?: string): Promise<ReleaseWorkItemRef[]>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
- baseReleaseId
-
number
- top
-
number
- artifactAlias
-
string
Mengembalikan
Promise<ReleaseWorkItemRef[]>
getSourceBranches(string, number)
function getSourceBranches(project: string, definitionId: number): Promise<string[]>Parameter
- project
-
string
ID proyek atau nama proyek
- definitionId
-
number
Mengembalikan
Promise<string[]>
getSummaryMailSections(string, number)
function getSummaryMailSections(project: string, releaseId: number): Promise<SummaryMailSection[]>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Mengembalikan
Promise<SummaryMailSection[]>
getTags(string)
function getTags(project: string): Promise<string[]>Parameter
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<string[]>
getTaskAttachmentContent(string, number, number, number, string, string, string, string)
Dapatkan lampiran tugas.
function getTaskAttachmentContent(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, recordId: string, type: string, name: string): Promise<ArrayBuffer>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Id rilis.
- environmentId
-
number
Id lingkungan rilis.
- attemptId
-
number
Jumlah upaya penyebaran.
- timelineId
-
string
Id Garis Waktu tugas.
- recordId
-
string
Id rekaman lampiran.
- type
-
string
Jenis lampiran.
- name
-
string
Nama lampiran.
Mengembalikan
Promise<ArrayBuffer>
getTaskAttachments(string, number, number, number, string, string)
Dapatkan lampiran tugas.
function getTaskAttachments(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, type: string): Promise<ReleaseTaskAttachment[]>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Id rilis.
- environmentId
-
number
Id lingkungan rilis.
- attemptId
-
number
Jumlah upaya penyebaran.
- timelineId
-
string
Id Garis Waktu tugas.
- type
-
string
Jenis lampiran.
Mengembalikan
Promise<ReleaseTaskAttachment[]>
getTaskLog(string, number, number, number, number, number, number)
Mendapatkan log tugas rilis sebagai file teks biasa.
function getTaskLog(project: string, releaseId: number, environmentId: number, releaseDeployPhaseId: number, taskId: number, startLine?: number, endLine?: number): Promise<string>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Id rilis.
- environmentId
-
number
Id lingkungan rilis.
- releaseDeployPhaseId
-
number
Id fase penyebaran rilis.
- taskId
-
number
Id ReleaseTask untuk log.
- startLine
-
number
Memulai nomor baris untuk log
- endLine
-
number
Mengakhiri nomor baris untuk log
Mengembalikan
Promise<string>
getTaskLog2(string, number, number, number, string, number, number, number)
Mendapatkan log tugas rilis sebagai file teks biasa.
function getTaskLog2(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, taskId: number, startLine?: number, endLine?: number): Promise<string>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Id rilis.
- environmentId
-
number
Id lingkungan rilis.
- attemptId
-
number
- timelineId
-
string
- taskId
-
number
Id ReleaseTask untuk log.
- startLine
-
number
Memulai nomor baris untuk log
- endLine
-
number
Mengakhiri nomor baris untuk log
Mengembalikan
Promise<string>
getTasks(string, number, number, number)
function getTasks(project: string, releaseId: number, environmentId: number, attemptId?: number): Promise<ReleaseTask[]>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
- environmentId
-
number
- attemptId
-
number
Mengembalikan
Promise<ReleaseTask[]>
getTasks2(string, number, number, number, string)
function getTasks2(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string): Promise<ReleaseTask[]>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
- environmentId
-
number
- attemptId
-
number
- timelineId
-
string
Mengembalikan
Promise<ReleaseTask[]>
getTasksForTaskGroup(string, number, number, number)
function getTasksForTaskGroup(project: string, releaseId: number, environmentId: number, releaseDeployPhaseId: number): Promise<ReleaseTask[]>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
- environmentId
-
number
- releaseDeployPhaseId
-
number
Mengembalikan
Promise<ReleaseTask[]>
listDefinitionEnvironmentTemplates(string, boolean)
Mendapatkan daftar templat lingkungan definisi
function listDefinitionEnvironmentTemplates(project: string, isDeleted?: boolean): Promise<ReleaseDefinitionEnvironmentTemplate[]>Parameter
- project
-
string
ID proyek atau nama proyek
- isDeleted
-
boolean
'true' untuk mendapatkan templat lingkungan definisi yang telah dihapus. Defaultnya adalah 'false'
Mengembalikan
Promise<ReleaseDefinitionEnvironmentTemplate[]>
sendSummaryMail(MailMessage, string, number)
function sendSummaryMail(mailMessage: MailMessage, project: string, releaseId: number): Promise<void>Parameter
- mailMessage
- MailMessage
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Mengembalikan
Promise<void>
undeleteRelease(string, number, string)
Membatalkan penghapusan rilis yang dihapus sementara.
function undeleteRelease(project: string, releaseId: number, comment: string): Promise<void>Parameter
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Id rilis yang akan dihapus.
- comment
-
string
Komentar apa pun untuk membatalkan penghapusan.
Mengembalikan
Promise<void>
undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)
Membatalkan penghapusan definisi rilis.
function undeleteReleaseDefinition(releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter, project: string, definitionId: number): Promise<ReleaseDefinition>Parameter
- releaseDefinitionUndeleteParameter
- ReleaseDefinitionUndeleteParameter
Objek untuk definisi rilis yang tidak terdelete.
- project
-
string
ID proyek atau nama proyek
- definitionId
-
number
Id definisi rilis yang akan dihapus
Mengembalikan
Promise<ReleaseDefinition>
undeleteReleaseDefinitionEnvironmentTemplate(string, string)
Membatalkan penghapusan templat lingkungan definisi rilis.
function undeleteReleaseDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<ReleaseDefinitionEnvironmentTemplate>Parameter
- project
-
string
ID proyek atau nama proyek
- templateId
-
string
Id templat lingkungan definisi yang akan dihapus
Mengembalikan
Promise<ReleaseDefinitionEnvironmentTemplate>
updateFolder(Folder, string, string)
updateGates(GateUpdateMetadata, string, number)
Memperbarui gerbang untuk penyebaran.
function updateGates(gateUpdateMetadata: GateUpdateMetadata, project: string, gateStepId: number): Promise<ReleaseGates>Parameter
- gateUpdateMetadata
- GateUpdateMetadata
Metadata untuk menambal Gerbang Rilis.
- project
-
string
ID proyek atau nama proyek
- gateStepId
-
number
Id langkah gerbang.
Mengembalikan
Promise<ReleaseGates>
updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)
Perbarui intervensi manual.
function updateManualIntervention(manualInterventionUpdateMetadata: ManualInterventionUpdateMetadata, project: string, releaseId: number, manualInterventionId: number): Promise<ManualIntervention>Parameter
- manualInterventionUpdateMetadata
- ManualInterventionUpdateMetadata
Meta data untuk memperbarui intervensi manual.
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Id rilis.
- manualInterventionId
-
number
Id intervensi manual.
Mengembalikan
Promise<ManualIntervention>
updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)
Memperbarui pengaturan rilis alur Organisasi
function updateOrgPipelineReleaseSettings(newSettings: OrgPipelineReleaseSettingsUpdateParameters): Promise<OrgPipelineReleaseSettings>Parameter
- newSettings
- OrgPipelineReleaseSettingsUpdateParameters
Mengembalikan
Promise<OrgPipelineReleaseSettings>
updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)
Memperbarui pengaturan rilis alur
function updatePipelineReleaseSettings(newSettings: ProjectPipelineReleaseSettingsUpdateParameters, project: string): Promise<ProjectPipelineReleaseSettings>Parameter
- newSettings
- ProjectPipelineReleaseSettingsUpdateParameters
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<ProjectPipelineReleaseSettings>
updateRelease(Release, string, number)
Memperbarui objek rilis lengkap.
function updateRelease(release: Release, project: string, releaseId: number): Promise<Release>Parameter
- release
- Release
Rilis objek untuk pembaruan.
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Id rilis yang akan diperbarui.
Mengembalikan
Promise<Release>
updateReleaseApproval(ReleaseApproval, string, number)
Memperbarui status persetujuan
function updateReleaseApproval(approval: ReleaseApproval, project: string, approvalId: number): Promise<ReleaseApproval>Parameter
- approval
- ReleaseApproval
Objek ReleaseApproval memiliki status, pemberi persetujuan, dan komentar.
- project
-
string
ID proyek atau nama proyek
- approvalId
-
number
Id persetujuan.
Mengembalikan
Promise<ReleaseApproval>
updateReleaseApprovals(ReleaseApproval[], string)
function updateReleaseApprovals(approvals: ReleaseApproval[], project: string): Promise<ReleaseApproval[]>Parameter
- approvals
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<ReleaseApproval[]>
updateReleaseDefinition(ReleaseDefinition, string, boolean)
Memperbarui definisi rilis.
function updateReleaseDefinition(releaseDefinition: ReleaseDefinition, project: string, skipTasksValidation?: boolean): Promise<ReleaseDefinition>Parameter
- releaseDefinition
- ReleaseDefinition
Rilis objek definisi untuk diperbarui.
- project
-
string
ID proyek atau nama proyek
- skipTasksValidation
-
boolean
Lewati bendera boolean validasi tugas
Mengembalikan
Promise<ReleaseDefinition>
updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)
Memperbarui status lingkungan rilis
function updateReleaseEnvironment(environmentUpdateData: ReleaseEnvironmentUpdateMetadata, project: string, releaseId: number, environmentId: number): Promise<ReleaseEnvironment>Parameter
- environmentUpdateData
- ReleaseEnvironmentUpdateMetadata
Data meta pembaruan lingkungan.
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Id rilis.
- environmentId
-
number
Id lingkungan rilis.
Mengembalikan
Promise<ReleaseEnvironment>
updateReleaseResource(ReleaseUpdateMetadata, string, number)
Memperbarui beberapa properti rilis.
function updateReleaseResource(releaseUpdateMetadata: ReleaseUpdateMetadata, project: string, releaseId: number): Promise<Release>Parameter
- releaseUpdateMetadata
- ReleaseUpdateMetadata
Properti rilis yang akan diperbarui.
- project
-
string
ID proyek atau nama proyek
- releaseId
-
number
Id rilis yang akan diperbarui.
Mengembalikan
Promise<Release>
updateReleaseSettings(ReleaseSettings, string)
Memperbarui pengaturan rilis
function updateReleaseSettings(releaseSettings: ReleaseSettings, project: string): Promise<ReleaseSettings>Parameter
- releaseSettings
- ReleaseSettings
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<ReleaseSettings>