Share via


ReleaseRestClient class

Basisklasse, die zum Senden von Anforderungen an VSS-REST-APIs verwendet werden soll (abgeleitet von).

Extends

Konstruktoren

ReleaseRestClient(IVssRestClientOptions)

Eigenschaften

RESOURCE_AREA_ID

Methoden

addDefinitionTag(string, number, string)

Fügt einer Definition ein Tag hinzu.

addDefinitionTags(string[], string, number)

Fügt einer Definition mehrere Tags hinzu.

addReleaseTag(string, number, string)

Fügt einer releaseId ein Tag hinzu.

addReleaseTags(string[], string, number)

Fügt einem Release tag hinzu

createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)

Erstellt eine Definitionsumgebungsvorlage.

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

Erstellt einen neuen Ordner.

createRelease(ReleaseStartMetadata, string)

Erstellen Sie ein Release.

createReleaseDefinition(ReleaseDefinition, string)

Erstellen einer Releasedefinition

deleteDefinitionEnvironmentTemplate(string, string)

Löschen einer Definitionsumgebungsvorlage

deleteDefinitionTag(string, number, string)

Löscht ein Tag aus einer Definition.

deleteFavorites(string, string, string, string)
deleteFolder(string, string)

Löscht einen Definitionsordner für den angegebenen Ordnernamen und Pfad sowie alle vorhandenen Definitionen.

deleteRelease(string, number, string)

Vorläufiges Löschen einer Version

deleteReleaseDefinition(string, number, string, boolean)

Löschen Sie eine Releasedefinition.

deleteReleaseTag(string, number, string)

Löscht ein Tag aus einem Release.

getAgentArtifactDefinitions(string, number)

Gibt die Artefaktdetails zurück, die für den Automatisierungs-Agent erforderlich sind.

getApproval(string, number, boolean)

Erhalten Sie eine Genehmigung.

getApprovalHistory(string, number)

Abrufen des Genehmigungsverlaufs.

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

Abrufen einer Liste der Genehmigungen

getArtifactTypeDefinitions(string)
getArtifactVersions(string, number)
getArtifactVersionsForSources(Artifact[], string)
getAutoTriggerIssues(string, string, string, string)
getDefinitionEnvironments(string, string, string[])
getDefinitionEnvironmentTemplate(string, string)

Ruft eine Definitionsumgebungsvorlage ab.

getDefinitionRevision(string, number, number)

Abrufen der Releasedefinition für eine bestimmte definitionId und Revision

getDefinitionTags(string, number)

Ruft die Tags für eine Definition ab.

getDeploymentBadge(string, number, number, string)

Ruft einen Badge ab, der die status der letzten Bereitstellung für eine Umgebung angibt.

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

Abrufen einer Liste der Bereitstellungen

getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)
getFavorites(string, string, string)
getFlightAssignments(string)
getFolders(string, string, FolderPathQueryOrder)

Ruft Ordner ab.

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

Ruft Gate-Protokolle ab.

getInputValues(InputValuesQuery, string)
getIssues(string, number, string)
getLog(string, number, number, number, number)

Ruft Protokolle ab.

getLogs(string, number)

Ruft Protokolle für eine Release-ID ab.

getManualIntervention(string, number, number)

Rufen Sie einen manuellen Eingriff für eine bestimmte Release- und manuelle Eingriffs-ID ab.

getManualInterventions(string, number)

Listet alle manuellen Eingriffe für eine bestimmte Version auf.

getMetrics(string, Date)
getOrgPipelineReleaseSettings()

Ruft Die Releaseeinstellungen der Organisationspipeline ab.

getPipelineReleaseSettings(string)

Ruft Pipeline-Releaseeinstellungen ab.

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

Abrufen eines Release

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

Rufen Sie eine Releasedefinition ab.

getReleaseDefinitionHistory(string, number)

Abrufen des Revisionsverlaufs für eine Releasedefinition

getReleaseDefinitionRevision(string, number, number)

Rufen Sie die Releasedefinition einer bestimmten Revision ab.

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

Rufen Sie eine Liste der Releasedefinitionen ab.

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

Abrufen der Releasezusammenfassung einer angegebenen Definitions-ID.

getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)

Rufen Sie eine Releaseumgebung ab.

getReleaseHistory(string, number)
getReleaseProjects(string, string)
getReleaseRevision(string, number, number)

Rufen Sie die Freigabe für eine bestimmte Revisionsnummer ab.

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

Abrufen einer Liste der Releases

getReleaseSettings(string)

Ruft die Releaseeinstellungen ab.

getReleaseTags(string, number)

Ruft die Tags für ein Release ab.

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

Ruft eine Releasetaskanlage ab.

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

Rufen Sie die Releasetaskanlagen ab.

getReleaseWorkItemsRefs(string, number, number, number, string)
getSourceBranches(string, number)
getSummaryMailSections(string, number)
getTags(string)
getTaskAttachmentContent(string, number, number, number, string, string, string, string)

Ruft eine Aufgabenanlage ab.

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

Rufen Sie die Aufgabenanlagen ab.

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

Ruft das Aufgabenprotokoll einer Version als reine Textdatei ab.

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

Ruft das Aufgabenprotokoll einer Version als reine Textdatei ab.

getTasks(string, number, number, number)
getTasks2(string, number, number, number, string)
getTasksForTaskGroup(string, number, number, number)
listDefinitionEnvironmentTemplates(string, boolean)

Ruft eine Liste von Definitionsumgebungsvorlagen ab.

sendSummaryMail(MailMessage, string, number)
undeleteRelease(string, number, string)

Wiederherstellen eines vorläufig gelöschten Release.

undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)

Wiederherstellen einer Releasedefinition

undeleteReleaseDefinitionEnvironmentTemplate(string, string)

Wiederherstellen einer Umgebungsvorlage für eine Releasedefinition

updateFolder(Folder, string, string)

Updates einen vorhandenen Ordner unter einem bestimmten vorhandenen Pfad.

updateGates(GateUpdateMetadata, string, number)

Updates das Gate für eine Bereitstellung.

updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)

Aktualisieren Sie den manuellen Eingriff.

updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)

Versionseinstellungen für Updates Org-Pipeline

updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)

Updates Einstellungen für Pipelinefreigaben

updateRelease(Release, string, number)

Aktualisieren Sie ein vollständiges Releaseobjekt.

updateReleaseApproval(ReleaseApproval, string, number)

Aktualisieren status einer Genehmigung

updateReleaseApprovals(ReleaseApproval[], string)
updateReleaseDefinition(ReleaseDefinition, string)

Aktualisieren Sie eine Releasedefinition.

updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)

Aktualisieren des status einer Releaseumgebung

updateReleaseResource(ReleaseUpdateMetadata, string, number)

Aktualisieren Sie einige Eigenschaften einer Version.

updateReleaseSettings(ReleaseSettings, string)

Updates der Releaseeinstellungen

Details zum Konstruktor

ReleaseRestClient(IVssRestClientOptions)

new ReleaseRestClient(options: IVssRestClientOptions)

Parameter

Details zur Eigenschaft

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Eigenschaftswert

string

Details zur Methode

addDefinitionTag(string, number, string)

Fügt einer Definition ein Tag hinzu.

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

Parameter

project

string

Projekt-ID oder Projektname

releaseDefinitionId

number

tag

string

Gibt zurück

Promise<string[]>

addDefinitionTags(string[], string, number)

Fügt einer Definition mehrere Tags hinzu.

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

Parameter

tags

string[]

project

string

Projekt-ID oder Projektname

releaseDefinitionId

number

Gibt zurück

Promise<string[]>

addReleaseTag(string, number, string)

Fügt einer releaseId ein Tag hinzu.

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

tag

string

Gibt zurück

Promise<string[]>

addReleaseTags(string[], string, number)

Fügt einem Release tag hinzu

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

Parameter

tags

string[]

project

string

Projekt-ID oder Projektname

releaseId

number

Gibt zurück

Promise<string[]>

createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)

Erstellt eine Definitionsumgebungsvorlage.

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

Parameter

template
ReleaseDefinitionEnvironmentTemplate

Zu erstellende Definitionsumgebungsvorlage

project

string

Projekt-ID oder Projektname

Gibt zurück

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

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

Parameter

favoriteItems

FavoriteItem[]

project

string

Projekt-ID oder Projektname

scope

string

identityId

string

Gibt zurück

Promise<FavoriteItem[]>

createFolder(Folder, string, string)

Erstellt einen neuen Ordner.

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

Parameter

folder
Folder

.

project

string

Projekt-ID oder Projektname

path

string

Pfad des Ordners.

Gibt zurück

Promise<Folder>

createRelease(ReleaseStartMetadata, string)

Erstellen Sie ein Release.

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

Parameter

releaseStartMetadata
ReleaseStartMetadata

Metadaten zum Erstellen eines Release.

project

string

Projekt-ID oder Projektname

Gibt zurück

Promise<Release>

createReleaseDefinition(ReleaseDefinition, string)

Erstellen einer Releasedefinition

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

Parameter

releaseDefinition
ReleaseDefinition

Zu erstellende Releasedefinitionsobjekt.

project

string

Projekt-ID oder Projektname

Gibt zurück

deleteDefinitionEnvironmentTemplate(string, string)

Löschen einer Definitionsumgebungsvorlage

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

Parameter

project

string

Projekt-ID oder Projektname

templateId

string

ID der Definitionsumgebungsvorlage

Gibt zurück

Promise<void>

deleteDefinitionTag(string, number, string)

Löscht ein Tag aus einer Definition.

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

Parameter

project

string

Projekt-ID oder Projektname

releaseDefinitionId

number

tag

string

Gibt zurück

Promise<string[]>

deleteFavorites(string, string, string, string)

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

Parameter

project

string

Projekt-ID oder Projektname

scope

string

identityId

string

favoriteItemIds

string

Gibt zurück

Promise<void>

deleteFolder(string, string)

Löscht einen Definitionsordner für den angegebenen Ordnernamen und Pfad sowie alle vorhandenen Definitionen.

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

Parameter

project

string

Projekt-ID oder Projektname

path

string

Pfad des zu löschenden Ordners.

Gibt zurück

Promise<void>

deleteRelease(string, number, string)

Vorläufiges Löschen einer Version

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

ID des Release.

comment

string

Kommentar zum Löschen eines Release.

Gibt zurück

Promise<void>

deleteReleaseDefinition(string, number, string, boolean)

Löschen Sie eine Releasedefinition.

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

Parameter

project

string

Projekt-ID oder Projektname

definitionId

number

ID der Releasedefinition.

comment

string

Kommentar zum Löschen einer Releasedefinition.

forceDelete

boolean

"true", um alle laufenden Releasebereitstellungen automatisch abzubrechen und mit dem Löschen der Releasedefinition fortzufahren. Der Standardwert ist "false".

Gibt zurück

Promise<void>

deleteReleaseTag(string, number, string)

Löscht ein Tag aus einem Release.

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

tag

string

Gibt zurück

Promise<string[]>

getAgentArtifactDefinitions(string, number)

Gibt die Artefaktdetails zurück, die für den Automatisierungs-Agent erforderlich sind.

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

Gibt zurück

getApproval(string, number, boolean)

Erhalten Sie eine Genehmigung.

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

Parameter

project

string

Projekt-ID oder Projektname

approvalId

number

ID der Genehmigung.

includeHistory

boolean

"true", um den Verlauf der Genehmigung einzuschließen. Der Standardwert ist "false".

Gibt zurück

Promise<ReleaseApproval>

getApprovalHistory(string, number)

Abrufen des Genehmigungsverlaufs.

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

Parameter

project

string

Projekt-ID oder Projektname

approvalStepId

number

ID der Genehmigung.

Gibt zurück

Promise<ReleaseApproval>

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

Abrufen einer Liste der Genehmigungen

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

Parameter

project

string

Projekt-ID oder Projektname

assignedToFilter

string

Diesem Benutzer zugewiesene Genehmigungen.

statusFilter
ApprovalStatus

Genehmigungen mit diesem status. Der Standardwert ist "ausstehend".

releaseIdsFilter

number[]

Genehmigungen für release-IDs, die im Filter erwähnt werden. Mehrere Releases können erwähnt werden, indem Sie sie durch "," trennen, z. B. releaseIdsFilter=1,2,3,4.

typeFilter
ApprovalType

Genehmigung mit diesem Typ.

top

number

Anzahl der zu erhaltenden Genehmigungen. Standard ist 50.

continuationToken

number

Ruft die Genehmigungen nach dem bereitgestellten Fortsetzungstoken ab.

queryOrder
ReleaseQueryOrder

Ruft die Ergebnisse in der definierten Reihenfolge der erstellten Genehmigungen ab. Der Standardwert ist "absteigend".

includeMyGroupApprovals

boolean

"true", um meine Gruppengenehmigungen einzuschließen. Der Standardwert ist "false".

Gibt zurück

getArtifactTypeDefinitions(string)

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

Parameter

project

string

Projekt-ID oder Projektname

Gibt zurück

getArtifactVersions(string, number)

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

Parameter

project

string

Projekt-ID oder Projektname

releaseDefinitionId

number

Gibt zurück

getArtifactVersionsForSources(Artifact[], string)

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

Parameter

artifacts

Artifact[]

project

string

Projekt-ID oder Projektname

Gibt zurück

getAutoTriggerIssues(string, string, string, string)

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

Parameter

artifactType

string

sourceId

string

artifactVersionId

string

project

string

Projekt-ID oder Projektname

Gibt zurück

Promise<AutoTriggerIssue[]>

getDefinitionEnvironments(string, string, string[])

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

Parameter

project

string

Projekt-ID oder Projektname

taskGroupId

string

propertyFilters

string[]

Gibt zurück

getDefinitionEnvironmentTemplate(string, string)

Ruft eine Definitionsumgebungsvorlage ab.

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

Parameter

project

string

Projekt-ID oder Projektname

templateId

string

ID der Definitionsumgebungsvorlage

Gibt zurück

getDefinitionRevision(string, number, number)

Abrufen der Releasedefinition für eine bestimmte definitionId und Revision

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

Parameter

project

string

Projekt-ID oder Projektname

definitionId

number

ID der Definition.

revision

number

ID der Revision.

Gibt zurück

Promise<string>

getDefinitionTags(string, number)

Ruft die Tags für eine Definition ab.

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

Parameter

project

string

Projekt-ID oder Projektname

releaseDefinitionId

number

Gibt zurück

Promise<string[]>

getDeploymentBadge(string, number, number, string)

Ruft einen Badge ab, der die status der letzten Bereitstellung für eine Umgebung angibt.

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

Parameter

projectId

string

Die ID des Projekts.

releaseDefinitionId

number

Die ID der Releasedefinition.

environmentId

number

Die ID der Umgebung.

branchName

string

Der Name des Branchs.

Gibt zurück

Promise<string>

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

Abrufen einer Liste der Bereitstellungen

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

Parameter

project

string

Projekt-ID oder Projektname

definitionId

number

Listet die Bereitstellungen für eine bestimmte Definitions-ID auf.

definitionEnvironmentId

number

Listen Sie die Bereitstellungen für eine bestimmte Definitionsumgebungs-ID auf.

createdBy

string

Listet die Bereitstellungen auf, für die Bereitstellungen als angegebene Identität erstellt werden.

minModifiedTime

Date

Listen Sie die Bereitstellungen mit LastModified time >= minModifiedTime auf.

maxModifiedTime

Date

Listen Sie die Bereitstellungen mit LastModified time <= maxModifiedTime auf.

deploymentStatus
DeploymentStatus

Listen Sie die Bereitstellungen mit den angegebenen Bereitstellungs-status auf. Der Standardwert ist "All".

operationStatus
DeploymentOperationStatus

Auflisten der Bereitstellungen mit dem angegebenen Vorgang status. Der Standardwert ist "All".

latestAttemptsOnly

boolean

"true", um Bereitstellungen nur mit dem letzten Versuch einzuschließen. Der Standardwert ist "false".

queryOrder
ReleaseQueryOrder

Listen Sie die Bereitstellungen mit der angegebenen Abfragereihenfolge auf. Der Standardwert ist "Absteigend".

top

number

Listen Sie die Bereitstellungen mit dem angegebenen Anfang auf. Der Standardanfang ist "50" und "Max top" ist "100".

continuationToken

number

Listen Sie die Bereitstellungen mit der Bereitstellungs-ID >= continuationToken auf.

createdFor

string

Listet die Bereitstellungen auf, für die Bereitstellungen als identitätsangabe angefordert werden.

minStartedTime

Date

Listen Sie die Bereitstellungen mit StartedOn time >= minStartedTime auf.

maxStartedTime

Date

Listen Sie die Bereitstellungen mit StartedOn time <= maxStartedTime auf.

sourceBranch

string

Listet die Bereitstellungen auf, die über den angegebenen Branchnamen bereitgestellt werden.

Gibt zurück

Promise<PagedList<Deployment>>

getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)

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

Parameter

queryParameters
DeploymentQueryParameters
project

string

Projekt-ID oder Projektname

Gibt zurück

Promise<Deployment[]>

getFavorites(string, string, string)

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

Parameter

project

string

Projekt-ID oder Projektname

scope

string

identityId

string

Gibt zurück

Promise<FavoriteItem[]>

getFlightAssignments(string)

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

Parameter

flightName

string

Gibt zurück

Promise<string[]>

getFolders(string, string, FolderPathQueryOrder)

Ruft Ordner ab.

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

Parameter

project

string

Projekt-ID oder Projektname

path

string

Pfad des Ordners.

queryOrder
FolderPathQueryOrder

Ruft die Ergebnisse in der definierten Reihenfolge ab. Der Standardwert ist "None".

Gibt zurück

Promise<Folder[]>

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

Ruft Gate-Protokolle ab.

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

ID des Release.

environmentId

number

ID der Releaseumgebung.

gateId

number

ID des Gates.

taskId

number

ReleaseTask-ID für das Protokoll.

Gibt zurück

Promise<string>

getInputValues(InputValuesQuery, string)

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

Parameter

project

string

Projekt-ID oder Projektname

Gibt zurück

Promise<InputValuesQuery>

getIssues(string, number, string)

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

Parameter

project

string

Projekt-ID oder Projektname

buildId

number

sourceId

string

Gibt zurück

Promise<AutoTriggerIssue[]>

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

Ruft Protokolle ab.

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

ID des Release.

environmentId

number

ID der Releaseumgebung.

taskId

number

ReleaseTask-ID für das Protokoll.

attemptId

number

ID des Versuchs.

Gibt zurück

Promise<string>

getLogs(string, number)

Ruft Protokolle für eine Release-ID ab.

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

ID des Release.

Gibt zurück

Promise<ArrayBuffer>

getManualIntervention(string, number, number)

Rufen Sie einen manuellen Eingriff für eine bestimmte Release- und manuelle Eingriffs-ID ab.

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

ID des Release.

manualInterventionId

number

ID des manuellen Eingriffs.

Gibt zurück

getManualInterventions(string, number)

Listet alle manuellen Eingriffe für eine bestimmte Version auf.

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

ID des Release.

Gibt zurück

Promise<ManualIntervention[]>

getMetrics(string, Date)

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

Parameter

project

string

Projekt-ID oder Projektname

minMetricsTime

Date

Gibt zurück

Promise<Metric[]>

getOrgPipelineReleaseSettings()

Ruft Die Releaseeinstellungen der Organisationspipeline ab.

function getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>

Gibt zurück

getPipelineReleaseSettings(string)

Ruft Pipeline-Releaseeinstellungen ab.

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

Parameter

project

string

Projekt-ID oder Projektname

Gibt zurück

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

Abrufen eines Release

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

ID des Release.

approvalFilters
ApprovalFilters

Ein Filter, der das selektive Abrufen von Genehmigungsschritten basierend darauf ermöglicht, ob er automatisiert oder manuell erfolgt. Dies würde auch entscheiden, ob wir Momentaufnahmen vor und nach der Genehmigung abrufen sollten. Setzt standardmäßig alle voraus

propertyFilters

string[]

Eine durch Trennzeichen getrennte Liste erweiterter Eigenschaften, die abgerufen werden sollen. Wenn festgelegt, enthält das zurückgegebene Release Werte für die angegebenen Eigenschafts-IDs (sofern vorhanden). Wenn sie nicht festgelegt ist, werden die Eigenschaften nicht eingeschlossen.

expand
SingleReleaseExpands

Eine Eigenschaft, die in der Version erweitert werden soll.

topGateRecords

number

Anzahl der abzurufenden Releasegatedatensätze. Der Standardwert ist 5.

Gibt zurück

Promise<Release>

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

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

baseReleaseId

number

top

number

artifactAlias

string

Gibt zurück

Promise<Change[]>

getReleaseDefinition(string, number, string[])

Rufen Sie eine Releasedefinition ab.

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

Parameter

project

string

Projekt-ID oder Projektname

definitionId

number

ID der Releasedefinition.

propertyFilters

string[]

Eine durch Trennzeichen getrennte Liste erweiterter Eigenschaften, die abgerufen werden sollen. Wenn festgelegt, enthält die zurückgegebene Releasedefinition Werte für die angegebenen Eigenschafts-IDs (sofern vorhanden). Wenn sie nicht festgelegt ist, werden die Eigenschaften nicht eingeschlossen.

Gibt zurück

getReleaseDefinitionHistory(string, number)

Abrufen des Revisionsverlaufs für eine Releasedefinition

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

Parameter

project

string

Projekt-ID oder Projektname

definitionId

number

ID der Definition.

Gibt zurück

getReleaseDefinitionRevision(string, number, number)

Rufen Sie die Releasedefinition einer bestimmten Revision ab.

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

Parameter

project

string

Projekt-ID oder Projektname

definitionId

number

ID der Releasedefinition.

revision

number

Revisionsnummer der Releasedefinition.

Gibt zurück

Promise<string>

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

Rufen Sie eine Liste der Releasedefinitionen ab.

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

Parameter

project

string

Projekt-ID oder Projektname

searchText

string

Abrufen von Releasedefinitionen mit Namen, die searchText enthalten.

expand
ReleaseDefinitionExpands

Die Eigenschaften, die in der Liste der Releasedefinitionen erweitert werden sollen.

artifactType

string

Releasedefinitionen mit dem angegebenen artifactType werden zurückgegeben. Werte können Build, Jenkins, GitHub, Nuget, Team Build (extern), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild sein.

artifactSourceId

string

Releasedefinitionen mit der angegebenen artifactSourceId werden zurückgegeben. Beispiel: Beim Build wäre es {projectGuid}:{BuildDefinitionId}, für Jenkins {JenkinsConnectionId}:{JenkinsDefinitionId}, für TfsOnPremPrem wäre es {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. Für Artefakte von Drittanbietern, z. B. TeamCity, BitBucket, können Sie in vss-extension.json unter https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions"uniqueSourceIdentifier" verweisen.

top

number

Anzahl der abzurufenden Releasedefinitionen.

continuationToken

string

Ruft die Releasedefinitionen nach dem bereitgestellten Fortsetzungstoken ab.

queryOrder
ReleaseDefinitionQueryOrder

Ruft die Ergebnisse in der definierten Reihenfolge ab. Der Standardwert ist "IdAscending".

path

string

Ruft die Releasedefinitionen unter dem angegebenen Pfad ab.

isExactNameMatch

boolean

"true" ruft die Releasedefinitionen mit exakter Übereinstimmung ab, wie in searchText angegeben. Der Standardwert ist "false".

tagFilter

string[]

Eine durch Trennzeichen getrennte Liste von Tags. Es werden nur Releasedefinitionen mit diesen Tags zurückgegeben.

propertyFilters

string[]

Eine durch Trennzeichen getrennte Liste erweiterter Eigenschaften, die abgerufen werden sollen. Wenn festgelegt, enthalten die zurückgegebenen Releasedefinitionen Werte für die angegebenen Eigenschafts-IDs (sofern vorhanden). Wenn sie nicht festgelegt ist, werden die Eigenschaften nicht eingeschlossen. Beachten Sie, dass dadurch keine Releasedefinition aus ergebnissen herausfiltert wird, unabhängig davon, ob die Eigenschaft festgelegt ist oder nicht.

definitionIdFilter

string[]

Eine durch Trennzeichen getrennte Liste der abzurufenden Releasedefinitionen.

isDeleted

boolean

"true", um gelöschte Releasedefinitionen abzurufen. Der Standardwert ist "false".

searchTextContainsFolderName

boolean

"true", um die Releasedefinitionen unter dem Ordner mit dem in searchText angegebenen Namen abzurufen. Der Standardwert ist "false".

Gibt zurück

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

Abrufen der Releasezusammenfassung einer angegebenen Definitions-ID.

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

Parameter

project

string

Projekt-ID oder Projektname

definitionId

number

ID der Definition zum Abrufen der Releasezusammenfassung.

releaseCount

number

Anzahl der Releases, die in die Zusammenfassung aufgenommen werden sollen.

includeArtifact

boolean

Fügen Sie Artefaktdetails ein. Der Standardwert ist "false".

definitionEnvironmentIdsFilter

number[]

Gibt zurück

getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)

Rufen Sie eine Releaseumgebung ab.

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

ID des Release.

environmentId

number

ID der Releaseumgebung.

expand
ReleaseEnvironmentExpands

Eine Eigenschaft, die in der Umgebung erweitert werden soll.

Gibt zurück

getReleaseHistory(string, number)

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

Gibt zurück

Promise<ReleaseRevision[]>

getReleaseProjects(string, string)

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

Parameter

artifactType

string

artifactSourceId

string

Gibt zurück

Promise<ProjectReference[]>

getReleaseRevision(string, number, number)

Rufen Sie die Freigabe für eine bestimmte Revisionsnummer ab.

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

ID des Release.

definitionSnapshotRevision

number

Definition Momentaufnahme Revisionsnummer.

Gibt zurück

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)

Abrufen einer Liste der Releases

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

Parameter

project

string

Projekt-ID oder Projektname

definitionId

number

Releases aus dieser Releasedefinitions-ID.

definitionEnvironmentId

number

searchText

string

Releases mit Namen, die searchText enthalten.

createdBy

string

Von diesem Benutzer erstellte Releases.

statusFilter
ReleaseStatus

Releases mit diesem status.

environmentStatusFilter

number

minCreatedTime

Date

Releases, die nach diesem Zeitpunkt erstellt wurden.

maxCreatedTime

Date

Releases, die vor diesem Zeitpunkt erstellt wurden.

queryOrder
ReleaseQueryOrder

Ruft die Ergebnisse in der definierten Reihenfolge des Erstellungsdatums für Releases ab. Der Standardwert ist absteigend.

top

number

Anzahl der abzurufenden Releases. Standard ist 50.

continuationToken

number

Ruft die Releases nach dem bereitgestellten Fortsetzungstoken ab.

expand
ReleaseExpands

Die Eigenschaft, die in der Liste der Releases erweitert werden soll.

artifactTypeId

string

Releases mit der angegebenen artifactTypeId werden zurückgegeben. Werte können Build, Jenkins, GitHub, Nuget, Team Build (extern), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild sein.

sourceId

string

Eindeutiger Bezeichner des verwendeten Artefakts. Beispiel: Beim Build wäre es {projectGuid}:{BuildDefinitionId}, für Jenkins {JenkinsConnectionId}:{JenkinsDefinitionId}, für TfsOnPremPrem wäre es {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. Für Artefakte von Drittanbietern, z. B. TeamCity, BitBucket, können Sie in vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensionsauf "uniqueSourceIdentifier" verweisen.

artifactVersionId

string

Releases mit der angegebenen artifactVersionId werden zurückgegeben. Im Fall von Build artifactType ist dies z. B. buildId.

sourceBranchFilter

string

Releases mit dem angegebenen sourceBranchFilter werden zurückgegeben.

isDeleted

boolean

Ruft die vorläufig gelöschten Releases ab, wenn true.

tagFilter

string[]

Eine durch Trennzeichen getrennte Liste von Tags. Es werden nur Releases mit diesen Tags zurückgegeben.

propertyFilters

string[]

Eine durch Trennzeichen getrennte Liste erweiterter Eigenschaften, die abgerufen werden sollen. Wenn festgelegt, enthalten die zurückgegebenen Releases Werte für die angegebenen Eigenschafts-IDs (sofern vorhanden). Wenn sie nicht festgelegt ist, werden die Eigenschaften nicht eingeschlossen. Beachten Sie, dass dadurch kein Release aus Ergebnissen herausfiltert wird, unabhängig davon, ob die Eigenschaft festgelegt ist oder nicht.

releaseIdFilter

number[]

Eine durch Trennzeichen getrennte Liste von Releases-IDs. Es werden nur Releases mit diesen IDs zurückgegeben.

path

string

Releases unter diesem Ordnerpfad werden zurückgegeben.

Gibt zurück

Promise<PagedList<Release>>

getReleaseSettings(string)

Ruft die Releaseeinstellungen ab.

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

Parameter

project

string

Projekt-ID oder Projektname

Gibt zurück

Promise<ReleaseSettings>

getReleaseTags(string, number)

Ruft die Tags für ein Release ab.

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

Gibt zurück

Promise<string[]>

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

Ruft eine Releasetaskanlage ab.

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

ID des Release.

environmentId

number

ID der Releaseumgebung.

attemptId

number

Anzahl des Bereitstellungsversuchs.

planId

string

Plan-ID der Bereitstellungsphase.

timelineId

string

Zeitachsen-ID der Aufgabe.

recordId

string

Datensatz-ID der Anlage.

type

string

Typ der Anlage.

name

string

Der Name der Anlage.

Gibt zurück

Promise<ArrayBuffer>

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

Rufen Sie die Releasetaskanlagen ab.

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

ID des Release.

environmentId

number

ID der Releaseumgebung.

attemptId

number

Anzahl des Bereitstellungsversuchs.

planId

string

Plan-ID der Bereitstellungsphase.

type

string

Typ der Anlage.

Gibt zurück

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

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

baseReleaseId

number

top

number

artifactAlias

string

Gibt zurück

Promise<ReleaseWorkItemRef[]>

getSourceBranches(string, number)

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

Parameter

project

string

Projekt-ID oder Projektname

definitionId

number

Gibt zurück

Promise<string[]>

getSummaryMailSections(string, number)

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

Gibt zurück

Promise<SummaryMailSection[]>

getTags(string)

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

Parameter

project

string

Projekt-ID oder Projektname

Gibt zurück

Promise<string[]>

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

Ruft eine Aufgabenanlage ab.

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

ID des Release.

environmentId

number

ID der Releaseumgebung.

attemptId

number

Die Anzahl der Bereitstellungsversuche.

timelineId

string

Zeitachsen-ID der Aufgabe.

recordId

string

Datensatz-ID der Anlage.

type

string

Typ der Anlage.

name

string

Der Name der Anlage.

Gibt zurück

Promise<ArrayBuffer>

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

Rufen Sie die Aufgabenanlagen ab.

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

Id der Version.

environmentId

number

ID der Releaseumgebung.

attemptId

number

Die Anzahl der Bereitstellungsversuche.

timelineId

string

Zeitachsen-ID der Aufgabe.

type

string

Typ der Anlage.

Gibt zurück

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

Ruft das Aufgabenprotokoll einer Version als reine Textdatei ab.

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

Id der Version.

environmentId

number

Id der Releaseumgebung.

releaseDeployPhaseId

number

Releasebereitstellungsphase-ID.

taskId

number

ReleaseTask-ID für das Protokoll.

startLine

number

Startzeilennummer für Protokolle

endLine

number

Endzeilennummer für Protokolle

Gibt zurück

Promise<string>

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

Ruft das Aufgabenprotokoll einer Version als reine Textdatei ab.

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

Id der Version.

environmentId

number

Id der Releaseumgebung.

attemptId

number

timelineId

string

taskId

number

ReleaseTask-ID für das Protokoll.

startLine

number

Startzeilennummer für Protokolle

endLine

number

Endzeilennummer für Protokolle

Gibt zurück

Promise<string>

getTasks(string, number, number, number)

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

environmentId

number

attemptId

number

Gibt zurück

Promise<ReleaseTask[]>

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

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

environmentId

number

attemptId

number

timelineId

string

Gibt zurück

Promise<ReleaseTask[]>

getTasksForTaskGroup(string, number, number, number)

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

environmentId

number

releaseDeployPhaseId

number

Gibt zurück

Promise<ReleaseTask[]>

listDefinitionEnvironmentTemplates(string, boolean)

Ruft eine Liste von Definitionsumgebungsvorlagen ab.

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

Parameter

project

string

Projekt-ID oder Projektname

isDeleted

boolean

"true", um gelöschte Definitionsumgebungsvorlagen abzurufen. Der Standardwert ist "false".

Gibt zurück

sendSummaryMail(MailMessage, string, number)

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

Parameter

mailMessage
MailMessage
project

string

Projekt-ID oder Projektname

releaseId

number

Gibt zurück

Promise<void>

undeleteRelease(string, number, string)

Wiederherstellen eines vorläufig gelöschten Release.

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

Parameter

project

string

Projekt-ID oder Projektname

releaseId

number

Id der Veröffentlichung, die rückgängig gemacht werden soll.

comment

string

Beliebiger Kommentar zum Wiederherstellen.

Gibt zurück

Promise<void>

undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)

Wiederherstellen einer Releasedefinition

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

Parameter

releaseDefinitionUndeleteParameter
ReleaseDefinitionUndeleteParameter

Objekt für die Undelete-Releasedefinition.

project

string

Projekt-ID oder Projektname

definitionId

number

ID der Releasedefinition, die rückgängig gemacht werden soll

Gibt zurück

undeleteReleaseDefinitionEnvironmentTemplate(string, string)

Wiederherstellen einer Umgebungsvorlage für eine Releasedefinition

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

Parameter

project

string

Projekt-ID oder Projektname

templateId

string

ID der zu wiederherstellenden Definitionsumgebungsvorlage

Gibt zurück

updateFolder(Folder, string, string)

Updates einen vorhandenen Ordner unter einem bestimmten vorhandenen Pfad.

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

Parameter

folder
Folder

.

project

string

Projekt-ID oder Projektname

path

string

Pfad des zu aktualisierenden Ordners.

Gibt zurück

Promise<Folder>

updateGates(GateUpdateMetadata, string, number)

Updates das Gate für eine Bereitstellung.

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

Parameter

gateUpdateMetadata
GateUpdateMetadata

Metadaten zum Patchen der Release Gates.

project

string

Projekt-ID oder Projektname

gateStepId

number

Gate-Schritt-ID.

Gibt zurück

Promise<ReleaseGates>

updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)

Aktualisieren Sie den manuellen Eingriff.

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

Parameter

manualInterventionUpdateMetadata
ManualInterventionUpdateMetadata

Metadaten zum Aktualisieren des manuellen Eingriffs.

project

string

Projekt-ID oder Projektname

releaseId

number

Id der Version.

manualInterventionId

number

ID des manuellen Eingriffs.

Gibt zurück

updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)

Versionseinstellungen für Updates Org-Pipeline

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

Parameter

Gibt zurück

updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)

Updates Einstellungen für Pipelinefreigaben

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

Parameter

project

string

Projekt-ID oder Projektname

Gibt zurück

updateRelease(Release, string, number)

Aktualisieren Sie ein vollständiges Releaseobjekt.

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

Parameter

release
Release

Release-Objekt für das Update.

project

string

Projekt-ID oder Projektname

releaseId

number

ID der zu aktualisierenden Version.

Gibt zurück

Promise<Release>

updateReleaseApproval(ReleaseApproval, string, number)

Aktualisieren status einer Genehmigung

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

Parameter

approval
ReleaseApproval

ReleaseApproval-Objekt mit status, Genehmigenden und Kommentaren.

project

string

Projekt-ID oder Projektname

approvalId

number

Id der Genehmigung.

Gibt zurück

Promise<ReleaseApproval>

updateReleaseApprovals(ReleaseApproval[], string)

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

Parameter

approvals

ReleaseApproval[]

project

string

Projekt-ID oder Projektname

Gibt zurück

Promise<ReleaseApproval[]>

updateReleaseDefinition(ReleaseDefinition, string)

Aktualisieren Sie eine Releasedefinition.

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

Parameter

releaseDefinition
ReleaseDefinition

Zu aktualisierende Freigabedefinitionsobjekt.

project

string

Projekt-ID oder Projektname

Gibt zurück

updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)

Aktualisieren des status einer Releaseumgebung

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

Parameter

environmentUpdateData
ReleaseEnvironmentUpdateMetadata

Metadaten zur Umgebungsaktualisierung.

project

string

Projekt-ID oder Projektname

releaseId

number

Id der Version.

environmentId

number

Id der Releaseumgebung.

Gibt zurück

updateReleaseResource(ReleaseUpdateMetadata, string, number)

Aktualisieren Sie einige Eigenschaften einer Version.

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

Parameter

releaseUpdateMetadata
ReleaseUpdateMetadata

Eigenschaften der zu aktualisierenden Veröffentlichung.

project

string

Projekt-ID oder Projektname

releaseId

number

ID der zu aktualisierenden Version.

Gibt zurück

Promise<Release>

updateReleaseSettings(ReleaseSettings, string)

Updates der Releaseeinstellungen

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

Parameter

releaseSettings
ReleaseSettings
project

string

Projekt-ID oder Projektname

Gibt zurück

Promise<ReleaseSettings>