ReleaseRestClient class

Csomag:: azure-devops-extension-api

Alaposztály, amelyet a VSS REST API-k kéréseinek igényléséhez (származtatásából) kell használni

Extends: RestClientBase

Konstruktorok

ReleaseRestClient(IVssRestClientOptions)

Tulajdonságok

Metódusok

addDefinitionTag(string, number, string)	Címke hozzáadása definícióhoz
addDefinitionTags(string[], string, number)	Több címke hozzáadása definícióhoz
addReleaseTag(string, number, string)	Címke hozzáadása releaseId azonosítóhoz
addReleaseTags(string[], string, number)	Címke hozzáadása egy kiadáshoz
createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)	Definíciókörnyezetsablon létrehozása
createFavorites(FavoriteItem[], string, string, string)
createFolder(Folder, string, string)	Új mappát hoz létre.
createRelease(ReleaseStartMetadata, string)	Hozzon létre egy kiadást.
createReleaseDefinition(ReleaseDefinition, string)	Kiadásdefiníció létrehozása
deleteDefinitionEnvironmentTemplate(string, string)	Definíciókörnyezeti sablon törlése
deleteDefinitionTag(string, number, string)	Címke törlése definícióból
deleteFavorites(string, string, string, string)
deleteFolder(string, string)	Törli a megadott mappa nevét és elérési útját tartalmazó definíciómappát, valamint az összes meglévő definíciót.
deleteRelease(string, number, string)	Kiadás helyreállítható törlése
deleteReleaseDefinition(string, number, string, boolean)	Törölje a kiadási definíciót.
deleteReleaseTag(string, number, string)	Címke törlése egy kiadásból
getAgentArtifactDefinitions(string, number)	Az Automation-ügynök által igényelt összetevők részleteit adja vissza
getApproval(string, number, boolean)	Jóváhagyás kérése.
getApprovalHistory(string, number)	Jóváhagyási előzmények lekérése.
getApprovals(string, string, ApprovalStatus, number[], ApprovalType, number, number, ReleaseQueryOrder, boolean)	Jóváhagyások listájának lekérése
getArtifactTypeDefinitions(string)
getArtifactVersions(string, number)
getArtifactVersionsForSources(Artifact[], string)
getAutoTriggerIssues(string, string, string, string)
getDefinitionEnvironments(string, string, string[])
getDefinitionEnvironmentTemplate(string, string)	Definíciókörnyezeti sablon lekéri
getDefinitionRevision(string, number, number)	Kiadási definíció lekérése egy adott definícióazonosítóhoz és -változathoz
getDefinitionTags(string, number)	A definíció címkéinek lekérdezése
getDeploymentBadge(string, number, number, string)	Egy jelvényt kap, amely jelzi a környezet legutóbbi üzembe helyezésének állapotát.
getDeployments(string, number, number, string, Date, Date, DeploymentStatus, DeploymentOperationStatus, boolean, ReleaseQueryOrder, number, number, string, Date, Date, string)	Az üzemelő példányok listájának lekérése
getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)
getFavorites(string, string, string)
getFlightAssignments(string)
getFolders(string, string, FolderPathQueryOrder)	Mappákat kap.
getGateLog(string, number, number, number, number)	Kapunaplók lekérése
getInputValues(InputValuesQuery, string)
getIssues(string, number, string)
getLog(string, number, number, number, number)	Naplók lekérése
getLogs(string, number)	A kiadási azonosító naplóinak lekérése.
getManualIntervention(string, number, number)	Manuális beavatkozás lekérése egy adott kiadáshoz és manuális beavatkozási azonosítóhoz.
getManualInterventions(string, number)	Listázz minden manuális beavatkozást egy adott kiadáshoz.
getMetrics(string, Date)
getOrgPipelineReleaseSettings()	Szervezeti folyamat kiadási beállításainak lekérdezése
getPipelineReleaseSettings(string)	A folyamat kiadási beállításainak lekérdezése
getRelease(string, number, ApprovalFilters, string[], SingleReleaseExpands, number, boolean)	Kiadás lekérése
getReleaseChanges(string, number, number, number, string)
getReleaseDefinition(string, number, string[], boolean)	Szerezze be a kiadás definícióját.
getReleaseDefinitionHistory(string, number)	Verzióelőzmények lekérése kiadási definícióhoz
getReleaseDefinitionRevision(string, number, number)	Egy adott változat kiadási definíciójának lekérése.
getReleaseDefinitions(string, string, ReleaseDefinitionExpands, string, string, number, string, ReleaseDefinitionQueryOrder, string, boolean, string[], string[], string[], boolean, boolean)	A kiadási definíciók listájának lekérése.
getReleaseDefinitionSummary(string, number, number, boolean, number[])	Egy adott definícióazonosító kiadási összegzésének lekérése.
getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)	Kiadási környezet lekérése.
getReleaseHistory(string, number)
getReleaseProjects(string, string)
getReleaseRevision(string, number, number)	Egy adott változatszám kiadásának lekérése.
getReleases(string, number, number, string, string, ReleaseStatus, number, Date, Date, ReleaseQueryOrder, number, number, ReleaseExpands, string, string, string, string, boolean, string[], string[], number[], string)	Kiadások listájának lekérése
getReleaseSettings(string)	Lekéri a kiadási beállításokat
getReleaseTags(string, number)	A kiadás címkéinek lekérése
getReleaseTaskAttachmentContent(string, number, number, number, string, string, string, string, string)	Kiadási feladat mellékletének lekérése.
getReleaseTaskAttachments(string, number, number, number, string, string)	Kérje le a kiadási feladat mellékleteit.
getReleaseWorkItemsRefs(string, number, number, number, string)
getSourceBranches(string, number)
getSummaryMailSections(string, number)
getTags(string)
getTaskAttachmentContent(string, number, number, number, string, string, string, string)	Feladat mellékletének lekérése.
getTaskAttachments(string, number, number, number, string, string)	A feladat mellékleteinek lekérése.
getTaskLog(string, number, number, number, number, number, number)	Lekéri a kiadás feladatnaplóját egyszerű szöveges fájlként.
getTaskLog2(string, number, number, number, string, number, number, number)	Lekéri a kiadás feladatnaplóját egyszerű szöveges fájlként.
getTasks(string, number, number, number)
getTasks2(string, number, number, number, string)
getTasksForTaskGroup(string, number, number, number)
listDefinitionEnvironmentTemplates(string, boolean)	Lekéri a definíciókörnyezetsablonok listáját
sendSummaryMail(MailMessage, string, number)
undeleteRelease(string, number, string)	Törölje a helyreállíthatóan törölt kiadást.
undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)	Kiadásdefiníció törlése.
undeleteReleaseDefinitionEnvironmentTemplate(string, string)	Kiadásdefiníciós környezeti sablon leválasztása.
updateFolder(Folder, string, string)	Frissíti a meglévő mappát a megadott elérési úton.
updateGates(GateUpdateMetadata, string, number)	Frissíti a kaput az üzembe helyezéshez.
updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)	Manuális beavatkozás frissítése.
updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)	A szervezeti folyamat kiadási beállításainak frissítése
updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)	A folyamat kiadási beállításainak frissítése
updateRelease(Release, string, number)	Frissítsen egy teljes kiadási objektumot.
updateReleaseApproval(ReleaseApproval, string, number)	Jóváhagyás frissítési állapota
updateReleaseApprovals(ReleaseApproval[], string)
updateReleaseDefinition(ReleaseDefinition, string, boolean)	Frissítsen egy kiadási definíciót.
updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)	Kiadási környezet állapotának frissítése
updateReleaseResource(ReleaseUpdateMetadata, string, number)	Frissítse a kiadás néhány tulajdonságát.
updateReleaseSettings(ReleaseSettings, string)	A kiadási beállítások frissítése

Konstruktor adatai

ReleaseRestClient(IVssRestClientOptions)

new ReleaseRestClient(options: IVssRestClientOptions)

Paraméterek

options: IVssRestClientOptions

Tulajdonság adatai

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Tulajdonság értéke

string

Metódus adatai

addDefinitionTag(string, number, string)

Címke hozzáadása definícióhoz

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseDefinitionId: number

tag: string

Válaszok

Promise<string[]>

addDefinitionTags(string[], string, number)

Több címke hozzáadása definícióhoz

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

Paraméterek

tags: string[]

project: string

Projektazonosító vagy projektnév

releaseDefinitionId: number

Válaszok

Promise<string[]>

addReleaseTag(string, number, string)

Címke hozzáadása releaseId azonosítóhoz

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

tag: string

Válaszok

Promise<string[]>

addReleaseTags(string[], string, number)

Címke hozzáadása egy kiadáshoz

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

Paraméterek

tags: string[]

project: string

Projektazonosító vagy projektnév

releaseId: number

Válaszok

Promise<string[]>

createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)

Definíciókörnyezetsablon létrehozása

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

Paraméterek

template: ReleaseDefinitionEnvironmentTemplate

Létrehozandó definíciókörnyezetsablon

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<ReleaseDefinitionEnvironmentTemplate>

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

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

Paraméterek

favoriteItems: FavoriteItem[]

project: string

Projektazonosító vagy projektnév

scope: string

identityId: string

Válaszok

Promise<FavoriteItem[]>

createFolder(Folder, string, string)

Új mappát hoz létre.

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

Paraméterek

folder: Folder

mappa.

project: string

Projektazonosító vagy projektnév

path: string

A mappa elérési útja.

Válaszok

Promise<Folder>

createRelease(ReleaseStartMetadata, string)

Hozzon létre egy kiadást.

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

Paraméterek

releaseStartMetadata: ReleaseStartMetadata

A kiadás létrehozásához kapcsolódó metaadatok.

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<Release>

createReleaseDefinition(ReleaseDefinition, string)

Kiadásdefiníció létrehozása

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

Paraméterek

releaseDefinition: ReleaseDefinition

létrehozandó kiadásdefiníciós objektum.

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<ReleaseDefinition>

deleteDefinitionEnvironmentTemplate(string, string)

Definíciókörnyezeti sablon törlése

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

Paraméterek

project: string

Projektazonosító vagy projektnév

templateId: string

A definíciókörnyezet-sablon azonosítója

Válaszok

Promise<void>

deleteDefinitionTag(string, number, string)

Címke törlése definícióból

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseDefinitionId: number

tag: string

Válaszok

Promise<string[]>

deleteFavorites(string, string, string, string)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

scope: string

identityId: string

favoriteItemIds: string

Válaszok

Promise<void>

deleteFolder(string, string)

Törli a megadott mappa nevét és elérési útját tartalmazó definíciómappát, valamint az összes meglévő definíciót.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

path: string

A törölni kívánt mappa elérési útja.

Válaszok

Promise<void>

deleteRelease(string, number, string)

Kiadás helyreállítható törlése

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

A kiadás azonosítója.

comment: string

Megjegyzés a kiadás törléséhez.

Válaszok

Promise<void>

deleteReleaseDefinition(string, number, string, boolean)

Törölje a kiadási definíciót.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

definitionId: number

A kiadási definíció azonosítója.

comment: string

Megjegyzés a kiadásdefiníció törléséhez.

forceDelete: boolean

"true" a folyamatban lévő kiadások telepítésének automatikus megszakításához és a kiadásdefiníció törlésének folytatásához. Az alapértelmezett érték "false".

Válaszok

Promise<void>

deleteReleaseTag(string, number, string)

Címke törlése egy kiadásból

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

tag: string

Válaszok

Promise<string[]>

getAgentArtifactDefinitions(string, number)

Az Automation-ügynök által igényelt összetevők részleteit adja vissza

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

Válaszok

Promise<AgentArtifactDefinition[]>

getApproval(string, number, boolean)

Jóváhagyás kérése.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

approvalId: number

A jóváhagyás azonosítója.

includeHistory: boolean

"igaz" a jóváhagyás előzményeinek belefoglalásához. Az alapértelmezett érték "false".

Válaszok

Promise<ReleaseApproval>

getApprovalHistory(string, number)

Jóváhagyási előzmények lekérése.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

approvalStepId: number

A jóváhagyás azonosítója.

Válaszok

Promise<ReleaseApproval>

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

Jóváhagyások listájának lekérése

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

Paraméterek

project: string

Projektazonosító vagy projektnév

assignedToFilter: string

A felhasználóhoz rendelt jóváhagyások.

statusFilter: ApprovalStatus

Ezzel az állapottal rendelkező jóváhagyások. Az alapértelmezett érték "függőben".

releaseIdsFilter: number[]

A szűrőben említett kiadási azonosító(k) jóváhagyása. Több kiadást is megemlíthet, ha a ", például releaseIdsFilter=1,2,3,4" elemet választja el egymástól.

typeFilter: ApprovalType

Jóváhagyás ehhez a típushoz.

top: number

A lekérendő jóváhagyások száma. Az alapértelmezett érték 50.

continuationToken: number

Lekéri a jóváhagyásokat a folytatási jogkivonat megadása után.

queryOrder: ReleaseQueryOrder

Az eredményeket a létrehozott jóváhagyások meghatározott sorrendjében kapja meg. Az alapértelmezett érték "csökkenő".

includeMyGroupApprovals: boolean

"true" (igaz) a csoportjóváhagyások belefoglalásához. Az alapértelmezett érték "false".

Válaszok

Promise<PagedList<ReleaseApproval>>

getArtifactTypeDefinitions(string)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<ArtifactTypeDefinition[]>

getArtifactVersions(string, number)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseDefinitionId: number

Válaszok

Promise<ArtifactVersionQueryResult>

getArtifactVersionsForSources(Artifact[], string)

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

Paraméterek

artifacts: Artifact[]

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<ArtifactVersionQueryResult>

getAutoTriggerIssues(string, string, string, string)

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

Paraméterek

artifactType: string

sourceId: string

artifactVersionId: string

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<AutoTriggerIssue[]>

getDefinitionEnvironments(string, string, string[])

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

Paraméterek

project: string

Projektazonosító vagy projektnév

taskGroupId: string

propertyFilters: string[]

Válaszok

Promise<DefinitionEnvironmentReference[]>

getDefinitionEnvironmentTemplate(string, string)

Definíciókörnyezeti sablon lekéri

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

Paraméterek

project: string

Projektazonosító vagy projektnév

templateId: string

A definíciókörnyezet-sablon azonosítója

Válaszok

Promise<ReleaseDefinitionEnvironmentTemplate>

getDefinitionRevision(string, number, number)

Kiadási definíció lekérése egy adott definícióazonosítóhoz és -változathoz

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

Paraméterek

project: string

Projektazonosító vagy projektnév

definitionId: number

A definíció azonosítója.

revision: number

A változat azonosítója.

Válaszok

Promise<string>

getDefinitionTags(string, number)

A definíció címkéinek lekérdezése

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseDefinitionId: number

Válaszok

Promise<string[]>

getDeploymentBadge(string, number, number, string)

Egy jelvényt kap, amely jelzi a környezet legutóbbi üzembe helyezésének állapotát.

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

Paraméterek

projectId: string

A projekt azonosítója.

releaseDefinitionId: number

A kiadási definíció azonosítója.

environmentId: number

A környezet azonosítója.

branchName: string

Az ág neve.

Válaszok

Promise<string>

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

Az üzemelő példányok listájának lekérése

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>>

Paraméterek

project: string

Projektazonosító vagy projektnév

definitionId: number

Egy adott definícióazonosító üzembe helyezésének listázása.

definitionEnvironmentId: number

Egy adott definíciókörnyezet-azonosító üzembe helyezésének listázása.

createdBy: string

Sorolja fel azokat az üzemelő példányokat, amelyekhez az üzemelő példányok identitásként vannak megadva.

minModifiedTime: Date

Sorolja fel az üzemelő példányokat a LastModified time = minModifiedTime értékekkel >.

maxModifiedTime: Date

Sorolja fel az üzemelő példányokat a LastModified time = maxModifiedTime értékekkel <.

deploymentStatus: DeploymentStatus

A megadott üzembehelyezési állapotú üzemelő példányok listázása. Az alapértelmezett érték az "Összes".

operationStatus: DeploymentOperationStatus

A megadott műveleti állapotú üzemelő példányok listázása. Az alapértelmezett érték az "Összes".

latestAttemptsOnly: boolean

"igaz", hogy csak a legújabb kísérlettel rendelkező üzemelő példányokat tartalmazza. Az alapértelmezett érték "false".

queryOrder: ReleaseQueryOrder

Az üzemelő példányok listázása adott lekérdezési sorrendben. Az alapértelmezett érték a "Csökkenő".

top: number

Az üzemelő példányok listázása a megadott felsővel. Az alapértelmezett felső "50", a max. felső pedig "100".

continuationToken: number

Az üzemelő példányok listázása az üzembe helyezés azonosítójával >= continuationToken.

createdFor: string

Adja meg azokat az üzemelő példányokat, amelyekhez a rendszer identitásként kéri az üzemelő példányokat.

minStartedTime: Date

Sorolja fel az üzemelő példányokat a StartedOn idő = minStartedTime értékekkel >.

maxStartedTime: Date

Az üzemelő példányok listázása a StartedOn idő = maxStartedTime használatával <.

sourceBranch: string

Sorolja fel a megadott ágnévből üzembe helyezett üzemelő példányokat.

Válaszok

Promise<PagedList<Deployment>>

getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)

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

Paraméterek

queryParameters: DeploymentQueryParameters

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<Deployment[]>

getFavorites(string, string, string)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

scope: string

identityId: string

Válaszok

Promise<FavoriteItem[]>

getFlightAssignments(string)

function getFlightAssignments(flightName?: string): Promise<string[]>

Paraméterek

flightName: string

Válaszok

Promise<string[]>

getFolders(string, string, FolderPathQueryOrder)

Mappákat kap.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

path: string

A mappa elérési útja.

queryOrder: FolderPathQueryOrder

Az eredményeket a megadott sorrendben kapja meg. Az alapértelmezett érték a "Nincs".

Válaszok

Promise<Folder[]>

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

Kapunaplók lekérése

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

A kiadás azonosítója.

environmentId: number

A kiadási környezet azonosítója.

gateId: number

A kapu azonosítója.

taskId: number

A napló ReleaseTask-azonosítója.

Válaszok

Promise<string>

getInputValues(InputValuesQuery, string)

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

Paraméterek

query: InputValuesQuery

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<InputValuesQuery>

getIssues(string, number, string)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

sourceId: string

Válaszok

Promise<AutoTriggerIssue[]>

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

Naplók lekérése

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

A kiadás azonosítója.

environmentId: number

A kiadási környezet azonosítója.

taskId: number

A napló ReleaseTask-azonosítója.

attemptId: number

A kísérlet azonosítója.

Válaszok

Promise<string>

getLogs(string, number)

A kiadási azonosító naplóinak lekérése.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

A kiadás azonosítója.

Válaszok

Promise<ArrayBuffer>

getManualIntervention(string, number, number)

Manuális beavatkozás lekérése egy adott kiadáshoz és manuális beavatkozási azonosítóhoz.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

A kiadás azonosítója.

manualInterventionId: number

A manuális beavatkozás azonosítója.

Válaszok

Promise<ManualIntervention>

getManualInterventions(string, number)

Listázz minden manuális beavatkozást egy adott kiadáshoz.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

A kiadás azonosítója.

Válaszok

Promise<ManualIntervention[]>

getMetrics(string, Date)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

minMetricsTime: Date

Válaszok

Promise<Metric[]>

getOrgPipelineReleaseSettings()

Szervezeti folyamat kiadási beállításainak lekérdezése

function getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>

Válaszok

Promise<OrgPipelineReleaseSettings>

getPipelineReleaseSettings(string)

A folyamat kiadási beállításainak lekérdezése

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

Paraméterek

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<ProjectPipelineReleaseSettings>

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

Kiadás lekérése

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

A kiadás azonosítója.

approvalFilters: ApprovalFilters

Szűrő, amely lehetővé tenné a jóváhagyási lépések szelektív lekérését attól függően, hogy az automatizált vagy manuális. Ez azt is eldönti, hogy lekérjük-e a jóváhagyás előtti és utáni pillanatképeket. Alapértelmezés szerint az összeset feltételezi

propertyFilters: string[]

A lekérendő kiterjesztett tulajdonságok vesszővel tagolt listája. Ha be van állítva, a visszaadott kiadás a megadott tulajdonságazonosítók értékeit tartalmazza (ha léteznek). Ha nincs beállítva, a tulajdonságok nem lesznek belefoglalva.

expand: SingleReleaseExpands

A kiadásban kibontandó tulajdonság.

topGateRecords: number

A lekérendő kiadási kapurekordok száma. Az alapértelmezett érték 5.

includeDisabledDefinitions: boolean

Letiltott definíciók belefoglalása (ha a "hamis" értékre van állítva, akkor az alapértelmezett érték "igaz")

Válaszok

Promise<Release>

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

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

baseReleaseId: number

top: number

artifactAlias: string

Válaszok

Promise<Change[]>

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

Szerezze be a kiadás definícióját.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

definitionId: number

A kiadási definíció azonosítója.

propertyFilters: string[]

A lekérendő kiterjesztett tulajdonságok vesszővel tagolt listája. Ha be van állítva, a visszaadott kiadási definíció a megadott tulajdonságazonosítók értékeit tartalmazza (ha léteznek). Ha nincs beállítva, a tulajdonságok nem lesznek belefoglalva.

includeDisabled: boolean

Logikai jelző a letiltott definíciók belefoglalásához.

Válaszok

Promise<ReleaseDefinition>

getReleaseDefinitionHistory(string, number)

Verzióelőzmények lekérése kiadási definícióhoz

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

Paraméterek

project: string

Projektazonosító vagy projektnév

definitionId: number

A definíció azonosítója.

Válaszok

Promise<ReleaseDefinitionRevision[]>

getReleaseDefinitionRevision(string, number, number)

Egy adott változat kiadási definíciójának lekérése.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

definitionId: number

A kiadási definíció azonosítója.

revision: number

A kiadási definíció változatszáma.

Válaszok

Promise<string>

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

A kiadási definíciók listájának lekérése.

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>>

Paraméterek

project: string

Projektazonosító vagy projektnév

searchText: string

A searchText nevet tartalmazó kiadási definíciók lekérése.

expand: ReleaseDefinitionExpands

A kiadásdefiníciók listájában kibontandó tulajdonságok.

artifactType: string

A rendszer visszaadja a megadott artifactType-tal rendelkező kiadásdefiníciókat. Az értékek lehetnek Build, Jenkins, GitHub, Nuget, Team Build (külső), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.

artifactSourceId: string

A rendszer visszaadja a megadott artifactSourceId azonosítójú kiadási definíciókat. Például a build esetében a következő lenne: {projectGuid}:{BuildDefinitionId}, Jenkins esetén {JenkinsConnectionId}:{JenkinsDefinitionId}, TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. Külső összetevők( például TeamCity, BitBucket) esetén az "uniqueSourceIdentifier" kifejezésre hivatkozhat vss-extension.json a https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.

top: number

A lekérendő kiadási definíciók száma.

continuationToken: string

Lekéri a kiadási definíciókat a megadott folytatási jogkivonat után.

queryOrder: ReleaseDefinitionQueryOrder

Az eredményeket a megadott sorrendben kapja meg. Az alapértelmezett érték az "IdAscending".

path: string

Lekéri a kiadási definíciókat a megadott elérési út alatt.

isExactNameMatch: boolean

"true", hogy lekérje a kiadási definíciókat a searchTextben megadott pontos egyezéssel. Az alapértelmezett érték "false".

tagFilter: string[]

A címkék vesszővel tagolt listája. A rendszer csak az ezekkel a címkékkel rendelkező kiadásdefiníciókat adja vissza.

propertyFilters: string[]

A lekérendő kiterjesztett tulajdonságok vesszővel tagolt listája. Ha be van állítva, a visszaadott kiadási definíciók a megadott tulajdonságazonosítók értékeit tartalmazzák (ha léteznek). Ha nincs beállítva, a tulajdonságok nem lesznek belefoglalva. Vegye figyelembe, hogy ez nem szűri ki a kiadási definíciót az eredményekből, függetlenül attól, hogy rendelkezik-e tulajdonságkészlettel.

definitionIdFilter: string[]

A lekérendő kiadási definíciók vesszővel tagolt listája.

isDeleted: boolean

"igaz" a törölt kiadási definíciók lekéréséhez. Az alapértelmezett érték "false" (hamis)

searchTextContainsFolderName: boolean

"true" (igaz) a kiadási definíciók lekéréséhez a searchTextben megadott névvel rendelkező mappában. Az alapértelmezett érték "false".

Válaszok

Promise<PagedList<ReleaseDefinition>>

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

Egy adott definícióazonosító kiadási összegzésének lekérése.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

definitionId: number

A definíció azonosítója a kiadás összegzésének lekéréséhez.

releaseCount: number

Az összefoglalóban szerepeltetni kívánt kiadások száma.

includeArtifact: boolean

Adja meg az összetevők részleteit. Az alapértelmezett érték "false".

definitionEnvironmentIdsFilter: number[]

Válaszok

Promise<ReleaseDefinitionSummary>

getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)

Kiadási környezet lekérése.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

A kiadás azonosítója.

environmentId: number

A kiadási környezet azonosítója.

expand: ReleaseEnvironmentExpands

Egy olyan tulajdonság, amelyet ki kell bontani a környezetben.

Válaszok

Promise<ReleaseEnvironment>

getReleaseHistory(string, number)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

Válaszok

Promise<ReleaseRevision[]>

getReleaseProjects(string, string)

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

Paraméterek

artifactType: string

artifactSourceId: string

Válaszok

Promise<ProjectReference[]>

getReleaseRevision(string, number, number)

Egy adott változatszám kiadásának lekérése.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

A kiadás azonosítója.

definitionSnapshotRevision: number

Definíció pillanatképének változatszáma.

Válaszok

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)

Kiadások listájának lekérése

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[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

definitionId: number

A kiadásdefiníció azonosítójából származó kiadások.

definitionEnvironmentId: number

searchText: string

A searchText nevet tartalmazó kiadások.

createdBy: string

A felhasználó által létrehozott kiadások.

statusFilter: ReleaseStatus

Az ilyen állapotú kiadások.

environmentStatusFilter: number

minCreatedTime: Date

Az ezt követően létrehozott kiadások.

maxCreatedTime: Date

Az ez előtt létrehozott kiadások.

queryOrder: ReleaseQueryOrder

Az eredményeket a kiadások létrehozási dátumának meghatározott sorrendjében kapja meg. Az alapértelmezett érték csökkenő.

top: number

Lekérendő kiadások száma. Az alapértelmezett érték 50.

continuationToken: number

Lekéri a kiadásokat a folytatási jogkivonat megadása után.

expand: ReleaseExpands

Az a tulajdonság, amelyet ki kell bontani a kiadások listájában.

artifactTypeId: string

A rendszer visszaadja a megadott artifactTypeId azonosítójú kiadásokat. Az értékek lehetnek Build, Jenkins, GitHub, Nuget, Team Build (külső), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.

sourceId: string

A használt összetevő egyedi azonosítója. Például a build esetében a következő lenne: {projectGuid}:{BuildDefinitionId}, Jenkins esetén {JenkinsConnectionId}:{JenkinsDefinitionId}, TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. Külső összetevők( például TeamCity, BitBucket) esetén az "uniqueSourceIdentifier" kifejezésre hivatkozhat vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.

artifactVersionId: string

A rendszer visszaadja a megadott artifactVersionId azonosítóval rendelkező kiadásokat. Build artifactType esetén például buildazonosító.

sourceBranchFilter: string

A rendszer visszaadja a megadott sourceBranchFilter-kiadásokat (a environmentStatusFilterrel nem használható).

isDeleted: boolean

Lekéri a helyreállíthatóan törölt kiadásokat, ha igaz.

tagFilter: string[]

A címkék vesszővel tagolt listája. A rendszer csak az ezekkel a címkékkel rendelkező kiadásokat adja vissza.

propertyFilters: string[]

A lekérendő kiterjesztett tulajdonságok vesszővel tagolt listája. Ha be van állítva, a visszaadott kiadások a megadott tulajdonságazonosítók értékeit tartalmazzák (ha léteznek). Ha nincs beállítva, a tulajdonságok nem lesznek belefoglalva. Vegye figyelembe, hogy ez nem szűri ki a kiadásokat az eredményekből, függetlenül attól, hogy rendelkezik-e tulajdonságkészlettel.

releaseIdFilter: number[]

A kiadások azonosítóinak vesszővel tagolt listája. A rendszer csak az ezekkel az azonosítókkal rendelkező kiadásokat adja vissza.

path: string

A mappa elérési útjának kiadásait a rendszer visszaadja

Válaszok

Promise<Release[]>

getReleaseSettings(string)

Lekéri a kiadási beállításokat

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

Paraméterek

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<ReleaseSettings>

getReleaseTags(string, number)

A kiadás címkéinek lekérése

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

Válaszok

Promise<string[]>

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

Kiadási feladat mellékletének lekérése.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

A kiadás azonosítója.

environmentId: number

A kiadási környezet azonosítója.

attemptId: number

Az üzembe helyezési kísérlet száma.

planId: string

Az üzembe helyezési fázis tervazonosítója.

timelineId: string

A tevékenység idővonal-azonosítója.

recordId: string

A melléklet rekordazonosítója.

type: string

A melléklet típusa.

name: string

A melléklet neve.

Válaszok

Promise<ArrayBuffer>

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

Kérje le a kiadási feladat mellékleteit.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

A kiadás azonosítója.

environmentId: number

A kiadási környezet azonosítója.

attemptId: number

Az üzembe helyezési kísérlet száma.

planId: string

Az üzembe helyezési fázis tervazonosítója.

type: string

A melléklet típusa.

Válaszok

Promise<ReleaseTaskAttachment[]>

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

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

baseReleaseId: number

top: number

artifactAlias: string

Válaszok

Promise<ReleaseWorkItemRef[]>

getSourceBranches(string, number)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

definitionId: number

Válaszok

Promise<string[]>

getSummaryMailSections(string, number)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

Válaszok

Promise<SummaryMailSection[]>

getTags(string)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<string[]>

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

Feladat mellékletének lekérése.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

A kiadás azonosítója.

environmentId: number

A kiadási környezet azonosítója.

attemptId: number

Az üzembe helyezési kísérlet száma.

timelineId: string

A tevékenység idővonal-azonosítója.

recordId: string

A melléklet rekordazonosítója.

type: string

A melléklet típusa.

name: string

A melléklet neve.

Válaszok

Promise<ArrayBuffer>

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

A feladat mellékleteinek lekérése.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

A kiadás azonosítója.

environmentId: number

A kiadási környezet azonosítója.

attemptId: number

Az üzembe helyezési kísérlet száma.

timelineId: string

A tevékenység idővonal-azonosítója.

type: string

A melléklet típusa.

Válaszok

Promise<ReleaseTaskAttachment[]>

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

Lekéri a kiadás feladatnaplóját egyszerű szöveges fájlként.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

A kiadás azonosítója.

environmentId: number

A kiadási környezet azonosítója.

releaseDeployPhaseId: number

Kiadás üzembe helyezési fázisazonosítója.

taskId: number

A napló ReleaseTask-azonosítója.

startLine: number

Kezdősor száma a naplókhoz

endLine: number

Naplók zárósorszáma

Válaszok

Promise<string>

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

Lekéri a kiadás feladatnaplóját egyszerű szöveges fájlként.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

A kiadás azonosítója.

environmentId: number

A kiadási környezet azonosítója.

attemptId: number

timelineId: string

taskId: number

A napló ReleaseTask-azonosítója.

startLine: number

Kezdősor száma a naplókhoz

endLine: number

Naplók zárósorszáma

Válaszok

Promise<string>

getTasks(string, number, number, number)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

environmentId: number

attemptId: number

Válaszok

Promise<ReleaseTask[]>

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

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

environmentId: number

attemptId: number

timelineId: string

Válaszok

Promise<ReleaseTask[]>

getTasksForTaskGroup(string, number, number, number)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

environmentId: number

releaseDeployPhaseId: number

Válaszok

Promise<ReleaseTask[]>

listDefinitionEnvironmentTemplates(string, boolean)

Lekéri a definíciókörnyezetsablonok listáját

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

Paraméterek

project: string

Projektazonosító vagy projektnév

isDeleted: boolean

"true" (igaz) a törölt definíciókörnyezeti sablonok lekéréséhez. Az alapértelmezett érték "false" (hamis)

Válaszok

Promise<ReleaseDefinitionEnvironmentTemplate[]>

sendSummaryMail(MailMessage, string, number)

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

Paraméterek

mailMessage: MailMessage

project: string

Projektazonosító vagy projektnév

releaseId: number

Válaszok

Promise<void>

undeleteRelease(string, number, string)

Törölje a helyreállíthatóan törölt kiadást.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

releaseId: number

A törölni kívánt kiadás azonosítója.

comment: string

Bármilyen megjegyzés a feloldáshoz.

Válaszok

Promise<void>

undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)

Kiadásdefiníció törlése.

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

Paraméterek

releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter

A kiadási definíció visszavonása objektuma.

project: string

Projektazonosító vagy projektnév

definitionId: number

A törölni kívánt kiadási definíció azonosítója

Válaszok

Promise<ReleaseDefinition>

undeleteReleaseDefinitionEnvironmentTemplate(string, string)

Kiadásdefiníciós környezeti sablon leválasztása.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

templateId: string

A törölni kívánt definíciókörnyezetsablon azonosítója

Válaszok

Promise<ReleaseDefinitionEnvironmentTemplate>

updateFolder(Folder, string, string)

Frissíti a meglévő mappát a megadott elérési úton.

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

Paraméterek

folder: Folder

mappa.

project: string

Projektazonosító vagy projektnév

path: string

A frissíteni kívánt mappa elérési útja.

Válaszok

Promise<Folder>

updateGates(GateUpdateMetadata, string, number)

Frissíti a kaput az üzembe helyezéshez.

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

Paraméterek

gateUpdateMetadata: GateUpdateMetadata

Metaadatok a kiadási kapuk javításához.

project: string

Projektazonosító vagy projektnév

gateStepId: number

Kapu lépésazonosítója.

Válaszok

Promise<ReleaseGates>

updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)

Manuális beavatkozás frissítése.

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

Paraméterek

manualInterventionUpdateMetadata: ManualInterventionUpdateMetadata

Metaadatok a manuális beavatkozás frissítéséhez.

project: string

Projektazonosító vagy projektnév

releaseId: number

A kiadás azonosítója.

manualInterventionId: number

A manuális beavatkozás azonosítója.

Válaszok

Promise<ManualIntervention>

updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)

A szervezeti folyamat kiadási beállításainak frissítése

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

Paraméterek

newSettings: OrgPipelineReleaseSettingsUpdateParameters

Válaszok

Promise<OrgPipelineReleaseSettings>

updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)

A folyamat kiadási beállításainak frissítése

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

Paraméterek

newSettings: ProjectPipelineReleaseSettingsUpdateParameters

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<ProjectPipelineReleaseSettings>

updateRelease(Release, string, number)

Frissítsen egy teljes kiadási objektumot.

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

Paraméterek

release: Release

Kiadási objektum a frissítéshez.

project: string

Projektazonosító vagy projektnév

releaseId: number

A frissíteni kívánt kiadás azonosítója.

Válaszok

Promise<Release>

updateReleaseApproval(ReleaseApproval, string, number)

Jóváhagyás frissítési állapota

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

Paraméterek

approval: ReleaseApproval

A ReleaseApproval objektum állapota, jóváhagyója és megjegyzései vannak.

project: string

Projektazonosító vagy projektnév

approvalId: number

A jóváhagyás azonosítója.

Válaszok

Promise<ReleaseApproval>

updateReleaseApprovals(ReleaseApproval[], string)

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

Paraméterek

approvals: ReleaseApproval[]

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<ReleaseApproval[]>

updateReleaseDefinition(ReleaseDefinition, string, boolean)

Frissítsen egy kiadási definíciót.

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

Paraméterek

releaseDefinition: ReleaseDefinition

Frissítendő kiadásdefiníciós objektum.

project: string

Projektazonosító vagy projektnév

skipTasksValidation: boolean

Feladatérvényesítési logikai jelző kihagyása

Válaszok

Promise<ReleaseDefinition>

updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)

Kiadási környezet állapotának frissítése

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

Paraméterek

environmentUpdateData: ReleaseEnvironmentUpdateMetadata

A környezet metaadatainak frissítése.

project: string

Projektazonosító vagy projektnév

releaseId: number

A kiadás azonosítója.

environmentId: number

A kiadási környezet azonosítója.

Válaszok

Promise<ReleaseEnvironment>

updateReleaseResource(ReleaseUpdateMetadata, string, number)

Frissítse a kiadás néhány tulajdonságát.

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

Paraméterek

releaseUpdateMetadata: ReleaseUpdateMetadata

A frissítendő kiadás tulajdonságai.

project: string

Projektazonosító vagy projektnév

releaseId: number

A frissíteni kívánt kiadás azonosítója.

Válaszok

Promise<Release>

updateReleaseSettings(ReleaseSettings, string)

A kiadási beállítások frissítése

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

Paraméterek

releaseSettings: ReleaseSettings

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<ReleaseSettings>

Megosztás a következőn keresztül:

ReleaseRestClient class

Konstruktorok

Tulajdonságok

Metódusok

Konstruktor adatai

ReleaseRestClient(IVssRestClientOptions)

Paraméterek

Tulajdonság adatai

RESOURCE_AREA_ID

Tulajdonság értéke

Metódus adatai

addDefinitionTag(string, number, string)

Paraméterek

Válaszok

addDefinitionTags(string[], string, number)

Paraméterek

Válaszok

addReleaseTag(string, number, string)

Paraméterek

Válaszok

addReleaseTags(string[], string, number)

Paraméterek

Válaszok

createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)

Paraméterek

Válaszok

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

Paraméterek

Válaszok

createFolder(Folder, string, string)

Paraméterek

Válaszok

createRelease(ReleaseStartMetadata, string)

Paraméterek

Válaszok

createReleaseDefinition(ReleaseDefinition, string)

Paraméterek

Válaszok

deleteDefinitionEnvironmentTemplate(string, string)

Paraméterek

Válaszok

deleteDefinitionTag(string, number, string)

Paraméterek

Válaszok

deleteFavorites(string, string, string, string)

Paraméterek

Válaszok

deleteFolder(string, string)

Paraméterek

Válaszok

deleteRelease(string, number, string)

Paraméterek

Válaszok

deleteReleaseDefinition(string, number, string, boolean)

Paraméterek

Válaszok

deleteReleaseTag(string, number, string)

Paraméterek

Válaszok

getAgentArtifactDefinitions(string, number)

Paraméterek

Válaszok

getApproval(string, number, boolean)

Paraméterek

Válaszok

getApprovalHistory(string, number)

Paraméterek

Válaszok

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

Paraméterek

Válaszok

getArtifactTypeDefinitions(string)

Paraméterek

Válaszok

getArtifactVersions(string, number)

Paraméterek

Válaszok

getArtifactVersionsForSources(Artifact[], string)

Paraméterek