ReleaseRestClient class

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

Základní třída, která by se měla použít (odvozená) k provádění požadavků na rozhraní REST API služby VSS

Extends: RestClientBase

Konstruktory

ReleaseRestClient(IVssRestClientOptions)

Vlastnosti

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 prostředí definice.
createFavorites(FavoriteItem[], string, string, string)
createFolder(Folder, string, string)	Vytvoří novou složku.
createRelease(ReleaseStartMetadata, string)	Vytvořte verzi.
createReleaseDefinition(ReleaseDefinition, string)	Vytvoření definice verze
deleteDefinitionEnvironmentTemplate(string, string)	Odstranění šablony prostředí definice
deleteDefinitionTag(string, number, string)	Odstraní značku z definice.
deleteFavorites(string, string, string, string)
deleteFolder(string, string)	Odstraní složku definice pro daný název a cestu ke složce a všechny její existující definice.
deleteRelease(string, number, string)	Obnovitelné odstranění vydané verze
deleteReleaseDefinition(string, number, string, boolean)	Odstraňte definici 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 prostředí definice.
getDefinitionRevision(string, number, number)	Získání definice vydané 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 nejnovější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)
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í verze kanálu organizace.
getPipelineReleaseSettings(string)	Získá nastavení verze kanálu.
getRelease(string, number, ApprovalFilters, string[], SingleReleaseExpands, number, boolean)	Získání verze
getReleaseChanges(string, number, number, number, string)
getReleaseDefinition(string, number, string[], boolean)	Získejte definici verze.
getReleaseDefinitionHistory(string, number)	Získání historie revizí pro definici verze
getReleaseDefinitionRevision(string, number, number)	Získejte definici vydané 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 vydané verze pro dané ID definice.
getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)	Získejte prostředí 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 vydaných 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 ú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 úkolu.
getTaskAttachments(string, number, number, number, string, string)	Získejte přílohy úkolů.
getTaskLog(string, number, number, number, number, number, number)	Získá protokol úloh vydané verze jako soubor prostého textu.
getTaskLog2(string, number, number, number, string, number, number, number)	Získá protokol úloh vydané verze jako soubor 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)	Odstranění obnovitelně odstraněné verze
undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)	Zrušení definice vydané verze
undeleteReleaseDefinitionEnvironmentTemplate(string, string)	Odstranění šablony prostředí definice vydané verze
updateFolder(Folder, string, string)	Aktualizuje existující složku v dané existující cestě.
updateGates(GateUpdateMetadata, string, number)	Aktualizuje bránu pro nasazení.
updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)	Aktualizujte ruční zásah.
updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)	Aktualizace nastavení verze kanálu organizace
updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)	Aktualizace nastavení verze kanálu
updateRelease(Release, string, number)	Aktualizace kompletního objektu vydané verze
updateReleaseApproval(ReleaseApproval, string, number)	Aktualizace stavu schválení
updateReleaseApprovals(ReleaseApproval[], string)
updateReleaseDefinition(ReleaseDefinition, string, boolean)	Aktualizujte definici 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)	Aktualizuje nastavení vydaných verzí.

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 prostředí definice.

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

Parametry

template: ReleaseDefinitionEnvironmentTemplate

Šablona prostředí definice pro vytvoření

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žka.

project: string

ID projektu nebo název projektu

path: string

Cesta ke složce

Návraty

Promise<Folder>

createRelease(ReleaseStartMetadata, string)

Vytvořte verzi.

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

definiční objekt vydané verze pro vytvoření.

project: string

ID projektu nebo název projektu

Návraty

Promise<ReleaseDefinition>

deleteDefinitionEnvironmentTemplate(string, string)

Odstranění šablony prostředí definice

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

Parametry

project: string

ID projektu nebo název projektu

templateId: string

ID šablony prostředí definice

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 definice pro daný název a cestu ke složce 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 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, pokud chcete automaticky zrušit všechna probíhající nasazení 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" pro zahrnutí historie 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 čeká na vyřízení.

releaseIdsFilter: number[]

Schválení id vydaných verzí uvedených ve filtru Více verzí je možné zmínit tak, že je rozdělíte na ", např. releaseIdsFilter=1,2,3,4.

typeFilter: ApprovalType

Schválení s tímto typem

top: number

Počet schválení, která se mají 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" tak, 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 prostředí definice.

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

Parametry

project: string

ID projektu nebo název projektu

templateId: string

ID šablony prostředí definice

Návraty

Promise<ReleaseDefinitionEnvironmentTemplate>

getDefinitionRevision(string, number, number)

Získání definice vydané 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 nejnovější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

Vypíše nasazení pro dané ID definice.

definitionEnvironmentId: number

Uveďte nasazení pro dané ID prostředí definice.

createdBy: string

Uveďte nasazení, pro která se nasazení vytvoří jako zadaná identita.

minModifiedTime: Date

Uveďte nasazení s časem >LastModified = minModifiedTime.

maxModifiedTime: Date

Uveďte nasazení s časem <LastModified = maxModifiedTime.

deploymentStatus: DeploymentStatus

Uveďte seznam nasazení s daným stavem nasazení. Výchozí hodnota je Vše.

operationStatus: DeploymentOperationStatus

Zobrazí seznam nasazení s daným stavem operace. Výchozí hodnota je Vše.

latestAttemptsOnly: boolean

"true" pro zahrnutí nasazení pouze s nejnovějším pokusem. Výchozí hodnota je false.

queryOrder: ReleaseQueryOrder

Uveďte seznam nasazení s daným pořadím dotazů. Výchozí hodnota je Sestupně.

top: number

Uveďte seznam nasazení s danou nejvyšší instancí. Výchozí horní hodnota je 50 a maximální hodnota je 100.

continuationToken: number

Uveďte nasazení s ID >nasazení = continuationToken.

createdFor: string

Vypíše nasazení, pro která se budou vyžadovat nasazení jako zadaná identita.

minStartedTime: Date

Uveďte nasazení s časem >StartedOn = minStartedTime.

maxStartedTime: Date

Vypíše nasazení s časem StartedOn <= maxStartedTime.

sourceBranch: string

Uveďte seznam nasazení nasazených 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[]>

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í verze.

gateId: number

ID brány.

taskId: number

ID releaseTask pro protokol.

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í verze.

taskId: number

ID releaseTask pro protokol.

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í verze 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, boolean)

Získání verze

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

Parametry

project: string

ID projektu nebo název projektu

releaseId: number

ID vydané verze.

approvalFilters: ApprovalFilters

Filtr, který by umožnil selektivní načtení schvalovacích kroků na základě toho, jestli je automatizovaný, nebo ruční. To by také rozhodlo, jestli bychom měli načíst snímky před schválením 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 má načíst. Pokud je nastaveno, vrácená verze bude obsahovat hodnoty pro zadané ID vlastnosti (pokud existují). Pokud není nastavená, vlastnosti nebudou zahrnuty.

expand: SingleReleaseExpands

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

topGateRecords: number

Počet záznamů bran vydaných verzí, které se mají získat. Výchozí hodnota je 5.

includeDisabledDefinitions: boolean

Zahrňte zakázané definice (pokud je nastavená hodnota false vrátí chybu, výchozí hodnota je true).

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

Získejte definici verze.

function getReleaseDefinition(project: string, definitionId: number, propertyFilters?: string[], includeDisabled?: boolean): 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 má načíst. Pokud je nastavena, vrácená definice vydané verze bude obsahovat hodnoty pro zadané ID vlastnosti (pokud existují). Pokud není nastavená, vlastnosti nebudou zahrnuty.

includeDisabled: boolean

Logický příznak pro zahrnutí zakázaných definic.

Návraty

Promise<ReleaseDefinition>

getReleaseDefinitionHistory(string, number)

Získání historie revizí pro definici 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 vydané 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 se měly rozbalit v seznamu definic vydané verze.

artifactType: string

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

artifactSourceId: string

Vrátí se definice vydané verze s daným id artifactSourceId. Například pro sestavení by to bylo {projectGuid}:{BuildDefinitionId}, pro Jenkinse by to bylo {JenkinsConnectionId}:{JenkinsDefinitionId}, pro TfsOnPrem by to bylo {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. U artefaktů třetích stran, například TeamCity, BitBucket, můžete v https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensionsodkazovat na uniqueSourceIdentifier uvnitř vss-extension.json .

top: number

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

continuationToken: string

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

queryOrder: ReleaseDefinitionQueryOrder

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

path: string

Získá definice vydané verze pod zadanou cestou.

isExactNameMatch: boolean

"true", aby získal definice vydané verze s přesnou shodou, jak je uvedeno v searchTextu. 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ý se má načíst. Pokud je tato sada nastavená, vrácené definice vydané verze budou obsahovat hodnoty pro zadané ID vlastnosti (pokud existují). Pokud není nastavená, vlastnosti nebudou zahrnuty. Všimněte si, že tato možnost nevyfiltruje žádnou definici vydané verze z výsledků bez ohledu na to, jestli má nastavenou vlastnost nebo ne.

definitionIdFilter: string[]

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

isDeleted: boolean

"true" pro získání definic vydaných verzí, které byly odstraněny. 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 vydané verze pro dané 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 vydaných 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í 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í verze.

expand: ReleaseEnvironmentExpands

Vlastnost, která by se měla rozšířit v prostředí.

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 vydaných 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<Release[]>

Parametry

project: string

ID projektu nebo název projektu

definitionId: number

Vydané verze z tohoto ID definice 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, které byly vytvořeny po této době.

maxCreatedTime: Date

Vydané verze, které byly vytvořeny před touto dobou.

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é se mají získat Výchozí hodnota je 50.

continuationToken: number

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

expand: ReleaseExpands

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

artifactTypeId: string

Vrátí se vydané verze s daným id 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 Jenkinse by to bylo {JenkinsConnectionId}:{JenkinsDefinitionId}, pro TfsOnPrem by to bylo {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. U artefaktů třetích stran, například TeamCity, BitBucket, můžete v vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensionsodkazovat na uniqueSourceIdentifier .

artifactVersionId: string

Vrátí se vydané verze s daným id artifactVersionId. Například v případě build artifactType se jedná o id buildu.

sourceBranchFilter: string

Vydané verze s daným zdrojemBranchFilter budou vráceny (nebude použito s environmentStatusFilter).

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ý se má načíst. Pokud je nastaveno, vrácené verze budou obsahovat hodnoty pro zadané ID vlastnosti (pokud existují). Pokud není nastavená, vlastnosti nebudou zahrnuty. Mějte na paměti, že nebude odfiltrovat žádné verze z výsledků bez ohledu na to, zda má vlastnost nastavena, nebo ne.

releaseIdFilter: number[]

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

path: string

Vrátí se verze v rámci této cesty ke složce.

Návraty

Promise<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í 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 ú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í 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 ú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í 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 úkolů.

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í 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 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í verze.

releaseDeployPhaseId: number

ID fáze nasazení verze

taskId: number

ID releaseTask pro protokol.

startLine: number

Počáteční číslo řádku pro protokoly

endLine: number

Koncové číslo řádku pro protokoly

Návraty

Promise<string>

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

Získá protokol úloh vydané verze jako soubor 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í verze.

attemptId: number

timelineId: string

taskId: number

ID releaseTask pro protokol.

startLine: number

Počáteční číslo řádku pro protokoly

endLine: number

Koncové číslo řá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 prostředí definic, 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)

Odstranění 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á se má zrušit.

comment: string

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

Návraty

Promise<void>

undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)

Zrušení definice vydané verze

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

Parametry

releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter

Objekt pro definici obnovení verze.

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)

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 prostředí definice, která se má zrušit

Návraty

Promise<ReleaseDefinitionEnvironmentTemplate>

updateFolder(Folder, string, string)

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

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

Parametry

folder: Folder

složka.

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)

Aktualizuje bránu pro nasazení.

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

Parametry

gateUpdateMetadata: GateUpdateMetadata

Metadata pro opravu vydaných bran

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

Meta data 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í verze kanálu organizace

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

Parametry

newSettings: OrgPipelineReleaseSettingsUpdateParameters

Návraty

Promise<OrgPipelineReleaseSettings>

updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)

Aktualizace nastavení verze kanálu

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)

Aktualizace kompletního objektu vydané verze

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

Parametry

release: Release

Objekt vydané verze pro aktualizaci.

project: string

ID projektu nebo název projektu

releaseId: number

ID vydané 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, který má stav, schvalovatele a komentáře.

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

Aktualizujte definici verze.

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

Parametry

releaseDefinition: ReleaseDefinition

Objekt definice vydané verze, který se má aktualizovat.

project: string

ID projektu nebo název projektu

skipTasksValidation: boolean

Přeskočení logického příznaku ověření úlohy

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í 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 vydané verze, která se má aktualizovat.

project: string

ID projektu nebo název projektu

releaseId: number

ID vydané verze, která se má aktualizovat.

Návraty

Promise<Release>

updateReleaseSettings(ReleaseSettings, string)

Aktualizuje nastavení vydaných verzí.

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

Parametry

releaseSettings: ReleaseSettings

project: string

ID projektu nebo název projektu

Návraty

Promise<ReleaseSettings>

Váš názor

Byla tato stránka užitečná?

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