ReleaseRestClient class

Pakiet:: azure-devops-extension-api

Klasa bazowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Rozszerza: RestClientBase

Konstruktorów

ReleaseRestClient(IVssRestClientOptions)

Właściwości

Metody

addDefinitionTag(string, number, string)	Dodaje tag do definicji
addDefinitionTags(string[], string, number)	Dodaje wiele tagów do definicji
addReleaseTag(string, number, string)	Dodaje tag do identyfikatora releaseId
addReleaseTags(string[], string, number)	Dodaje tag do wydania
createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)	Tworzy szablon środowiska definicji
createFavorites(FavoriteItem[], string, string, string)
createFolder(Folder, string, string)	Tworzy nowy folder.
createRelease(ReleaseStartMetadata, string)	Utwórz wydanie.
createReleaseDefinition(ReleaseDefinition, string)	Tworzenie definicji wydania
deleteDefinitionEnvironmentTemplate(string, string)	Usuwanie szablonu środowiska definicji
deleteDefinitionTag(string, number, string)	Usuwa tag z definicji
deleteFavorites(string, string, string, string)
deleteFolder(string, string)	Usuwa folder definicji dla danej nazwy folderu i ścieżki oraz wszystkie istniejące definicje.
deleteRelease(string, number, string)	Usuwanie nietrwałe wydania
deleteReleaseDefinition(string, number, string, boolean)	Usuń definicję wydania.
deleteReleaseTag(string, number, string)	Usuwa tag z wydania
getAgentArtifactDefinitions(string, number)	Zwraca szczegóły artefaktu wymagane przez agenta automatyzacji
getApproval(string, number, boolean)	Uzyskaj zatwierdzenie.
getApprovalHistory(string, number)	Uzyskaj historię zatwierdzania.
getApprovals(string, string, ApprovalStatus, number[], ApprovalType, number, number, ReleaseQueryOrder, boolean)	Pobieranie listy zatwierdzeń
getArtifactTypeDefinitions(string)
getArtifactVersions(string, number)
getArtifactVersionsForSources(Artifact[], string)
getAutoTriggerIssues(string, string, string, string)
getDefinitionEnvironments(string, string, string[])
getDefinitionEnvironmentTemplate(string, string)	Pobiera szablon środowiska definicji
getDefinitionRevision(string, number, number)	Pobieranie definicji wydania dla danego identyfikatora definicji i poprawki
getDefinitionTags(string, number)	Pobiera tagi definicji
getDeploymentBadge(string, number, number, string)	Pobiera wskaźnik wskazujący stan ostatniego wdrożenia dla środowiska.
getDeployments(string, number, number, string, Date, Date, DeploymentStatus, DeploymentOperationStatus, boolean, ReleaseQueryOrder, number, number, string, Date, Date, string)	Pobieranie listy wdrożeń
getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)
getFavorites(string, string, string)
getFolders(string, string, FolderPathQueryOrder)	Pobiera foldery.
getGateLog(string, number, number, number, number)	Pobiera dzienniki bramy
getInputValues(InputValuesQuery, string)
getIssues(string, number, string)
getLog(string, number, number, number, number)	Pobiera dzienniki
getLogs(string, number)	Pobieranie dzienników dla identyfikatora wydania.
getManualIntervention(string, number, number)	Uzyskaj interwencję ręczną dla danego wydania i identyfikatora interwencji ręcznej.
getManualInterventions(string, number)	Lista wszystkich ręcznych interwencji dla danego wydania.
getMetrics(string, Date)
getOrgPipelineReleaseSettings()	Pobiera ustawienia wydania potoku organizacji
getPipelineReleaseSettings(string)	Pobiera ustawienia wydania potoku
getRelease(string, number, ApprovalFilters, string[], SingleReleaseExpands, number, boolean)	Uzyskiwanie wydania
getReleaseChanges(string, number, number, number, string)
getReleaseDefinition(string, number, string[], boolean)	Pobierz definicję wydania.
getReleaseDefinitionHistory(string, number)	Pobieranie historii poprawek dla definicji wydania
getReleaseDefinitionRevision(string, number, number)	Pobierz definicję wydania danej poprawki.
getReleaseDefinitions(string, string, ReleaseDefinitionExpands, string, string, number, string, ReleaseDefinitionQueryOrder, string, boolean, string[], string[], string[], boolean, boolean)	Pobierz listę definicji wydania.
getReleaseDefinitionSummary(string, number, number, boolean, number[])	Pobierz podsumowanie wydania danego identyfikatora definicji.
getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)	Pobierz środowisko wydania.
getReleaseHistory(string, number)
getReleaseProjects(string, string)
getReleaseRevision(string, number, number)	Pobierz wydanie dla danego numeru poprawki.
getReleases(string, number, number, string, string, ReleaseStatus, number, Date, Date, ReleaseQueryOrder, number, number, ReleaseExpands, string, string, string, string, boolean, string[], string[], number[], string)	Pobieranie listy wydań
getReleaseSettings(string)	Pobiera ustawienia wydania
getReleaseTags(string, number)	Pobiera tagi dla wydania
getReleaseTaskAttachmentContent(string, number, number, number, string, string, string, string, string)	Pobierz załącznik zadania wydania.
getReleaseTaskAttachments(string, number, number, number, string, string)	Pobierz załączniki zadań wydania.
getReleaseWorkItemsRefs(string, number, number, number, string)
getSourceBranches(string, number)
getSummaryMailSections(string, number)
getTags(string)
getTaskAttachmentContent(string, number, number, number, string, string, string, string)	Pobierz załącznik zadania.
getTaskAttachments(string, number, number, number, string, string)	Pobierz załączniki zadań.
getTaskLog(string, number, number, number, number, number, number)	Pobiera dziennik zadań wydania jako plik w postaci zwykłego tekstu.
getTaskLog2(string, number, number, number, string, number, number, number)	Pobiera dziennik zadań wydania jako plik w postaci zwykłego tekstu.
getTasks(string, number, number, number)
getTasks2(string, number, number, number, string)
getTasksForTaskGroup(string, number, number, number)
listDefinitionEnvironmentTemplates(string, boolean)	Pobiera listę szablonów środowisk definicji
sendSummaryMail(MailMessage, string, number)
undeleteRelease(string, number, string)	Cofanie usunięcia nietrwałego wydania.
undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)	Cofanie usunięcia definicji wydania.
undeleteReleaseDefinitionEnvironmentTemplate(string, string)	Cofnij usunięcie szablonu środowiska definicji wydania.
updateFolder(Folder, string, string)	Aktualizuje istniejący folder pod daną istniejącą ścieżką.
updateGates(GateUpdateMetadata, string, number)	Aktualizuje bramę wdrożenia.
updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)	Aktualizowanie interwencji ręcznej.
updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)	Aktualizacje ustawień wydania potoku organizacji
updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)	Ustawienia wydania potoku aktualizacji
updateRelease(Release, string, number)	Aktualizowanie kompletnego obiektu wydania.
updateReleaseApproval(ReleaseApproval, string, number)	Aktualizowanie stanu zatwierdzenia
updateReleaseApprovals(ReleaseApproval[], string)
updateReleaseDefinition(ReleaseDefinition, string, boolean)	Aktualizowanie definicji wydania.
updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)	Aktualizowanie stanu środowiska wydania
updateReleaseResource(ReleaseUpdateMetadata, string, number)	Zaktualizuj kilka właściwości wydania.
updateReleaseSettings(ReleaseSettings, string)	Aktualizuje ustawienia wydania

Szczegóły konstruktora

ReleaseRestClient(IVssRestClientOptions)

new ReleaseRestClient(options: IVssRestClientOptions)

Parametry

options: IVssRestClientOptions

Szczegóły nieruchomości

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Wartość nieruchomości

string

Szczegóły metody

addDefinitionTag(string, number, string)

Dodaje tag do definicji

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseDefinitionId: number

tag: string

Zwraca

Promise<string[]>

addDefinitionTags(string[], string, number)

Dodaje wiele tagów do definicji

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

Parametry

tags: string[]

project: string

Identyfikator projektu lub nazwa projektu

releaseDefinitionId: number

Zwraca

Promise<string[]>

addReleaseTag(string, number, string)

Dodaje tag do identyfikatora releaseId

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

tag: string

Zwraca

Promise<string[]>

addReleaseTags(string[], string, number)

Dodaje tag do wydania

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

Parametry

tags: string[]

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Zwraca

Promise<string[]>

createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)

Tworzy szablon środowiska definicji

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

Parametry

template: ReleaseDefinitionEnvironmentTemplate

Szablon środowiska definicji do utworzenia

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<ReleaseDefinitionEnvironmentTemplate>

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

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

Parametry

favoriteItems: FavoriteItem[]

project: string

Identyfikator projektu lub nazwa projektu

scope: string

identityId: string

Zwraca

Promise<FavoriteItem[]>

createFolder(Folder, string, string)

Tworzy nowy folder.

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

Parametry

folder: Folder

folder.

project: string

Identyfikator projektu lub nazwa projektu

path: string

Ścieżka folderu.

Zwraca

Promise<Folder>

createRelease(ReleaseStartMetadata, string)

Utwórz wydanie.

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

Parametry

releaseStartMetadata: ReleaseStartMetadata

Metadane do utworzenia wydania.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<Release>

createReleaseDefinition(ReleaseDefinition, string)

Tworzenie definicji wydania

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

Parametry

releaseDefinition: ReleaseDefinition

obiekt definicji wydania do utworzenia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<ReleaseDefinition>

deleteDefinitionEnvironmentTemplate(string, string)

Usuwanie szablonu środowiska definicji

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

templateId: string

Identyfikator szablonu środowiska definicji

Zwraca

Promise<void>

deleteDefinitionTag(string, number, string)

Usuwa tag z definicji

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseDefinitionId: number

tag: string

Zwraca

Promise<string[]>

deleteFavorites(string, string, string, string)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

scope: string

identityId: string

favoriteItemIds: string

Zwraca

Promise<void>

deleteFolder(string, string)

Usuwa folder definicji dla danej nazwy folderu i ścieżki oraz wszystkie istniejące definicje.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

path: string

Ścieżka folderu do usunięcia.

Zwraca

Promise<void>

deleteRelease(string, number, string)

Usuwanie nietrwałe wydania

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Identyfikator wydania.

comment: string

Komentarz dotyczący usuwania wydania.

Zwraca

Promise<void>

deleteReleaseDefinition(string, number, string, boolean)

Usuń definicję wydania.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

definitionId: number

Identyfikator definicji wydania.

comment: string

Komentarz dotyczący usuwania definicji wydania.

forceDelete: boolean

Wartość "true", aby automatycznie anulować wszystkie wdrożenia wersji w toku i kontynuować usuwanie definicji wydania. Wartość domyślna to "false".

Zwraca

Promise<void>

deleteReleaseTag(string, number, string)

Usuwa tag z wydania

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

tag: string

Zwraca

Promise<string[]>

getAgentArtifactDefinitions(string, number)

Zwraca szczegóły artefaktu wymagane przez agenta automatyzacji

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Zwraca

Promise<AgentArtifactDefinition[]>

getApproval(string, number, boolean)

Uzyskaj zatwierdzenie.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

approvalId: number

Identyfikator zatwierdzenia.

includeHistory: boolean

"true", aby uwzględnić historię zatwierdzenia. Wartość domyślna to "false".

Zwraca

Promise<ReleaseApproval>

getApprovalHistory(string, number)

Uzyskaj historię zatwierdzania.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

approvalStepId: number

Identyfikator zatwierdzenia.

Zwraca

Promise<ReleaseApproval>

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

Pobieranie listy zatwierdzeń

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

Identyfikator projektu lub nazwa projektu

assignedToFilter: string

Zatwierdzenia przypisane do tego użytkownika.

statusFilter: ApprovalStatus

Zatwierdzenia o tym stanie. Wartość domyślna to "pending".

releaseIdsFilter: number[]

Zatwierdzenia identyfikatorów wydań wymienionych w filtrze. Wiele wydań można wymienić, oddzielając je ciągiem "", np. releaseIdsFilter=1,2,3,4.

typeFilter: ApprovalType

Zatwierdzenie przy użyciu tego typu.

top: number

Liczba zatwierdzeń do pobrania. Wartość domyślna to 50.

continuationToken: number

Pobiera zatwierdzenia po podanym tokenie kontynuacji.

queryOrder: ReleaseQueryOrder

Pobiera wyniki w zdefiniowanej kolejności utworzonych zatwierdzeń. Wartość domyślna to "malejąco".

includeMyGroupApprovals: boolean

"true" w celu uwzględnienia moich zatwierdzeń grupy. Wartość domyślna to "false".

Zwraca

Promise<PagedList<ReleaseApproval>>

getArtifactTypeDefinitions(string)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<ArtifactTypeDefinition[]>

getArtifactVersions(string, number)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseDefinitionId: number

Zwraca

Promise<ArtifactVersionQueryResult>

getArtifactVersionsForSources(Artifact[], string)

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

Parametry

artifacts: Artifact[]

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

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

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<AutoTriggerIssue[]>

getDefinitionEnvironments(string, string, string[])

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

taskGroupId: string

propertyFilters: string[]

Zwraca

Promise<DefinitionEnvironmentReference[]>

getDefinitionEnvironmentTemplate(string, string)

Pobiera szablon środowiska definicji

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

templateId: string

Identyfikator szablonu środowiska definicji

Zwraca

Promise<ReleaseDefinitionEnvironmentTemplate>

getDefinitionRevision(string, number, number)

Pobieranie definicji wydania dla danego identyfikatora definicji i poprawki

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

definitionId: number

Identyfikator definicji.

revision: number

Identyfikator poprawki.

Zwraca

Promise<string>

getDefinitionTags(string, number)

Pobiera tagi definicji

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseDefinitionId: number

Zwraca

Promise<string[]>

getDeploymentBadge(string, number, number, string)

Pobiera wskaźnik wskazujący stan ostatniego wdrożenia dla środowiska.

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

Parametry

projectId: string

Identyfikator projektu.

releaseDefinitionId: number

Identyfikator definicji wydania.

environmentId: number

Identyfikator środowiska.

branchName: string

Nazwa gałęzi.

Zwraca

Promise<string>

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

Pobieranie listy wdrożeń

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

Identyfikator projektu lub nazwa projektu

definitionId: number

Wyświetl listę wdrożeń dla danego identyfikatora definicji.

definitionEnvironmentId: number

Wyświetl listę wdrożeń dla danego identyfikatora środowiska definicji.

createdBy: string

Wyświetl listę wdrożeń, dla których wdrożenia są tworzone jako określone tożsamości.

minModifiedTime: Date

Wyświetl listę wdrożeń o czasie ostatniej modyfikacji >= minModifiedTime.

maxModifiedTime: Date

Wyświetl listę wdrożeń o czasie ostatniej modyfikacji <= maxModifiedTime.

deploymentStatus: DeploymentStatus

Wyświetl listę wdrożeń z danym stanem wdrożenia. Wartość domyślna to "Wszystko".

operationStatus: DeploymentOperationStatus

Wyświetl listę wdrożeń ze stanem danej operacji. Wartość domyślna to "Wszystko".

latestAttemptsOnly: boolean

Wartość "true", aby uwzględnić wdrożenia tylko z najnowszą próbą. Wartość domyślna to "false".

queryOrder: ReleaseQueryOrder

Wyświetl listę wdrożeń z daną kolejnością zapytań. Wartość domyślna to "Descending".

top: number

Wyświetl listę wdrożeń z danym elementem u góry. Domyślna górna wartość to "50", a maksymalna górna wartość to "100".

continuationToken: number

Wyświetl listę wdrożeń z identyfikatorem wdrożenia >= continuationToken.

createdFor: string

Wyświetl listę wdrożeń, dla których są wymagane wdrożenia zgodnie z określoną tożsamością.

minStartedTime: Date

Wyświetl listę wdrożeń z wartością StartedOn time >= minStartedTime.

maxStartedTime: Date

Wyświetl listę wdrożeń z wartością StartedOn time <= maxStartedTime.

sourceBranch: string

Wyświetl listę wdrożeń wdrożonych z danej nazwy gałęzi.

Zwraca

Promise<PagedList<Deployment>>

getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)

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

Parametry

queryParameters: DeploymentQueryParameters

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<Deployment[]>

getFavorites(string, string, string)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

scope: string

identityId: string

Zwraca

Promise<FavoriteItem[]>

getFolders(string, string, FolderPathQueryOrder)

Pobiera foldery.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

path: string

Ścieżka folderu.

queryOrder: FolderPathQueryOrder

Pobiera wyniki w zdefiniowanej kolejności. Wartość domyślna to "Brak".

Zwraca

Promise<Folder[]>

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

Pobiera dzienniki bramy

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Identyfikator wydania.

environmentId: number

Identyfikator środowiska wydania.

gateId: number

Identyfikator bramy.

taskId: number

Identyfikator releaseTask dziennika.

Zwraca

Promise<string>

getInputValues(InputValuesQuery, string)

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

Parametry

query: InputValuesQuery

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<InputValuesQuery>

getIssues(string, number, string)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

sourceId: string

Zwraca

Promise<AutoTriggerIssue[]>

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

Pobiera dzienniki

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Identyfikator wydania.

environmentId: number

Identyfikator środowiska wydania.

taskId: number

Identyfikator releaseTask dziennika.

attemptId: number

Identyfikator próby.

Zwraca

Promise<string>

getLogs(string, number)

Pobieranie dzienników dla identyfikatora wydania.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Identyfikator wydania.

Zwraca

Promise<ArrayBuffer>

getManualIntervention(string, number, number)

Uzyskaj interwencję ręczną dla danego wydania i identyfikatora interwencji ręcznej.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Identyfikator wydania.

manualInterventionId: number

Identyfikator interwencji ręcznej.

Zwraca

Promise<ManualIntervention>

getManualInterventions(string, number)

Lista wszystkich ręcznych interwencji dla danego wydania.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Identyfikator wydania.

Zwraca

Promise<ManualIntervention[]>

getMetrics(string, Date)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

minMetricsTime: Date

Zwraca

Promise<Metric[]>

getOrgPipelineReleaseSettings()

Pobiera ustawienia wydania potoku organizacji

function getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>

Zwraca

Promise<OrgPipelineReleaseSettings>

getPipelineReleaseSettings(string)

Pobiera ustawienia wydania potoku

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<ProjectPipelineReleaseSettings>

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

Uzyskiwanie wydania

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Identyfikator wydania.

approvalFilters: ApprovalFilters

Filtr, który umożliwia selektywne pobieranie kroków zatwierdzania na podstawie tego, czy jest zautomatyzowany, czy ręczny. Pozwoliłoby to również zdecydować, czy należy pobrać migawki przed zatwierdzeniem i po ich opublikowaniu. Zakłada, że wszystko domyślnie

propertyFilters: string[]

Rozdzielana przecinkami lista właściwości rozszerzonych do pobrania. W przypadku ustawienia zwrócone wydanie będzie zawierać wartości dla określonych identyfikatorów właściwości (jeśli istnieją). Jeśli nie zostanie ustawiona, właściwości nie zostaną uwzględnione.

expand: SingleReleaseExpands

Właściwość, która powinna zostać rozszerzona w wydaniu.

topGateRecords: number

Liczba rekordów bramy wydania do pobrania. Wartość domyślna to 5.

includeDisabledDefinitions: boolean

Uwzględnij wyłączone definicje (jeśli ustawiono wartość "false" zwraca błąd, wartość domyślna to "true")

Zwraca

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

Identyfikator projektu lub nazwa projektu

releaseId: number

baseReleaseId: number

top: number

artifactAlias: string

Zwraca

Promise<Change[]>

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

Pobierz definicję wydania.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

definitionId: number

Identyfikator definicji wydania.

propertyFilters: string[]

Rozdzielana przecinkami lista właściwości rozszerzonych do pobrania. W przypadku ustawienia zwrócona definicja wydania będzie zawierać wartości dla określonych identyfikatorów właściwości (jeśli istnieją). Jeśli nie zostanie ustawiona, właściwości nie zostaną uwzględnione.

includeDisabled: boolean

Flaga logiczna do uwzględnienia wyłączonych definicji.

Zwraca

Promise<ReleaseDefinition>

getReleaseDefinitionHistory(string, number)

Pobieranie historii poprawek dla definicji wydania

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

definitionId: number

Identyfikator definicji.

Zwraca

Promise<ReleaseDefinitionRevision[]>

getReleaseDefinitionRevision(string, number, number)

Pobierz definicję wydania danej poprawki.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

definitionId: number

Identyfikator definicji wydania.

revision: number

Numer poprawki definicji wydania.

Zwraca

Promise<string>

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

Pobierz listę definicji wydania.

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

Identyfikator projektu lub nazwa projektu

searchText: string

Pobierz definicje wydania z nazwami zawierającymi tekst wyszukiwania.

expand: ReleaseDefinitionExpands

Właściwości, które powinny zostać rozwinięte na liście definicji wydania.

artifactType: string

Zostaną zwrócone definicje wydania z danym elementem artifactType. Wartości mogą być następujące: Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.

artifactSourceId: string

Zostaną zwrócone definicje wydania z danym identyfikatorem artifactSourceId. Na przykład w przypadku kompilacji będzie to {projectGuid}:{BuildDefinitionId}, dla serwera Jenkins będzie to {JenkinsConnectionId}:{JenkinsDefinitionId}, dla tfsOnPrem będzie to {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. W przypadku artefaktów innych firm, np. TeamCity, BitBucket można odwołać się do elementu "uniqueSourceIdentifier" w vss-extension.json w https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.

top: number

Liczba definicji wersji do pobrania.

continuationToken: string

Pobiera definicje wersji po podanym tokenie kontynuacji.

queryOrder: ReleaseDefinitionQueryOrder

Pobiera wyniki w zdefiniowanej kolejności. Wartość domyślna to "IdAscending".

path: string

Pobiera definicje wydania w określonej ścieżce.

isExactNameMatch: boolean

Wartość "true", aby pobierać definicje wydania z dokładnym dopasowaniem określonym w polu searchText. Wartość domyślna to "false".

tagFilter: string[]

Rozdzielana przecinkami lista tagów. Zostaną zwrócone tylko definicje wersji z tymi tagami.

propertyFilters: string[]

Rozdzielana przecinkami lista właściwości rozszerzonych do pobrania. W przypadku ustawienia zwrócone definicje wydania będą zawierać wartości dla określonych identyfikatorów właściwości (jeśli istnieją). Jeśli nie zostanie ustawiona, właściwości nie zostaną uwzględnione. Należy pamiętać, że nie spowoduje to odfiltrowania żadnej definicji wydania z wyników niezależnie od tego, czy ma ustawioną właściwość, czy nie.

definitionIdFilter: string[]

Rozdzielana przecinkami lista definicji wersji do pobrania.

isDeleted: boolean

"true", aby pobrać definicje wersji, które zostały usunięte. Wartość domyślna to "false"

searchTextContainsFolderName: boolean

"true", aby pobrać definicje wydania w folderze o nazwie określonej w searchText. Wartość domyślna to "false".

Zwraca

Promise<PagedList<ReleaseDefinition>>

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

Pobierz podsumowanie wydania danego identyfikatora definicji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

definitionId: number

Identyfikator definicji, aby uzyskać podsumowanie wydania.

releaseCount: number

Liczba wydań do ujęć w podsumowaniu.

includeArtifact: boolean

Uwzględnij szczegóły artefaktu. Wartość domyślna to "false".

definitionEnvironmentIdsFilter: number[]

Zwraca

Promise<ReleaseDefinitionSummary>

getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)

Pobierz środowisko wydania.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Identyfikator wydania.

environmentId: number

Identyfikator środowiska wydania.

expand: ReleaseEnvironmentExpands

Właściwość, która powinna zostać rozszerzona w środowisku.

Zwraca

Promise<ReleaseEnvironment>

getReleaseHistory(string, number)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Zwraca

Promise<ReleaseRevision[]>

getReleaseProjects(string, string)

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

Parametry

artifactType: string

artifactSourceId: string

Zwraca

Promise<ProjectReference[]>

getReleaseRevision(string, number, number)

Pobierz wydanie dla danego numeru poprawki.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Identyfikator wydania.

definitionSnapshotRevision: number

Numer poprawki migawki definicji.

Zwraca

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)

Pobieranie listy wydań

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

Identyfikator projektu lub nazwa projektu

definitionId: number

Wydania z tego identyfikatora definicji wydania.

definitionEnvironmentId: number

searchText: string

Wydania z nazwami zawierającymi tekst wyszukiwania.

createdBy: string

Wydania utworzone przez tego użytkownika.

statusFilter: ReleaseStatus

Wydania, które mają ten stan.

environmentStatusFilter: number

minCreatedTime: Date

Wydania, które zostały utworzone po tym czasie.

maxCreatedTime: Date

Wydania, które zostały utworzone wcześniej.

queryOrder: ReleaseQueryOrder

Pobiera wyniki w zdefiniowanej kolejności daty utworzenia dla wersji. Wartość domyślna to malejąco.

top: number

Liczba wersji do pobrania. Wartość domyślna to 50.

continuationToken: number

Pobiera wersje po podanym tokenie kontynuacji.

expand: ReleaseExpands

Właściwość, która powinna zostać rozwinięta na liście wydań.

artifactTypeId: string

Zostaną zwrócone wydania z danym identyfikatorem artifactTypeId. Wartości mogą być następujące: Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.

sourceId: string

Unikatowy identyfikator użytego artefaktu. Na przykład w przypadku kompilacji będzie to {projectGuid}:{BuildDefinitionId}, dla serwera Jenkins będzie to {JenkinsConnectionId}:{JenkinsDefinitionId}, dla tfsOnPrem będzie to {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. W przypadku artefaktów innych firm, np. TeamCity, BitBucket można odwołać się do elementu "uniqueSourceIdentifier" w vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.

artifactVersionId: string

Wersje z podanym identyfikatorem artifactVersionId zostaną zwrócone. Na przykład w przypadku elementu Build artifactType jest to buildId.

sourceBranchFilter: string

Wersje z danym źródłemBranchFilter zostaną zwrócone (nie należy ich używać ze środowiskiemStatusFilter).

isDeleted: boolean

Pobiera nietrwałe usunięte wersje, jeśli ma wartość true.

tagFilter: string[]

Rozdzielana przecinkami lista tagów. Zostaną zwrócone tylko wersje z tymi tagami.

propertyFilters: string[]

Rozdzielana przecinkami lista właściwości rozszerzonych do pobrania. W przypadku ustawienia zwrócone wydania będą zawierać wartości dla określonych identyfikatorów właściwości (jeśli istnieją). Jeśli nie zostanie ustawiona, właściwości nie zostaną uwzględnione. Należy pamiętać, że nie spowoduje to odfiltrowania żadnego wydania z wyników niezależnie od tego, czy ma ustawioną właściwość, czy nie.

releaseIdFilter: number[]

Rozdzielana przecinkami lista identyfikatorów wydań. Zostaną zwrócone tylko wersje z tymi identyfikatorami.

path: string

Wersje w tej ścieżce folderu zostaną zwrócone

Zwraca

Promise<Release[]>

getReleaseSettings(string)

Pobiera ustawienia wydania

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<ReleaseSettings>

getReleaseTags(string, number)

Pobiera tagi dla wydania

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Zwraca

Promise<string[]>

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

Pobierz załącznik zadania wydania.

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

Identyfikator projektu lub nazwa projektu

releaseId: number

Identyfikator wydania.

environmentId: number

Identyfikator środowiska wydania.

attemptId: number

Próba wdrożenia.

planId: string

Identyfikator planu fazy wdrażania.

timelineId: string

Identyfikator osi czasu zadania.

recordId: string

Identyfikator rekordu załącznika.

type: string

Typ załącznika.

name: string

Nazwa załącznika.

Zwraca

Promise<ArrayBuffer>

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

Pobierz załączniki zadań wydania.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Identyfikator wydania.

environmentId: number

Identyfikator środowiska wydania.

attemptId: number

Próba wdrożenia.

planId: string

Identyfikator planu fazy wdrażania.

type: string

Typ załącznika.

Zwraca

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

Identyfikator projektu lub nazwa projektu

releaseId: number

baseReleaseId: number

top: number

artifactAlias: string

Zwraca

Promise<ReleaseWorkItemRef[]>

getSourceBranches(string, number)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

definitionId: number

Zwraca

Promise<string[]>

getSummaryMailSections(string, number)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Zwraca

Promise<SummaryMailSection[]>

getTags(string)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<string[]>

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

Pobierz załącznik zadania.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Identyfikator wydania.

environmentId: number

Identyfikator środowiska wydania.

attemptId: number

Próba wdrożenia.

timelineId: string

Identyfikator osi czasu zadania.

recordId: string

Identyfikator rekordu załącznika.

type: string

Typ załącznika.

name: string

Nazwa załącznika.

Zwraca

Promise<ArrayBuffer>

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

Pobierz załączniki zadań.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Identyfikator wydania.

environmentId: number

Identyfikator środowiska wydania.

attemptId: number

Próba wdrożenia.

timelineId: string

Identyfikator osi czasu zadania.

type: string

Typ załącznika.

Zwraca

Promise<ReleaseTaskAttachment[]>

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

Pobiera dziennik zadań wydania jako plik w postaci zwykłego tekstu.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Identyfikator wydania.

environmentId: number

Identyfikator środowiska wydania.

releaseDeployPhaseId: number

Identyfikator fazy wdrażania wydania.

taskId: number

Identyfikator releaseTask dziennika.

startLine: number

Numer wiersza początkowego dla dzienników

endLine: number

Końcowy numer wiersza dla dzienników

Zwraca

Promise<string>

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

Pobiera dziennik zadań wydania jako plik w postaci zwykłego tekstu.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Identyfikator wydania.

environmentId: number

Identyfikator środowiska wydania.

attemptId: number

timelineId: string

taskId: number

Identyfikator releaseTask dziennika.

startLine: number

Numer wiersza początkowego dla dzienników

endLine: number

Końcowy numer wiersza dla dzienników

Zwraca

Promise<string>

getTasks(string, number, number, number)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

environmentId: number

attemptId: number

Zwraca

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

Identyfikator projektu lub nazwa projektu

releaseId: number

environmentId: number

attemptId: number

timelineId: string

Zwraca

Promise<ReleaseTask[]>

getTasksForTaskGroup(string, number, number, number)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

environmentId: number

releaseDeployPhaseId: number

Zwraca

Promise<ReleaseTask[]>

listDefinitionEnvironmentTemplates(string, boolean)

Pobiera listę szablonów środowisk definicji

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

isDeleted: boolean

"true" w celu pobrania szablonów środowiska definicji, które zostały usunięte. Wartość domyślna to "false"

Zwraca

Promise<ReleaseDefinitionEnvironmentTemplate[]>

sendSummaryMail(MailMessage, string, number)

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

Parametry

mailMessage: MailMessage

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Zwraca

Promise<void>

undeleteRelease(string, number, string)

Cofanie usunięcia nietrwałego wydania.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Identyfikator wydania, który ma być nieukończony.

comment: string

Wszelkie komentarze dotyczące nieuzupełniania.

Zwraca

Promise<void>

undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)

Cofanie usunięcia definicji wydania.

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

Parametry

releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter

Obiekt do cofania definicji wydania.

project: string

Identyfikator projektu lub nazwa projektu

definitionId: number

Identyfikator definicji wydania, która ma być nieukończona

Zwraca

Promise<ReleaseDefinition>

undeleteReleaseDefinitionEnvironmentTemplate(string, string)

Cofnij usunięcie szablonu środowiska definicji wydania.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

templateId: string

Identyfikator szablonu środowiska definicji, który ma być nieukończony

Zwraca

Promise<ReleaseDefinitionEnvironmentTemplate>

updateFolder(Folder, string, string)

Aktualizuje istniejący folder pod daną istniejącą ścieżką.

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

Parametry

folder: Folder

folder.

project: string

Identyfikator projektu lub nazwa projektu

path: string

Ścieżka folderu do aktualizacji.

Zwraca

Promise<Folder>

updateGates(GateUpdateMetadata, string, number)

Aktualizuje bramę wdrożenia.

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

Parametry

gateUpdateMetadata: GateUpdateMetadata

Metadane do poprawiania bram wydania.

project: string

Identyfikator projektu lub nazwa projektu

gateStepId: number

Identyfikator kroku bramy.

Zwraca

Promise<ReleaseGates>

updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)

Aktualizowanie interwencji ręcznej.

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

Parametry

manualInterventionUpdateMetadata: ManualInterventionUpdateMetadata

Metadane do aktualizowania interwencji ręcznej.

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Identyfikator wydania.

manualInterventionId: number

Identyfikator interwencji ręcznej.

Zwraca

Promise<ManualIntervention>

updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)

Aktualizacje ustawień wydania potoku organizacji

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

Parametry

newSettings: OrgPipelineReleaseSettingsUpdateParameters

Zwraca

Promise<OrgPipelineReleaseSettings>

updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)

Ustawienia wydania potoku aktualizacji

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

Parametry

newSettings: ProjectPipelineReleaseSettingsUpdateParameters

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<ProjectPipelineReleaseSettings>

updateRelease(Release, string, number)

Aktualizowanie kompletnego obiektu wydania.

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

Parametry

release: Release

Zwolnij obiekt aktualizacji.

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Identyfikator wydania do aktualizacji.

Zwraca

Promise<Release>

updateReleaseApproval(ReleaseApproval, string, number)

Aktualizowanie stanu zatwierdzenia

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

Parametry

approval: ReleaseApproval

Obiekt ReleaseApproval ma stan, osoba zatwierdzająca i komentarze.

project: string

Identyfikator projektu lub nazwa projektu

approvalId: number

Identyfikator zatwierdzenia.

Zwraca

Promise<ReleaseApproval>

updateReleaseApprovals(ReleaseApproval[], string)

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

Parametry

approvals: ReleaseApproval[]

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<ReleaseApproval[]>

updateReleaseDefinition(ReleaseDefinition, string, boolean)

Aktualizowanie definicji wydania.

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

Parametry

releaseDefinition: ReleaseDefinition

Obiekt definicji wydania do aktualizacji.

project: string

Identyfikator projektu lub nazwa projektu

skipTasksValidation: boolean

Pomiń flagę logiczną walidacji zadania

Zwraca

Promise<ReleaseDefinition>

updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)

Aktualizowanie stanu środowiska wydania

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

Parametry

environmentUpdateData: ReleaseEnvironmentUpdateMetadata

Środowisko aktualizuje metadane.

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Identyfikator wydania.

environmentId: number

Identyfikator środowiska wydania.

Zwraca

Promise<ReleaseEnvironment>

updateReleaseResource(ReleaseUpdateMetadata, string, number)

Zaktualizuj kilka właściwości wydania.

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

Parametry

releaseUpdateMetadata: ReleaseUpdateMetadata

Właściwości wydania do aktualizacji.

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Identyfikator wydania do aktualizacji.

Zwraca

Promise<Release>

updateReleaseSettings(ReleaseSettings, string)

Aktualizuje ustawienia wydania

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

Parametry

releaseSettings: ReleaseSettings

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<ReleaseSettings>

Sprzężenie zwrotne

Czy ta strona była pomocna?

Udostępnij za pomocą

ReleaseRestClient class

Konstruktorów

Właściwości

Metody

Szczegóły konstruktora

ReleaseRestClient(IVssRestClientOptions)

Parametry

Szczegóły nieruchomości

RESOURCE_AREA_ID

Wartość nieruchomości

Szczegóły metody

addDefinitionTag(string, number, string)

Parametry

Zwraca

addDefinitionTags(string[], string, number)

Parametry

Zwraca

addReleaseTag(string, number, string)

Parametry

Zwraca

addReleaseTags(string[], string, number)

Parametry

Zwraca

createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)

Parametry

Zwraca

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

Parametry

Zwraca

createFolder(Folder, string, string)

Parametry

Zwraca

createRelease(ReleaseStartMetadata, string)

Parametry

Zwraca

createReleaseDefinition(ReleaseDefinition, string)

Parametry

Zwraca

deleteDefinitionEnvironmentTemplate(string, string)

Parametry

Zwraca

deleteDefinitionTag(string, number, string)

Parametry

Zwraca

deleteFavorites(string, string, string, string)

Parametry

Zwraca

deleteFolder(string, string)

Parametry

Zwraca

deleteRelease(string, number, string)

Parametry

Zwraca

deleteReleaseDefinition(string, number, string, boolean)

Parametry

Zwraca

deleteReleaseTag(string, number, string)

Parametry

Zwraca

getAgentArtifactDefinitions(string, number)

Parametry

Zwraca

getApproval(string, number, boolean)

Parametry

Zwraca

getApprovalHistory(string, number)

Parametry

Zwraca

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

Parametry

Zwraca

getArtifactTypeDefinitions(string)

Parametry

Zwraca

getArtifactVersions(string, number)

Parametry

Zwraca

getArtifactVersionsForSources(Artifact[], string)

Parametry