ReleaseRestClient class

Pakket:: azure-devops-extension-api

Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen naar VSS REST API's

Uitbreiding: RestClientBase

Constructors

ReleaseRestClient(IVssRestClientOptions)

Eigenschappen

Methoden

addDefinitionTag(string, number, string)	Een tag toevoegen aan een definitie
addDefinitionTags(string[], string, number)	Voegt meerdere tags toe aan een definitie
addReleaseTag(string, number, string)	Een tag toevoegen aan een releaseId
addReleaseTags(string[], string, number)	Tag toevoegen aan een release
createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)	Een definitieomgevingssjabloon maken
createFavorites(FavoriteItem[], string, string, string)
createFolder(Folder, string, string)	Hiermee maakt u een nieuwe map.
createRelease(ReleaseStartMetadata, string)	Maak een release.
createReleaseDefinition(ReleaseDefinition, string)	Een releasedefinitie maken
deleteDefinitionEnvironmentTemplate(string, string)	Een definitieomgevingssjabloon verwijderen
deleteDefinitionTag(string, number, string)	Hiermee verwijdert u een tag uit een definitie
deleteFavorites(string, string, string, string)
deleteFolder(string, string)	Hiermee verwijdert u een definitiemap voor de opgegeven mapnaam en het pad en alle bestaande definities.
deleteRelease(string, number, string)	Een release voorlopig verwijderen
deleteReleaseDefinition(string, number, string, boolean)	Verwijder een releasedefinitie.
deleteReleaseTag(string, number, string)	Hiermee verwijdert u een tag uit een release
getAgentArtifactDefinitions(string, number)	Retourneert de artefactdetails die de automatiseringsagent vereist
getApproval(string, number, boolean)	Een goedkeuring krijgen.
getApprovalHistory(string, number)	Goedkeuringsgeschiedenis ophalen.
getApprovals(string, string, ApprovalStatus, number[], ApprovalType, number, number, ReleaseQueryOrder, boolean)	Een lijst met goedkeuringen ophalen
getArtifactTypeDefinitions(string)
getArtifactVersions(string, number)
getArtifactVersionsForSources(Artifact[], string)
getAutoTriggerIssues(string, string, string, string)
getDefinitionEnvironments(string, string, string[])
getDefinitionEnvironmentTemplate(string, string)	Hiermee haalt u een definitieomgevingssjabloon op
getDefinitionRevision(string, number, number)	Releasedefinitie ophalen voor een bepaalde definitionId en revisie
getDefinitionTags(string, number)	Hiermee haalt u de tags voor een definitie op
getDeploymentBadge(string, number, number, string)	Hiermee haalt u een badge op die de status van de meest recente implementatie voor een omgeving aangeeft.
getDeployments(string, number, number, string, Date, Date, DeploymentStatus, DeploymentOperationStatus, boolean, ReleaseQueryOrder, number, number, string, Date, Date, string)	Een lijst met implementaties ophalen
getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)
getFavorites(string, string, string)
getFolders(string, string, FolderPathQueryOrder)	Hiermee haalt u mappen op.
getGateLog(string, number, number, number, number)	Poortlogboeken ophalen
getInputValues(InputValuesQuery, string)
getIssues(string, number, string)
getLog(string, number, number, number, number)	Logboeken ophalen
getLogs(string, number)	Haal logboeken op voor een release-id.
getManualIntervention(string, number, number)	Handmatige interventie ophalen voor een bepaalde release en handmatige interventie-id.
getManualInterventions(string, number)	Vermeld alle handmatige interventies voor een bepaalde release.
getMetrics(string, Date)
getOrgPipelineReleaseSettings()	Release-instellingen voor organisatiepijplijn ophaalt
getPipelineReleaseSettings(string)	Instellingen voor pijplijnrelease worden ophaalt
getRelease(string, number, ApprovalFilters, string[], SingleReleaseExpands, number, boolean)	Een release ophalen
getReleaseChanges(string, number, number, number, string)
getReleaseDefinition(string, number, string[], boolean)	Haal een releasedefinitie op.
getReleaseDefinitionHistory(string, number)	Revisiegeschiedenis voor een releasedefinitie ophalen
getReleaseDefinitionRevision(string, number, number)	Releasedefinitie van een bepaalde revisie ophalen.
getReleaseDefinitions(string, string, ReleaseDefinitionExpands, string, string, number, string, ReleaseDefinitionQueryOrder, string, boolean, string[], string[], string[], boolean, boolean)	Haal een lijst met releasedefinities op.
getReleaseDefinitionSummary(string, number, number, boolean, number[])	Download de releasesamenvatting van een bepaalde definitie-id.
getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)	Haal een release-omgeving op.
getReleaseHistory(string, number)
getReleaseProjects(string, string)
getReleaseRevision(string, number, number)	Download release voor een bepaald revisienummer.
getReleases(string, number, number, string, string, ReleaseStatus, number, Date, Date, ReleaseQueryOrder, number, number, ReleaseExpands, string, string, string, string, boolean, string[], string[], number[], string)	Een lijst met releases ophalen
getReleaseSettings(string)	Haalt de release-instellingen op
getReleaseTags(string, number)	Haalt de tags voor een release op
getReleaseTaskAttachmentContent(string, number, number, number, string, string, string, string, string)	Haal een releasetaakbijlage op.
getReleaseTaskAttachments(string, number, number, number, string, string)	Haal de releasetaakbijlagen op.
getReleaseWorkItemsRefs(string, number, number, number, string)
getSourceBranches(string, number)
getSummaryMailSections(string, number)
getTags(string)
getTaskAttachmentContent(string, number, number, number, string, string, string, string)	Een taakbijlage ophalen.
getTaskAttachments(string, number, number, number, string, string)	Haal de taakbijlagen op.
getTaskLog(string, number, number, number, number, number, number)	Hiermee haalt u het taaklogboek van een release op als een tekstbestand zonder opmaak.
getTaskLog2(string, number, number, number, string, number, number, number)	Hiermee haalt u het taaklogboek van een release op als een tekstbestand zonder opmaak.
getTasks(string, number, number, number)
getTasks2(string, number, number, number, string)
getTasksForTaskGroup(string, number, number, number)
listDefinitionEnvironmentTemplates(string, boolean)	Hiermee haalt u een lijst met definitieomgevingssjablonen op
sendSummaryMail(MailMessage, string, number)
undeleteRelease(string, number, string)	De verwijdering van een voorlopig verwijderde release ongedaan maken.
undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)	De releasedefinitie ongedaan maken.
undeleteReleaseDefinitionEnvironmentTemplate(string, string)	Een sjabloon voor de releasedefinitieomgeving ongedaan maken.
updateFolder(Folder, string, string)	Hiermee wordt een bestaande map bijgewerkt op het opgegeven bestaande pad.
updateGates(GateUpdateMetadata, string, number)	Hiermee werkt u de poort voor een implementatie bij.
updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)	Handmatige interventie bijwerken.
updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)	Release-instellingen voor organisatiepijplijnen bijwerken
updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)	Release-instellingen voor pijplijn bijwerken
updateRelease(Release, string, number)	Een volledig releaseobject bijwerken.
updateReleaseApproval(ReleaseApproval, string, number)	Status van een goedkeuring bijwerken
updateReleaseApprovals(ReleaseApproval[], string)
updateReleaseDefinition(ReleaseDefinition, string, boolean)	Een releasedefinitie bijwerken.
updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)	De status van een release-omgeving bijwerken
updateReleaseResource(ReleaseUpdateMetadata, string, number)	Werk enkele eigenschappen van een release bij.
updateReleaseSettings(ReleaseSettings, string)	De release-instellingen bijwerken

Constructordetails

ReleaseRestClient(IVssRestClientOptions)

new ReleaseRestClient(options: IVssRestClientOptions)

Parameters

options: IVssRestClientOptions

Eigenschapdetails

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Waarde van eigenschap

string

Methodedetails

addDefinitionTag(string, number, string)

Een tag toevoegen aan een definitie

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

Parameters

project: string

Project-id of projectnaam

releaseDefinitionId: number

tag: string

Retouren

Promise<string[]>

addDefinitionTags(string[], string, number)

Voegt meerdere tags toe aan een definitie

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

Parameters

tags: string[]

project: string

Project-id of projectnaam

releaseDefinitionId: number

Retouren

Promise<string[]>

addReleaseTag(string, number, string)

Een tag toevoegen aan een releaseId

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

tag: string

Retouren

Promise<string[]>

addReleaseTags(string[], string, number)

Tag toevoegen aan een release

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

Parameters

tags: string[]

project: string

Project-id of projectnaam

releaseId: number

Retouren

Promise<string[]>

createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)

Een definitieomgevingssjabloon maken

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

Parameters

template: ReleaseDefinitionEnvironmentTemplate

Sjabloon voor definitieomgeving om te maken

project: string

Project-id of projectnaam

Retouren

Promise<ReleaseDefinitionEnvironmentTemplate>

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

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

Parameters

favoriteItems: FavoriteItem[]

project: string

Project-id of projectnaam

scope: string

identityId: string

Retouren

Promise<FavoriteItem[]>

createFolder(Folder, string, string)

Hiermee maakt u een nieuwe map.

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

Parameters

folder: Folder

map.

project: string

Project-id of projectnaam

path: string

Pad van de map.

Retouren

Promise<Folder>

createRelease(ReleaseStartMetadata, string)

Maak een release.

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

Parameters

releaseStartMetadata: ReleaseStartMetadata

Metagegevens voor het maken van een release.

project: string

Project-id of projectnaam

Retouren

Promise<Release>

createReleaseDefinition(ReleaseDefinition, string)

Een releasedefinitie maken

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

Parameters

releaseDefinition: ReleaseDefinition

releasedefinitieobject dat moet worden gemaakt.

project: string

Project-id of projectnaam

Retouren

Promise<ReleaseDefinition>

deleteDefinitionEnvironmentTemplate(string, string)

Een definitieomgevingssjabloon verwijderen

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

Parameters

project: string

Project-id of projectnaam

templateId: string

Id van de definitieomgevingssjabloon

Retouren

Promise<void>

deleteDefinitionTag(string, number, string)

Hiermee verwijdert u een tag uit een definitie

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

Parameters

project: string

Project-id of projectnaam

releaseDefinitionId: number

tag: string

Retouren

Promise<string[]>

deleteFavorites(string, string, string, string)

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

Parameters

project: string

Project-id of projectnaam

scope: string

identityId: string

favoriteItemIds: string

Retouren

Promise<void>

deleteFolder(string, string)

Hiermee verwijdert u een definitiemap voor de opgegeven mapnaam en het pad en alle bestaande definities.

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

Parameters

project: string

Project-id of projectnaam

path: string

Pad van de map die u wilt verwijderen.

Retouren

Promise<void>

deleteRelease(string, number, string)

Een release voorlopig verwijderen

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

Id van de release.

comment: string

Opmerking voor het verwijderen van een release.

Retouren

Promise<void>

deleteReleaseDefinition(string, number, string, boolean)

Verwijder een releasedefinitie.

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

Parameters

project: string

Project-id of projectnaam

definitionId: number

Id van de releasedefinitie.

comment: string

Opmerking voor het verwijderen van een releasedefinitie.

forceDelete: boolean

'true' om automatisch eventuele implementaties van de release in uitvoering te annuleren en door te gaan met het verwijderen van releasedefinities. De standaardwaarde is 'false'.

Retouren

Promise<void>

deleteReleaseTag(string, number, string)

Hiermee verwijdert u een tag uit een release

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

tag: string

Retouren

Promise<string[]>

getAgentArtifactDefinitions(string, number)

Retourneert de artefactdetails die de automatiseringsagent vereist

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

Retouren

Promise<AgentArtifactDefinition[]>

getApproval(string, number, boolean)

Een goedkeuring krijgen.

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

Parameters

project: string

Project-id of projectnaam

approvalId: number

Id van de goedkeuring.

includeHistory: boolean

'waar' om de geschiedenis van de goedkeuring op te nemen. De standaardwaarde is 'false'.

Retouren

Promise<ReleaseApproval>

getApprovalHistory(string, number)

Goedkeuringsgeschiedenis ophalen.

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

Parameters

project: string

Project-id of projectnaam

approvalStepId: number

Id van de goedkeuring.

Retouren

Promise<ReleaseApproval>

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

Een lijst met goedkeuringen ophalen

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

Parameters

project: string

Project-id of projectnaam

assignedToFilter: string

Goedkeuringen die aan deze gebruiker zijn toegewezen.

statusFilter: ApprovalStatus

Goedkeuringen met deze status. De standaardwaarde is 'in behandeling'.

releaseIdsFilter: number[]

Goedkeuringen voor release-id('s) die in het filter worden vermeld. Meerdere releases kunnen worden vermeld door ze te scheiden met ',' bijvoorbeeld releaseIdsFilter=1,2,3,4.

typeFilter: ApprovalType

Goedkeuring met dit type.

top: number

Het aantal goedkeuringen dat moet worden ontvangen. De standaardwaarde is 50.

continuationToken: number

Hiermee worden de goedkeuringen opgehaald nadat het vervolgtoken is opgegeven.

queryOrder: ReleaseQueryOrder

Hiermee worden de resultaten opgehaald in de gedefinieerde volgorde van gemaakte goedkeuringen. De standaardwaarde is aflopend.

includeMyGroupApprovals: boolean

'waar' om mijn groepsgoedkeuringen op te nemen. De standaardwaarde is 'false'.

Retouren

Promise<PagedList<ReleaseApproval>>

getArtifactTypeDefinitions(string)

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

Parameters

project: string

Project-id of projectnaam

Retouren

Promise<ArtifactTypeDefinition[]>

getArtifactVersions(string, number)

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

Parameters

project: string

Project-id of projectnaam

releaseDefinitionId: number

Retouren

Promise<ArtifactVersionQueryResult>

getArtifactVersionsForSources(Artifact[], string)

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

Parameters

artifacts: Artifact[]

project: string

Project-id of projectnaam

Retouren

Promise<ArtifactVersionQueryResult>

getAutoTriggerIssues(string, string, string, string)

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

Parameters

artifactType: string

sourceId: string

artifactVersionId: string

project: string

Project-id of projectnaam

Retouren

Promise<AutoTriggerIssue[]>

getDefinitionEnvironments(string, string, string[])

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

Parameters

project: string

Project-id of projectnaam

taskGroupId: string

propertyFilters: string[]

Retouren

Promise<DefinitionEnvironmentReference[]>

getDefinitionEnvironmentTemplate(string, string)

Hiermee haalt u een definitieomgevingssjabloon op

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

Parameters

project: string

Project-id of projectnaam

templateId: string

Id van de definitieomgevingssjabloon

Retouren

Promise<ReleaseDefinitionEnvironmentTemplate>

getDefinitionRevision(string, number, number)

Releasedefinitie ophalen voor een bepaalde definitionId en revisie

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

Parameters

project: string

Project-id of projectnaam

definitionId: number

Id van de definitie.

revision: number

Id van de revisie.

Retouren

Promise<string>

getDefinitionTags(string, number)

Hiermee haalt u de tags voor een definitie op

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

Parameters

project: string

Project-id of projectnaam

releaseDefinitionId: number

Retouren

Promise<string[]>

getDeploymentBadge(string, number, number, string)

Hiermee haalt u een badge op die de status van de meest recente implementatie voor een omgeving aangeeft.

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

Parameters

projectId: string

De id van het project.

releaseDefinitionId: number

De id van de releasedefinitie.

environmentId: number

De id van de omgeving.

branchName: string

De naam van de vertakking.

Retouren

Promise<string>

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

Een lijst met implementaties ophalen

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

Parameters

project: string

Project-id of projectnaam

definitionId: number

Vermeld de implementaties voor een bepaalde definitie-id.

definitionEnvironmentId: number

Vermeld de implementaties voor een bepaalde definitie-omgevings-id.

createdBy: string

Vermeld de implementaties waarvoor implementaties worden gemaakt als identiteit opgegeven.

minModifiedTime: Date

Vermeld de implementaties met LastModified-tijd >= minModifiedTime.

maxModifiedTime: Date

Vermeld de implementaties met LastModified-tijd <= maxModifiedTime.

deploymentStatus: DeploymentStatus

Vermeld de implementaties met de opgegeven implementatiestatus. De standaardwaarde is 'Alles'.

operationStatus: DeploymentOperationStatus

Vermeld de implementaties met de opgegeven bewerkingsstatus. De standaardwaarde is 'Alles'.

latestAttemptsOnly: boolean

'waar' om implementaties met alleen de meest recente poging op te nemen. De standaardwaarde is 'false'.

queryOrder: ReleaseQueryOrder

Vermeld de implementaties met een bepaalde queryvolgorde. De standaardwaarde is Aflopend.

top: number

Vermeld de implementaties met de opgegeven top. De standaardtop is '50' en Max top is '100'.

continuationToken: number

Geef de implementaties weer met de implementatie-id >= continuationToken.

createdFor: string

Vermeld de implementaties waarvoor implementaties worden aangevraagd als een opgegeven identiteit.

minStartedTime: Date

Geef de implementaties weer met StartedOn time >= minStartedTime.

maxStartedTime: Date

Geef de implementaties weer met StartedOn time <= maxStartedTime.

sourceBranch: string

Vermeld de implementaties die zijn geïmplementeerd op basis van de opgegeven naam van de vertakking.

Retouren

Promise<PagedList<Deployment>>

getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)

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

Parameters

queryParameters: DeploymentQueryParameters

project: string

Project-id of projectnaam

Retouren

Promise<Deployment[]>

getFavorites(string, string, string)

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

Parameters

project: string

Project-id of projectnaam

scope: string

identityId: string

Retouren

Promise<FavoriteItem[]>

getFolders(string, string, FolderPathQueryOrder)

Hiermee haalt u mappen op.

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

Parameters

project: string

Project-id of projectnaam

path: string

Pad van de map.

queryOrder: FolderPathQueryOrder

Haalt de resultaten op in de gedefinieerde volgorde. De standaardwaarde is 'Geen'.

Retouren

Promise<Folder[]>

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

Poortlogboeken ophalen

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

Id van de release.

environmentId: number

Id van release-omgeving.

gateId: number

Id van de poort.

taskId: number

ReleaseTask-id voor het logboek.

Retouren

Promise<string>

getInputValues(InputValuesQuery, string)

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

Parameters

query: InputValuesQuery

project: string

Project-id of projectnaam

Retouren

Promise<InputValuesQuery>

getIssues(string, number, string)

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

Parameters

project: string

Project-id of projectnaam

buildId: number

sourceId: string

Retouren

Promise<AutoTriggerIssue[]>

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

Logboeken ophalen

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

Id van de release.

environmentId: number

Id van release-omgeving.

taskId: number

ReleaseTask-id voor het logboek.

attemptId: number

Id van de poging.

Retouren

Promise<string>

getLogs(string, number)

Haal logboeken op voor een release-id.

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

Id van de release.

Retouren

Promise<ArrayBuffer>

getManualIntervention(string, number, number)

Handmatige interventie ophalen voor een bepaalde release en handmatige interventie-id.

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

Id van de release.

manualInterventionId: number

Id van de handmatige interventie.

Retouren

Promise<ManualIntervention>

getManualInterventions(string, number)

Vermeld alle handmatige interventies voor een bepaalde release.

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

Id van de release.

Retouren

Promise<ManualIntervention[]>

getMetrics(string, Date)

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

Parameters

project: string

Project-id of projectnaam

minMetricsTime: Date

Retouren

Promise<Metric[]>

getOrgPipelineReleaseSettings()

Release-instellingen voor organisatiepijplijn ophaalt

function getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>

Retouren

Promise<OrgPipelineReleaseSettings>

getPipelineReleaseSettings(string)

Instellingen voor pijplijnrelease worden ophaalt

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

Parameters

project: string

Project-id of projectnaam

Retouren

Promise<ProjectPipelineReleaseSettings>

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

Een release ophalen

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

Id van de release.

approvalFilters: ApprovalFilters

Een filter waarmee goedkeuringsstappen selectief kunnen worden opgehaald op basis van of het geautomatiseerd of handmatig is. Hiermee wordt ook bepaald of we momentopnamen van voorafgaande en na goedkeuring moeten ophalen. Gaat standaard uit van Alles

propertyFilters: string[]

Een door komma's gescheiden lijst met uitgebreide eigenschappen die moeten worden opgehaald. Als deze optie is ingesteld, bevat de geretourneerde release waarden voor de opgegeven eigenschap-id's (indien aanwezig). Als deze niet is ingesteld, worden eigenschappen niet opgenomen.

expand: SingleReleaseExpands

Een eigenschap die moet worden uitgebreid in de release.

topGateRecords: number

Aantal releasepoortrecords dat moet worden get. De standaardwaarde is 5.

includeDisabledDefinitions: boolean

Uitgeschakelde definities opnemen (als deze is ingesteld op 'false' resulteert in een fout, is de standaardwaarde 'true')

Retouren

Promise<Release>

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

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

baseReleaseId: number

top: number

artifactAlias: string

Retouren

Promise<Change[]>

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

Haal een releasedefinitie op.

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

Parameters

project: string

Project-id of projectnaam

definitionId: number

Id van de releasedefinitie.

propertyFilters: string[]

Een door komma's gescheiden lijst met uitgebreide eigenschappen die moeten worden opgehaald. Als deze is ingesteld, bevat de geretourneerde releasedefinitie waarden voor de opgegeven eigenschap-id's (indien aanwezig). Als deze niet is ingesteld, worden eigenschappen niet opgenomen.

includeDisabled: boolean

Booleaanse vlag voor het opnemen van uitgeschakelde definities.

Retouren

Promise<ReleaseDefinition>

getReleaseDefinitionHistory(string, number)

Revisiegeschiedenis voor een releasedefinitie ophalen

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

Parameters

project: string

Project-id of projectnaam

definitionId: number

Id van de definitie.

Retouren

Promise<ReleaseDefinitionRevision[]>

getReleaseDefinitionRevision(string, number, number)

Releasedefinitie van een bepaalde revisie ophalen.

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

Parameters

project: string

Project-id of projectnaam

definitionId: number

Id van de releasedefinitie.

revision: number

Revisienummer van de releasedefinitie.

Retouren

Promise<string>

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

Haal een lijst met releasedefinities op.

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

Parameters

project: string

Project-id of projectnaam

searchText: string

Releasedefinities ophalen met namen die searchText bevatten.

expand: ReleaseDefinitionExpands

De eigenschappen die moeten worden uitgevouwen in de lijst met releasedefinities.

artifactType: string

Releasedefinities met het gegeven artifactType worden geretourneerd. Waarden kunnen build, Jenkins, GitHub, Nuget, Team Build (extern), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild zijn.

artifactSourceId: string

Releasedefinities met opgegeven artifactSourceId worden geretourneerd. Bijvoorbeeld: voor build is dit {projectGuid}:{BuildDefinitionId}, voor Jenkins zou het {JenkinsConnectionId}:{JenkinsDefinitionId}, voor TfsOnPrem, het zou {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId} zijn. Voor artefacten van derden, zoals TeamCity, Kunt u BitBucket verwijzen naar 'uniqueSourceIdentifier' in vss-extension.json op https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.

top: number

Aantal releasedefinities dat moet worden get.

continuationToken: string

Haalt de releasedefinities op nadat het vervolgtoken is opgegeven.

queryOrder: ReleaseDefinitionQueryOrder

Haalt de resultaten op in de gedefinieerde volgorde. De standaardwaarde is IdAscending.

path: string

Hiermee haalt u de releasedefinities onder het opgegeven pad op.

isExactNameMatch: boolean

'true' om de releasedefinities te krijgen met exacte overeenkomst zoals opgegeven in searchText. De standaardwaarde is 'false'.

tagFilter: string[]

Een door komma's gescheiden lijst met tags. Alleen releasedefinities met deze tags worden geretourneerd.

propertyFilters: string[]

Een door komma's gescheiden lijst met uitgebreide eigenschappen die moeten worden opgehaald. Indien ingesteld, bevatten de geretourneerde releasedefinities waarden voor de opgegeven eigenschap-id's (indien aanwezig). Als deze niet is ingesteld, worden eigenschappen niet opgenomen. Houd er rekening mee dat hiermee geen releasedefinitie wordt gefilterd op basis van resultaten, ongeacht of er eigenschappen zijn ingesteld of niet.

definitionIdFilter: string[]

Een door komma's gescheiden lijst met releasedefinities die moeten worden opgehaald.

isDeleted: boolean

'waar' om releasedefinities op te halen die zijn verwijderd. De standaardwaarde is 'false'

searchTextContainsFolderName: boolean

'true' om de releasedefinities op te halen onder de map met de naam die is opgegeven in searchText. De standaardwaarde is 'false'.

Retouren

Promise<PagedList<ReleaseDefinition>>

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

Download de releasesamenvatting van een bepaalde definitie-id.

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

Parameters

project: string

Project-id of projectnaam

definitionId: number

Id van de definitie om een releaseoverzicht op te halen.

releaseCount: number

Het aantal releases dat moet worden opgenomen in een samenvatting.

includeArtifact: boolean

Neem artefactdetails op. De standaardwaarde is 'false'.

definitionEnvironmentIdsFilter: number[]

Retouren

Promise<ReleaseDefinitionSummary>

getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)

Haal een release-omgeving op.

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

Id van de release.

environmentId: number

Id van de release-omgeving.

expand: ReleaseEnvironmentExpands

Een eigenschap die moet worden uitgebreid in de omgeving.

Retouren

Promise<ReleaseEnvironment>

getReleaseHistory(string, number)

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

Retouren

Promise<ReleaseRevision[]>

getReleaseProjects(string, string)

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

Parameters

artifactType: string

artifactSourceId: string

Retouren

Promise<ProjectReference[]>

getReleaseRevision(string, number, number)

Download release voor een bepaald revisienummer.

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

Id van de release.

definitionSnapshotRevision: number

Revisienummer van definitiemomentopname.

Retouren

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)

Een lijst met releases ophalen

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

Parameters

project: string

Project-id of projectnaam

definitionId: number

Releases van deze releasedefinitie-id.

definitionEnvironmentId: number

searchText: string

Releases met namen die searchText bevatten.

createdBy: string

Releases die door deze gebruiker zijn gemaakt.

statusFilter: ReleaseStatus

Releases met deze status.

environmentStatusFilter: number

minCreatedTime: Date

Releases die na deze tijd zijn gemaakt.

maxCreatedTime: Date

Releases die vóór deze tijd zijn gemaakt.

queryOrder: ReleaseQueryOrder

Hiermee haalt u de resultaten op in de gedefinieerde volgorde van de gemaakte datum voor releases. De standaardwaarde is aflopend.

top: number

Aantal releases dat moet worden get. De standaardwaarde is 50.

continuationToken: number

Haalt de releases op na het opgegeven vervolgtoken.

expand: ReleaseExpands

De eigenschap die moet worden uitgevouwen in de lijst met releases.

artifactTypeId: string

Releases met opgegeven artifactTypeId worden geretourneerd. Waarden kunnen build, Jenkins, GitHub, Nuget, Team Build (extern), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild zijn.

sourceId: string

Unieke id van het gebruikte artefact. Bijvoorbeeld: voor build is dit {projectGuid}:{BuildDefinitionId}, voor Jenkins zou het {JenkinsConnectionId}:{JenkinsDefinitionId}, voor TfsOnPrem, het zou {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId} zijn. Voor artefacten van derden, zoals TeamCity, BitBucket, kunt u 'uniqueSourceIdentifier' in vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensionsraadplegen.

artifactVersionId: string

Releases met opgegeven artifactVersionId worden geretourneerd. In het geval van Build artifactType is dit bijvoorbeeld buildId.

sourceBranchFilter: string

Releases met opgegeven sourceBranchFilter worden geretourneerd (niet te gebruiken met environmentStatusFilter).

isDeleted: boolean

Hiermee haalt u de voorlopig verwijderde releases op, indien waar.

tagFilter: string[]

Een door komma's gescheiden lijst met tags. Alleen releases met deze tags worden geretourneerd.

propertyFilters: string[]

Een door komma's gescheiden lijst met uitgebreide eigenschappen die moeten worden opgehaald. Indien ingesteld, bevatten de geretourneerde releases waarden voor de opgegeven eigenschap-id's (indien aanwezig). Als deze niet is ingesteld, worden eigenschappen niet opgenomen. Houd er rekening mee dat hiermee geen release van resultaten wordt uitgefilterd, ongeacht of de eigenschap is ingesteld of niet.

releaseIdFilter: number[]

Een door komma's gescheiden lijst met releases-id's. Alleen releases met deze id's worden geretourneerd.

path: string

Releases onder dit mappad worden geretourneerd

Retouren

Promise<Release[]>

getReleaseSettings(string)

Haalt de release-instellingen op

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

Parameters

project: string

Project-id of projectnaam

Retouren

Promise<ReleaseSettings>

getReleaseTags(string, number)

Haalt de tags voor een release op

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

Retouren

Promise<string[]>

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

Haal een releasetaakbijlage op.

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

Id van de release.

environmentId: number

Id van de release-omgeving.

attemptId: number

Aantal implementatiepogingen.

planId: string

Plan-id van de implementatiefase.

timelineId: string

Tijdlijn-id van de taak.

recordId: string

Record-id van bijlage.

type: string

Type bijlage.

name: string

Naam van de bijlage.

Retouren

Promise<ArrayBuffer>

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

Haal de releasetaakbijlagen op.

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

Id van de release.

environmentId: number

Id van de release-omgeving.

attemptId: number

Aantal implementatiepogingen.

planId: string

Plan-id van de implementatiefase.

type: string

Type bijlage.

Retouren

Promise<ReleaseTaskAttachment[]>

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

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

baseReleaseId: number

top: number

artifactAlias: string

Retouren

Promise<ReleaseWorkItemRef[]>

getSourceBranches(string, number)

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

Parameters

project: string

Project-id of projectnaam

definitionId: number

Retouren

Promise<string[]>

getSummaryMailSections(string, number)

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

Retouren

Promise<SummaryMailSection[]>

getTags(string)

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

Parameters

project: string

Project-id of projectnaam

Retouren

Promise<string[]>

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

Een taakbijlage ophalen.

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

Id van de release.

environmentId: number

Id van de release-omgeving.

attemptId: number

Aantal implementatiepogingen.

timelineId: string

Tijdlijn-id van de taak.

recordId: string

Record-id van bijlage.

type: string

Type bijlage.

name: string

Naam van de bijlage.

Retouren

Promise<ArrayBuffer>

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

Haal de taakbijlagen op.

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

Id van de release.

environmentId: number

Id van de release-omgeving.

attemptId: number

Aantal implementatiepogingen.

timelineId: string

Tijdlijn-id van de taak.

type: string

Type bijlage.

Retouren

Promise<ReleaseTaskAttachment[]>

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

Hiermee haalt u het taaklogboek van een release op als een tekstbestand zonder opmaak.

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

Id van de release.

environmentId: number

Id van release-omgeving.

releaseDeployPhaseId: number

Fase-id release-implementatie.

taskId: number

ReleaseTask-id voor het logboek.

startLine: number

Regelnummer voor logboeken starten

endLine: number

Eindregelnummer voor logboeken

Retouren

Promise<string>

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

Hiermee haalt u het taaklogboek van een release op als een tekstbestand zonder opmaak.

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

Id van de release.

environmentId: number

Id van release-omgeving.

attemptId: number

timelineId: string

taskId: number

ReleaseTask-id voor het logboek.

startLine: number

Regelnummer voor logboeken starten

endLine: number

Eindregelnummer voor logboeken

Retouren

Promise<string>

getTasks(string, number, number, number)

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

environmentId: number

attemptId: number

Retouren

Promise<ReleaseTask[]>

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

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

environmentId: number

attemptId: number

timelineId: string

Retouren

Promise<ReleaseTask[]>

getTasksForTaskGroup(string, number, number, number)

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

environmentId: number

releaseDeployPhaseId: number

Retouren

Promise<ReleaseTask[]>

listDefinitionEnvironmentTemplates(string, boolean)

Hiermee haalt u een lijst met definitieomgevingssjablonen op

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

Parameters

project: string

Project-id of projectnaam

isDeleted: boolean

Waar om definitieomgevingssjablonen op te halen die zijn verwijderd. De standaardwaarde is 'false'

Retouren

Promise<ReleaseDefinitionEnvironmentTemplate[]>

sendSummaryMail(MailMessage, string, number)

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

Parameters

mailMessage: MailMessage

project: string

Project-id of projectnaam

releaseId: number

Retouren

Promise<void>

undeleteRelease(string, number, string)

De verwijdering van een voorlopig verwijderde release ongedaan maken.

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

Parameters

project: string

Project-id of projectnaam

releaseId: number

Id van release die ongedaan moet worden gemaakt.

comment: string

Eventuele opmerkingen voor het ongedaan maken van verwijdering.

Retouren

Promise<void>

undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)

De releasedefinitie ongedaan maken.

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

Parameters

releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter

Object voor het ongedaan maken van de releasedefinitie.

project: string

Project-id of projectnaam

definitionId: number

Id van de releasedefinitie die ongedaan moet worden gemaakt

Retouren

Promise<ReleaseDefinition>

undeleteReleaseDefinitionEnvironmentTemplate(string, string)

Een sjabloon voor de releasedefinitieomgeving ongedaan maken.

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

Parameters

project: string

Project-id of projectnaam

templateId: string

Id van de definitieomgevingssjabloon die ongedaan moet worden gemaakt

Retouren

Promise<ReleaseDefinitionEnvironmentTemplate>

updateFolder(Folder, string, string)

Hiermee wordt een bestaande map bijgewerkt op het opgegeven bestaande pad.

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

Parameters

folder: Folder

map.

project: string

Project-id of projectnaam

path: string

Pad van de map die moet worden bijgewerkt.

Retouren

Promise<Folder>

updateGates(GateUpdateMetadata, string, number)

Hiermee werkt u de poort voor een implementatie bij.

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

Parameters

gateUpdateMetadata: GateUpdateMetadata

Metagegevens om de releasepoorten te patchen.

project: string

Project-id of projectnaam

gateStepId: number

Stap-id van poort.

Retouren

Promise<ReleaseGates>

updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)

Handmatige interventie bijwerken.

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

Parameters

manualInterventionUpdateMetadata: ManualInterventionUpdateMetadata

Metagegevens voor het bijwerken van handmatige interventie.

project: string

Project-id of projectnaam

releaseId: number

Id van de release.

manualInterventionId: number

Id van de handmatige interventie.

Retouren

Promise<ManualIntervention>

updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)

Release-instellingen voor organisatiepijplijnen bijwerken

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

Parameters

newSettings: OrgPipelineReleaseSettingsUpdateParameters

Retouren

Promise<OrgPipelineReleaseSettings>

updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)

Release-instellingen voor pijplijn bijwerken

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

Parameters

newSettings: ProjectPipelineReleaseSettingsUpdateParameters

project: string

Project-id of projectnaam

Retouren

Promise<ProjectPipelineReleaseSettings>

updateRelease(Release, string, number)

Een volledig releaseobject bijwerken.

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

Parameters

release: Release

Releaseobject voor update.

project: string

Project-id of projectnaam

releaseId: number

Id van de release die moet worden bijgewerkt.

Retouren

Promise<Release>

updateReleaseApproval(ReleaseApproval, string, number)

Status van een goedkeuring bijwerken

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

Parameters

approval: ReleaseApproval

ReleaseApproval-object met status, fiatteur en opmerkingen.

project: string

Project-id of projectnaam

approvalId: number

Id van de goedkeuring.

Retouren

Promise<ReleaseApproval>

updateReleaseApprovals(ReleaseApproval[], string)

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

Parameters

approvals: ReleaseApproval[]

project: string

Project-id of projectnaam

Retouren

Promise<ReleaseApproval[]>

updateReleaseDefinition(ReleaseDefinition, string, boolean)

Een releasedefinitie bijwerken.

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

Parameters

releaseDefinition: ReleaseDefinition

Releasedefinitieobject dat moet worden bijgewerkt.

project: string

Project-id of projectnaam

skipTasksValidation: boolean

Booleaanse vlag voor taakvalidatie overslaan

Retouren

Promise<ReleaseDefinition>

updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)

De status van een release-omgeving bijwerken

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

Parameters

environmentUpdateData: ReleaseEnvironmentUpdateMetadata

Metagegevens in de omgeving bijwerken.

project: string

Project-id of projectnaam

releaseId: number

Id van de release.

environmentId: number

Id van release-omgeving.

Retouren

Promise<ReleaseEnvironment>

updateReleaseResource(ReleaseUpdateMetadata, string, number)

Werk enkele eigenschappen van een release bij.

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

Parameters

releaseUpdateMetadata: ReleaseUpdateMetadata

Eigenschappen van release die moeten worden bijgewerkt.

project: string

Project-id of projectnaam

releaseId: number

Id van de release die moet worden bijgewerkt.

Retouren

Promise<Release>

updateReleaseSettings(ReleaseSettings, string)

De release-instellingen bijwerken

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

Parameters

releaseSettings: ReleaseSettings

project: string

Project-id of projectnaam

Retouren

Promise<ReleaseSettings>

Feedback

Is deze pagina nuttig?

Delen via

ReleaseRestClient class

Constructors

Eigenschappen

Methoden

Constructordetails

ReleaseRestClient(IVssRestClientOptions)

Parameters

Eigenschapdetails

RESOURCE_AREA_ID

Waarde van eigenschap

Methodedetails

addDefinitionTag(string, number, string)

Parameters

Retouren

addDefinitionTags(string[], string, number)

Parameters

Retouren

addReleaseTag(string, number, string)

Parameters

Retouren

addReleaseTags(string[], string, number)

Parameters

Retouren

createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)

Parameters

Retouren

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

Parameters

Retouren

createFolder(Folder, string, string)

Parameters

Retouren

createRelease(ReleaseStartMetadata, string)

Parameters

Retouren

createReleaseDefinition(ReleaseDefinition, string)

Parameters

Retouren

deleteDefinitionEnvironmentTemplate(string, string)

Parameters

Retouren

deleteDefinitionTag(string, number, string)

Parameters

Retouren

deleteFavorites(string, string, string, string)

Parameters

Retouren

deleteFolder(string, string)

Parameters

Retouren

deleteRelease(string, number, string)

Parameters

Retouren

deleteReleaseDefinition(string, number, string, boolean)

Parameters

Retouren

deleteReleaseTag(string, number, string)

Parameters

Retouren

getAgentArtifactDefinitions(string, number)

Parameters

Retouren

getApproval(string, number, boolean)

Parameters

Retouren

getApprovalHistory(string, number)

Parameters

Retouren

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

Parameters

Retouren

getArtifactTypeDefinitions(string)

Parameters

Retouren

getArtifactVersions(string, number)

Parameters

Retouren

getArtifactVersionsForSources(Artifact[], string)

Parameters