ReleaseRestClient class
Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes aux API REST VSS
- Extends
Constructeurs
| Release |
Propriétés
| RESOURCE_AREA_ID |
Méthodes
Détails du constructeur
ReleaseRestClient(IVssRestClientOptions)
Détails de la propriété
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValeur de 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
Retours
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
Retours
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
Retours
Promise<string[]>
addReleaseTags(string[], string, number)
Ajoute une balise à une mise en production
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
Retours
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
Retours
Promise<ReleaseDefinitionEnvironmentTemplate>
createFavorites(FavoriteItem[], string, string, string)
function createFavorites(favoriteItems: FavoriteItem[], project: string, scope: string, identityId?: string): Promise<FavoriteItem[]>Paramètres
- favoriteItems
- project
-
string
ID de projet ou nom du projet
- scope
-
string
- identityId
-
string
Retours
Promise<FavoriteItem[]>
createFolder(Folder, string, string)
Crée un dossier.
function createFolder(folder: Folder, project: string, path?: string): Promise<Folder>Paramètres
- folder
- Folder
.
- project
-
string
ID de projet ou nom du projet
- path
-
string
Chemin du dossier.
Retours
Promise<Folder>
createRelease(ReleaseStartMetadata, string)
Créer une mise en production.
function createRelease(releaseStartMetadata: ReleaseStartMetadata, project: string): Promise<Release>Paramètres
- releaseStartMetadata
- ReleaseStartMetadata
Métadonnées pour créer une mise en production.
- project
-
string
ID de projet ou nom du projet
Retours
Promise<Release>
createReleaseDefinition(ReleaseDefinition, string)
Création d’une définition de version
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
Retours
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
Retours
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
Retours
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
Retours
Promise<void>
deleteFolder(string, string)
Supprime un dossier de définition pour un nom et un chemin d’accès donnés, ainsi que toutes ses 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 du dossier à supprimer.
Retours
Promise<void>
deleteRelease(string, number, string)
Suppression réversible d’une mise en production
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 mise en production.
Retours
Promise<void>
deleteReleaseDefinition(string, number, string, boolean)
Supprimer 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 tous les déploiements de mise en production en cours et poursuivre la suppression de la définition de mise en production . La valeur par défaut est « false ».
Retours
Promise<void>
deleteReleaseTag(string, number, string)
Supprime une balise d’une mise en production
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
Retours
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
Retours
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 ».
Retours
Promise<ReleaseApproval>
getApprovalHistory(string, number)
Obtenir l’historique des approbations.
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.
Retours
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 ce status. La valeur par défaut est « en attente ».
- releaseIdsFilter
-
number[]
Approbations pour le ou les ID de version 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. 50 par défaut.
- 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écroissant ».
- includeMyGroupApprovals
-
boolean
« true » pour inclure les approbations de mon groupe. La valeur par défaut est « false ».
Retours
Promise<PagedList<ReleaseApproval>>
getArtifactTypeDefinitions(string)
function getArtifactTypeDefinitions(project: string): Promise<ArtifactTypeDefinition[]>Paramètres
- project
-
string
ID de projet ou nom du projet
Retours
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
Retours
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
Retours
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
Retours
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[]
Retours
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
Retours
Promise<ReleaseDefinitionEnvironmentTemplate>
getDefinitionRevision(string, number, number)
Obtenir la définition de mise en production pour une définitionId et une révision données
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.
Retours
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
Retours
Promise<string[]>
getDeploymentBadge(string, number, number, string)
Obtient un badge qui indique le status 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.
Retours
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 pour 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 LastModified time >= minModifiedTime.
- maxModifiedTime
-
Date
Répertoriez les déploiements avec LastModified time <= maxModifiedTime.
- deploymentStatus
- DeploymentStatus
Répertoriez les déploiements avec des status de déploiement donnés. La valeur par défaut est « All ».
- operationStatus
- DeploymentOperationStatus
Répertoriez les déploiements avec des status d’opération donnés. 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 un ordre de requête donné. La valeur par défaut est « Décroissante ».
- top
-
number
Répertoriez les déploiements avec le top 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 StartedOn time >= minStartedTime.
- maxStartedTime
-
Date
Répertoriez les déploiements avec StartedOn time <= maxStartedTime.
- sourceBranch
-
string
Répertoriez les déploiements déployés à partir d’un nom de branche donné.
Retours
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
Retours
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
Retours
Promise<FavoriteItem[]>
getFlightAssignments(string)
function getFlightAssignments(flightName?: string): Promise<string[]>Paramètres
- flightName
-
string
Retours
Promise<string[]>
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 du dossier.
- queryOrder
- FolderPathQueryOrder
Obtient les résultats dans l’ordre défini. La valeur par défaut est « None ».
Retours
Promise<Folder[]>
getGateLog(string, number, number, number, number)
Obtient les journaux d’activité de la 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
ReleaseTask ID pour le journal.
Retours
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
Retours
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
Retours
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
ReleaseTask ID pour le journal.
- attemptId
-
number
ID de la tentative.
Retours
Promise<string>
getLogs(string, number)
Obtenez les journaux d’activité d’un ID de version.
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.
Retours
Promise<ArrayBuffer>
getManualIntervention(string, number, number)
Obtenez une intervention manuelle pour une version donnée et un 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.
Retours
Promise<ManualIntervention>
getManualInterventions(string, number)
Répertorier 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.
Retours
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
Retours
Promise<Metric[]>
getOrgPipelineReleaseSettings()
Obtient les paramètres de mise en production du pipeline d’organisation
function getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>Retours
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
Retours
Promise<ProjectPipelineReleaseSettings>
getRelease(string, number, ApprovalFilters, string[], SingleReleaseExpands, number)
Obtenir une version
function getRelease(project: string, releaseId: number, approvalFilters?: ApprovalFilters, propertyFilters?: string[], expand?: SingleReleaseExpands, topGateRecords?: number): 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 selon qu’elle est automatisée ou manuelle. Cela déciderait également si nous devons extraire les instantanés de pré 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 renvoyée contient des valeurs pour les ID de propriété spécifiés (s’ils existent). Si elle n’est pas définie, 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 la porte de mise en production à obtenir. La valeur par défaut est 5.
Retours
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
Retours
Promise<Change[]>
getReleaseDefinition(string, number, string[])
Obtenir une définition de mise en production.
function getReleaseDefinition(project: string, definitionId: number, propertyFilters?: string[]): 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). Si elle n’est pas définie, les propriétés ne sont pas incluses.
Retours
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.
Retours
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.
Retours
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
Obtenez 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 de mise en production.
- 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é seront retournées. Par exemple, pour la build, il s’agirait de {projectGuid} :{BuildDefinitionId}, pour Jenkins il s’agirait de {JenkinsConnectionId} :{JenkinsDefinitionId}, pour TfsOnPrem il s’agirait de {TfsOnPremConnectionId} :{ProjectName} :{TfsOnPremDefinitionId}. Pour les artefacts tiers, par exemple TeamCity et BitBucket, vous pouvez faire référence à « uniqueSourceIdentifier » dans vss-extension.json à l’adresse 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 spécifié.
- isExactNameMatch
-
boolean
« true » pour obtenir les définitions de mise en production avec la correspondance exacte spécifiée dans searchText. La valeur par défaut est « false ».
- tagFilter
-
string[]
Liste de balises délimitées par des virgules. 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 elles sont définies, les définitions de mise en production retournées contiennent des valeurs pour les ID de propriété spécifiés (s’ils existent). Si elles ne sont pas définies, les propriétés ne sont pas incluses. Notez que cela ne filtre aucune définition de mise en production des résultats, que la propriété soit 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 avec le nom spécifié dans searchText. La valeur par défaut est « false ».
Retours
Promise<PagedList<ReleaseDefinition>>
getReleaseDefinitionSummary(string, number, number, boolean, number[])
Obtenir le résumé de la mise en production 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 mises en production à inclure dans le résumé.
- includeArtifact
-
boolean
Inclure les détails de l’artefact. La valeur par défaut est « false ».
- definitionEnvironmentIdsFilter
-
number[]
Retours
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.
Retours
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
Retours
Promise<ReleaseRevision[]>
getReleaseProjects(string, string)
function getReleaseProjects(artifactType: string, artifactSourceId: string): Promise<ProjectReference[]>Paramètres
- artifactType
-
string
- artifactSourceId
-
string
Retours
Promise<ProjectReference[]>
getReleaseRevision(string, number, number)
Obtenir la mise en production pour 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
Définition instantané numéro de révision.
Retours
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<PagedList<Release>>Paramètres
- project
-
string
ID de projet ou nom du projet
- definitionId
-
number
Versions de cet ID de définition de mise en production.
- definitionEnvironmentId
-
number
- searchText
-
string
Mises en production avec des noms contenant searchText.
- createdBy
-
string
Mises en production créées par cet utilisateur.
- statusFilter
- ReleaseStatus
Versions qui ont ce status.
- environmentStatusFilter
-
number
- minCreatedTime
-
Date
Mises en production créées après ce délai.
- maxCreatedTime
-
Date
Mises en production créées avant cette heure.
- 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. 50 par défaut.
- continuationToken
-
number
Obtient les mises en production 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 build, il s’agirait de {projectGuid} :{BuildDefinitionId}, pour Jenkins il s’agirait de {JenkinsConnectionId} :{JenkinsDefinitionId}, pour TfsOnPrem il s’agirait de {TfsOnPremConnectionId} :{ProjectName} :{TfsOnPremDefinitionId}. Pour les artefacts tiers, par exemple TeamCity, BitBucket, vous pouvez faire référence à « uniqueSourceIdentifier » dans 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 mises en production avec sourceBranchFilter donné seront retournées.
- isDeleted
-
boolean
Obtient les mises en production supprimées de manière réversible, si la valeur est true.
- tagFilter
-
string[]
Liste de balises délimitées par des virgules. Seules les mises 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 versions renvoyées contiennent des valeurs pour les ID de propriété spécifiés (s’ils existent). Si elles ne sont pas définies, les propriétés ne sont pas incluses. Notez que cela ne filtre aucune version des résultats, que la propriété soit définie ou non.
- releaseIdFilter
-
number[]
Liste délimitée par des virgules d’ID de versions. Seules les versions avec ces ID sont retournées.
- path
-
string
Les mises en production sous ce chemin d’accès de dossier seront retournées
Retours
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
Retours
Promise<ReleaseSettings>
getReleaseTags(string, number)
Obtient les balises d’une mise en production
function getReleaseTags(project: string, releaseId: number): Promise<string[]>Paramètres
- project
-
string
ID de projet ou nom du projet
- releaseId
-
number
Retours
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.
Retours
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.
Retours
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
Retours
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
Retours
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
Retours
Promise<SummaryMailSection[]>
getTags(string)
function getTags(project: string): Promise<string[]>Paramètres
- project
-
string
ID de projet ou nom du projet
Retours
Promise<string[]>
getTaskAttachmentContent(string, number, number, number, string, string, string, string)
Obtenir une pièce jointe à une 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.
Retours
Promise<ArrayBuffer>
getTaskAttachments(string, number, number, number, string, string)
Obtenez les pièces jointes de 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.
Retours
Promise<ReleaseTaskAttachment[]>
getTaskLog(string, number, number, number, number, number, number)
Obtient le journal des tâches d’une mise en production sous la forme d’un fichier de 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 la phase de déploiement de mise en production.
- taskId
-
number
ReleaseTask ID pour le journal.
- startLine
-
number
Numéro de ligne de départ pour les journaux
- endLine
-
number
Numéro de ligne de fin pour les journaux
Retours
Promise<string>
getTaskLog2(string, number, number, number, string, number, number, number)
Obtient le journal des tâches d’une mise en production sous la forme d’un fichier de 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
ReleaseTask ID pour le journal.
- startLine
-
number
Numéro de ligne de départ pour les journaux
- endLine
-
number
Numéro de ligne de fin pour les journaux
Retours
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
Retours
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
Retours
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
Retours
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 »
Retours
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
Retours
Promise<void>
undeleteRelease(string, number, string)
Annuler la suppression d’une mise en production supprimée de manière réversible.
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 la mise en production à supprimer.
- comment
-
string
Tout commentaire pour annuler la suppression.
Retours
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 annuler la suppression de la définition de mise en production.
- project
-
string
ID de projet ou nom du projet
- definitionId
-
number
ID de la définition de mise en production à supprimer
Retours
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
Retours
Promise<ReleaseDefinitionEnvironmentTemplate>
updateFolder(Folder, string, string)
Mises à 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
.
- project
-
string
ID de projet ou nom du projet
- path
-
string
Chemin du dossier à mettre à jour.
Retours
Promise<Folder>
updateGates(GateUpdateMetadata, string, number)
Mises à 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.
Retours
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.
Retours
Promise<ManualIntervention>
updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)
Paramètres de mise en production du pipeline Mises à jour Org
function updateOrgPipelineReleaseSettings(newSettings: OrgPipelineReleaseSettingsUpdateParameters): Promise<OrgPipelineReleaseSettings>Paramètres
- newSettings
- OrgPipelineReleaseSettingsUpdateParameters
Retours
Promise<OrgPipelineReleaseSettings>
updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)
paramètres de mise en production du pipeline Mises à jour
function updatePipelineReleaseSettings(newSettings: ProjectPipelineReleaseSettingsUpdateParameters, project: string): Promise<ProjectPipelineReleaseSettings>Paramètres
- newSettings
- ProjectPipelineReleaseSettingsUpdateParameters
- project
-
string
ID de projet ou nom du projet
Retours
Promise<ProjectPipelineReleaseSettings>
updateRelease(Release, string, number)
Mettre à 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 mise en production à mettre à jour.
Retours
Promise<Release>
updateReleaseApproval(ReleaseApproval, string, number)
Mettre à jour status d’une approbation
function updateReleaseApproval(approval: ReleaseApproval, project: string, approvalId: number): Promise<ReleaseApproval>Paramètres
- approval
- ReleaseApproval
Objet ReleaseApproval ayant status, approbateur et commentaires.
- project
-
string
ID de projet ou nom du projet
- approvalId
-
number
ID de l’approbation.
Retours
Promise<ReleaseApproval>
updateReleaseApprovals(ReleaseApproval[], string)
function updateReleaseApprovals(approvals: ReleaseApproval[], project: string): Promise<ReleaseApproval[]>Paramètres
- approvals
- project
-
string
ID de projet ou nom du projet
Retours
Promise<ReleaseApproval[]>
updateReleaseDefinition(ReleaseDefinition, string)
Mettre à jour une définition de mise en production.
function updateReleaseDefinition(releaseDefinition: ReleaseDefinition, project: string): 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
Retours
Promise<ReleaseDefinition>
updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)
Mettre à jour la status d’un environnement de mise en production
function updateReleaseEnvironment(environmentUpdateData: ReleaseEnvironmentUpdateMetadata, project: string, releaseId: number, environmentId: number): Promise<ReleaseEnvironment>Paramètres
- environmentUpdateData
- ReleaseEnvironmentUpdateMetadata
Métadonnées de mise à jour 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.
Retours
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 mise en production à mettre à jour.
- project
-
string
ID de projet ou nom du projet
- releaseId
-
number
ID de la mise en production à mettre à jour.
Retours
Promise<Release>
updateReleaseSettings(ReleaseSettings, string)
Mises à 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
Retours
Promise<ReleaseSettings>