ReleaseRestClient class

Colis:: azure-devops-extension-api

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des API REST VSS

S' étend: RestClientBase

Constructeurs

ReleaseRestClient(IVssRestClientOptions)

Propriétés

Méthode

addDefinitionTag(string, number, string)	Ajoute une balise à une définition
addDefinitionTags(string[], string, number)	Ajoute plusieurs balises à une définition
addReleaseTag(string, number, string)	Ajoute une balise à un releaseId
addReleaseTags(string[], string, number)	Ajoute une balise à une version
createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)	Crée un modèle d’environnement de définition
createFavorites(FavoriteItem[], string, string, string)
createFolder(Folder, string, string)	Crée un dossier.
createRelease(ReleaseStartMetadata, string)	Créez une version.
createReleaseDefinition(ReleaseDefinition, string)	Créer une définition de mise en production
deleteDefinitionEnvironmentTemplate(string, string)	Supprimer un modèle d’environnement de définition
deleteDefinitionTag(string, number, string)	Supprime une balise d’une définition
deleteFavorites(string, string, string, string)
deleteFolder(string, string)	Supprime un dossier de définition pour un nom de dossier et un chemin d’accès donnés, ainsi que toutes les définitions existantes.
deleteRelease(string, number, string)	Suppression réversible d’une version
deleteReleaseDefinition(string, number, string, boolean)	Supprimez une définition de mise en production.
deleteReleaseTag(string, number, string)	Supprime une balise d’une version
getAgentArtifactDefinitions(string, number)	Retourne les détails de l’artefact requis par l’agent Automation
getApproval(string, number, boolean)	Obtenez une approbation.
getApprovalHistory(string, number)	Obtenir l’historique d’approbation.
getApprovals(string, string, ApprovalStatus, number[], ApprovalType, number, number, ReleaseQueryOrder, boolean)	Obtenir la liste des approbations
getArtifactTypeDefinitions(string)
getArtifactVersions(string, number)
getArtifactVersionsForSources(Artifact[], string)
getAutoTriggerIssues(string, string, string, string)
getDefinitionEnvironments(string, string, string[])
getDefinitionEnvironmentTemplate(string, string)	Obtient un modèle d’environnement de définition
getDefinitionRevision(string, number, number)	Obtenir la définition de mise en production pour un id de définition et une révision donnés
getDefinitionTags(string, number)	Obtient les balises d’une définition
getDeploymentBadge(string, number, number, string)	Obtient un badge qui indique l’état du déploiement le plus récent pour un environnement.
getDeployments(string, number, number, string, Date, Date, DeploymentStatus, DeploymentOperationStatus, boolean, ReleaseQueryOrder, number, number, string, Date, Date, string)	Obtenir la liste des déploiements
getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)
getFavorites(string, string, string)
getFolders(string, string, FolderPathQueryOrder)	Obtient les dossiers.
getGateLog(string, number, number, number, number)	Obtient les journaux d’activité de porte
getInputValues(InputValuesQuery, string)
getIssues(string, number, string)
getLog(string, number, number, number, number)	Obtient les journaux d’activité
getLogs(string, number)	Obtenir les journaux d’activité d’un ID de mise en production.
getManualIntervention(string, number, number)	Obtenez une intervention manuelle pour une version donnée et l’ID d’intervention manuelle.
getManualInterventions(string, number)	Répertoriez toutes les interventions manuelles pour une version donnée.
getMetrics(string, Date)
getOrgPipelineReleaseSettings()	Obtient les paramètres de mise en production du pipeline d’organisation
getPipelineReleaseSettings(string)	Obtient les paramètres de mise en production du pipeline
getRelease(string, number, ApprovalFilters, string[], SingleReleaseExpands, number, boolean)	Obtenir une version
getReleaseChanges(string, number, number, number, string)
getReleaseDefinition(string, number, string[], boolean)	Obtenir une définition de mise en production.
getReleaseDefinitionHistory(string, number)	Obtenir l’historique des révisions pour une définition de mise en production
getReleaseDefinitionRevision(string, number, number)	Obtenir la définition de mise en production d’une révision donnée.
getReleaseDefinitions(string, string, ReleaseDefinitionExpands, string, string, number, string, ReleaseDefinitionQueryOrder, string, boolean, string[], string[], string[], boolean, boolean)	Obtenez la liste des définitions de mise en production.
getReleaseDefinitionSummary(string, number, number, boolean, number[])	Obtenir le résumé de publication d’un ID de définition donné.
getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)	Obtenir un environnement de mise en production.
getReleaseHistory(string, number)
getReleaseProjects(string, string)
getReleaseRevision(string, number, number)	Obtenir la version d’un numéro de révision donné.
getReleases(string, number, number, string, string, ReleaseStatus, number, Date, Date, ReleaseQueryOrder, number, number, ReleaseExpands, string, string, string, string, boolean, string[], string[], number[], string)	Obtenir la liste des versions
getReleaseSettings(string)	Obtient les paramètres de mise en production
getReleaseTags(string, number)	Obtient les balises d’une version
getReleaseTaskAttachmentContent(string, number, number, number, string, string, string, string, string)	Obtenir une pièce jointe de tâche de mise en production.
getReleaseTaskAttachments(string, number, number, number, string, string)	Obtenez les pièces jointes de la tâche de mise en production.
getReleaseWorkItemsRefs(string, number, number, number, string)
getSourceBranches(string, number)
getSummaryMailSections(string, number)
getTags(string)
getTaskAttachmentContent(string, number, number, number, string, string, string, string)	Obtenir une pièce jointe de tâche.
getTaskAttachments(string, number, number, number, string, string)	Obtenez les pièces jointes de la tâche.
getTaskLog(string, number, number, number, number, number, number)	Obtient le journal des tâches d’une mise en production sous forme de fichier texte brut.
getTaskLog2(string, number, number, number, string, number, number, number)	Obtient le journal des tâches d’une mise en production sous forme de fichier texte brut.
getTasks(string, number, number, number)
getTasks2(string, number, number, number, string)
getTasksForTaskGroup(string, number, number, number)
listDefinitionEnvironmentTemplates(string, boolean)	Obtient une liste de modèles d’environnement de définition
sendSummaryMail(MailMessage, string, number)
undeleteRelease(string, number, string)	Annulez la suppression réversible d’une version supprimée.
undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)	Annuler la suppression d’une définition de mise en production.
undeleteReleaseDefinitionEnvironmentTemplate(string, string)	Annuler la suppression d’un modèle d’environnement de définition de mise en production.
updateFolder(Folder, string, string)	Met à jour un dossier existant au chemin d’accès existant donné.
updateGates(GateUpdateMetadata, string, number)	Met à jour la porte d’un déploiement.
updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)	Mettre à jour l’intervention manuelle.
updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)	Met à jour les paramètres de mise en production du pipeline d’organisation
updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)	Mises à jour des paramètres de mise en production du pipeline
updateRelease(Release, string, number)	Mettez à jour un objet de mise en production complet.
updateReleaseApproval(ReleaseApproval, string, number)	Mettre à jour l’état d’une approbation
updateReleaseApprovals(ReleaseApproval[], string)
updateReleaseDefinition(ReleaseDefinition, string, boolean)	Mettez à jour une définition de mise en production.
updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)	Mettre à jour l’état d’un environnement de mise en production
updateReleaseResource(ReleaseUpdateMetadata, string, number)	Mettez à jour quelques propriétés d’une version.
updateReleaseSettings(ReleaseSettings, string)	Met à jour les paramètres de mise en production

Détails du constructeur

ReleaseRestClient(IVssRestClientOptions)

new ReleaseRestClient(options: IVssRestClientOptions)

Paramètres

options: IVssRestClientOptions

Détails de la propriété

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valeur de la propriété

string

Détails de la méthode

addDefinitionTag(string, number, string)

Ajoute une balise à une définition

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

Paramètres

project: string

ID de projet ou nom du projet

releaseDefinitionId: number

tag: string

Retourne

Promise<string[]>

addDefinitionTags(string[], string, number)

Ajoute plusieurs balises à une définition

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

Paramètres

tags: string[]

project: string

ID de projet ou nom du projet

releaseDefinitionId: number

Retourne

Promise<string[]>

addReleaseTag(string, number, string)

Ajoute une balise à un releaseId

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

tag: string

Retourne

Promise<string[]>

addReleaseTags(string[], string, number)

Ajoute une balise à une version

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

Paramètres

tags: string[]

project: string

ID de projet ou nom du projet

releaseId: number

Retourne

Promise<string[]>

createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)

Crée un modèle d’environnement de définition

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

Paramètres

template: ReleaseDefinitionEnvironmentTemplate

Modèle d’environnement de définition à créer

project: string

ID de projet ou nom du projet

Retourne

Promise<ReleaseDefinitionEnvironmentTemplate>

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

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

Paramètres

favoriteItems: FavoriteItem[]

project: string

ID de projet ou nom du projet

scope: string

identityId: string

Retourne

Promise<FavoriteItem[]>

createFolder(Folder, string, string)

Crée un dossier.

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

Paramètres

folder: Folder

dossier.

project: string

ID de projet ou nom du projet

path: string

Chemin d’accès du dossier.

Retourne

Promise<Folder>

createRelease(ReleaseStartMetadata, string)

Créez une version.

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

Paramètres

releaseStartMetadata: ReleaseStartMetadata

Métadonnées pour créer une version.

project: string

ID de projet ou nom du projet

Retourne

Promise<Release>

createReleaseDefinition(ReleaseDefinition, string)

Créer une définition de mise en production

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

Paramètres

releaseDefinition: ReleaseDefinition

objet de définition de mise en production à créer.

project: string

ID de projet ou nom du projet

Retourne

Promise<ReleaseDefinition>

deleteDefinitionEnvironmentTemplate(string, string)

Supprimer un modèle d’environnement de définition

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

Paramètres

project: string

ID de projet ou nom du projet

templateId: string

ID du modèle d’environnement de définition

Retourne

Promise<void>

deleteDefinitionTag(string, number, string)

Supprime une balise d’une définition

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

Paramètres

project: string

ID de projet ou nom du projet

releaseDefinitionId: number

tag: string

Retourne

Promise<string[]>

deleteFavorites(string, string, string, string)

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

Paramètres

project: string

ID de projet ou nom du projet

scope: string

identityId: string

favoriteItemIds: string

Retourne

Promise<void>

deleteFolder(string, string)

Supprime un dossier de définition pour un nom de dossier et un chemin d’accès donnés, ainsi que toutes les définitions existantes.

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

Paramètres

project: string

ID de projet ou nom du projet

path: string

Chemin d’accès du dossier à supprimer.

Retourne

Promise<void>

deleteRelease(string, number, string)

Suppression réversible d’une version

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

ID de la version.

comment: string

Commentaire pour la suppression d’une version.

Retourne

Promise<void>

deleteReleaseDefinition(string, number, string, boolean)

Supprimez une définition de mise en production.

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

Paramètres

project: string

ID de projet ou nom du projet

definitionId: number

ID de la définition de mise en production.

comment: string

Commentaire pour la suppression d’une définition de mise en production.

forceDelete: boolean

'true' pour annuler automatiquement les déploiements de mises en production en cours et poursuivre la suppression de la définition de mise en production. La valeur par défaut est « false ».

Retourne

Promise<void>

deleteReleaseTag(string, number, string)

Supprime une balise d’une version

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

tag: string

Retourne

Promise<string[]>

getAgentArtifactDefinitions(string, number)

Retourne les détails de l’artefact requis par l’agent Automation

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

Retourne

Promise<AgentArtifactDefinition[]>

getApproval(string, number, boolean)

Obtenez une approbation.

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

Paramètres

project: string

ID de projet ou nom du projet

approvalId: number

ID de l’approbation.

includeHistory: boolean

« true » pour inclure l’historique de l’approbation. La valeur par défaut est « false ».

Retourne

Promise<ReleaseApproval>

getApprovalHistory(string, number)

Obtenir l’historique d’approbation.

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

Paramètres

project: string

ID de projet ou nom du projet

approvalStepId: number

ID de l’approbation.

Retourne

Promise<ReleaseApproval>

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

Obtenir la liste des approbations

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

Paramètres

project: string

ID de projet ou nom du projet

assignedToFilter: string

Approbations attribuées à cet utilisateur.

statusFilter: ApprovalStatus

Approbations avec cet état. La valeur par défaut est « en attente ».

releaseIdsFilter: number[]

Approbations pour les ID de mise en production mentionnés dans le filtre. Plusieurs versions peuvent être mentionnées en les séparant par « », par exemple releaseIdsFilter=1,2,3,4.

typeFilter: ApprovalType

Approbation avec ce type.

top: number

Nombre d’approbations à obtenir. La valeur par défaut est 50.

continuationToken: number

Obtient les approbations après le jeton de continuation fourni.

queryOrder: ReleaseQueryOrder

Obtient les résultats dans l’ordre défini des approbations créées. La valeur par défaut est « décroissante ».

includeMyGroupApprovals: boolean

« true » pour inclure mes approbations de groupe. La valeur par défaut est « false ».

Retourne

Promise<PagedList<ReleaseApproval>>

getArtifactTypeDefinitions(string)

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

Paramètres

project: string

ID de projet ou nom du projet

Retourne

Promise<ArtifactTypeDefinition[]>

getArtifactVersions(string, number)

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

Paramètres

project: string

ID de projet ou nom du projet

releaseDefinitionId: number

Retourne

Promise<ArtifactVersionQueryResult>

getArtifactVersionsForSources(Artifact[], string)

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

Paramètres

artifacts: Artifact[]

project: string

ID de projet ou nom du projet

Retourne

Promise<ArtifactVersionQueryResult>

getAutoTriggerIssues(string, string, string, string)

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

Paramètres

artifactType: string

sourceId: string

artifactVersionId: string

project: string

ID de projet ou nom du projet

Retourne

Promise<AutoTriggerIssue[]>

getDefinitionEnvironments(string, string, string[])

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

Paramètres

project: string

ID de projet ou nom du projet

taskGroupId: string

propertyFilters: string[]

Retourne

Promise<DefinitionEnvironmentReference[]>

getDefinitionEnvironmentTemplate(string, string)

Obtient un modèle d’environnement de définition

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

Paramètres

project: string

ID de projet ou nom du projet

templateId: string

ID du modèle d’environnement de définition

Retourne

Promise<ReleaseDefinitionEnvironmentTemplate>

getDefinitionRevision(string, number, number)

Obtenir la définition de mise en production pour un id de définition et une révision donnés

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

Paramètres

project: string

ID de projet ou nom du projet

definitionId: number

ID de la définition.

revision: number

ID de la révision.

Retourne

Promise<string>

getDefinitionTags(string, number)

Obtient les balises d’une définition

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

Paramètres

project: string

ID de projet ou nom du projet

releaseDefinitionId: number

Retourne

Promise<string[]>

getDeploymentBadge(string, number, number, string)

Obtient un badge qui indique l’état du déploiement le plus récent pour un environnement.

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

Paramètres

projectId: string

ID du projet.

releaseDefinitionId: number

ID de la définition de mise en production.

environmentId: number

ID de l’environnement.

branchName: string

Nom de la branche.

Retourne

Promise<string>

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

Obtenir la liste des déploiements

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

Paramètres

project: string

ID de projet ou nom du projet

definitionId: number

Répertoriez les déploiements d’un ID de définition donné.

definitionEnvironmentId: number

Répertoriez les déploiements pour un ID d’environnement de définition donné.

createdBy: string

Répertoriez les déploiements pour lesquels les déploiements sont créés en tant qu’identité spécifiée.

minModifiedTime: Date

Répertoriez les déploiements avec l’heure LastModified >= minModifiedTime.

maxModifiedTime: Date

Répertoriez les déploiements avec l’heure LastModified <= maxModifiedTime.

deploymentStatus: DeploymentStatus

Répertoriez les déploiements avec un état de déploiement donné. La valeur par défaut est « All ».

operationStatus: DeploymentOperationStatus

Répertoriez les déploiements avec l’état de l’opération donné. La valeur par défaut est « All ».

latestAttemptsOnly: boolean

« true » pour inclure les déploiements avec la dernière tentative uniquement. La valeur par défaut est « false ».

queryOrder: ReleaseQueryOrder

Répertoriez les déploiements avec l’ordre de requête donné. La valeur par défaut est « Décroissante ».

top: number

Répertoriez les déploiements avec le haut donné. Le haut par défaut est « 50 » et le haut maximal est « 100 ».

continuationToken: number

Répertoriez les déploiements avec l’ID de déploiement >= continuationToken.

createdFor: string

Répertoriez les déploiements pour lesquels les déploiements sont demandés en tant qu’identité spécifiée.

minStartedTime: Date

Répertoriez les déploiements avec l’heure StartedOn >= minStartedTime.

maxStartedTime: Date

Répertoriez les déploiements avec l’heure StartedOn <= maxStartedTime.

sourceBranch: string

Répertoriez les déploiements déployés à partir du nom de branche donné.

Retourne

Promise<PagedList<Deployment>>

getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)

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

Paramètres

queryParameters: DeploymentQueryParameters

project: string

ID de projet ou nom du projet

Retourne

Promise<Deployment[]>

getFavorites(string, string, string)

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

Paramètres

project: string

ID de projet ou nom du projet

scope: string

identityId: string

Retourne

Promise<FavoriteItem[]>

getFolders(string, string, FolderPathQueryOrder)

Obtient les dossiers.

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

Paramètres

project: string

ID de projet ou nom du projet

path: string

Chemin d’accès du dossier.

queryOrder: FolderPathQueryOrder

Obtient les résultats dans l’ordre défini. La valeur par défaut est « None ».

Retourne

Promise<Folder[]>

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

Obtient les journaux d’activité de porte

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

ID de la version.

environmentId: number

ID de l’environnement de mise en production.

gateId: number

ID de la porte.

taskId: number

ID ReleaseTask pour le journal.

Retourne

Promise<string>

getInputValues(InputValuesQuery, string)

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

Paramètres

query: InputValuesQuery

project: string

ID de projet ou nom du projet

Retourne

Promise<InputValuesQuery>

getIssues(string, number, string)

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

Paramètres

project: string

ID de projet ou nom du projet

buildId: number

sourceId: string

Retourne

Promise<AutoTriggerIssue[]>

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

Obtient les journaux d’activité

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

ID de la version.

environmentId: number

ID de l’environnement de mise en production.

taskId: number

ID ReleaseTask pour le journal.

attemptId: number

ID de la tentative.

Retourne

Promise<string>

getLogs(string, number)

Obtenir les journaux d’activité d’un ID de mise en production.

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

ID de la version.

Retourne

Promise<ArrayBuffer>

getManualIntervention(string, number, number)

Obtenez une intervention manuelle pour une version donnée et l’ID d’intervention manuelle.

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

ID de la version.

manualInterventionId: number

ID de l’intervention manuelle.

Retourne

Promise<ManualIntervention>

getManualInterventions(string, number)

Répertoriez toutes les interventions manuelles pour une version donnée.

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

ID de la version.

Retourne

Promise<ManualIntervention[]>

getMetrics(string, Date)

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

Paramètres

project: string

ID de projet ou nom du projet

minMetricsTime: Date

Retourne

Promise<Metric[]>

getOrgPipelineReleaseSettings()

Obtient les paramètres de mise en production du pipeline d’organisation

function getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>

Retourne

Promise<OrgPipelineReleaseSettings>

getPipelineReleaseSettings(string)

Obtient les paramètres de mise en production du pipeline

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

Paramètres

project: string

ID de projet ou nom du projet

Retourne

Promise<ProjectPipelineReleaseSettings>

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

Obtenir une version

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

ID de la version.

approvalFilters: ApprovalFilters

Filtre qui permet d’extraire les étapes d’approbation de manière sélective en fonction de son automatisation ou de son manuel. Cela déciderait également si nous devrions récupérer des instantanés de pré-approbation et de post-approbation. Suppose tout par défaut

propertyFilters: string[]

Liste délimitée par des virgules des propriétés étendues à récupérer. Si elle est définie, la version retournée contient des valeurs pour les ID de propriété spécifiés (s’ils existent). S’il n’est pas défini, les propriétés ne sont pas incluses.

expand: SingleReleaseExpands

Propriété qui doit être développée dans la version.

topGateRecords: number

Nombre d’enregistrements de porte de mise en production à obtenir. La valeur par défaut est 5.

includeDisabledDefinitions: boolean

Inclure les définitions désactivées (si la valeur est « false » renvoie l’erreur, la valeur par défaut est « true »)

Retourne

Promise<Release>

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

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

baseReleaseId: number

top: number

artifactAlias: string

Retourne

Promise<Change[]>

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

Obtenir une définition de mise en production.

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

Paramètres

project: string

ID de projet ou nom du projet

definitionId: number

ID de la définition de mise en production.

propertyFilters: string[]

Liste délimitée par des virgules des propriétés étendues à récupérer. Si elle est définie, la définition de mise en production retournée contient des valeurs pour les ID de propriété spécifiés (s’ils existent). S’il n’est pas défini, les propriétés ne sont pas incluses.

includeDisabled: boolean

Indicateur booléen pour inclure des définitions désactivées.

Retourne

Promise<ReleaseDefinition>

getReleaseDefinitionHistory(string, number)

Obtenir l’historique des révisions pour une définition de mise en production

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

Paramètres

project: string

ID de projet ou nom du projet

definitionId: number

ID de la définition.

Retourne

Promise<ReleaseDefinitionRevision[]>

getReleaseDefinitionRevision(string, number, number)

Obtenir la définition de mise en production d’une révision donnée.

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

Paramètres

project: string

ID de projet ou nom du projet

definitionId: number

ID de la définition de mise en production.

revision: number

Numéro de révision de la définition de mise en production.

Retourne

Promise<string>

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

Obtenez la liste des définitions de mise en production.

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

Paramètres

project: string

ID de projet ou nom du projet

searchText: string

Obtenir des définitions de mise en production avec des noms contenant searchText.

expand: ReleaseDefinitionExpands

Propriétés qui doivent être développées dans la liste des définitions release.

artifactType: string

Les définitions de mise en production avec artifactType donné sont retournées. Les valeurs peuvent être Build, Jenkins, GitHub, Nuget, Team Build (externe), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.

artifactSourceId: string

Les définitions de mise en production avec artifactSourceId donné sont retournées. Par exemple, pour la génération, il s’agit de {projectGuid} :{BuildDefinitionId}, pour Jenkins, il s’agit de {JenkinsConnectionId} :{JenkinsDefinitionId}, pour TfsOnPrem, il s’agit de {TfsOnPremConnectionId} :{ProjectName} :{TfsOnPremDefinitionId}. Pour les artefacts tiers, par exemple TeamCity, BitBucket, vous pouvez faire référence à « uniqueSourceIdentifier » à l’intérieur de vss-extension.json à https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.

top: number

Nombre de définitions de mise en production à obtenir.

continuationToken: string

Obtient les définitions de mise en production après le jeton de continuation fourni.

queryOrder: ReleaseDefinitionQueryOrder

Obtient les résultats dans l’ordre défini. La valeur par défaut est « IdAscending ».

path: string

Obtient les définitions de mise en production sous le chemin d’accès spécifié.

isExactNameMatch: boolean

'true' pour obtenir les définitions de mise en production avec une correspondance exacte, comme spécifié dans searchText. La valeur par défaut est « false ».

tagFilter: string[]

Liste délimitée par des virgules de balises. Seules les définitions de mise en production avec ces balises sont retournées.

propertyFilters: string[]

Liste délimitée par des virgules des propriétés étendues à récupérer. Si elle est définie, les définitions de mise en production retournées contiennent des valeurs pour les ID de propriété spécifiés (s’ils existent). S’il n’est pas défini, les propriétés ne sont pas incluses. Notez que cela ne filtre aucune définition de mise en production des résultats, quelle que soit la propriété définie ou non.

definitionIdFilter: string[]

Liste délimitée par des virgules des définitions de mise en production à récupérer.

isDeleted: boolean

« true » pour obtenir les définitions de mise en production qui ont été supprimées. La valeur par défaut est « false »

searchTextContainsFolderName: boolean

'true' pour obtenir les définitions de mise en production sous le dossier portant le nom spécifié dans searchText. La valeur par défaut est « false ».

Retourne

Promise<PagedList<ReleaseDefinition>>

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

Obtenir le résumé de publication d’un ID de définition donné.

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

Paramètres

project: string

ID de projet ou nom du projet

definitionId: number

ID de la définition pour obtenir le résumé de la mise en production.

releaseCount: number

Nombre de versions à inclure dans le résumé.

includeArtifact: boolean

Incluez les détails de l’artefact. La valeur par défaut est « false ».

definitionEnvironmentIdsFilter: number[]

Retourne

Promise<ReleaseDefinitionSummary>

getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)

Obtenir un environnement de mise en production.

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

ID de la version.

environmentId: number

ID de l’environnement de mise en production.

expand: ReleaseEnvironmentExpands

Propriété qui doit être développée dans l’environnement.

Retourne

Promise<ReleaseEnvironment>

getReleaseHistory(string, number)

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

Retourne

Promise<ReleaseRevision[]>

getReleaseProjects(string, string)

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

Paramètres

artifactType: string

artifactSourceId: string

Retourne

Promise<ProjectReference[]>

getReleaseRevision(string, number, number)

Obtenir la version d’un numéro de révision donné.

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

ID de la version.

definitionSnapshotRevision: number

Numéro de révision de capture instantanée de définition.

Retourne

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)

Obtenir la liste des versions

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

Paramètres

project: string

ID de projet ou nom du projet

definitionId: number

Libère de cet ID de définition de mise en production.

definitionEnvironmentId: number

searchText: string

Libère avec des noms contenant searchText.

createdBy: string

Versions créées par cet utilisateur.

statusFilter: ReleaseStatus

Versions qui ont cet état.

environmentStatusFilter: number

minCreatedTime: Date

Versions créées après cette date.

maxCreatedTime: Date

Versions créées avant cette date.

queryOrder: ReleaseQueryOrder

Obtient les résultats dans l’ordre défini de la date de création pour les versions. La valeur par défaut est décroissante.

top: number

Nombre de versions à obtenir. La valeur par défaut est 50.

continuationToken: number

Obtient les versions après le jeton de continuation fourni.

expand: ReleaseExpands

Propriété qui doit être développée dans la liste des versions.

artifactTypeId: string

Les mises en production avec artifactTypeId donné sont retournées. Les valeurs peuvent être Build, Jenkins, GitHub, Nuget, Team Build (externe), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.

sourceId: string

Identificateur unique de l’artefact utilisé. Par exemple, pour la génération, il s’agit de {projectGuid} :{BuildDefinitionId}, pour Jenkins, il s’agit de {JenkinsConnectionId} :{JenkinsDefinitionId}, pour TfsOnPrem, il s’agit de {TfsOnPremConnectionId} :{ProjectName} :{TfsOnPremDefinitionId}. Pour les artefacts tiers, par exemple TeamCity, BitBucket, vous pouvez faire référence à « uniqueSourceIdentifier » à l’intérieur de vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.

artifactVersionId: string

Les mises en production avec artifactVersionId donné sont retournées. Par exemple, dans le cas de Build artifactType, il s’agit de buildId.

sourceBranchFilter: string

Les versions avec sourceBranchFilter donnée sont retournées (pas à utiliser avec environmentStatusFilter).

isDeleted: boolean

Obtient les versions supprimées de manière réversible, si la valeur est true.

tagFilter: string[]

Liste délimitée par des virgules de balises. Seules les versions avec ces balises sont retournées.

propertyFilters: string[]

Liste délimitée par des virgules des propriétés étendues à récupérer. Si elle est définie, les versions retournées contiennent des valeurs pour les ID de propriété spécifiés (s’ils existent). S’il n’est pas défini, les propriétés ne sont pas incluses. Notez que cela ne filtre aucune version des résultats indépendamment du fait qu’elle ait une propriété définie ou non.

releaseIdFilter: number[]

Liste délimitée par des virgules d’ID de mise en production. Seules les versions avec ces ID sont retournées.

path: string

Les mises en production sous ce chemin d’accès au dossier sont retournées

Retourne

Promise<Release[]>

getReleaseSettings(string)

Obtient les paramètres de mise en production

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

Paramètres

project: string

ID de projet ou nom du projet

Retourne

Promise<ReleaseSettings>

getReleaseTags(string, number)

Obtient les balises d’une version

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

Retourne

Promise<string[]>

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

Obtenir une pièce jointe de tâche de mise en production.

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

ID de la version.

environmentId: number

ID de l’environnement de mise en production.

attemptId: number

Nombre de tentatives de déploiement.

planId: string

ID de plan de la phase de déploiement.

timelineId: string

ID de chronologie de la tâche.

recordId: string

ID d’enregistrement de la pièce jointe.

type: string

Type de la pièce jointe.

name: string

Nom de la pièce jointe.

Retourne

Promise<ArrayBuffer>

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

Obtenez les pièces jointes de la tâche de mise en production.

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

ID de la version.

environmentId: number

ID de l’environnement de mise en production.

attemptId: number

Nombre de tentatives de déploiement.

planId: string

ID de plan de la phase de déploiement.

type: string

Type de la pièce jointe.

Retourne

Promise<ReleaseTaskAttachment[]>

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

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

baseReleaseId: number

top: number

artifactAlias: string

Retourne

Promise<ReleaseWorkItemRef[]>

getSourceBranches(string, number)

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

Paramètres

project: string

ID de projet ou nom du projet

definitionId: number

Retourne

Promise<string[]>

getSummaryMailSections(string, number)

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

Retourne

Promise<SummaryMailSection[]>

getTags(string)

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

Paramètres

project: string

ID de projet ou nom du projet

Retourne

Promise<string[]>

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

Obtenir une pièce jointe de tâche.

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

ID de la version.

environmentId: number

ID de l’environnement de mise en production.

attemptId: number

Nombre de tentatives de déploiement.

timelineId: string

ID de chronologie de la tâche.

recordId: string

ID d’enregistrement de la pièce jointe.

type: string

Type de la pièce jointe.

name: string

Nom de la pièce jointe.

Retourne

Promise<ArrayBuffer>

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

Obtenez les pièces jointes de la tâche.

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

ID de la version.

environmentId: number

ID de l’environnement de mise en production.

attemptId: number

Nombre de tentatives de déploiement.

timelineId: string

ID de chronologie de la tâche.

type: string

Type de la pièce jointe.

Retourne

Promise<ReleaseTaskAttachment[]>

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

Obtient le journal des tâches d’une mise en production sous forme de fichier texte brut.

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

ID de la version.

environmentId: number

ID de l’environnement de mise en production.

releaseDeployPhaseId: number

Id de phase de déploiement de mise en production.

taskId: number

ID ReleaseTask pour le journal.

startLine: number

Numéro de ligne de départ des journaux

endLine: number

Numéro de ligne de fin des journaux

Retourne

Promise<string>

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

Obtient le journal des tâches d’une mise en production sous forme de fichier texte brut.

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

ID de la version.

environmentId: number

ID de l’environnement de mise en production.

attemptId: number

timelineId: string

taskId: number

ID ReleaseTask pour le journal.

startLine: number

Numéro de ligne de départ des journaux

endLine: number

Numéro de ligne de fin des journaux

Retourne

Promise<string>

getTasks(string, number, number, number)

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

environmentId: number

attemptId: number

Retourne

Promise<ReleaseTask[]>

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

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

environmentId: number

attemptId: number

timelineId: string

Retourne

Promise<ReleaseTask[]>

getTasksForTaskGroup(string, number, number, number)

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

environmentId: number

releaseDeployPhaseId: number

Retourne

Promise<ReleaseTask[]>

listDefinitionEnvironmentTemplates(string, boolean)

Obtient une liste de modèles d’environnement de définition

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

Paramètres

project: string

ID de projet ou nom du projet

isDeleted: boolean

« true » pour obtenir les modèles d’environnement de définition qui ont été supprimés. La valeur par défaut est « false »

Retourne

Promise<ReleaseDefinitionEnvironmentTemplate[]>

sendSummaryMail(MailMessage, string, number)

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

Paramètres

mailMessage: MailMessage

project: string

ID de projet ou nom du projet

releaseId: number

Retourne

Promise<void>

undeleteRelease(string, number, string)

Annulez la suppression réversible d’une version supprimée.

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

ID de mise en production à supprimer.

comment: string

Tout commentaire pour annuler la suppression.

Retourne

Promise<void>

undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)

Annuler la suppression d’une définition de mise en production.

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

Paramètres

releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter

Objet pour la définition de mise en production undelete.

project: string

ID de projet ou nom du projet

definitionId: number

ID de la définition de mise en production à supprimer

Retourne

Promise<ReleaseDefinition>

undeleteReleaseDefinitionEnvironmentTemplate(string, string)

Annuler la suppression d’un modèle d’environnement de définition de mise en production.

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

Paramètres

project: string

ID de projet ou nom du projet

templateId: string

ID du modèle d’environnement de définition à supprimer

Retourne

Promise<ReleaseDefinitionEnvironmentTemplate>

updateFolder(Folder, string, string)

Met à jour un dossier existant au chemin d’accès existant donné.

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

Paramètres

folder: Folder

dossier.

project: string

ID de projet ou nom du projet

path: string

Chemin du dossier à mettre à jour.

Retourne

Promise<Folder>

updateGates(GateUpdateMetadata, string, number)

Met à jour la porte d’un déploiement.

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

Paramètres

gateUpdateMetadata: GateUpdateMetadata

Métadonnées pour corriger les portes de mise en production.

project: string

ID de projet ou nom du projet

gateStepId: number

ID de l’étape de la porte.

Retourne

Promise<ReleaseGates>

updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)

Mettre à jour l’intervention manuelle.

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

Paramètres

manualInterventionUpdateMetadata: ManualInterventionUpdateMetadata

Métadonnées pour mettre à jour l’intervention manuelle.

project: string

ID de projet ou nom du projet

releaseId: number

ID de la version.

manualInterventionId: number

ID de l’intervention manuelle.

Retourne

Promise<ManualIntervention>

updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)

Met à jour les paramètres de mise en production du pipeline d’organisation

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

Paramètres

newSettings: OrgPipelineReleaseSettingsUpdateParameters

Retourne

Promise<OrgPipelineReleaseSettings>

updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)

Mises à jour des paramètres de mise en production du pipeline

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

Paramètres

newSettings: ProjectPipelineReleaseSettingsUpdateParameters

project: string

ID de projet ou nom du projet

Retourne

Promise<ProjectPipelineReleaseSettings>

updateRelease(Release, string, number)

Mettez à jour un objet de mise en production complet.

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

Paramètres

release: Release

Objet Release pour la mise à jour.

project: string

ID de projet ou nom du projet

releaseId: number

ID de la version à mettre à jour.

Retourne

Promise<Release>

updateReleaseApproval(ReleaseApproval, string, number)

Mettre à jour l’état d’une approbation

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

Paramètres

approval: ReleaseApproval

Objet ReleaseApproval ayant l’état, l’approbateur et les commentaires.

project: string

ID de projet ou nom du projet

approvalId: number

ID de l’approbation.

Retourne

Promise<ReleaseApproval>

updateReleaseApprovals(ReleaseApproval[], string)

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

Paramètres

approvals: ReleaseApproval[]

project: string

ID de projet ou nom du projet

Retourne

Promise<ReleaseApproval[]>

updateReleaseDefinition(ReleaseDefinition, string, boolean)

Mettez à jour une définition de mise en production.

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

Paramètres

releaseDefinition: ReleaseDefinition

Objet de définition de mise en production à mettre à jour.

project: string

ID de projet ou nom du projet

skipTasksValidation: boolean

Ignorer l’indicateur booléen de validation de tâche

Retourne

Promise<ReleaseDefinition>

updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)

Mettre à jour l’état d’un environnement de mise en production

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

Paramètres

environmentUpdateData: ReleaseEnvironmentUpdateMetadata

Mise à jour des métadonnées de l’environnement.

project: string

ID de projet ou nom du projet

releaseId: number

ID de la version.

environmentId: number

ID de l’environnement de mise en production.

Retourne

Promise<ReleaseEnvironment>

updateReleaseResource(ReleaseUpdateMetadata, string, number)

Mettez à jour quelques propriétés d’une version.

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

Paramètres

releaseUpdateMetadata: ReleaseUpdateMetadata

Propriétés de publication à mettre à jour.

project: string

ID de projet ou nom du projet

releaseId: number

ID de la version à mettre à jour.

Retourne

Promise<Release>

updateReleaseSettings(ReleaseSettings, string)

Met à jour les paramètres de mise en production

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

Paramètres

releaseSettings: ReleaseSettings

project: string

ID de projet ou nom du projet

Retourne

Promise<ReleaseSettings>

Commentaires

Cette page a-t-elle été utile ?

Partager via

ReleaseRestClient class

Constructeurs

Propriétés

Méthode

Détails du constructeur

ReleaseRestClient(IVssRestClientOptions)

Paramètres

Détails de la propriété

RESOURCE_AREA_ID

Valeur de la propriété

Détails de la méthode

addDefinitionTag(string, number, string)

Paramètres

Retourne

addDefinitionTags(string[], string, number)

Paramètres

Retourne

addReleaseTag(string, number, string)

Paramètres

Retourne

addReleaseTags(string[], string, number)

Paramètres

Retourne

createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)

Paramètres

Retourne

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

Paramètres

Retourne

createFolder(Folder, string, string)

Paramètres

Retourne

createRelease(ReleaseStartMetadata, string)

Paramètres

Retourne

createReleaseDefinition(ReleaseDefinition, string)

Paramètres

Retourne

deleteDefinitionEnvironmentTemplate(string, string)

Paramètres

Retourne

deleteDefinitionTag(string, number, string)

Paramètres

Retourne

deleteFavorites(string, string, string, string)

Paramètres

Retourne

deleteFolder(string, string)

Paramètres

Retourne

deleteRelease(string, number, string)

Paramètres

Retourne

deleteReleaseDefinition(string, number, string, boolean)

Paramètres

Retourne

deleteReleaseTag(string, number, string)

Paramètres

Retourne

getAgentArtifactDefinitions(string, number)

Paramètres

Retourne

getApproval(string, number, boolean)

Paramètres

Retourne

getApprovalHistory(string, number)

Paramètres

Retourne

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

Paramètres

Retourne

getArtifactTypeDefinitions(string)

Paramètres

Retourne

getArtifactVersions(string, number)

Paramètres

Retourne

getArtifactVersionsForSources(Artifact[], string)

Paramètres