ReleaseRestClient class

Referens

Paket:: azure-devops-extension-api

Basklass som ska användas (härledd från) för att göra begäranden till VSS REST-API:erna

Extends: RestClientBase

Konstruktorer

ReleaseRestClient(IVssRestClientOptions)

Egenskaper

RESOURCE_AREA_ID

Metoder

addDefinitionTag(string, number, string)	Lägger till en tagg i en definition
addDefinitionTags(string[], string, number)	Lägger till flera taggar i en definition
addReleaseTag(string, number, string)	Lägger till en tagg i ett releaseId
addReleaseTags(string[], string, number)	Lägger till tagg i en version
createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)	Skapar en definitionsmiljömall
createFavorites(FavoriteItem[], string, string, string)
createFolder(Folder, string, string)	Skapar en ny mapp.
createRelease(ReleaseStartMetadata, string)	Skapa en version.
createReleaseDefinition(ReleaseDefinition, string)	Skapa en versionsdefinition
deleteDefinitionEnvironmentTemplate(string, string)	Ta bort en definitionsmiljömall
deleteDefinitionTag(string, number, string)	Tar bort en tagg från en definition
deleteFavorites(string, string, string, string)
deleteFolder(string, string)	Tar bort en definitionsmapp för angivet mappnamn och sökväg och alla befintliga definitioner.
deleteRelease(string, number, string)	Mjuk borttagning av en version
deleteReleaseDefinition(string, number, string, boolean)	Ta bort en versionsdefinition.
deleteReleaseTag(string, number, string)	Tar bort en tagg från en version
getAgentArtifactDefinitions(string, number)	Returnerar artefaktinformationen som automationsagenten kräver
getApproval(string, number, boolean)	Få ett godkännande.
getApprovalHistory(string, number)	Hämta godkännandehistorik.
getApprovals(string, string, ApprovalStatus, number[], ApprovalType, number, number, ReleaseQueryOrder, boolean)	Hämta en lista över godkännanden
getArtifactTypeDefinitions(string)
getArtifactVersions(string, number)
getArtifactVersionsForSources(Artifact[], string)
getAutoTriggerIssues(string, string, string, string)
getDefinitionEnvironments(string, string, string[])
getDefinitionEnvironmentTemplate(string, string)	Hämtar en definitionsmiljömall
getDefinitionRevision(string, number, number)	Hämta versionsdefinition för ett angivet definitions-ID och en revision
getDefinitionTags(string, number)	Hämtar taggarna för en definition
getDeploymentBadge(string, number, number, string)	Hämtar ett märke som anger status för den senaste distributionen för en miljö.
getDeployments(string, number, number, string, Date, Date, DeploymentStatus, DeploymentOperationStatus, boolean, ReleaseQueryOrder, number, number, string, Date, Date, string)	Hämta en lista över distributioner
getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)
getFavorites(string, string, string)
getFlightAssignments(string)
getFolders(string, string, FolderPathQueryOrder)	Hämtar mappar.
getGateLog(string, number, number, number, number)	Hämtar portloggar
getInputValues(InputValuesQuery, string)
getIssues(string, number, string)
getLog(string, number, number, number, number)	Hämtar loggar
getLogs(string, number)	Hämta loggar för ett versions-ID.
getManualIntervention(string, number, number)	Hämta manuella åtgärder för en viss version och ett manuellt åtgärds-ID.
getManualInterventions(string, number)	Lista alla manuella åtgärder för en viss version.
getMetrics(string, Date)
getOrgPipelineReleaseSettings()	Hämtar versionsinställningar för organisationspipeline
getPipelineReleaseSettings(string)	Hämtar versionsinställningar för pipeline
getRelease(string, number, ApprovalFilters, string[], SingleReleaseExpands, number)	Hämta en version
getReleaseChanges(string, number, number, number, string)
getReleaseDefinition(string, number, string[])	Hämta en versionsdefinition.
getReleaseDefinitionHistory(string, number)	Hämta revisionshistorik för en versionsdefinition
getReleaseDefinitionRevision(string, number, number)	Hämta versionsdefinitionen för en viss revision.
getReleaseDefinitions(string, string, ReleaseDefinitionExpands, string, string, number, string, ReleaseDefinitionQueryOrder, string, boolean, string[], string[], string[], boolean, boolean)	Hämta en lista över versionsdefinitioner.
getReleaseDefinitionSummary(string, number, number, boolean, number[])	Hämta en versionssammanfattning av ett visst definitions-ID.
getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)	Hämta en versionsmiljö.
getReleaseHistory(string, number)
getReleaseProjects(string, string)
getReleaseRevision(string, number, number)	Hämta version för ett angivet revisionsnummer.
getReleases(string, number, number, string, string, ReleaseStatus, number, Date, Date, ReleaseQueryOrder, number, number, ReleaseExpands, string, string, string, string, boolean, string[], string[], number[], string)	Hämta en lista över versioner
getReleaseSettings(string)	Hämtar versionsinställningarna
getReleaseTags(string, number)	Hämtar taggarna för en version
getReleaseTaskAttachmentContent(string, number, number, number, string, string, string, string, string)	Hämta en bifogad versionsuppgift.
getReleaseTaskAttachments(string, number, number, number, string, string)	Hämta de bifogade filerna för versionsaktiviteten.
getReleaseWorkItemsRefs(string, number, number, number, string)
getSourceBranches(string, number)
getSummaryMailSections(string, number)
getTags(string)
getTaskAttachmentContent(string, number, number, number, string, string, string, string)	Hämta en bifogad uppgift.
getTaskAttachments(string, number, number, number, string, string)	Hämta aktivitetsbilagorna.
getTaskLog(string, number, number, number, number, number, number)	Hämtar aktivitetsloggen för en version som en oformaterad textfil.
getTaskLog2(string, number, number, number, string, number, number, number)	Hämtar aktivitetsloggen för en version som en oformaterad textfil.
getTasks(string, number, number, number)
getTasks2(string, number, number, number, string)
getTasksForTaskGroup(string, number, number, number)
listDefinitionEnvironmentTemplates(string, boolean)	Hämtar en lista över definitionsmiljömallar
sendSummaryMail(MailMessage, string, number)
undeleteRelease(string, number, string)	Ta bort en mjuk borttagen version.
undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)	Ta bort en versionsdefinition.
undeleteReleaseDefinitionEnvironmentTemplate(string, string)	Ta bort en miljömall för versionsdefinitioner.
updateFolder(Folder, string, string)	Uppdateringar en befintlig mapp på angiven befintlig sökväg.
updateGates(GateUpdateMetadata, string, number)	Uppdateringar porten för en distribution.
updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)	Uppdatera manuella åtgärder.
updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)	versionsinställningar för Uppdateringar organisationspipeline
updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)	versionsinställningar för Uppdateringar pipeline
updateRelease(Release, string, number)	Uppdatera ett fullständigt versionsobjekt.
updateReleaseApproval(ReleaseApproval, string, number)	Uppdatera status för ett godkännande
updateReleaseApprovals(ReleaseApproval[], string)
updateReleaseDefinition(ReleaseDefinition, string)	Uppdatera en versionsdefinition.
updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)	Uppdatera status för en versionsmiljö
updateReleaseResource(ReleaseUpdateMetadata, string, number)	Uppdatera några egenskaper för en version.
updateReleaseSettings(ReleaseSettings, string)	Uppdateringar versionsinställningarna

Konstruktorinformation

ReleaseRestClient(IVssRestClientOptions)

new ReleaseRestClient(options: IVssRestClientOptions)

Parametrar

options: IVssRestClientOptions

Egenskapsinformation

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Egenskapsvärde

string

Metodinformation

addDefinitionTag(string, number, string)

Lägger till en tagg i en definition

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseDefinitionId: number

tag: string

Returer

Promise<string[]>

addDefinitionTags(string[], string, number)

Lägger till flera taggar i en definition

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

Parametrar

tags: string[]

project: string

Projekt-ID eller projektnamn

releaseDefinitionId: number

Returer

Promise<string[]>

addReleaseTag(string, number, string)

Lägger till en tagg i ett releaseId

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

tag: string

Returer

Promise<string[]>

addReleaseTags(string[], string, number)

Lägger till tagg i en version

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

Parametrar

tags: string[]

project: string

Projekt-ID eller projektnamn

releaseId: number

Returer

Promise<string[]>

createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)

Skapar en definitionsmiljömall

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

Parametrar

template: ReleaseDefinitionEnvironmentTemplate

Definitionsmiljömall att skapa

project: string

Projekt-ID eller projektnamn

Returer

Promise<ReleaseDefinitionEnvironmentTemplate>

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

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

Parametrar

favoriteItems: FavoriteItem[]

project: string

Projekt-ID eller projektnamn

scope: string

identityId: string

Returer

Promise<FavoriteItem[]>

createFolder(Folder, string, string)

Skapar en ny mapp.

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

Parametrar

folder: Folder

Mappen.

project: string

Projekt-ID eller projektnamn

path: string

Sökväg till mappen.

Returer

Promise<Folder>

createRelease(ReleaseStartMetadata, string)

Skapa en version.

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

Parametrar

releaseStartMetadata: ReleaseStartMetadata

Metadata för att skapa en version.

project: string

Projekt-ID eller projektnamn

Returer

Promise<Release>

createReleaseDefinition(ReleaseDefinition, string)

Skapa en versionsdefinition

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

Parametrar

releaseDefinition: ReleaseDefinition

versionsdefinitionsobjekt som ska skapas.

project: string

Projekt-ID eller projektnamn

Returer

Promise<ReleaseDefinition>

deleteDefinitionEnvironmentTemplate(string, string)

Ta bort en definitionsmiljömall

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

Parametrar

project: string

Projekt-ID eller projektnamn

templateId: string

ID för definitionsmiljömallen

Returer

Promise<void>

deleteDefinitionTag(string, number, string)

Tar bort en tagg från en definition

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseDefinitionId: number

tag: string

Returer

Promise<string[]>

deleteFavorites(string, string, string, string)

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

Parametrar

project: string

Projekt-ID eller projektnamn

scope: string

identityId: string

favoriteItemIds: string

Returer

Promise<void>

deleteFolder(string, string)

Tar bort en definitionsmapp för angivet mappnamn och sökväg och alla befintliga definitioner.

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

Parametrar

project: string

Projekt-ID eller projektnamn

path: string

Sökväg till mappen som ska tas bort.

Returer

Promise<void>

deleteRelease(string, number, string)

Mjuk borttagning av en version

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

ID för versionen.

comment: string

Kommentar för att ta bort en version.

Returer

Promise<void>

deleteReleaseDefinition(string, number, string, boolean)

Ta bort en versionsdefinition.

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

Parametrar

project: string

Projekt-ID eller projektnamn

definitionId: number

ID för versionsdefinitionen.

comment: string

Kommentar för att ta bort en versionsdefinition.

forceDelete: boolean

"true" för att automatiskt avbryta pågående versionsdistributioner och fortsätta med borttagningen av versionsdefinitionen. Standardvärdet är "false".

Returer

Promise<void>

deleteReleaseTag(string, number, string)

Tar bort en tagg från en version

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

tag: string

Returer

Promise<string[]>

getAgentArtifactDefinitions(string, number)

Returnerar artefaktinformationen som automationsagenten kräver

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

Returer

Promise<AgentArtifactDefinition[]>

getApproval(string, number, boolean)

Få ett godkännande.

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

Parametrar

project: string

Projekt-ID eller projektnamn

approvalId: number

Id för godkännandet.

includeHistory: boolean

"sant" för att inkludera godkännandets historik. Standardvärdet är "false".

Returer

Promise<ReleaseApproval>

getApprovalHistory(string, number)

Hämta godkännandehistorik.

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

Parametrar

project: string

Projekt-ID eller projektnamn

approvalStepId: number

Id för godkännandet.

Returer

Promise<ReleaseApproval>

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

Hämta en lista över godkännanden

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

Parametrar

project: string

Projekt-ID eller projektnamn

assignedToFilter: string

Godkännanden som tilldelats den här användaren.

statusFilter: ApprovalStatus

Godkännanden med den här statusen. Standardvärdet är "väntar".

releaseIdsFilter: number[]

Godkännanden för versions-ID:t som anges i filtret. Flera versioner kan nämnas genom att separera dem med "", t.ex. releaseIdsFilter=1,2,3,4.

typeFilter: ApprovalType

Godkännande med den här typen.

top: number

Antal godkännanden att få. Standardvärdet är 50.

continuationToken: number

Hämtar godkännanden efter den angivna fortsättningstoken.

queryOrder: ReleaseQueryOrder

Hämtar resultaten i den definierade ordningen för skapade godkännanden. Standardvärdet är "fallande".

includeMyGroupApprovals: boolean

"sant" för att inkludera mina gruppgodkännanden. Standardvärdet är "false".

Returer

Promise<PagedList<ReleaseApproval>>

getArtifactTypeDefinitions(string)

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

Parametrar

project: string

Projekt-ID eller projektnamn

Returer

Promise<ArtifactTypeDefinition[]>

getArtifactVersions(string, number)

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseDefinitionId: number

Returer

Promise<ArtifactVersionQueryResult>

getArtifactVersionsForSources(Artifact[], string)

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

Parametrar

artifacts: Artifact[]

project: string

Projekt-ID eller projektnamn

Returer

Promise<ArtifactVersionQueryResult>

getAutoTriggerIssues(string, string, string, string)

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

Parametrar

artifactType: string

sourceId: string

artifactVersionId: string

project: string

Projekt-ID eller projektnamn

Returer

Promise<AutoTriggerIssue[]>

getDefinitionEnvironments(string, string, string[])

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

Parametrar

project: string

Projekt-ID eller projektnamn

taskGroupId: string

propertyFilters: string[]

Returer

Promise<DefinitionEnvironmentReference[]>

getDefinitionEnvironmentTemplate(string, string)

Hämtar en definitionsmiljömall

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

Parametrar

project: string

Projekt-ID eller projektnamn

templateId: string

ID för definitionsmiljömallen

Returer

Promise<ReleaseDefinitionEnvironmentTemplate>

getDefinitionRevision(string, number, number)

Hämta versionsdefinition för ett angivet definitions-ID och en revision

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

Parametrar

project: string

Projekt-ID eller projektnamn

definitionId: number

ID för definitionen.

revision: number

ID för revisionen.

Returer

Promise<string>

getDefinitionTags(string, number)

Hämtar taggarna för en definition

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseDefinitionId: number

Returer

Promise<string[]>

getDeploymentBadge(string, number, number, string)

Hämtar ett märke som anger status för den senaste distributionen för en miljö.

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

Parametrar

projectId: string

ID för projektet.

releaseDefinitionId: number

ID för versionsdefinitionen.

environmentId: number

ID för miljön.

branchName: string

Namnet på grenen.

Returer

Promise<string>

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

Hämta en lista över distributioner

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

Parametrar

project: string

Projekt-ID eller projektnamn

definitionId: number

Visa en lista över distributioner för ett visst definitions-ID.

definitionEnvironmentId: number

Lista distributionerna för ett visst definitionsmiljö-ID.

createdBy: string

Lista de distributioner som distributioner skapas för som den angivna identiteten.

minModifiedTime: Date

Lista distributionerna med LastModified time >= minModifiedTime.

maxModifiedTime: Date

Lista distributionerna med LastModified time <= maxModifiedTime.

deploymentStatus: DeploymentStatus

Lista distributionerna med angiven distributionsstatus. Standardvärdet är "Alla".

operationStatus: DeploymentOperationStatus

Lista distributionerna med angiven åtgärdsstatus. Standardvärdet är "Alla".

latestAttemptsOnly: boolean

"true" för att inkludera distributioner med endast det senaste försöket. Standardvärdet är "false".

queryOrder: ReleaseQueryOrder

Lista distributionerna med angiven frågeordning. Standardvärdet är "Fallande".

top: number

Lista distributionerna med angiven överkant. Standardtopen är "50" och Max top är "100".

continuationToken: number

Lista distributionerna med distributions-ID >= continuationToken.

createdFor: string

Lista de distributioner som distributioner begärs för som angiven identitet.

minStartedTime: Date

Lista distributionerna med StartedOn-tid >= minStartedTime.

maxStartedTime: Date

Lista distributionerna med StartedOn-tid <= maxStartedTime.

sourceBranch: string

Lista de distributioner som distribueras från det angivna grennamnet.

Returer

Promise<PagedList<Deployment>>

getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)

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

Parametrar

queryParameters: DeploymentQueryParameters

project: string

Projekt-ID eller projektnamn

Returer

Promise<Deployment[]>

getFavorites(string, string, string)

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

Parametrar

project: string

Projekt-ID eller projektnamn

scope: string

identityId: string

Returer

Promise<FavoriteItem[]>

getFlightAssignments(string)

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

Parametrar

flightName: string

Returer

Promise<string[]>

getFolders(string, string, FolderPathQueryOrder)

Hämtar mappar.

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

Parametrar

project: string

Projekt-ID eller projektnamn

path: string

Sökväg till mappen.

queryOrder: FolderPathQueryOrder

Hämtar resultaten i den definierade ordningen. Standardvärdet är "Ingen".

Returer

Promise<Folder[]>

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

Hämtar portloggar

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

ID för versionen.

environmentId: number

ID för versionsmiljön.

gateId: number

Id för grinden.

taskId: number

ReleaseTask-ID för loggen.

Returer

Promise<string>

getInputValues(InputValuesQuery, string)

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

Parametrar

query: InputValuesQuery

project: string

Projekt-ID eller projektnamn

Returer

Promise<InputValuesQuery>

getIssues(string, number, string)

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

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

sourceId: string

Returer

Promise<AutoTriggerIssue[]>

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

Hämtar loggar

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

ID för versionen.

environmentId: number

ID för versionsmiljön.

taskId: number

ReleaseTask-ID för loggen.

attemptId: number

ID för försöket.

Returer

Promise<string>

getLogs(string, number)

Hämta loggar för ett versions-ID.

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

ID för versionen.

Returer

Promise<ArrayBuffer>

getManualIntervention(string, number, number)

Hämta manuella åtgärder för en viss version och ett manuellt åtgärds-ID.

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

ID för versionen.

manualInterventionId: number

ID för manuell åtgärd.

Returer

Promise<ManualIntervention>

getManualInterventions(string, number)

Lista alla manuella åtgärder för en viss version.

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

ID för versionen.

Returer

Promise<ManualIntervention[]>

getMetrics(string, Date)

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

Parametrar

project: string

Projekt-ID eller projektnamn

minMetricsTime: Date

Returer

Promise<Metric[]>

getOrgPipelineReleaseSettings()

Hämtar versionsinställningar för organisationspipeline

function getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>

Returer

Promise<OrgPipelineReleaseSettings>

getPipelineReleaseSettings(string)

Hämtar versionsinställningar för pipeline

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

Parametrar

project: string

Projekt-ID eller projektnamn

Returer

Promise<ProjectPipelineReleaseSettings>

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

Hämta en version

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

ID för versionen.

approvalFilters: ApprovalFilters

Ett filter som gör det möjligt att hämta godkännandesteg selektivt baserat på om det är automatiserat eller manuellt. Detta avgör också om vi ska hämta ögonblicksbilder före och efter godkännande. Förutsätter alla som standard

propertyFilters: string[]

En kommaavgränsad lista över utökade egenskaper som ska hämtas. Om det anges innehåller den returnerade versionen värden för de angivna egenskaps-ID:erna (om de finns). Om inte anges inkluderas inte egenskaper.

expand: SingleReleaseExpands

En egenskap som ska expanderas i versionen.

topGateRecords: number

Antal versionsgrindsposter som ska hämtas. Standardvärdet är 5.

Returer

Promise<Release>

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

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

baseReleaseId: number

top: number

artifactAlias: string

Returer

Promise<Change[]>

getReleaseDefinition(string, number, string[])

Hämta en versionsdefinition.

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

Parametrar

project: string

Projekt-ID eller projektnamn

definitionId: number

ID för versionsdefinitionen.

propertyFilters: string[]

En kommaavgränsad lista över utökade egenskaper som ska hämtas. Om det anges innehåller den returnerade versionsdefinitionen värden för de angivna egenskaps-ID:erna (om de finns). Om inte anges inkluderas inte egenskaper.

Returer

Promise<ReleaseDefinition>

getReleaseDefinitionHistory(string, number)

Hämta revisionshistorik för en versionsdefinition

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

Parametrar

project: string

Projekt-ID eller projektnamn

definitionId: number

ID för definitionen.

Returer

Promise<ReleaseDefinitionRevision[]>

getReleaseDefinitionRevision(string, number, number)

Hämta versionsdefinitionen för en viss revision.

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

Parametrar

project: string

Projekt-ID eller projektnamn

definitionId: number

ID för versionsdefinitionen.

revision: number

Versionsdefinitionens revisionsnummer.

Returer

Promise<string>

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

Hämta en lista över versionsdefinitioner.

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

Parametrar

project: string

Projekt-ID eller projektnamn

searchText: string

Hämta versionsdefinitioner med namn som innehåller searchText.

expand: ReleaseDefinitionExpands

De egenskaper som ska utökas i listan över versionsdefinitioner.

artifactType: string

Versionsdefinitioner med angiven artifactType returneras. Värdena kan vara Build, Jenkins, GitHub, Nuget, Team Build (extern), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.

artifactSourceId: string

Versionsdefinitioner med angivet artifactSourceId returneras. T.ex. För bygget skulle det vara {projectGuid}:{BuildDefinitionId}, för Jenkins skulle det vara {JenkinsConnectionId}:{JenkinsDefinitionId}, för TfsOnPrem skulle det vara {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. För artefakter från tredje part, t.ex. TeamCity, BitBucket, kan du referera till "uniqueSourceIdentifier" i vss-extension.json på https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.

top: number

Antal versionsdefinitioner som ska hämtas.

continuationToken: string

Hämtar versionsdefinitionerna efter den angivna fortsättningstoken.

queryOrder: ReleaseDefinitionQueryOrder

Hämtar resultaten i den definierade ordningen. Standardvärdet är "IdAscending".

path: string

Hämtar versionsdefinitionerna under den angivna sökvägen.

isExactNameMatch: boolean

"true" för att hämta versionsdefinitionerna med exakt matchning enligt vad som anges i searchText. Standardvärdet är "false".

tagFilter: string[]

En kommaavgränsad lista över taggar. Endast versionsdefinitioner med dessa taggar returneras.

propertyFilters: string[]

En kommaavgränsad lista över utökade egenskaper som ska hämtas. Om det anges innehåller de returnerade versionsdefinitionerna värden för de angivna egenskaps-ID:na (om de finns). Om det inte anges inkluderas inte egenskaper. Observera att detta inte filtrerar bort någon versionsdefinition från resultat oavsett om egenskapen har angetts eller inte.

definitionIdFilter: string[]

En kommaavgränsad lista över versionsdefinitioner som ska hämtas.

isDeleted: boolean

"true" för att hämta versionsdefinitioner som har tagits bort. Standardvärdet är "false"

searchTextContainsFolderName: boolean

"true" för att hämta versionsdefinitionerna under mappen med namnet som anges i searchText. Standardvärdet är "false".

Returer

Promise<PagedList<ReleaseDefinition>>

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

Hämta en versionssammanfattning av ett visst definitions-ID.

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

Parametrar

project: string

Projekt-ID eller projektnamn

definitionId: number

ID för definitionen för att hämta versionssammanfattningen.

releaseCount: number

Antal versioner som ska ingå i sammanfattningen.

includeArtifact: boolean

Inkludera artefaktinformation. Standardvärdet är "false".

definitionEnvironmentIdsFilter: number[]

Returer

Promise<ReleaseDefinitionSummary>

getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)

Hämta en versionsmiljö.

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

ID för versionen.

environmentId: number

ID för versionsmiljön.

expand: ReleaseEnvironmentExpands

En egenskap som ska utökas i miljön.

Returer

Promise<ReleaseEnvironment>

getReleaseHistory(string, number)

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

Returer

Promise<ReleaseRevision[]>

getReleaseProjects(string, string)

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

Parametrar

artifactType: string

artifactSourceId: string

Returer

Promise<ProjectReference[]>

getReleaseRevision(string, number, number)

Hämta version för ett angivet revisionsnummer.

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

ID för versionen.

definitionSnapshotRevision: number

Revisionsnummer för definitionsögonblicksbild.

Returer

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)

Hämta en lista över versioner

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

Parametrar

project: string

Projekt-ID eller projektnamn

definitionId: number

Versioner från det här versionsdefinitions-ID:t.

definitionEnvironmentId: number

searchText: string

Versioner med namn som innehåller searchText.

createdBy: string

Versioner som skapats av den här användaren.

statusFilter: ReleaseStatus

Versioner som har den här statusen.

environmentStatusFilter: number

minCreatedTime: Date

Versioner som skapades efter den här tiden.

maxCreatedTime: Date

Versioner som skapades före den här tiden.

queryOrder: ReleaseQueryOrder

Hämtar resultaten i den definierade ordningen för det skapade datumet för lanseringar. Standardvärdet är fallande.

top: number

Antal versioner som ska hämtas. Standardvärdet är 50.

continuationToken: number

Hämtar versionerna efter den angivna fortsättningstoken.

expand: ReleaseExpands

Den egenskap som ska expanderas i listan över versioner.

artifactTypeId: string

Versioner med angivet artifactTypeId returneras. Värdena kan vara Build, Jenkins, GitHub, Nuget, Team Build (extern), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.

sourceId: string

Unik identifierare för artefakten som används. T.ex. För bygget skulle det vara {projectGuid}:{BuildDefinitionId}, för Jenkins skulle det vara {JenkinsConnectionId}:{JenkinsDefinitionId}, för TfsOnPrem skulle det vara {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. För artefakter från tredje part, t.ex. TeamCity, BitBucket, kan du referera till "uniqueSourceIdentifier" i vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.

artifactVersionId: string

Versioner med angivet artifactVersionId returneras. Om det till exempel gäller Build artifactType är det buildId.

sourceBranchFilter: string

Versioner med angivet sourceBranchFilter returneras.

isDeleted: boolean

Hämtar de mjukt borttagna versionerna, om det är sant.

tagFilter: string[]

En kommaavgränsad lista över taggar. Endast versioner med dessa taggar returneras.

propertyFilters: string[]

En kommaavgränsad lista över utökade egenskaper som ska hämtas. Om det anges innehåller de returnerade versionerna värden för de angivna egenskaps-ID:na (om de finns). Om det inte anges inkluderas inte egenskaper. Observera att detta inte filtrerar bort någon version från resultat oavsett om egenskapen har angetts eller inte.

releaseIdFilter: number[]

En kommaavgränsad lista över lanserings-ID:t. Endast versioner med dessa ID:t returneras.

path: string

Versioner under den här mappsökvägen returneras

Returer

Promise<PagedList<Release>>

getReleaseSettings(string)

Hämtar versionsinställningarna

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

Parametrar

project: string

Projekt-ID eller projektnamn

Returer

Promise<ReleaseSettings>

getReleaseTags(string, number)

Hämtar taggarna för en version

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

Returer

Promise<string[]>

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

Hämta en bifogad versionsuppgift.

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

ID för versionen.

environmentId: number

ID för versionsmiljön.

attemptId: number

Försök till antal distributioner.

planId: string

Plan-ID för distributionsfasen.

timelineId: string

Tidslinje-ID för uppgiften.

recordId: string

Post-ID för bifogad fil.

type: string

Typ av bifogad fil.

name: string

Namnet på den bifogade filen.

Returer

Promise<ArrayBuffer>

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

Hämta de bifogade filerna för versionsaktiviteten.

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

ID för versionen.

environmentId: number

ID för versionsmiljön.

attemptId: number

Försök till antal distributioner.

planId: string

Plan-ID för distributionsfasen.

type: string

Typ av bifogad fil.

Returer

Promise<ReleaseTaskAttachment[]>

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

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

baseReleaseId: number

top: number

artifactAlias: string

Returer

Promise<ReleaseWorkItemRef[]>

getSourceBranches(string, number)

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

Parametrar

project: string

Projekt-ID eller projektnamn

definitionId: number

Returer

Promise<string[]>

getSummaryMailSections(string, number)

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

Returer

Promise<SummaryMailSection[]>

getTags(string)

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

Parametrar

project: string

Projekt-ID eller projektnamn

Returer

Promise<string[]>

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

Hämta en bifogad uppgift.

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

ID för versionen.

environmentId: number

ID för versionsmiljön.

attemptId: number

Försök till antal distributioner.

timelineId: string

Tidslinje-ID för uppgiften.

recordId: string

Post-ID för bifogad fil.

type: string

Typ av bifogad fil.

name: string

Namnet på den bifogade filen.

Returer

Promise<ArrayBuffer>

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

Hämta aktivitetsbilagorna.

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

ID för versionen.

environmentId: number

ID för versionsmiljön.

attemptId: number

Försök till antal distributioner.

timelineId: string

Tidslinje-ID för uppgiften.

type: string

Typ av bifogad fil.

Returer

Promise<ReleaseTaskAttachment[]>

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

Hämtar aktivitetsloggen för en version som en oformaterad textfil.

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

ID för versionen.

environmentId: number

ID för versionsmiljön.

releaseDeployPhaseId: number

Versionsdistributionsfas-ID.

taskId: number

ReleaseTask-ID för loggen.

startLine: number

Startradsnummer för loggar

endLine: number

Slutradsnummer för loggar

Returer

Promise<string>

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

Hämtar aktivitetsloggen för en version som en oformaterad textfil.

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

ID för versionen.

environmentId: number

ID för versionsmiljön.

attemptId: number

timelineId: string

taskId: number

ReleaseTask-ID för loggen.

startLine: number

Startradsnummer för loggar

endLine: number

Slutradsnummer för loggar

Returer

Promise<string>

getTasks(string, number, number, number)

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

environmentId: number

attemptId: number

Returer

Promise<ReleaseTask[]>

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

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

environmentId: number

attemptId: number

timelineId: string

Returer

Promise<ReleaseTask[]>

getTasksForTaskGroup(string, number, number, number)

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

environmentId: number

releaseDeployPhaseId: number

Returer

Promise<ReleaseTask[]>

listDefinitionEnvironmentTemplates(string, boolean)

Hämtar en lista över definitionsmiljömallar

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

Parametrar

project: string

Projekt-ID eller projektnamn

isDeleted: boolean

"true" för att hämta definitionsmiljömallar som har tagits bort. Standardvärdet är "falskt"

Returer

Promise<ReleaseDefinitionEnvironmentTemplate[]>

sendSummaryMail(MailMessage, string, number)

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

Parametrar

mailMessage: MailMessage

project: string

Projekt-ID eller projektnamn

releaseId: number

Returer

Promise<void>

undeleteRelease(string, number, string)

Ta bort en mjuk borttagen version.

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

ID för den version som ska tas bort.

comment: string

Eventuella kommentarer för att ta bort.

Returer

Promise<void>

undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)

Ta bort en versionsdefinition.

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

Parametrar

releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter

Objekt för att ta bort versionsdefinitionen.

project: string

Projekt-ID eller projektnamn

definitionId: number

ID för versionsdefinitionen som ska tas bort

Returer

Promise<ReleaseDefinition>

undeleteReleaseDefinitionEnvironmentTemplate(string, string)

Ta bort en miljömall för versionsdefinitioner.

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

Parametrar

project: string

Projekt-ID eller projektnamn

templateId: string

ID för definitionsmiljömallen som ska tas bort

Returer

Promise<ReleaseDefinitionEnvironmentTemplate>

updateFolder(Folder, string, string)

Uppdateringar en befintlig mapp på angiven befintlig sökväg.

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

Parametrar

folder: Folder

Mappen.

project: string

Projekt-ID eller projektnamn

path: string

Sökväg till mappen som ska uppdateras.

Returer

Promise<Folder>

updateGates(GateUpdateMetadata, string, number)

Uppdateringar porten för en distribution.

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

Parametrar

gateUpdateMetadata: GateUpdateMetadata

Metadata för att korrigera Versionsgrindarna.

project: string

Projekt-ID eller projektnamn

gateStepId: number

Gate steg ID.

Returer

Promise<ReleaseGates>

updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)

Uppdatera manuella åtgärder.

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

Parametrar

manualInterventionUpdateMetadata: ManualInterventionUpdateMetadata

Metadata för att uppdatera manuella åtgärder.

project: string

Projekt-ID eller projektnamn

releaseId: number

ID för versionen.

manualInterventionId: number

ID för manuell åtgärd.

Returer

Promise<ManualIntervention>

updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)

versionsinställningar för Uppdateringar organisationspipeline

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

Parametrar

newSettings: OrgPipelineReleaseSettingsUpdateParameters

Returer

Promise<OrgPipelineReleaseSettings>

updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)

versionsinställningar för Uppdateringar pipeline

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

Parametrar

newSettings: ProjectPipelineReleaseSettingsUpdateParameters

project: string

Projekt-ID eller projektnamn

Returer

Promise<ProjectPipelineReleaseSettings>

updateRelease(Release, string, number)

Uppdatera ett fullständigt versionsobjekt.

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

Parametrar

release: Release

Versionsobjekt för uppdatering.

project: string

Projekt-ID eller projektnamn

releaseId: number

ID för versionen som ska uppdateras.

Returer

Promise<Release>

updateReleaseApproval(ReleaseApproval, string, number)

Uppdatera status för ett godkännande

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

Parametrar

approval: ReleaseApproval

ReleaseApproval-objekt med status, godkännare och kommentarer.

project: string

Projekt-ID eller projektnamn

approvalId: number

Id för godkännandet.

Returer

Promise<ReleaseApproval>

updateReleaseApprovals(ReleaseApproval[], string)

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

Parametrar

approvals: ReleaseApproval[]

project: string

Projekt-ID eller projektnamn

Returer

Promise<ReleaseApproval[]>

updateReleaseDefinition(ReleaseDefinition, string)

Uppdatera en versionsdefinition.

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

Parametrar

releaseDefinition: ReleaseDefinition

Versionsdefinitionsobjekt som ska uppdateras.

project: string

Projekt-ID eller projektnamn

Returer

Promise<ReleaseDefinition>

updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)

Uppdatera status för en versionsmiljö

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

Parametrar

environmentUpdateData: ReleaseEnvironmentUpdateMetadata

Uppdatera metadata för miljön.

project: string

Projekt-ID eller projektnamn

releaseId: number

ID för versionen.

environmentId: number

ID för versionsmiljön.

Returer

Promise<ReleaseEnvironment>

updateReleaseResource(ReleaseUpdateMetadata, string, number)

Uppdatera några egenskaper för en version.

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

Parametrar

releaseUpdateMetadata: ReleaseUpdateMetadata

Egenskaper för den version som ska uppdateras.

project: string

Projekt-ID eller projektnamn

releaseId: number

ID för versionen som ska uppdateras.

Returer

Promise<Release>

updateReleaseSettings(ReleaseSettings, string)

Uppdateringar versionsinställningarna

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

Parametrar

releaseSettings: ReleaseSettings

project: string

Projekt-ID eller projektnamn

Returer

Promise<ReleaseSettings>

Dela via

ReleaseRestClient class

Konstruktorer

Egenskaper

Metoder

Konstruktorinformation

ReleaseRestClient(IVssRestClientOptions)

Parametrar

Egenskapsinformation

RESOURCE_AREA_ID

Egenskapsvärde

Metodinformation

addDefinitionTag(string, number, string)

Parametrar

Returer

addDefinitionTags(string[], string, number)

Parametrar

Returer

addReleaseTag(string, number, string)

Parametrar

Returer

addReleaseTags(string[], string, number)

Parametrar

Returer

createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)

Parametrar

Returer

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

Parametrar

Returer

createFolder(Folder, string, string)

Parametrar

Returer

createRelease(ReleaseStartMetadata, string)

Parametrar

Returer

createReleaseDefinition(ReleaseDefinition, string)

Parametrar

Returer

deleteDefinitionEnvironmentTemplate(string, string)

Parametrar

Returer

deleteDefinitionTag(string, number, string)

Parametrar

Returer

deleteFavorites(string, string, string, string)

Parametrar

Returer

deleteFolder(string, string)

Parametrar

Returer

deleteRelease(string, number, string)

Parametrar

Returer

deleteReleaseDefinition(string, number, string, boolean)

Parametrar

Returer

deleteReleaseTag(string, number, string)

Parametrar

Returer

getAgentArtifactDefinitions(string, number)

Parametrar

Returer

getApproval(string, number, boolean)

Parametrar

Returer

getApprovalHistory(string, number)

Parametrar

Returer

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

Parametrar

Returer

getArtifactTypeDefinitions(string)

Parametrar

Returer

getArtifactVersions(string, number)

Parametrar

Returer

getArtifactVersionsForSources(Artifact[], string)

Parametrar