ReleaseRestClient class

Paket:: azure-devops-extension-api

Basisklasse, die verwendet werden soll (abgeleitet von), um Anforderungen an VSS-REST-APIs zu stellen

Extends: RestClientBase

Konstruktoren

ReleaseRestClient(IVssRestClientOptions)

Eigenschaften

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 eine Kategorie zu einer Version 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 eine Version.
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 Freigabe
deleteReleaseDefinition(string, number, string, boolean)	Löschen sie eine Releasedefinition.
deleteReleaseTag(string, number, string)	Löscht ein Tag aus einer Version.
getAgentArtifactDefinitions(string, number)	Gibt die Artefaktdetails zurück, die der Automatisierungs-Agent benötigt
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 von 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 ein Signal ab, das den Status der neuesten 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 von Bereitstellungen
getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)
getFavorites(string, string, 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)	Abrufen von Protokollen für eine Release-ID.
getManualIntervention(string, number, number)	Abrufen eines manuellen Eingriffs für eine bestimmte Release- und manuelle Interventions-ID.
getManualInterventions(string, number)	Listet alle manuellen Interventionen für eine bestimmte Version auf.
getMetrics(string, Date)
getOrgPipelineReleaseSettings()	Ruft Veröffentlichungseinstellungen der Organisationspipeline ab
getPipelineReleaseSettings(string)	Ruft Pipelineversionseinstellungen ab
getRelease(string, number, ApprovalFilters, string[], SingleReleaseExpands, number, boolean)	Abrufen einer Version
getReleaseChanges(string, number, number, number, string)
getReleaseDefinition(string, number, string[], boolean)	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 Überarbeitung ab.
getReleaseDefinitions(string, string, ReleaseDefinitionExpands, string, string, number, string, ReleaseDefinitionQueryOrder, string, boolean, string[], string[], string[], boolean, boolean)	Dient zum Abrufen einer Liste der Versionsdefinitionen.
getReleaseDefinitionSummary(string, number, number, boolean, number[])	Abrufen der Versionszusammenfassung einer bestimmten Definitions-ID.
getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)	Rufen Sie eine Releaseumgebung ab.
getReleaseHistory(string, number)
getReleaseProjects(string, string)
getReleaseRevision(string, number, number)	Abrufen der Version für eine bestimmte Revisionsnummer.
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 von Versionen
getReleaseSettings(string)	Ruft die Versionseinstellungen ab.
getReleaseTags(string, number)	Ruft die Tags für eine Version ab.
getReleaseTaskAttachmentContent(string, number, number, number, string, string, string, string, string)	Abrufen einer Freigabeaufgabenanlage.
getReleaseTaskAttachments(string, number, number, number, string, string)	Rufen Sie die Releaseaufgabenanlagen ab.
getReleaseWorkItemsRefs(string, number, number, number, string)
getSourceBranches(string, number)
getSummaryMailSections(string, number)
getTags(string)
getTaskAttachmentContent(string, number, number, number, string, string, string, string)	Dient zum Abrufen einer Aufgabenanlage.
getTaskAttachments(string, number, number, number, string, string)	Rufen Sie die Aufgabenanlagen ab.
getTaskLog(string, number, number, number, number, number, number)	Ruft das Aufgabenprotokoll einer Freigabe als Nur-Text-Datei ab.
getTaskLog2(string, number, number, number, string, number, number, number)	Ruft das Aufgabenprotokoll einer Freigabe als Nur-Text-Datei ab.
getTasks(string, number, number, number)
getTasks2(string, number, number, number, string)
getTasksForTaskGroup(string, number, number, number)
listDefinitionEnvironmentTemplates(string, boolean)	Ruft eine Liste der Definitionsumgebungsvorlagen ab
sendSummaryMail(MailMessage, string, number)
undeleteRelease(string, number, string)	Rückgängigmachen einer vorläufig gelöschten Freigabe.
undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)	Heben Sie eine Releasedefinition auf.
undeleteReleaseDefinitionEnvironmentTemplate(string, string)	Heben Sie eine Releasedefinitionsumgebungsvorlage auf.
updateFolder(Folder, string, string)	Aktualisiert einen vorhandenen Ordner bei einem bestimmten vorhandenen Pfad.
updateGates(GateUpdateMetadata, string, number)	Aktualisiert das Gate für eine Bereitstellung.
updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)	Manuelle Intervention aktualisieren.
updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)	Updates Organisationspipeline-Versionseinstellungen
updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)	Aktualisierungen der Pipeline-Release-Einstellungen
updateRelease(Release, string, number)	Aktualisieren eines vollständigen Releaseobjekts.
updateReleaseApproval(ReleaseApproval, string, number)	Aktualisierungsstatus einer Genehmigung
updateReleaseApprovals(ReleaseApproval[], string)
updateReleaseDefinition(ReleaseDefinition, string, boolean)	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)	Aktualisiert die Versionseinstellungen.

Details zum Konstruktor

ReleaseRestClient(IVssRestClientOptions)

new ReleaseRestClient(options: IVssRestClientOptions)

Parameter

options: IVssRestClientOptions

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 eine Kategorie zu einer Version 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

Promise<ReleaseDefinitionEnvironmentTemplate>

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

Ordner.

project: string

Projekt-ID oder Projektname

path: string

Pfad des Ordners.

Gibt zurück

Promise<Folder>

createRelease(ReleaseStartMetadata, string)

Erstellen Sie eine Version.

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

Parameter

releaseStartMetadata: ReleaseStartMetadata

Metadaten zum Erstellen einer Version.

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

Release-Definitionsobjekt, das erstellt werden soll.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<ReleaseDefinition>

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 Freigabe

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

Parameter

project: string

Projekt-ID oder Projektname

releaseId: number

ID der Version.

comment: string

Kommentar zum Löschen einer Version.

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 in Bearbeitung ausgeführten 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 einer Version.

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 der Automatisierungs-Agent benötigt

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

Parameter

project: string

Projekt-ID oder Projektname

releaseId: number

Gibt zurück

Promise<AgentArtifactDefinition[]>

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 von 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 Versionen können erwähnt werden, indem sie durch "," getrennt werden, z. B. releaseIdsFilter=1,2,3,4.

typeFilter: ApprovalType

Genehmigung mit diesem Typ.

top: number

Anzahl der abzurufenden Genehmigungen. Der Standardwert 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

Promise<PagedList<ReleaseApproval>>

getArtifactTypeDefinitions(string)

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

Parameter

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<ArtifactTypeDefinition[]>

getArtifactVersions(string, number)

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

Parameter

project: string

Projekt-ID oder Projektname

releaseDefinitionId: number

Gibt zurück

Promise<ArtifactVersionQueryResult>

getArtifactVersionsForSources(Artifact[], string)

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

Parameter

artifacts: Artifact[]

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<ArtifactVersionQueryResult>

getAutoTriggerIssues(string, string, string, string)

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

Parameter

artifactType: string

sourceId: string

artifactVersionId: string

project: string

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

Promise<DefinitionEnvironmentReference[]>

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

Promise<ReleaseDefinitionEnvironmentTemplate>

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 Überarbeitung.

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 ein Signal ab, das den Status der neuesten 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 der Verzweigung.

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

Auflisten der Bereitstellungen für eine bestimmte Definitions-ID.

definitionEnvironmentId: number

Auflisten der Bereitstellungen für eine bestimmte Definitionsumgebungs-ID.

createdBy: string

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

minModifiedTime: Date

Auflisten der Bereitstellungen mit LastModified time >= minModifiedTime.

maxModifiedTime: Date

Auflisten der Bereitstellungen mit LastModified time <= maxModifiedTime.

deploymentStatus: DeploymentStatus

Listet die Bereitstellungen mit dem angegebenen Bereitstellungsstatus auf. Der Standardwert ist "Alle".

operationStatus: DeploymentOperationStatus

Listet die Bereitstellungen mit dem angegebenen Vorgangsstatus auf. Der Standardwert ist "Alle".

latestAttemptsOnly: boolean

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

queryOrder: ReleaseQueryOrder

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

top: number

Auflisten der Bereitstellungen mit dem angegebenen Anfang. Der Standardanfang ist "50", und "Max" ist "100".

continuationToken: number

Auflisten der Bereitstellungen mit der Bereitstellungs-ID >= continuationToken.

createdFor: string

Listet die Bereitstellungen auf, für die Bereitstellungen als Identität angegeben angefordert werden.

minStartedTime: Date

Auflisten der Bereitstellungen mit "StartedOn time >= minStartedTime".

maxStartedTime: Date

Auflisten der Bereitstellungen mit "StartedOn time <= maxStartedTime".

sourceBranch: string

Listet die Bereitstellungen auf, die aus dem angegebenen Verzweigungsnamen 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[]>

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 der Version.

environmentId: number

ID der Releaseumgebung.

gateId: number

ID des Tors.

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

query: InputValuesQuery

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 der Version.

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)

Abrufen von Protokollen für eine Release-ID.

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

Parameter

project: string

Projekt-ID oder Projektname

releaseId: number

ID der Version.

Gibt zurück

Promise<ArrayBuffer>

getManualIntervention(string, number, number)

Abrufen eines manuellen Eingriffs für eine bestimmte Release- und manuelle Interventions-ID.

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

Parameter

project: string

Projekt-ID oder Projektname

releaseId: number

ID der Version.

manualInterventionId: number

ID des manuellen Eingriffs.

Gibt zurück

Promise<ManualIntervention>

getManualInterventions(string, number)

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

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

Parameter

project: string

Projekt-ID oder Projektname

releaseId: number

ID der Version.

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 Veröffentlichungseinstellungen der Organisationspipeline ab

function getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>

Gibt zurück

Promise<OrgPipelineReleaseSettings>

getPipelineReleaseSettings(string)

Ruft Pipelineversionseinstellungen ab

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

Parameter

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<ProjectPipelineReleaseSettings>

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

Abrufen einer Version

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

Parameter

project: string

Projekt-ID oder Projektname

releaseId: number

ID der Version.

approvalFilters: ApprovalFilters

Ein Filter, mit dem Genehmigungsschritte selektiv abgerufen werden können, je nachdem, ob er automatisiert oder manuell ist. Dies würde auch entscheiden, ob Momentaufnahmen vor und nach der Genehmigung abgerufen werden sollen. Geht standardmäßig von "Alle" aus

propertyFilters: string[]

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

expand: SingleReleaseExpands

Eine Eigenschaft, die in der Version erweitert werden soll.

topGateRecords: number

Anzahl der abzurufenden Release-Gate-Datensätze. Der Standardwert ist 5.

includeDisabledDefinitions: boolean

Deaktivierte Definitionen einschließen (wenn der Fehler auf 'false' festgelegt ist, ist der Standardwert 'true')

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[], boolean)

Rufen Sie eine Releasedefinition ab.

function getReleaseDefinition(project: string, definitionId: number, propertyFilters?: string[], includeDisabled?: boolean): 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 keine Eigenschaften eingeschlossen.

includeDisabled: boolean

Boolesche Kennzeichnung, um deaktivierte Definitionen einzuschließen.

Gibt zurück

Promise<ReleaseDefinition>

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

Promise<ReleaseDefinitionRevision[]>

getReleaseDefinitionRevision(string, number, number)

Rufen Sie die Releasedefinition einer bestimmten Überarbeitung 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)

Dient zum Abrufen einer Liste der Versionsdefinitionen.

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 Versionsdefinitionen mit Namen, die searchText enthalten.

expand: ReleaseDefinitionExpands

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

artifactType: string

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

artifactSourceId: string

Releasedefinitionen mit gegebener artifactSourceId werden zurückgegeben. Zum Beispiel wäre es {projectGuid}:{BuildDefinitionId}, für Jenkins wäre es {JenkinsConnectionId}:{JenkinsDefinitionId}:{JenkinsDefinitionId}, für TfsOnPrem wäre es {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. Bei Artefakten von Drittanbietern, z. B. TeamCity, BitBucket können Sie in vss-extension.json unter https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensionsauf "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', um die Releasedefinitionen mit exakter Übereinstimmung wie in searchText angegeben zu erhalten. Der Standardwert ist 'false'.

tagFilter: string[]

Eine durch Trennzeichen getrennte Liste von Tags. Es werden nur Freigabedefinitionen 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 keine Eigenschaften eingeschlossen. Beachten Sie, dass dadurch keine Releasedefinition aus Ergebnissen herausfiltert wird, unabhängig davon, ob sie über einen Eigenschaftensatz verfügt oder nicht.

definitionIdFilter: string[]

Eine durch Trennzeichen getrennte Liste der abzurufenden Releasedefinitionen.

isDeleted: boolean

"true", um Releasedefinitionen abzurufen, die gelöscht wurden. Der Standardwert ist "false".

searchTextContainsFolderName: boolean

'true', um die Releasedefinitionen unter dem Ordner mit dem Namen abzurufen, wie in searchText angegeben. Der Standardwert ist 'false'.

Gibt zurück

Promise<PagedList<ReleaseDefinition>>

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

Abrufen der Versionszusammenfassung einer bestimmten 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 Versionszusammenfassung.

releaseCount: number

Anzahl der Versionen, die in der Zusammenfassung enthalten sein sollen.

includeArtifact: boolean

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

definitionEnvironmentIdsFilter: number[]

Gibt zurück

Promise<ReleaseDefinitionSummary>

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 der Version.

environmentId: number

ID der Releaseumgebung.

expand: ReleaseEnvironmentExpands

Eine Eigenschaft, die in der Umgebung erweitert werden soll.

Gibt zurück

Promise<ReleaseEnvironment>

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)

Abrufen der Version für eine bestimmte Revisionsnummer.

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

Parameter

project: string

Projekt-ID oder Projektname

releaseId: number

ID der Version.

definitionSnapshotRevision: number

Revisionsnummer der Definitionsmomentaufnahme.

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

function getReleases(project?: string, definitionId?: number, definitionEnvironmentId?: number, searchText?: string, createdBy?: string, statusFilter?: ReleaseStatus, environmentStatusFilter?: number, minCreatedTime?: Date, maxCreatedTime?: Date, queryOrder?: ReleaseQueryOrder, top?: number, continuationToken?: number, expand?: ReleaseExpands, artifactTypeId?: string, sourceId?: string, artifactVersionId?: string, sourceBranchFilter?: string, isDeleted?: boolean, tagFilter?: string[], propertyFilters?: string[], releaseIdFilter?: number[], path?: string): Promise<Release[]>

Parameter

project: string

Projekt-ID oder Projektname

definitionId: number

Versionen von dieser Versionsdefinitions-ID.

definitionEnvironmentId: number

searchText: string

Versionen mit Namen, die searchText enthalten.

createdBy: string

Versionen, die von diesem Benutzer erstellt wurden.

statusFilter: ReleaseStatus

Versionen mit diesem Status.

environmentStatusFilter: number

minCreatedTime: Date

Versionen, die nach dieser Zeit erstellt wurden.

maxCreatedTime: Date

Versionen, die vor dieser Zeit erstellt wurden.

queryOrder: ReleaseQueryOrder

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

top: number

Anzahl der abzurufenden Versionen. Der Standardwert ist 50.

continuationToken: number

Ruft die Versionen nach dem bereitgestellten Fortsetzungstoken ab.

expand: ReleaseExpands

Die Eigenschaft, die in der Liste der Versionen 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. Zum Beispiel wäre es {projectGuid}:{BuildDefinitionId}, für Jenkins wäre es {JenkinsConnectionId}:{JenkinsDefinitionId}:{JenkinsDefinitionId}, für TfsOnPrem wäre es {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. Bei Artefakten 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. Bei Build artifactType ist es z. B. buildId.

sourceBranchFilter: string

Versionen mit angegebenem sourceBranchFilter werden zurückgegeben (nicht mit environmentStatusFilter verwendet werden).

isDeleted: boolean

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

tagFilter: string[]

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

propertyFilters: string[]

Eine durch Trennzeichen getrennte Liste erweiterter Eigenschaften, die abgerufen werden sollen. Wenn festgelegt, enthalten die zurückgegebenen Versionen Werte für die angegebenen Eigenschafts-IDs (sofern vorhanden). Wenn sie nicht festgelegt ist, werden keine Eigenschaften eingeschlossen. Beachten Sie, dass dadurch keine Freigabe von Ergebnissen herausfiltert wird, unabhängig davon, ob sie über einen Eigenschaftensatz verfügt oder nicht.

releaseIdFilter: number[]

Eine durch Trennzeichen getrennte Liste der Veröffentlichungs-IDs. Es werden nur Versionen mit diesen IDs zurückgegeben.

path: string

Versionen unter diesem Ordnerpfad werden zurückgegeben.

Gibt zurück

Promise<Release[]>

getReleaseSettings(string)

Ruft die Versionseinstellungen 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 eine Version 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)

Abrufen einer Freigabeaufgabenanlage.

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 der Version.

environmentId: number

ID der Releaseumgebung.

attemptId: number

Versuchen Sie, die Anzahl der Bereitstellungen zu versuchen.

planId: string

Plan-ID der Bereitstellungsphase.

timelineId: string

Zeitachsen-ID des Vorgangs.

recordId: string

Datensatz-ID der Anlage.

type: string

Typ der Anlage.

name: string

Name der Anlage.

Gibt zurück

Promise<ArrayBuffer>

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

Rufen Sie die Releaseaufgabenanlagen 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 der Version.

environmentId: number

ID der Releaseumgebung.

attemptId: number

Versuchen Sie, die Anzahl der Bereitstellungen zu versuchen.

planId: string

Plan-ID der Bereitstellungsphase.

type: string

Typ der Anlage.

Gibt zurück

Promise<ReleaseTaskAttachment[]>

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

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

Parameter

project: string

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)

Dient zum Abrufen einer Aufgabenanlage.

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 der Version.

environmentId: number

ID der Releaseumgebung.

attemptId: number

Versuchen Sie, die Anzahl der Bereitstellungen zu versuchen.

timelineId: string

Zeitachsen-ID des Vorgangs.

recordId: string

Datensatz-ID der Anlage.

type: string

Typ der Anlage.

name: string

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

Versuchen Sie, die Anzahl der Bereitstellungen zu versuchen.

timelineId: string

Zeitachsen-ID des Vorgangs.

type: string

Typ der Anlage.

Gibt zurück

Promise<ReleaseTaskAttachment[]>

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

Ruft das Aufgabenprotokoll einer Freigabe als Nur-Text-Datei 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

Phasen-ID der Releasebereitstellungsphase.

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 Freigabe als Nur-Text-Datei 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 der Definitionsumgebungsvorlagen ab

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

Parameter

project: string

Projekt-ID oder Projektname

isDeleted: boolean

'true', um Definitionsumgebungsvorlagen abzurufen, die gelöscht wurden. Der Standardwert ist "false".

Gibt zurück

Promise<ReleaseDefinitionEnvironmentTemplate[]>

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)

Rückgängigmachen einer vorläufig gelöschten Freigabe.

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

Parameter

project: string

Projekt-ID oder Projektname

releaseId: number

Die ID der Freigabe, die rückgängig zu machen ist.

comment: string

Ein beliebiger Kommentar zum Rückgängigmachen.

Gibt zurück

Promise<void>

undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)

Heben Sie eine Releasedefinition auf.

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 zu machen ist

Gibt zurück

Promise<ReleaseDefinition>

undeleteReleaseDefinitionEnvironmentTemplate(string, string)

Heben Sie eine Releasedefinitionsumgebungsvorlage auf.

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

Parameter

project: string

Projekt-ID oder Projektname

templateId: string

ID der Definitionsumgebungsvorlage, die rückgängig zu machen ist

Gibt zurück

Promise<ReleaseDefinitionEnvironmentTemplate>

updateFolder(Folder, string, string)

Aktualisiert einen vorhandenen Ordner bei einem bestimmten vorhandenen Pfad.

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

Parameter

folder: Folder

Ordner.

project: string

Projekt-ID oder Projektname

path: string

Pfad des zu aktualisierenden Ordners.

Gibt zurück

Promise<Folder>

updateGates(GateUpdateMetadata, string, number)

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

Manuelle Intervention aktualisieren.

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

Parameter

manualInterventionUpdateMetadata: ManualInterventionUpdateMetadata

Metadaten zum Aktualisieren eines manuellen Eingriffs.

project: string

Projekt-ID oder Projektname

releaseId: number

ID der Version.

manualInterventionId: number

ID des manuellen Eingriffs.

Gibt zurück

Promise<ManualIntervention>

updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)

Updates Organisationspipeline-Versionseinstellungen

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

Parameter

newSettings: OrgPipelineReleaseSettingsUpdateParameters

Gibt zurück

Promise<OrgPipelineReleaseSettings>

updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)

Aktualisierungen der Pipeline-Release-Einstellungen

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

Parameter

newSettings: ProjectPipelineReleaseSettingsUpdateParameters

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<ProjectPipelineReleaseSettings>

updateRelease(Release, string, number)

Aktualisieren eines vollständigen Releaseobjekts.

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

Parameter

release: Release

Release-Objekt für die Aktualisierung.

project: string

Projekt-ID oder Projektname

releaseId: number

ID der zu aktualisierenden Version.

Gibt zurück

Promise<Release>

updateReleaseApproval(ReleaseApproval, string, number)

Aktualisierungsstatus einer Genehmigung

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

Parameter

approval: ReleaseApproval

ReleaseApproval-Objekt mit Status, Genehmiger 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, boolean)

Aktualisieren sie eine Releasedefinition.

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

Parameter

releaseDefinition: ReleaseDefinition

Releasedefinitionsobjekt, das aktualisiert werden soll.

project: string

Projekt-ID oder Projektname

skipTasksValidation: boolean

Boolesche Kennzeichnung für die Aufgabenüberprüfung überspringen

Gibt zurück

Promise<ReleaseDefinition>

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 der Umgebung werden aktualisiert.

project: string

Projekt-ID oder Projektname

releaseId: number

ID der Version.

environmentId: number

ID der Releaseumgebung.

Gibt zurück

Promise<ReleaseEnvironment>

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

project: string

Projekt-ID oder Projektname

releaseId: number

ID der zu aktualisierenden Version.

Gibt zurück

Promise<Release>

updateReleaseSettings(ReleaseSettings, string)

Aktualisiert die Versionseinstellungen.

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

Parameter

releaseSettings: ReleaseSettings

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<ReleaseSettings>

Feedback

War diese Seite hilfreich?

Freigeben über

ReleaseRestClient class

Konstruktoren

Eigenschaften

Methoden

Details zum Konstruktor

ReleaseRestClient(IVssRestClientOptions)

Parameter

Details zur Eigenschaft

RESOURCE_AREA_ID

Eigenschaftswert

Details zur Methode

addDefinitionTag(string, number, string)

Parameter

Gibt zurück

addDefinitionTags(string[], string, number)

Parameter

Gibt zurück

addReleaseTag(string, number, string)

Parameter

Gibt zurück

addReleaseTags(string[], string, number)

Parameter

Gibt zurück

createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)

Parameter

Gibt zurück

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

Parameter

Gibt zurück

createFolder(Folder, string, string)

Parameter

Gibt zurück

createRelease(ReleaseStartMetadata, string)

Parameter

Gibt zurück

createReleaseDefinition(ReleaseDefinition, string)

Parameter

Gibt zurück

deleteDefinitionEnvironmentTemplate(string, string)

Parameter

Gibt zurück

deleteDefinitionTag(string, number, string)

Parameter

Gibt zurück

deleteFavorites(string, string, string, string)

Parameter

Gibt zurück

deleteFolder(string, string)

Parameter

Gibt zurück

deleteRelease(string, number, string)

Parameter

Gibt zurück

deleteReleaseDefinition(string, number, string, boolean)

Parameter

Gibt zurück

deleteReleaseTag(string, number, string)

Parameter

Gibt zurück

getAgentArtifactDefinitions(string, number)

Parameter

Gibt zurück

getApproval(string, number, boolean)

Parameter

Gibt zurück

getApprovalHistory(string, number)

Parameter

Gibt zurück

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

Parameter

Gibt zurück

getArtifactTypeDefinitions(string)

Parameter

Gibt zurück

getArtifactVersions(string, number)

Parameter

Gibt zurück

getArtifactVersionsForSources(Artifact[], string)

Parameter