ReleaseRestClient class

Reference

Balíček:: azure-devops-extension-api

Základní třída, která by se měla používat (odvozená z) k vytváření požadavků na rozhraní REST api služby VSS

Extends: RestClientBase

Konstruktory

ReleaseRestClient(IVssRestClientOptions)

Vlastnosti

RESOURCE_AREA_ID

Metody

addDefinitionTag(string, number, string)	Přidá značku do definice.
addDefinitionTags(string[], string, number)	Přidá do definice více značek.
addReleaseTag(string, number, string)	Přidá značku do releaseId.
addReleaseTags(string[], string, number)	Přidá značku do vydané verze.
createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)	Vytvoří šablonu definičního prostředí.
createFavorites(FavoriteItem[], string, string, string)
createFolder(Folder, string, string)	Vytvoří novou složku.
createRelease(ReleaseStartMetadata, string)	Create vydání.
createReleaseDefinition(ReleaseDefinition, string)	Vytvoření definice verze
deleteDefinitionEnvironmentTemplate(string, string)	Odstranění šablony definičního prostředí
deleteDefinitionTag(string, number, string)	Odstraní značku z definice.
deleteFavorites(string, string, string, string)
deleteFolder(string, string)	Odstraní složku definic pro daný název složky a cestu a všechny její existující definice.
deleteRelease(string, number, string)	Obnovitelné odstranění vydané verze
deleteReleaseDefinition(string, number, string, boolean)	Odstraňte definici vydané verze.
deleteReleaseTag(string, number, string)	Odstraní značku z vydané verze.
getAgentArtifactDefinitions(string, number)	Vrátí podrobnosti artefaktu, které vyžaduje agent automatizace.
getApproval(string, number, boolean)	Získejte schválení.
getApprovalHistory(string, number)	Získejte historii schválení.
getApprovals(string, string, ApprovalStatus, number[], ApprovalType, number, number, ReleaseQueryOrder, boolean)	Získání seznamu schválení
getArtifactTypeDefinitions(string)
getArtifactVersions(string, number)
getArtifactVersionsForSources(Artifact[], string)
getAutoTriggerIssues(string, string, string, string)
getDefinitionEnvironments(string, string, string[])
getDefinitionEnvironmentTemplate(string, string)	Získá šablonu definičního prostředí.
getDefinitionRevision(string, number, number)	Získání definice verze pro dané id definice a revizi
getDefinitionTags(string, number)	Získá značky pro definici.
getDeploymentBadge(string, number, number, string)	Získá odznáček, který označuje stav posledního nasazení pro prostředí.
getDeployments(string, number, number, string, Date, Date, DeploymentStatus, DeploymentOperationStatus, boolean, ReleaseQueryOrder, number, number, string, Date, Date, string)	Získání seznamu nasazení
getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)
getFavorites(string, string, string)
getFlightAssignments(string)
getFolders(string, string, FolderPathQueryOrder)	Získá složky.
getGateLog(string, number, number, number, number)	Získá protokoly brány.
getInputValues(InputValuesQuery, string)
getIssues(string, number, string)
getLog(string, number, number, number, number)	Získá protokoly.
getLogs(string, number)	Získejte protokoly pro ID verze.
getManualIntervention(string, number, number)	Získejte ruční zásah pro danou verzi a ID ručního zásahu.
getManualInterventions(string, number)	Zobrazí seznam všech ručních zásahů pro danou verzi.
getMetrics(string, Date)
getOrgPipelineReleaseSettings()	Získá nastavení vydání kanálu organizace.
getPipelineReleaseSettings(string)	Získá nastavení verze kanálu.
getRelease(string, number, ApprovalFilters, string[], SingleReleaseExpands, number)	Získat verzi
getReleaseChanges(string, number, number, number, string)
getReleaseDefinition(string, number, string[])	Získejte definici vydané verze.
getReleaseDefinitionHistory(string, number)	Získání historie revizí pro definici vydané verze
getReleaseDefinitionRevision(string, number, number)	Získejte definici verze dané revize.
getReleaseDefinitions(string, string, ReleaseDefinitionExpands, string, string, number, string, ReleaseDefinitionQueryOrder, string, boolean, string[], string[], string[], boolean, boolean)	Získejte seznam definic vydaných verzí.
getReleaseDefinitionSummary(string, number, number, boolean, number[])	Získejte souhrn verze daného ID definice.
getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)	Získejte prostředí vydané verze.
getReleaseHistory(string, number)
getReleaseProjects(string, string)
getReleaseRevision(string, number, number)	Získejte verzi pro dané číslo revize.
getReleases(string, number, number, string, string, ReleaseStatus, number, Date, Date, ReleaseQueryOrder, number, number, ReleaseExpands, string, string, string, string, boolean, string[], string[], number[], string)	Získání seznamu verzí
getReleaseSettings(string)	Získá nastavení vydané verze.
getReleaseTags(string, number)	Získá značky pro verzi.
getReleaseTaskAttachmentContent(string, number, number, number, string, string, string, string, string)	Získejte přílohu úkolu vydané verze.
getReleaseTaskAttachments(string, number, number, number, string, string)	Získejte přílohy k úkolu vydané verze.
getReleaseWorkItemsRefs(string, number, number, number, string)
getSourceBranches(string, number)
getSummaryMailSections(string, number)
getTags(string)
getTaskAttachmentContent(string, number, number, number, string, string, string, string)	Získejte přílohu k úkolu.
getTaskAttachments(string, number, number, number, string, string)	Získejte přílohy k úkolu.
getTaskLog(string, number, number, number, number, number, number)	Získá protokol úloh vydané verze jako soubor ve formátu prostého textu.
getTaskLog2(string, number, number, number, string, number, number, number)	Získá protokol úloh vydané verze jako soubor ve formátu prostého textu.
getTasks(string, number, number, number)
getTasks2(string, number, number, number, string)
getTasksForTaskGroup(string, number, number, number)
listDefinitionEnvironmentTemplates(string, boolean)	Získá seznam šablon prostředí definic.
sendSummaryMail(MailMessage, string, number)
undeleteRelease(string, number, string)	Obnovení obnovitelné odstraněné verze
undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)	Zrušení odstranění definice vydané verze
undeleteReleaseDefinitionEnvironmentTemplate(string, string)	Zrušení odstranění šablony prostředí definice vydané verze
updateFolder(Folder, string, string)	Aktualizace existující složku v dané existující cestě.
updateGates(GateUpdateMetadata, string, number)	Aktualizace bránu nasazení.
updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)	Aktualizujte ruční zásah.
updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)	Aktualizace nastavení vydání kanálu organizace
updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)	nastavení verze kanálu Aktualizace
updateRelease(Release, string, number)	Aktualizujte objekt úplné verze.
updateReleaseApproval(ReleaseApproval, string, number)	Aktualizace stavu schválení
updateReleaseApprovals(ReleaseApproval[], string)
updateReleaseDefinition(ReleaseDefinition, string)	Aktualizujte definici vydané verze.
updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)	Aktualizace stavu prostředí vydané verze
updateReleaseResource(ReleaseUpdateMetadata, string, number)	Aktualizujte několik vlastností vydané verze.
updateReleaseSettings(ReleaseSettings, string)	Aktualizace nastavení verze

Podrobnosti konstruktoru

ReleaseRestClient(IVssRestClientOptions)

new ReleaseRestClient(options: IVssRestClientOptions)

Parametry

options: IVssRestClientOptions

Podrobnosti vlastnosti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Hodnota vlastnosti

string

Podrobnosti metody

addDefinitionTag(string, number, string)

Přidá značku do definice.

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

Parametry

project: string

ID projektu nebo název projektu

releaseDefinitionId: number

tag: string

Návraty

Promise<string[]>

addDefinitionTags(string[], string, number)

Přidá do definice více značek.

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

Parametry

tags: string[]

project: string

ID projektu nebo název projektu

releaseDefinitionId: number

Návraty

Promise<string[]>

addReleaseTag(string, number, string)

Přidá značku do releaseId.

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

tag: string

Návraty

Promise<string[]>

addReleaseTags(string[], string, number)

Přidá značku do vydané verze.

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

Parametry

tags: string[]

project: string

ID projektu nebo název projektu

releaseId: number

Návraty

Promise<string[]>

createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)

Vytvoří šablonu definičního prostředí.

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

Parametry

template: ReleaseDefinitionEnvironmentTemplate

Šablona prostředí definice, která se má vytvořit

project: string

ID projektu nebo název projektu

Návraty

Promise<ReleaseDefinitionEnvironmentTemplate>

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

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

Parametry

favoriteItems: FavoriteItem[]

project: string

ID projektu nebo název projektu

scope: string

identityId: string

Návraty

Promise<FavoriteItem[]>

createFolder(Folder, string, string)

Vytvoří novou složku.

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

Parametry

folder: Folder

Složky.

project: string

ID projektu nebo název projektu

path: string

Cesta ke složce

Návraty

Promise<Folder>

createRelease(ReleaseStartMetadata, string)

Create vydání.

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

Parametry

releaseStartMetadata: ReleaseStartMetadata

Metadata pro vytvoření verze

project: string

ID projektu nebo název projektu

Návraty

Promise<Release>

createReleaseDefinition(ReleaseDefinition, string)

Vytvoření definice verze

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

Parametry

releaseDefinition: ReleaseDefinition

objekt definice verze, který se má vytvořit.

project: string

ID projektu nebo název projektu

Návraty

Promise<ReleaseDefinition>

deleteDefinitionEnvironmentTemplate(string, string)

Odstranění šablony definičního prostředí

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

Parametry

project: string

ID projektu nebo název projektu

templateId: string

ID šablony definičního prostředí

Návraty

Promise<void>

deleteDefinitionTag(string, number, string)

Odstraní značku z definice.

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

Parametry

project: string

ID projektu nebo název projektu

releaseDefinitionId: number

tag: string

Návraty

Promise<string[]>

deleteFavorites(string, string, string, string)

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

Parametry

project: string

ID projektu nebo název projektu

scope: string

identityId: string

favoriteItemIds: string

Návraty

Promise<void>

deleteFolder(string, string)

Odstraní složku definic pro daný název složky a cestu a všechny její existující definice.

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

Parametry

project: string

ID projektu nebo název projektu

path: string

Cesta ke složce, kterou chcete odstranit.

Návraty

Promise<void>

deleteRelease(string, number, string)

Obnovitelné odstranění vydané verze

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

ID vydané verze.

comment: string

Komentář k odstranění vydané verze

Návraty

Promise<void>

deleteReleaseDefinition(string, number, string, boolean)

Odstraňte definici vydané verze.

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

Parametry

project: string

ID projektu nebo název projektu

definitionId: number

ID definice vydané verze.

comment: string

Komentář k odstranění definice vydané verze

forceDelete: boolean

"true" automaticky zruší všechna probíhající nasazení vydaných verzí a pokračovat v odstranění definice vydané verze . Výchozí hodnota je false.

Návraty

Promise<void>

deleteReleaseTag(string, number, string)

Odstraní značku z vydané verze.

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

tag: string

Návraty

Promise<string[]>

getAgentArtifactDefinitions(string, number)

Vrátí podrobnosti artefaktu, které vyžaduje agent automatizace.

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

Návraty

Promise<AgentArtifactDefinition[]>

getApproval(string, number, boolean)

Získejte schválení.

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

Parametry

project: string

ID projektu nebo název projektu

approvalId: number

ID schválení.

includeHistory: boolean

"true", aby zahrnovalo historii schválení. Výchozí hodnota je false.

Návraty

Promise<ReleaseApproval>

getApprovalHistory(string, number)

Získejte historii schválení.

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

Parametry

project: string

ID projektu nebo název projektu

approvalStepId: number

ID schválení.

Návraty

Promise<ReleaseApproval>

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

Získání seznamu schválení

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

Parametry

project: string

ID projektu nebo název projektu

assignedToFilter: string

Schválení přiřazená tomuto uživateli.

statusFilter: ApprovalStatus

Schválení s tímto stavem. Výchozí hodnota je čekající na vyřízení.

releaseIdsFilter: number[]

Schválení pro ID verzí uvedená ve filtru. Více vydaných verzí je možné uvést tak, že je oddělíte pomocí ,, například releaseIdsFilter=1,2,3,4.

typeFilter: ApprovalType

Schválení s tímto typem.

top: number

Počet schválení, která je potřeba získat. Výchozí hodnota je 50.

continuationToken: number

Získá schválení po poskytnutém tokenu pokračování.

queryOrder: ReleaseQueryOrder

Získá výsledky v definovaném pořadí vytvořených schválení. Výchozí hodnota je sestupná.

includeMyGroupApprovals: boolean

"true", aby zahrnovala schválení mé skupiny. Výchozí hodnota je false.

Návraty

Promise<PagedList<ReleaseApproval>>

getArtifactTypeDefinitions(string)

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

Parametry

project: string

ID projektu nebo název projektu

Návraty

Promise<ArtifactTypeDefinition[]>

getArtifactVersions(string, number)

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

Parametry

project: string

ID projektu nebo název projektu

releaseDefinitionId: number

Návraty

Promise<ArtifactVersionQueryResult>

getArtifactVersionsForSources(Artifact[], string)

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

Parametry

artifacts: Artifact[]

project: string

ID projektu nebo název projektu

Návraty

Promise<ArtifactVersionQueryResult>

getAutoTriggerIssues(string, string, string, string)

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

Parametry

artifactType: string

sourceId: string

artifactVersionId: string

project: string

ID projektu nebo název projektu

Návraty

Promise<AutoTriggerIssue[]>

getDefinitionEnvironments(string, string, string[])

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

Parametry

project: string

ID projektu nebo název projektu

taskGroupId: string

propertyFilters: string[]

Návraty

Promise<DefinitionEnvironmentReference[]>

getDefinitionEnvironmentTemplate(string, string)

Získá šablonu definičního prostředí.

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

Parametry

project: string

ID projektu nebo název projektu

templateId: string

ID šablony definičního prostředí

Návraty

Promise<ReleaseDefinitionEnvironmentTemplate>

getDefinitionRevision(string, number, number)

Získání definice verze pro dané id definice a revizi

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

Parametry

project: string

ID projektu nebo název projektu

definitionId: number

ID definice.

revision: number

ID revize.

Návraty

Promise<string>

getDefinitionTags(string, number)

Získá značky pro definici.

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

Parametry

project: string

ID projektu nebo název projektu

releaseDefinitionId: number

Návraty

Promise<string[]>

getDeploymentBadge(string, number, number, string)

Získá odznáček, který označuje stav posledního nasazení pro prostředí.

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

Parametry

projectId: string

ID projektu.

releaseDefinitionId: number

ID definice vydané verze.

environmentId: number

ID prostředí.

branchName: string

Název větve.

Návraty

Promise<string>

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

Získání seznamu nasazení

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

Parametry

project: string

ID projektu nebo název projektu

definitionId: number

Vypište nasazení pro dané ID definice.

definitionEnvironmentId: number

Vypište nasazení pro dané ID prostředí definice.

createdBy: string

Vypište nasazení, pro která se nasazení vytvoří jako zadaná identita.

minModifiedTime: Date

Vypište nasazení s hodnotou LastModified time >= minModifiedTime.

maxModifiedTime: Date

Vypište nasazení s parametrem LastModified time <= maxModifiedTime.

deploymentStatus: DeploymentStatus

Vypište nasazení s daným stavem nasazení. Výchozí hodnota je Vše.

operationStatus: DeploymentOperationStatus

Vypište nasazení s daným stavem operace. Výchozí hodnota je Vše.

latestAttemptsOnly: boolean

"true", aby zahrnovala nasazení pouze s nejnovějším pokusem. Výchozí hodnota je false.

queryOrder: ReleaseQueryOrder

Vypište nasazení s daným pořadím dotazů. Výchozí hodnota je Sestupně.

top: number

Vypište nasazení s daným vrcholem. Výchozí horní hodnota je 50 a maximální horní hodnota je 100.

continuationToken: number

Vypište nasazení s ID >nasazení = continuationToken.

createdFor: string

Vypište nasazení, pro která se vyžaduje nasazení, jako zadanou identitu.

minStartedTime: Date

Vypište nasazení pomocí hodnoty StartedOn time >= minStartedTime.

maxStartedTime: Date

Vypište nasazení s parametrem StartedOn time <= maxStartedTime.

sourceBranch: string

Vypište nasazení nasazená z daného názvu větve.

Návraty

Promise<PagedList<Deployment>>

getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)

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

Parametry

queryParameters: DeploymentQueryParameters

project: string

ID projektu nebo název projektu

Návraty

Promise<Deployment[]>

getFavorites(string, string, string)

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

Parametry

project: string

ID projektu nebo název projektu

scope: string

identityId: string

Návraty

Promise<FavoriteItem[]>

getFlightAssignments(string)

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

Parametry

flightName: string

Návraty

Promise<string[]>

getFolders(string, string, FolderPathQueryOrder)

Získá složky.

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

Parametry

project: string

ID projektu nebo název projektu

path: string

Cesta ke složce

queryOrder: FolderPathQueryOrder

Získá výsledky v definovaném pořadí. Výchozí hodnota je Žádná.

Návraty

Promise<Folder[]>

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

Získá protokoly brány.

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

ID vydané verze.

environmentId: number

ID prostředí vydané verze.

gateId: number

ID brány.

taskId: number

ReleaseTask ID protokolu.

Návraty

Promise<string>

getInputValues(InputValuesQuery, string)

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

Parametry

query: InputValuesQuery

project: string

ID projektu nebo název projektu

Návraty

Promise<InputValuesQuery>

getIssues(string, number, string)

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

Parametry

project: string

ID projektu nebo název projektu

buildId: number

sourceId: string

Návraty

Promise<AutoTriggerIssue[]>

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

Získá protokoly.

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

ID vydané verze.

environmentId: number

ID prostředí vydané verze.

taskId: number

ReleaseTask ID protokolu.

attemptId: number

ID pokusu.

Návraty

Promise<string>

getLogs(string, number)

Získejte protokoly pro ID verze.

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

ID vydané verze.

Návraty

Promise<ArrayBuffer>

getManualIntervention(string, number, number)

Získejte ruční zásah pro danou verzi a ID ručního zásahu.

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

ID vydané verze.

manualInterventionId: number

Id ručního zásahu.

Návraty

Promise<ManualIntervention>

getManualInterventions(string, number)

Zobrazí seznam všech ručních zásahů pro danou verzi.

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

ID vydané verze.

Návraty

Promise<ManualIntervention[]>

getMetrics(string, Date)

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

Parametry

project: string

ID projektu nebo název projektu

minMetricsTime: Date

Návraty

Promise<Metric[]>

getOrgPipelineReleaseSettings()

Získá nastavení vydání kanálu organizace.

function getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>

Návraty

Promise<OrgPipelineReleaseSettings>

getPipelineReleaseSettings(string)

Získá nastavení verze kanálu.

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

Parametry

project: string

ID projektu nebo název projektu

Návraty

Promise<ProjectPipelineReleaseSettings>

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

Získat verzi

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

ID vydané verze.

approvalFilters: ApprovalFilters

Filtr, který by umožňoval načíst schvalovací kroky selektivně podle toho, jestli je to automatizované, nebo ruční. To by také rozhodlo, jestli máme načíst snímky před a po schválení. Ve výchozím nastavení předpokládá vše.

propertyFilters: string[]

Seznam rozšířených vlastností oddělených čárkami, které se mají načíst. Pokud je tato vlastnost nastavená, bude vrácená verze obsahovat hodnoty pro ID zadané vlastnosti (pokud existují). Pokud není nastaveno, vlastnosti nebudou zahrnuty.

expand: SingleReleaseExpands

Vlastnost, která by měla být ve vydané verzi rozšířena.

topGateRecords: number

Počet záznamů o vydanou bránu, které chcete získat. Výchozí hodnota je 5.

Návraty

Promise<Release>

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

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

baseReleaseId: number

top: number

artifactAlias: string

Návraty

Promise<Change[]>

getReleaseDefinition(string, number, string[])

Získejte definici vydané verze.

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

Parametry

project: string

ID projektu nebo název projektu

definitionId: number

ID definice vydané verze.

propertyFilters: string[]

Seznam rozšířených vlastností oddělených čárkami, které se mají načíst. Pokud je tato vlastnost nastavená, bude vrácená definice verze obsahovat hodnoty pro id zadané vlastnosti (pokud existují). Pokud není nastaveno, vlastnosti nebudou zahrnuty.

Návraty

Promise<ReleaseDefinition>

getReleaseDefinitionHistory(string, number)

Získání historie revizí pro definici vydané verze

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

Parametry

project: string

ID projektu nebo název projektu

definitionId: number

ID definice.

Návraty

Promise<ReleaseDefinitionRevision[]>

getReleaseDefinitionRevision(string, number, number)

Získejte definici verze dané revize.

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

Parametry

project: string

ID projektu nebo název projektu

definitionId: number

ID definice vydané verze.

revision: number

Číslo revize definice vydané verze.

Návraty

Promise<string>

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

Získejte seznam definic vydaných verzí.

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

Parametry

project: string

ID projektu nebo název projektu

searchText: string

Získejte definice vydané verze s názvy obsahujícími searchText.

expand: ReleaseDefinitionExpands

Vlastnosti, které by měly být rozbalené v seznamu definic vydané verze.

artifactType: string

Vrátí se definice verzí s daným artifactType. Hodnoty můžou být Build, Jenkins, GitHub, NuGet, Team Build (externí), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.

artifactSourceId: string

Vrátí se definice verzí s daným identifikátorem artifactSourceId. Například pro sestavení by to bylo {projectGuid}:{BuildDefinitionId}, pro Jenkins by to bylo {JenkinsConnectionId}:{JenkinsDefinitionId}, pro TfsOnPrem by to bylo {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. U artefaktů třetích stran, jako je TeamCity nebo BitBucket, můžete odkazovat na uniqueSourceIdentifier uvnitř vss-extension.json na adrese https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.

top: number

Počet definic vydaných verzí, které se mají získat

continuationToken: string

Získá definice verze po poskytnutém tokenu pokračování.

queryOrder: ReleaseDefinitionQueryOrder

Získá výsledky v definovaném pořadí. Výchozí hodnota je IdAscending.

path: string

Získá definice verze v zadané cestě.

isExactNameMatch: boolean

Hodnota true získá definice vydané verze s přesnou shodou, jak je uvedeno v searchText. Výchozí hodnota je false.

tagFilter: string[]

Seznam značek oddělených čárkami. Vrátí se pouze definice verzí s těmito značkami.

propertyFilters: string[]

Seznam rozšířených vlastností oddělených čárkami, které mají být načteny. Pokud se nastaví, vrácené definice vydané verze budou obsahovat hodnoty pro id zadaných vlastností (pokud existují). Pokud nenastavíte, vlastnosti nebudou zahrnuty. Upozorňujeme, že se tím nevyfiltruje žádná definice vydané verze z výsledků bez ohledu na to, jestli má nastavenou vlastnost.

definitionIdFilter: string[]

Seznam definic vydaných verzí oddělených čárkami, které se mají načíst.

isDeleted: boolean

Hodnota true pro získání definic vydané verze, která byla odstraněna. Výchozí hodnota je false.

searchTextContainsFolderName: boolean

"true" pro získání definic vydané verze ve složce s názvem, jak je uvedeno v searchText. Výchozí hodnota je false.

Návraty

Promise<PagedList<ReleaseDefinition>>

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

Získejte souhrn verze daného ID definice.

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

Parametry

project: string

ID projektu nebo název projektu

definitionId: number

ID definice pro získání souhrnu vydané verze

releaseCount: number

Počet verzí, které se mají zahrnout do souhrnu

includeArtifact: boolean

Uveďte podrobnosti o artefaktech. Výchozí hodnota je false.

definitionEnvironmentIdsFilter: number[]

Návraty

Promise<ReleaseDefinitionSummary>

getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)

Získejte prostředí vydané verze.

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

ID vydané verze.

environmentId: number

ID prostředí vydané verze

expand: ReleaseEnvironmentExpands

Vlastnost, která by měla být v prostředí rozšířena.

Návraty

Promise<ReleaseEnvironment>

getReleaseHistory(string, number)

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

Návraty

Promise<ReleaseRevision[]>

getReleaseProjects(string, string)

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

Parametry

artifactType: string

artifactSourceId: string

Návraty

Promise<ProjectReference[]>

getReleaseRevision(string, number, number)

Získejte verzi pro dané číslo revize.

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

ID vydané verze.

definitionSnapshotRevision: number

Číslo revize snímku definice

Návraty

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)

Získání seznamu verzí

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

Parametry

project: string

ID projektu nebo název projektu

definitionId: number

Vydané verze z tohoto ID definice vydané verze.

definitionEnvironmentId: number

searchText: string

Vydané verze s názvy obsahujícími searchText.

createdBy: string

Vydané verze vytvořené tímto uživatelem.

statusFilter: ReleaseStatus

Vydané verze, které mají tento stav.

environmentStatusFilter: number

minCreatedTime: Date

Vydané verze vytvořené po tomto čase

maxCreatedTime: Date

Vydané verze vytvořené před tímto časem.

queryOrder: ReleaseQueryOrder

Získá výsledky v definovaném pořadí data vytvoření pro vydané verze. Výchozí hodnota je sestupná.

top: number

Počet vydaných verzí, které chcete získat. Výchozí hodnota je 50.

continuationToken: number

Získá vydané verze po poskytnutém tokenu pokračování.

expand: ReleaseExpands

Vlastnost, která by se měla rozbalit v seznamu verzí.

artifactTypeId: string

Vrátí se verze s daným identifikátorem artifactTypeId. Hodnoty můžou být Build, Jenkins, GitHub, NuGet, Team Build (externí), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.

sourceId: string

Jedinečný identifikátor použitého artefaktu. Například pro sestavení by to bylo {projectGuid}:{BuildDefinitionId}, pro Jenkins by to bylo {JenkinsConnectionId}:{JenkinsDefinitionId}, pro TfsOnPrem by to bylo {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. U artefaktů třetích stran, jako je TeamCity nebo BitBucket, můžete v vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensionsodkazovat na uniqueSourceIdentifier.

artifactVersionId: string

Vrátí se verze s daným identifikátorem artifactVersionId. Například v případě build artifactType je to buildId.

sourceBranchFilter: string

Vrátí se verze s daným filtrem sourceBranchFilter.

isDeleted: boolean

Získá obnovitelně odstraněné verze, pokud je true.

tagFilter: string[]

Seznam značek oddělených čárkami. Vrátí se jenom verze s těmito značkami.

propertyFilters: string[]

Seznam rozšířených vlastností oddělených čárkami, které mají být načteny. Pokud je nastaveno, vrácené verze budou obsahovat hodnoty pro id zadaných vlastností (pokud existují). Pokud nenastavíte, vlastnosti nebudou zahrnuty. Upozorňujeme, že se tím nevyfiltruje žádná verze z výsledků bez ohledu na to, jestli má nastavenou vlastnost nebo ne.

releaseIdFilter: number[]

Seznam ID vydaných verzí oddělených čárkami Vrátí se pouze verze s těmito ID.

path: string

Verze v této cestě ke složce se vrátí.

Návraty

Promise<PagedList<Release>>

getReleaseSettings(string)

Získá nastavení vydané verze.

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

Parametry

project: string

ID projektu nebo název projektu

Návraty

Promise<ReleaseSettings>

getReleaseTags(string, number)

Získá značky pro verzi.

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

Návraty

Promise<string[]>

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

Získejte přílohu úkolu vydané verze.

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

ID vydané verze.

environmentId: number

ID prostředí vydané verze

attemptId: number

Počet pokusů o nasazení.

planId: string

ID plánu fáze nasazení

timelineId: string

ID časové osy úkolu.

recordId: string

ID záznamu přílohy.

type: string

Typ přílohy.

name: string

Název přílohy

Návraty

Promise<ArrayBuffer>

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

Získejte přílohy k úkolu vydané verze.

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

ID vydané verze.

environmentId: number

ID prostředí vydané verze

attemptId: number

Počet pokusů o nasazení.

planId: string

ID plánu fáze nasazení

type: string

Typ přílohy.

Návraty

Promise<ReleaseTaskAttachment[]>

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

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

baseReleaseId: number

top: number

artifactAlias: string

Návraty

Promise<ReleaseWorkItemRef[]>

getSourceBranches(string, number)

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

Parametry

project: string

ID projektu nebo název projektu

definitionId: number

Návraty

Promise<string[]>

getSummaryMailSections(string, number)

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

Návraty

Promise<SummaryMailSection[]>

getTags(string)

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

Parametry

project: string

ID projektu nebo název projektu

Návraty

Promise<string[]>

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

Získejte přílohu k úkolu.

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

ID vydané verze.

environmentId: number

ID prostředí vydané verze.

attemptId: number

Počet pokusů o nasazení.

timelineId: string

ID časové osy úkolu.

recordId: string

ID záznamu přílohy

type: string

Typ přílohy.

name: string

Název přílohy.

Návraty

Promise<ArrayBuffer>

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

Získejte přílohy k úkolu.

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

ID vydané verze.

environmentId: number

ID prostředí vydané verze.

attemptId: number

Počet pokusů o nasazení.

timelineId: string

ID časové osy úkolu.

type: string

Typ přílohy.

Návraty

Promise<ReleaseTaskAttachment[]>

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

Získá protokol úloh vydané verze jako soubor ve formátu prostého textu.

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

ID vydané verze.

environmentId: number

ID prostředí vydané verze.

releaseDeployPhaseId: number

ID fáze nasazení verze

taskId: number

ReleaseTask ID protokolu.

startLine: number

Číslo počátečního řádku pro protokoly

endLine: number

Číslo koncového řádku pro protokoly

Návraty

Promise<string>

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

Získá protokol úloh vydané verze jako soubor ve formátu prostého textu.

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

ID vydané verze.

environmentId: number

ID prostředí vydané verze.

attemptId: number

timelineId: string

taskId: number

ReleaseTask ID protokolu.

startLine: number

Číslo počátečního řádku pro protokoly

endLine: number

Číslo koncového řádku pro protokoly

Návraty

Promise<string>

getTasks(string, number, number, number)

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

environmentId: number

attemptId: number

Návraty

Promise<ReleaseTask[]>

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

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

environmentId: number

attemptId: number

timelineId: string

Návraty

Promise<ReleaseTask[]>

getTasksForTaskGroup(string, number, number, number)

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

environmentId: number

releaseDeployPhaseId: number

Návraty

Promise<ReleaseTask[]>

listDefinitionEnvironmentTemplates(string, boolean)

Získá seznam šablon prostředí definic.

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

Parametry

project: string

ID projektu nebo název projektu

isDeleted: boolean

"true" pro získání šablon definičních prostředí, které byly odstraněny. Výchozí hodnota je false.

Návraty

Promise<ReleaseDefinitionEnvironmentTemplate[]>

sendSummaryMail(MailMessage, string, number)

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

Parametry

mailMessage: MailMessage

project: string

ID projektu nebo název projektu

releaseId: number

Návraty

Promise<void>

undeleteRelease(string, number, string)

Obnovení obnovitelné odstraněné verze

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

ID vydané verze, která má být zrušena.

comment: string

Jakýkoli komentář pro zrušení.

Návraty

Promise<void>

undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)

Zrušení odstranění definice vydané verze

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

Parametry

releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter

Object for undelete release definition.

project: string

ID projektu nebo název projektu

definitionId: number

ID definice vydané verze, která se má zrušit

Návraty

Promise<ReleaseDefinition>

undeleteReleaseDefinitionEnvironmentTemplate(string, string)

Zrušení odstranění šablony prostředí definice vydané verze

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

Parametry

project: string

ID projektu nebo název projektu

templateId: string

ID šablony definičního prostředí, která se má zrušit

Návraty

Promise<ReleaseDefinitionEnvironmentTemplate>

updateFolder(Folder, string, string)

Aktualizace existující složku v dané existující cestě.

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

Parametry

folder: Folder

Složky.

project: string

ID projektu nebo název projektu

path: string

Cesta ke složce, kterou chcete aktualizovat.

Návraty

Promise<Folder>

updateGates(GateUpdateMetadata, string, number)

Aktualizace bránu nasazení.

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

Parametry

gateUpdateMetadata: GateUpdateMetadata

Metadata pro opravu brány release.

project: string

ID projektu nebo název projektu

gateStepId: number

ID kroku brány.

Návraty

Promise<ReleaseGates>

updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)

Aktualizujte ruční zásah.

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

Parametry

manualInterventionUpdateMetadata: ManualInterventionUpdateMetadata

Metadata pro aktualizaci ručního zásahu.

project: string

ID projektu nebo název projektu

releaseId: number

ID vydané verze.

manualInterventionId: number

Id ručního zásahu.

Návraty

Promise<ManualIntervention>

updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)

Aktualizace nastavení vydání kanálu organizace

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

Parametry

newSettings: OrgPipelineReleaseSettingsUpdateParameters

Návraty

Promise<OrgPipelineReleaseSettings>

updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)

nastavení verze kanálu Aktualizace

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

Parametry

newSettings: ProjectPipelineReleaseSettingsUpdateParameters

project: string

ID projektu nebo název projektu

Návraty

Promise<ProjectPipelineReleaseSettings>

updateRelease(Release, string, number)

Aktualizujte objekt úplné verze.

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

Parametry

release: Release

Objekt verze pro aktualizaci.

project: string

ID projektu nebo název projektu

releaseId: number

ID verze, která se má aktualizovat.

Návraty

Promise<Release>

updateReleaseApproval(ReleaseApproval, string, number)

Aktualizace stavu schválení

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

Parametry

approval: ReleaseApproval

Objekt ReleaseApproval se stavem, schvalovatelem a komentáři.

project: string

ID projektu nebo název projektu

approvalId: number

ID schválení.

Návraty

Promise<ReleaseApproval>

updateReleaseApprovals(ReleaseApproval[], string)

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

Parametry

approvals: ReleaseApproval[]

project: string

ID projektu nebo název projektu

Návraty

Promise<ReleaseApproval[]>

updateReleaseDefinition(ReleaseDefinition, string)

Aktualizujte definici vydané verze.

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

Parametry

releaseDefinition: ReleaseDefinition

Objekt definice verze, který se má aktualizovat.

project: string

ID projektu nebo název projektu

Návraty

Promise<ReleaseDefinition>

updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)

Aktualizace stavu prostředí vydané verze

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

Parametry

environmentUpdateData: ReleaseEnvironmentUpdateMetadata

Metadata aktualizace prostředí

project: string

ID projektu nebo název projektu

releaseId: number

ID vydané verze.

environmentId: number

ID prostředí vydané verze.

Návraty

Promise<ReleaseEnvironment>

updateReleaseResource(ReleaseUpdateMetadata, string, number)

Aktualizujte několik vlastností vydané verze.

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

Parametry

releaseUpdateMetadata: ReleaseUpdateMetadata

Vlastnosti verze, která se má aktualizovat.

project: string

ID projektu nebo název projektu

releaseId: number

ID verze, která se má aktualizovat.

Návraty

Promise<Release>

updateReleaseSettings(ReleaseSettings, string)

Aktualizace nastavení verze

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

Parametry

releaseSettings: ReleaseSettings

project: string

ID projektu nebo název projektu

Návraty

Promise<ReleaseSettings>

Sdílet prostřednictvím

ReleaseRestClient class

Konstruktory

Vlastnosti

Metody

Podrobnosti konstruktoru

ReleaseRestClient(IVssRestClientOptions)

Parametry

Podrobnosti vlastnosti

RESOURCE_AREA_ID

Hodnota vlastnosti

Podrobnosti metody

addDefinitionTag(string, number, string)

Parametry

Návraty

addDefinitionTags(string[], string, number)

Parametry

Návraty

addReleaseTag(string, number, string)

Parametry

Návraty

addReleaseTags(string[], string, number)

Parametry

Návraty

createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)

Parametry

Návraty

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

Parametry

Návraty

createFolder(Folder, string, string)

Parametry

Návraty

createRelease(ReleaseStartMetadata, string)

Parametry

Návraty

createReleaseDefinition(ReleaseDefinition, string)

Parametry

Návraty

deleteDefinitionEnvironmentTemplate(string, string)

Parametry

Návraty

deleteDefinitionTag(string, number, string)

Parametry

Návraty

deleteFavorites(string, string, string, string)

Parametry

Návraty

deleteFolder(string, string)

Parametry

Návraty

deleteRelease(string, number, string)

Parametry

Návraty

deleteReleaseDefinition(string, number, string, boolean)

Parametry

Návraty

deleteReleaseTag(string, number, string)

Parametry

Návraty

getAgentArtifactDefinitions(string, number)

Parametry

Návraty

getApproval(string, number, boolean)

Parametry

Návraty

getApprovalHistory(string, number)

Parametry

Návraty

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

Parametry

Návraty

getArtifactTypeDefinitions(string)

Parametry

Návraty

getArtifactVersions(string, number)

Parametry

Návraty

getArtifactVersionsForSources(Artifact[], string)

Parametry