ReleaseRestClient class
Alaposztály, amelyet a VSS REST API-k kéréseinek igényléséhez (származtatása) kell használni
- Extends
static RESOURCE_AREA_ID: stringTulajdonság értéke
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[]>
Több címke hozzáadása egy 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[]>
Címke hozzáadása egy 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[]>
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[]>
Definíciós környezeti sablon 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>
function createFavorites(favoriteItems: FavoriteItem[], project: string, scope: string, identityId?: string): Promise<FavoriteItem[]>Paraméterek
- favoriteItems
- project
-
string
Projektazonosító vagy projektnév
- scope
-
string
- identityId
-
string
Válaszok
Promise<FavoriteItem[]>
Létrehoz egy új mappát.
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>
Létrehozás 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>
Kiadási definíció létrehozása
function createReleaseDefinition(releaseDefinition: ReleaseDefinition, project: string): Promise<ReleaseDefinition>Paraméterek
- releaseDefinition
- ReleaseDefinition
kiadásdefiníciós objektum létrehozása.
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<ReleaseDefinition>
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örnyezeti sablon azonosítója
Válaszok
Promise<void>
Címke törlése egy 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[]>
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>
Törli a megadott mappanévhez és elérési úthoz tartozó 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>
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 egy kiadás törléséhez.
Válaszok
Promise<void>
Kiadási definíció törlése.
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 egy kiadási definíció törléséhez.
- forceDelete
-
boolean
"true" a folyamatban lévő kiadási üzemelő példányok automatikus megszakításához és a kiadásdefiníció törléséhez. Az alapértelmezett érték a "false".
Válaszok
Promise<void>
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[]>
Visszaadja az Automation-ügynök által igényelt összetevők részleteit
function getAgentArtifactDefinitions(project: string, releaseId: number): Promise<AgentArtifactDefinition[]>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- releaseId
-
number
Válaszok
Promise<AgentArtifactDefinition[]>
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", hogy tartalmazza a jóváhagyás előzményeit. Az alapértelmezett érték a "false".
Válaszok
Promise<ReleaseApproval>
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
Jóváhagyások ezzel az állapottal. 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 elkülöníti őket a következővel: "," például releaseIdsFilter=1,2,3,4.
- 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
Lekéri az eredményeket a létrehozott jóváhagyások meghatározott sorrendjében. Az alapértelmezett érték a "csökkenő".
- includeMyGroupApprovals
-
boolean
"igaz", hogy tartalmazza a csoport jóváhagyását. Az alapértelmezett érték a "false".
Válaszok
Promise<PagedList<ReleaseApproval>>
function getArtifactTypeDefinitions(project: string): Promise<ArtifactTypeDefinition[]>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<ArtifactTypeDefinition[]>
function getArtifactVersions(project: string, releaseDefinitionId: number): Promise<ArtifactVersionQueryResult>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- releaseDefinitionId
-
number
Válaszok
Promise<ArtifactVersionQueryResult>
function getArtifactVersionsForSources(artifacts: Artifact[], project: string): Promise<ArtifactVersionQueryResult>Paraméterek
- artifacts
-
Artifact[]
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<ArtifactVersionQueryResult>
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[]>
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[]>
Lekéri a definíciókörnyezet sablonját
function getDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<ReleaseDefinitionEnvironmentTemplate>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- templateId
-
string
A definíciókörnyezeti sablon azonosítója
Válaszok
Promise<ReleaseDefinitionEnvironmentTemplate>
Adott definícióazonosító és -változat kiadási definíciójának lekérése
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>
Lekéri egy 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[]>
Egy jelvényt kap, amely egy környezet legutóbbi üzembe helyezésének állapotát jelzi.
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)
Ü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ó üzemelő példányainak listázása.
- definitionEnvironmentId
-
number
Egy adott definíció környezeti azonosítójának üzemelő példányainak listázása.
- createdBy
-
string
Sorolja fel azokat az üzemelő példányokat, amelyekhez az üzemelő példányok identitásként lettek létrehozva.
- minModifiedTime
-
Date
Sorolja fel az üzemelő példányokat a LastModified time >= minModifiedTime értékkel.
- maxModifiedTime
-
Date
Sorolja fel az üzemelő példányokat a LastModified time <= maxModifiedTime értékkel.
- deploymentStatus
- DeploymentStatus
Sorolja fel a megadott üzembe helyezési állapotú üzemelő példányokat. Az alapértelmezett érték az "Összes".
- operationStatus
- DeploymentOperationStatus
Sorolja fel a megadott műveleti állapotú üzemelő példányokat. Az alapértelmezett érték az "Összes".
- latestAttemptsOnly
-
boolean
"true" (igaz) értékre, hogy csak a legújabb kísérlettel rendelkező üzemelő példányokat tartalmazza. Az alapértelmezett érték a "false".
- queryOrder
- ReleaseQueryOrder
Sorolja fel az üzemelő példányokat a megadott 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
Sorolja fel az üzemelő példányokat az üzembehelyezési azonosító >= continuationToken értékkel.
- createdFor
-
string
Sorolja fel azokat az üzemelő példányokat, amelyekhez az üzemelő példányokat identitásként kérik.
- minStartedTime
-
Date
Sorolja fel az üzemelő példányokat a StartedOn time >= minStartedTime értékkel.
- maxStartedTime
-
Date
Sorolja fel az üzemelő példányokat a StartedOn time <= maxStartedTime értékkel.
- sourceBranch
-
string
Sorolja fel a megadott ágnévből üzembe helyezett üzemelő példányokat.
Válaszok
Promise<PagedList<Deployment>>
function getDeploymentsForMultipleEnvironments(queryParameters: DeploymentQueryParameters, project: string): Promise<Deployment[]>Paraméterek
- queryParameters
- DeploymentQueryParameters
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<Deployment[]>
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[]>
function getFlightAssignments(flightName?: string): Promise<string[]>Paraméterek
- flightName
-
string
Válaszok
Promise<string[]>
Mappákat szerez be.
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
Lekéri az eredményeket a megadott sorrendben. Az alapértelmezett érték a "Nincs".
Válaszok
Promise<Folder[]>
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
ReleaseTask A napló azonosítója.
Válaszok
Promise<string>
function getInputValues(query: InputValuesQuery, project: string): Promise<InputValuesQuery>Paraméterek
- query
- InputValuesQuery
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<InputValuesQuery>
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[]>
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
ReleaseTask A napló azonosítója.
- attemptId
-
number
A kísérlet azonosítója.
Válaszok
Promise<string>
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>
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>
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[]>
function getMetrics(project: string, minMetricsTime?: Date): Promise<Metric[]>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- minMetricsTime
-
Date
Válaszok
Promise<Metric[]>
Szervezeti folyamat kiadási beállításainak lekérdezése
function getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>Válaszok
Promise<OrgPipelineReleaseSettings>
Folyamatkiadási beállítások lekérdezése
function getPipelineReleaseSettings(project: string): Promise<ProjectPipelineReleaseSettings>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<ProjectPipelineReleaseSettings>
Kiadás lekérése
function getRelease(project: string, releaseId: number, approvalFilters?: ApprovalFilters, propertyFilters?: string[], expand?: SingleReleaseExpands, topGateRecords?: number): 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 beolvasását attól függően, hogy az automatikus 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 fogja tartalmazni (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.
Válaszok
Promise<Release>
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[]>
Kiadási definíció lekérése.
function getReleaseDefinition(project: string, definitionId: number, propertyFilters?: string[]): 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 fogja tartalmazni (ha léteznek). Ha nincs beállítva, a tulajdonságok nem lesznek belefoglalva.
Válaszok
Promise<ReleaseDefinition>
Kiadási definíció korrektúraelőzményeinek lekérése
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[]>
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
Kiadásdefiníciók lekérése searchText-et tartalmazó névvel.
- 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ásdefiníciókat. Például a build esetében a következő lenne: {projectGuid}:{BuildDefinitionId}, a Jenkins esetében a következő lenne: {JenkinsConnectionId}:{JenkinsDefinitionId}, tfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. Külső összetevők( például TeamCity, BitBucket) esetén az "uniqueSourceIdentifier" kifejezésre hivatkozhat a vss-extension.json a címen https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.
- top
-
number
A lekérendő kiadásdefiníciók száma.
- continuationToken
-
string
Lekéri a kiadási definíciókat a megadott folytatási jogkivonat után.
- queryOrder
- ReleaseDefinitionQueryOrder
Lekéri az eredményeket a megadott sorrendben. 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 a "false".
- tagFilter
-
string[]
A címkék vesszővel tagolt listája. Csak az ezekkel a címkékkel rendelkező kiadásdefiníciók lesznek visszaadva.
- 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 vagy sem.
- definitionIdFilter
-
string[]
A lekérendő kiadásdefiní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"
- searchTextContainsFolderName
-
boolean
"true" (igaz) a kiadási definíciók lekéréséhez a searchText mappában megadott névvel. Az alapértelmezett érték a "false".
Válaszok
Promise<PagedList<ReleaseDefinition>>
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 a "false".
- definitionEnvironmentIdsFilter
-
number[]
Válaszok
Promise<ReleaseDefinitionSummary>
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>
function getReleaseHistory(project: string, releaseId: number): Promise<ReleaseRevision[]>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- releaseId
-
number
Válaszok
Promise<ReleaseRevision[]>
function getReleaseProjects(artifactType: string, artifactSourceId: string): Promise<ProjectReference[]>Paraméterek
- artifactType
-
string
- artifactSourceId
-
string
Válaszok
Promise<ProjectReference[]>
Adott verziószá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-változatának szá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<PagedList<Release>>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- definitionId
-
number
A jelen kiadásdefiníció azonosítójának kiadásai.
- 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
Lekéri az eredményeket a kiadások létrehozási dátumának meghatározott sorrendjében. Az alapértelmezett érték csökkenő.
- top
-
number
A lekérendő kiadások száma. Az alapértelmezett érték 50.
- continuationToken
-
number
Lekéri a kiadásokat a megadott folytatási jogkivonat 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}, a Jenkins esetében a következő lenne: {JenkinsConnectionId}:{JenkinsDefinitionId}, tfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. Külső összetevők( például TeamCity, BitBucket) esetén az "uniqueSourceIdentifier" kifejezésre hivatkozhat a vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensionsbelül.
- artifactVersionId
-
string
A rendszer visszaadja a megadott artifactVersionId azonosítóval rendelkező kiadásokat. Például build artifactType esetén buildazonosító.
- sourceBranchFilter
-
string
A rendszer visszaadja a megadott sourceBranchFilter-kiadásokat.
- 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 vagy sem.
- 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 útja alatt lévő kiadások lesznek visszaadva
Válaszok
A kiadási beállítások lekérdezése
function getReleaseSettings(project: string): Promise<ReleaseSettings>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<ReleaseSettings>
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ősor-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>
A kiadási feladat mellékleteinek lekérése.
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[]>
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[]>
function getSourceBranches(project: string, definitionId: number): Promise<string[]>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- definitionId
-
number
Válaszok
Promise<string[]>
function getSummaryMailSections(project: string, releaseId: number): Promise<SummaryMailSection[]>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- releaseId
-
number
Válaszok
Promise<SummaryMailSection[]>
function getTags(project: string): Promise<string[]>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<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ősor-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>
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ősor-azonosítója.
- type
-
string
A melléklet típusa.
Válaszok
Promise<ReleaseTaskAttachment[]>
Lekéri egy 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
ReleaseTask-azonosító a naplóhoz.
- startLine
-
number
Kezdősor száma a naplókhoz
- endLine
-
number
A naplók zárósorszáma
Válaszok
Promise<string>
Lekéri egy 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
ReleaseTask-azonosító a naplóhoz.
- startLine
-
number
Kezdősor száma a naplókhoz
- endLine
-
number
A naplók zárósorszáma
Válaszok
Promise<string>
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[]>
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[]>
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[]>
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
"igaz" a törölt definíciókörnyezeti sablonok lekéréséhez. Az alapértelmezett érték "false"
Válaszok
Promise<ReleaseDefinitionEnvironmentTemplate[]>
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>
Helyreállíthatóan törölt kiadás törlése.
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 törléshez.
Válaszok
Promise<void>
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ó törlési 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>
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örnyezeti sablon azonosítója
Válaszok
Promise<ReleaseDefinitionEnvironmentTemplate>
Frissítések egy 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>
Frissítések az üzembe helyezés kapuja.
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>
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>
A szervezeti folyamat kiadási beállításainak Frissítések
function updateOrgPipelineReleaseSettings(newSettings: OrgPipelineReleaseSettingsUpdateParameters): Promise<OrgPipelineReleaseSettings>Paraméterek
- newSettings
- OrgPipelineReleaseSettingsUpdateParameters
Válaszok
Promise<OrgPipelineReleaseSettings>
Frissítések folyamat kiadási beállításai
function updatePipelineReleaseSettings(newSettings: ProjectPipelineReleaseSettingsUpdateParameters, project: string): Promise<ProjectPipelineReleaseSettings>Paraméterek
- newSettings
- ProjectPipelineReleaseSettingsUpdateParameters
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<ProjectPipelineReleaseSettings>
Frissítsen egy teljes kiadási objektumot.
function updateRelease(release: Release, project: string, releaseId: number): Promise<Release>Paraméterek
- release
- Release
Kiadási objektum 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>
Jóváhagyás állapotának frissítése
function updateReleaseApproval(approval: ReleaseApproval, project: string, approvalId: number): Promise<ReleaseApproval>Paraméterek
- approval
- ReleaseApproval
ReleaseApproval objektum állapota, jóváhagyója és megjegyzései.
- project
-
string
Projektazonosító vagy projektnév
- approvalId
-
number
A jóváhagyás azonosítója.
Válaszok
Promise<ReleaseApproval>
function updateReleaseApprovals(approvals: ReleaseApproval[], project: string): Promise<ReleaseApproval[]>Paraméterek
- approvals
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<ReleaseApproval[]>
Kiadási definíció frissítése.
function updateReleaseDefinition(releaseDefinition: ReleaseDefinition, project: string): Promise<ReleaseDefinition>Paraméterek
- releaseDefinition
- ReleaseDefinition
Kiadásdefiníciós objektum frissítendő.
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<ReleaseDefinition>
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 frissíti a metaadatokat.
- 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>
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>
A kiadási beállítások Frissítések
function updateReleaseSettings(releaseSettings: ReleaseSettings, project: string): Promise<ReleaseSettings>Paraméterek
- releaseSettings
- ReleaseSettings
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<ReleaseSettings>