ReleaseRestClient class
Classe di base da usare (derivata da) per effettuare richieste alle API REST vss
- Extends
Costruttori
| Release |
Proprietà
| RESOURCE_AREA_ID |
Metodi
Dettagli costruttore
ReleaseRestClient(IVssRestClientOptions)
Dettagli proprietà
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValore della proprietà
string
Dettagli metodo
addDefinitionTag(string, number, string)
Aggiunge un tag a una definizione
function addDefinitionTag(project: string, releaseDefinitionId: number, tag: string): Promise<string[]>Parametri
- project
-
string
ID progetto o nome progetto
- releaseDefinitionId
-
number
- tag
-
string
Restituisce
Promise<string[]>
addDefinitionTags(string[], string, number)
Aggiunge più tag a una definizione
function addDefinitionTags(tags: string[], project: string, releaseDefinitionId: number): Promise<string[]>Parametri
- tags
-
string[]
- project
-
string
ID progetto o nome progetto
- releaseDefinitionId
-
number
Restituisce
Promise<string[]>
addReleaseTag(string, number, string)
Aggiunge un tag a un releaseId
function addReleaseTag(project: string, releaseId: number, tag: string): Promise<string[]>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
- tag
-
string
Restituisce
Promise<string[]>
addReleaseTags(string[], string, number)
Aggiunge tag a una versione
function addReleaseTags(tags: string[], project: string, releaseId: number): Promise<string[]>Parametri
- tags
-
string[]
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
Restituisce
Promise<string[]>
createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)
Crea un modello di ambiente di definizione
function createDefinitionEnvironmentTemplate(template: ReleaseDefinitionEnvironmentTemplate, project: string): Promise<ReleaseDefinitionEnvironmentTemplate>Parametri
- template
- ReleaseDefinitionEnvironmentTemplate
Modello di ambiente di definizione da creare
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<ReleaseDefinitionEnvironmentTemplate>
createFavorites(FavoriteItem[], string, string, string)
function createFavorites(favoriteItems: FavoriteItem[], project: string, scope: string, identityId?: string): Promise<FavoriteItem[]>Parametri
- favoriteItems
- project
-
string
ID progetto o nome progetto
- scope
-
string
- identityId
-
string
Restituisce
Promise<FavoriteItem[]>
createFolder(Folder, string, string)
createRelease(ReleaseStartMetadata, string)
Creare una versione.
function createRelease(releaseStartMetadata: ReleaseStartMetadata, project: string): Promise<Release>Parametri
- releaseStartMetadata
- ReleaseStartMetadata
Metadati per creare una versione.
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<Release>
createReleaseDefinition(ReleaseDefinition, string)
Creare una definizione di versione
function createReleaseDefinition(releaseDefinition: ReleaseDefinition, project: string): Promise<ReleaseDefinition>Parametri
- releaseDefinition
- ReleaseDefinition
Oggetto definizione di versione da creare.
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<ReleaseDefinition>
deleteDefinitionEnvironmentTemplate(string, string)
Eliminare un modello di ambiente di definizione
function deleteDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<void>Parametri
- project
-
string
ID progetto o nome progetto
- templateId
-
string
ID del modello di ambiente di definizione
Restituisce
Promise<void>
deleteDefinitionTag(string, number, string)
Elimina un tag da una definizione
function deleteDefinitionTag(project: string, releaseDefinitionId: number, tag: string): Promise<string[]>Parametri
- project
-
string
ID progetto o nome progetto
- releaseDefinitionId
-
number
- tag
-
string
Restituisce
Promise<string[]>
deleteFavorites(string, string, string, string)
function deleteFavorites(project: string, scope: string, identityId?: string, favoriteItemIds?: string): Promise<void>Parametri
- project
-
string
ID progetto o nome progetto
- scope
-
string
- identityId
-
string
- favoriteItemIds
-
string
Restituisce
Promise<void>
deleteFolder(string, string)
Elimina una cartella di definizione per il nome e il percorso della cartella specificati e tutte le definizioni esistenti.
function deleteFolder(project: string, path: string): Promise<void>Parametri
- project
-
string
ID progetto o nome progetto
- path
-
string
Percorso della cartella da eliminare.
Restituisce
Promise<void>
deleteRelease(string, number, string)
Eliminazione temporanea di una versione
function deleteRelease(project: string, releaseId: number, comment?: string): Promise<void>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
ID della versione.
- comment
-
string
Commento per l'eliminazione di una versione.
Restituisce
Promise<void>
deleteReleaseDefinition(string, number, string, boolean)
Eliminare una definizione di versione.
function deleteReleaseDefinition(project: string, definitionId: number, comment?: string, forceDelete?: boolean): Promise<void>Parametri
- project
-
string
ID progetto o nome progetto
- definitionId
-
number
ID della definizione di versione.
- comment
-
string
Commento per l'eliminazione di una definizione di versione.
- forceDelete
-
boolean
'true' per annullare automaticamente tutte le distribuzioni di versioni in corso e procedere con l'eliminazione della definizione di versione . Il valore predefinito è 'false'.
Restituisce
Promise<void>
deleteReleaseTag(string, number, string)
Elimina un tag da una versione
function deleteReleaseTag(project: string, releaseId: number, tag: string): Promise<string[]>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
- tag
-
string
Restituisce
Promise<string[]>
getAgentArtifactDefinitions(string, number)
Restituisce i dettagli dell'artefatto richiesti dall'agente di automazione
function getAgentArtifactDefinitions(project: string, releaseId: number): Promise<AgentArtifactDefinition[]>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
Restituisce
Promise<AgentArtifactDefinition[]>
getApproval(string, number, boolean)
Ottenere un'approvazione.
function getApproval(project: string, approvalId: number, includeHistory?: boolean): Promise<ReleaseApproval>Parametri
- project
-
string
ID progetto o nome progetto
- approvalId
-
number
ID dell'approvazione.
- includeHistory
-
boolean
'true' per includere la cronologia dell'approvazione. Il valore predefinito è 'false'.
Restituisce
Promise<ReleaseApproval>
getApprovalHistory(string, number)
Ottenere la cronologia delle approvazioni.
function getApprovalHistory(project: string, approvalStepId: number): Promise<ReleaseApproval>Parametri
- project
-
string
ID progetto o nome progetto
- approvalStepId
-
number
ID dell'approvazione.
Restituisce
Promise<ReleaseApproval>
getApprovals(string, string, ApprovalStatus, number[], ApprovalType, number, number, ReleaseQueryOrder, boolean)
Ottenere un elenco di approvazioni
function getApprovals(project: string, assignedToFilter?: string, statusFilter?: ApprovalStatus, releaseIdsFilter?: number[], typeFilter?: ApprovalType, top?: number, continuationToken?: number, queryOrder?: ReleaseQueryOrder, includeMyGroupApprovals?: boolean): Promise<PagedList<ReleaseApproval>>Parametri
- project
-
string
ID progetto o nome progetto
- assignedToFilter
-
string
Approvazioni assegnate all'utente.
- statusFilter
- ApprovalStatus
Approvazioni con questo stato. Il valore predefinito è "in sospeso".
- releaseIdsFilter
-
number[]
Approvazioni per gli ID versione indicati nel filtro. È possibile menzionare più versioni separandole con "", ad esempio releaseIdsFilter=1,2,3,4.
- typeFilter
- ApprovalType
Approvazione con questo tipo.
- top
-
number
Numero di approvazioni da ottenere. Il valore predefinito è 50.
- continuationToken
-
number
Ottiene le approvazioni dopo il token di continuazione fornito.
- queryOrder
- ReleaseQueryOrder
Ottiene i risultati nell'ordine definito delle approvazioni create. Il valore predefinito è "decrescente".
- includeMyGroupApprovals
-
boolean
'true' per includere le approvazioni del gruppo. Il valore predefinito è 'false'.
Restituisce
Promise<PagedList<ReleaseApproval>>
getArtifactTypeDefinitions(string)
function getArtifactTypeDefinitions(project: string): Promise<ArtifactTypeDefinition[]>Parametri
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<ArtifactTypeDefinition[]>
getArtifactVersions(string, number)
function getArtifactVersions(project: string, releaseDefinitionId: number): Promise<ArtifactVersionQueryResult>Parametri
- project
-
string
ID progetto o nome progetto
- releaseDefinitionId
-
number
Restituisce
Promise<ArtifactVersionQueryResult>
getArtifactVersionsForSources(Artifact[], string)
function getArtifactVersionsForSources(artifacts: Artifact[], project: string): Promise<ArtifactVersionQueryResult>Parametri
- artifacts
-
Artifact[]
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<ArtifactVersionQueryResult>
getAutoTriggerIssues(string, string, string, string)
function getAutoTriggerIssues(artifactType: string, sourceId: string, artifactVersionId: string, project?: string): Promise<AutoTriggerIssue[]>Parametri
- artifactType
-
string
- sourceId
-
string
- artifactVersionId
-
string
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<AutoTriggerIssue[]>
getDefinitionEnvironments(string, string, string[])
function getDefinitionEnvironments(project: string, taskGroupId?: string, propertyFilters?: string[]): Promise<DefinitionEnvironmentReference[]>Parametri
- project
-
string
ID progetto o nome progetto
- taskGroupId
-
string
- propertyFilters
-
string[]
Restituisce
Promise<DefinitionEnvironmentReference[]>
getDefinitionEnvironmentTemplate(string, string)
Ottiene un modello di ambiente di definizione
function getDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<ReleaseDefinitionEnvironmentTemplate>Parametri
- project
-
string
ID progetto o nome progetto
- templateId
-
string
ID del modello di ambiente di definizione
Restituisce
Promise<ReleaseDefinitionEnvironmentTemplate>
getDefinitionRevision(string, number, number)
Ottenere la definizione di versione per una determinata definizioneId e revisione
function getDefinitionRevision(project: string, definitionId: number, revision: number): Promise<string>Parametri
- project
-
string
ID progetto o nome progetto
- definitionId
-
number
ID della definizione.
- revision
-
number
ID della revisione.
Restituisce
Promise<string>
getDefinitionTags(string, number)
Ottiene i tag per una definizione
function getDefinitionTags(project: string, releaseDefinitionId: number): Promise<string[]>Parametri
- project
-
string
ID progetto o nome progetto
- releaseDefinitionId
-
number
Restituisce
Promise<string[]>
getDeploymentBadge(string, number, number, string)
Ottiene un badge che indica lo stato della distribuzione più recente per un ambiente.
function getDeploymentBadge(projectId: string, releaseDefinitionId: number, environmentId: number, branchName?: string): Promise<string>Parametri
- projectId
-
string
ID del progetto.
- releaseDefinitionId
-
number
ID della definizione di versione.
- environmentId
-
number
ID dell'ambiente.
- branchName
-
string
Nome del ramo.
Restituisce
Promise<string>
getDeployments(string, number, number, string, Date, Date, DeploymentStatus, DeploymentOperationStatus, boolean, ReleaseQueryOrder, number, number, string, Date, Date, string)
Ottenere un elenco di distribuzioni
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>>Parametri
- project
-
string
ID progetto o nome progetto
- definitionId
-
number
Elencare le distribuzioni per un ID di definizione specificato.
- definitionEnvironmentId
-
number
Elencare le distribuzioni per un ID di ambiente di definizione specificato.
- createdBy
-
string
Elencare le distribuzioni per le quali le distribuzioni vengono create come identità specificate.
- minModifiedTime
-
Date
Elencare le distribuzioni con LastModified time >= minModifiedTime.
- maxModifiedTime
-
Date
Elencare le distribuzioni con LastModified time <= maxModifiedTime.
- deploymentStatus
- DeploymentStatus
Elencare le distribuzioni con lo stato di distribuzione specificato. Il valore predefinito è 'All'.
- operationStatus
- DeploymentOperationStatus
Elencare le distribuzioni con lo stato dell'operazione specificato. Il valore predefinito è 'All'.
- latestAttemptsOnly
-
boolean
'true' per includere solo le distribuzioni con il tentativo più recente. Il valore predefinito è 'false'.
- queryOrder
- ReleaseQueryOrder
Elencare le distribuzioni con un ordine di query specificato. Il valore predefinito è 'Descending'.
- top
-
number
Elencare le distribuzioni con la parte superiore specificata. La parte superiore predefinita è '50' e Max top è '100'.
- continuationToken
-
number
Elencare le distribuzioni con ID >distribuzione = continuationToken.
- createdFor
-
string
Elencare le distribuzioni per le quali vengono richieste distribuzioni come identità specificata.
- minStartedTime
-
Date
Elencare le distribuzioni con StartedOn time >= minStartedTime.
- maxStartedTime
-
Date
Elencare le distribuzioni con StartedOn time <= maxStartedTime.
- sourceBranch
-
string
Elencare le distribuzioni distribuite dal nome del ramo specificato.
Restituisce
Promise<PagedList<Deployment>>
getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)
function getDeploymentsForMultipleEnvironments(queryParameters: DeploymentQueryParameters, project: string): Promise<Deployment[]>Parametri
- queryParameters
- DeploymentQueryParameters
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<Deployment[]>
getFavorites(string, string, string)
function getFavorites(project: string, scope: string, identityId?: string): Promise<FavoriteItem[]>Parametri
- project
-
string
ID progetto o nome progetto
- scope
-
string
- identityId
-
string
Restituisce
Promise<FavoriteItem[]>
getFolders(string, string, FolderPathQueryOrder)
Ottiene le cartelle.
function getFolders(project: string, path?: string, queryOrder?: FolderPathQueryOrder): Promise<Folder[]>Parametri
- project
-
string
ID progetto o nome progetto
- path
-
string
Percorso della cartella.
- queryOrder
- FolderPathQueryOrder
Ottiene i risultati nell'ordine definito. Il valore predefinito è 'None'.
Restituisce
Promise<Folder[]>
getGateLog(string, number, number, number, number)
Ottiene i log di controllo
function getGateLog(project: string, releaseId: number, environmentId: number, gateId: number, taskId: number): Promise<string>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
ID della versione.
- environmentId
-
number
ID dell'ambiente di rilascio.
- gateId
-
number
ID del cancello.
- taskId
-
number
ReleaseTask ID per il log.
Restituisce
Promise<string>
getInputValues(InputValuesQuery, string)
function getInputValues(query: InputValuesQuery, project: string): Promise<InputValuesQuery>Parametri
- query
- InputValuesQuery
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<InputValuesQuery>
getIssues(string, number, string)
function getIssues(project: string, buildId: number, sourceId?: string): Promise<AutoTriggerIssue[]>Parametri
- project
-
string
ID progetto o nome progetto
- buildId
-
number
- sourceId
-
string
Restituisce
Promise<AutoTriggerIssue[]>
getLog(string, number, number, number, number)
Ottiene i log
function getLog(project: string, releaseId: number, environmentId: number, taskId: number, attemptId?: number): Promise<string>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
ID della versione.
- environmentId
-
number
ID dell'ambiente di rilascio.
- taskId
-
number
ReleaseTask ID per il log.
- attemptId
-
number
ID del tentativo.
Restituisce
Promise<string>
getLogs(string, number)
Ottenere i log per un ID versione.
function getLogs(project: string, releaseId: number): Promise<ArrayBuffer>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
ID della versione.
Restituisce
Promise<ArrayBuffer>
getManualIntervention(string, number, number)
Ottenere l'intervento manuale per un determinato ID di rilascio e intervento manuale.
function getManualIntervention(project: string, releaseId: number, manualInterventionId: number): Promise<ManualIntervention>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
ID della versione.
- manualInterventionId
-
number
ID dell'intervento manuale.
Restituisce
Promise<ManualIntervention>
getManualInterventions(string, number)
Elencare tutti gli interventi manuali per un determinato rilascio.
function getManualInterventions(project: string, releaseId: number): Promise<ManualIntervention[]>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
ID della versione.
Restituisce
Promise<ManualIntervention[]>
getMetrics(string, Date)
function getMetrics(project: string, minMetricsTime?: Date): Promise<Metric[]>Parametri
- project
-
string
ID progetto o nome progetto
- minMetricsTime
-
Date
Restituisce
Promise<Metric[]>
getOrgPipelineReleaseSettings()
Ottiene le impostazioni di rilascio della pipeline dell'organizzazione
function getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>Restituisce
Promise<OrgPipelineReleaseSettings>
getPipelineReleaseSettings(string)
Ottiene le impostazioni di rilascio della pipeline
function getPipelineReleaseSettings(project: string): Promise<ProjectPipelineReleaseSettings>Parametri
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<ProjectPipelineReleaseSettings>
getRelease(string, number, ApprovalFilters, string[], SingleReleaseExpands, number, boolean)
Ottenere una versione
function getRelease(project: string, releaseId: number, approvalFilters?: ApprovalFilters, propertyFilters?: string[], expand?: SingleReleaseExpands, topGateRecords?: number, includeDisabledDefinitions?: boolean): Promise<Release>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
ID della versione.
- approvalFilters
- ApprovalFilters
Filtro che consente di recuperare i passaggi di approvazione in modo selettivo in base al fatto che sia automatizzato o manuale. In questo modo si decide anche se recuperare gli snapshot di pre e post-approvazione. Presuppone tutti per impostazione predefinita
- propertyFilters
-
string[]
Elenco delimitato da virgole di proprietà estese da recuperare. Se impostata, la versione restituita conterrà i valori per gli ID proprietà specificati (se esistenti). Se non è impostata, le proprietà non verranno incluse.
- expand
- SingleReleaseExpands
Proprietà che deve essere espansa nella versione.
- topGateRecords
-
number
Numero di record di controllo della versione da ottenere. Il valore predefinito è 5.
- includeDisabledDefinitions
-
boolean
Includi definizioni disabilitate (se impostata su 'false' restituisce l'errore, il valore predefinito è 'true')
Restituisce
Promise<Release>
getReleaseChanges(string, number, number, number, string)
function getReleaseChanges(project: string, releaseId: number, baseReleaseId?: number, top?: number, artifactAlias?: string): Promise<Change[]>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
- baseReleaseId
-
number
- top
-
number
- artifactAlias
-
string
Restituisce
Promise<Change[]>
getReleaseDefinition(string, number, string[], boolean)
Ottenere una definizione di versione.
function getReleaseDefinition(project: string, definitionId: number, propertyFilters?: string[], includeDisabled?: boolean): Promise<ReleaseDefinition>Parametri
- project
-
string
ID progetto o nome progetto
- definitionId
-
number
ID della definizione di versione.
- propertyFilters
-
string[]
Elenco delimitato da virgole di proprietà estese da recuperare. Se impostata, la definizione di versione restituita conterrà i valori per gli ID proprietà specificati (se esistenti). Se non è impostata, le proprietà non verranno incluse.
- includeDisabled
-
boolean
Flag booleano per includere definizioni disabilitate.
Restituisce
Promise<ReleaseDefinition>
getReleaseDefinitionHistory(string, number)
Ottenere la cronologia delle revisioni per una definizione di versione
function getReleaseDefinitionHistory(project: string, definitionId: number): Promise<ReleaseDefinitionRevision[]>Parametri
- project
-
string
ID progetto o nome progetto
- definitionId
-
number
ID della definizione.
Restituisce
Promise<ReleaseDefinitionRevision[]>
getReleaseDefinitionRevision(string, number, number)
Ottenere la definizione di versione di una determinata revisione.
function getReleaseDefinitionRevision(project: string, definitionId: number, revision: number): Promise<string>Parametri
- project
-
string
ID progetto o nome progetto
- definitionId
-
number
ID della definizione di versione.
- revision
-
number
Numero di revisione della definizione di versione.
Restituisce
Promise<string>
getReleaseDefinitions(string, string, ReleaseDefinitionExpands, string, string, number, string, ReleaseDefinitionQueryOrder, string, boolean, string[], string[], string[], boolean, boolean)
Ottenere un elenco di definizioni di versione.
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>>Parametri
- project
-
string
ID progetto o nome progetto
- searchText
-
string
Ottenere definizioni di versione con nomi contenenti searchText.
- expand
- ReleaseDefinitionExpands
Proprietà che devono essere espanse nell'elenco delle definizioni di versione.
- artifactType
-
string
Verranno restituite le definizioni di versione con artifactType specificato. I valori possono essere Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.
- artifactSourceId
-
string
Verranno restituite le definizioni di versione con artifactSourceId specificato. Ad esempio, per la compilazione sarebbe {projectGuid}:{BuildDefinitionId}, per Jenkins sarà {JenkinsConnectionId}:{JenkinsDefinitionId}, per TfsOnPrem sarà {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremPreinitionId}. Per gli artefatti di terze parti, ad esempio TeamCity, BitBucket è possibile fare riferimento a 'uniqueSourceIdentifier' all'interno di vss-extension.json all'indirizzo https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.
- top
-
number
Numero di definizioni di versione da ottenere.
- continuationToken
-
string
Ottiene le definizioni di versione dopo il token di continuazione specificato.
- queryOrder
- ReleaseDefinitionQueryOrder
Ottiene i risultati nell'ordine definito. Il valore predefinito è 'IdAscending'.
- path
-
string
Ottiene le definizioni di versione nel percorso specificato.
- isExactNameMatch
-
boolean
'true' per ottenere le definizioni di versione con corrispondenza esatta come specificato in searchText. Il valore predefinito è 'false'.
- tagFilter
-
string[]
Elenco delimitato da virgole di tag. Verranno restituite solo le definizioni di versione con questi tag.
- propertyFilters
-
string[]
Elenco delimitato da virgole di proprietà estese da recuperare. Se impostata, le definizioni di versione restituite conterranno valori per gli ID proprietà specificati (se esistenti). Se non è impostata, le proprietà non verranno incluse. Si noti che non verrà filtrata alcuna definizione di versione dai risultati indipendentemente dal fatto che abbia o meno una proprietà impostata.
- definitionIdFilter
-
string[]
Elenco delimitato da virgole di definizioni di versione da recuperare.
- isDeleted
-
boolean
'true' per ottenere definizioni di versione eliminate. Il valore predefinito è 'false'
- searchTextContainsFolderName
-
boolean
'true' per ottenere le definizioni di versione nella cartella con nome come specificato in searchText. Il valore predefinito è 'false'.
Restituisce
Promise<PagedList<ReleaseDefinition>>
getReleaseDefinitionSummary(string, number, number, boolean, number[])
Ottenere il riepilogo della versione di un ID di definizione specificato.
function getReleaseDefinitionSummary(project: string, definitionId: number, releaseCount: number, includeArtifact?: boolean, definitionEnvironmentIdsFilter?: number[]): Promise<ReleaseDefinitionSummary>Parametri
- project
-
string
ID progetto o nome progetto
- definitionId
-
number
ID della definizione per ottenere il riepilogo della versione.
- releaseCount
-
number
Numero di versioni da includere in riepilogo.
- includeArtifact
-
boolean
Includere i dettagli dell'artefatto. Il valore predefinito è 'false'.
- definitionEnvironmentIdsFilter
-
number[]
Restituisce
Promise<ReleaseDefinitionSummary>
getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)
Ottenere un ambiente di rilascio.
function getReleaseEnvironment(project: string, releaseId: number, environmentId: number, expand?: ReleaseEnvironmentExpands): Promise<ReleaseEnvironment>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
ID della versione.
- environmentId
-
number
ID dell'ambiente di rilascio.
- expand
- ReleaseEnvironmentExpands
Proprietà che deve essere espansa nell'ambiente.
Restituisce
Promise<ReleaseEnvironment>
getReleaseHistory(string, number)
function getReleaseHistory(project: string, releaseId: number): Promise<ReleaseRevision[]>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
Restituisce
Promise<ReleaseRevision[]>
getReleaseProjects(string, string)
function getReleaseProjects(artifactType: string, artifactSourceId: string): Promise<ProjectReference[]>Parametri
- artifactType
-
string
- artifactSourceId
-
string
Restituisce
Promise<ProjectReference[]>
getReleaseRevision(string, number, number)
Ottenere la versione per un determinato numero di revisione.
function getReleaseRevision(project: string, releaseId: number, definitionSnapshotRevision: number): Promise<string>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
ID della versione.
- definitionSnapshotRevision
-
number
Numero di revisione dello snapshot di definizione.
Restituisce
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)
Ottenere un elenco di versioni
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[]>Parametri
- project
-
string
ID progetto o nome progetto
- definitionId
-
number
Rilascia l'ID della definizione di versione.
- definitionEnvironmentId
-
number
- searchText
-
string
Rilascia con nomi contenenti searchText.
- createdBy
-
string
Versioni create dall'utente.
- statusFilter
- ReleaseStatus
Versioni con questo stato.
- environmentStatusFilter
-
number
- minCreatedTime
-
Date
Versioni create dopo questa volta.
- maxCreatedTime
-
Date
Versioni create prima di questa volta.
- queryOrder
- ReleaseQueryOrder
Ottiene i risultati nell'ordine definito della data di creazione per le versioni. Il valore predefinito è decrescente.
- top
-
number
Numero di versioni da ottenere. Il valore predefinito è 50.
- continuationToken
-
number
Ottiene le versioni dopo il token di continuazione specificato.
- expand
- ReleaseExpands
Proprietà che deve essere espansa nell'elenco delle versioni.
- artifactTypeId
-
string
Verranno restituite le versioni con artifactTypeId specificato. I valori possono essere Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.
- sourceId
-
string
Identificatore univoco dell'artefatto utilizzato. Ad esempio, per la compilazione sarebbe {projectGuid}:{BuildDefinitionId}, per Jenkins sarà {JenkinsConnectionId}:{JenkinsDefinitionId}, per TfsOnPrem sarà {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremPreinitionId}. Per gli artefatti di terze parti, ad esempio TeamCity, BitBucket è possibile fare riferimento a 'uniqueSourceIdentifier' all'interno di vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.
- artifactVersionId
-
string
Verranno restituite le versioni con artifactVersionId specificato. Ad esempio, nel caso di Build artifactType, è buildId.
- sourceBranchFilter
-
string
Verranno restituite le versioni con sourceBranchFilter specificato (non da usare con environmentStatusFilter).
- isDeleted
-
boolean
Ottiene le versioni eliminate soft, se true.
- tagFilter
-
string[]
Elenco delimitato da virgole di tag. Verranno restituite solo le versioni con questi tag.
- propertyFilters
-
string[]
Elenco delimitato da virgole di proprietà estese da recuperare. Se impostata, le versioni restituite conterranno valori per gli ID proprietà specificati (se esistenti). Se non è impostata, le proprietà non verranno incluse. Si noti che in questo modo non verranno filtrati i risultati di rilascio, indipendentemente dal fatto che la proprietà sia impostata o meno.
- releaseIdFilter
-
number[]
Elenco delimitato da virgole di ID delle versioni. Verranno restituite solo le versioni con questi ID.
- path
-
string
Le versioni in questo percorso della cartella verranno restituite
Restituisce
Promise<Release[]>
getReleaseSettings(string)
Ottiene le impostazioni di versione
function getReleaseSettings(project: string): Promise<ReleaseSettings>Parametri
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<ReleaseSettings>
getReleaseTags(string, number)
Ottiene i tag per una versione
function getReleaseTags(project: string, releaseId: number): Promise<string[]>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
Restituisce
Promise<string[]>
getReleaseTaskAttachmentContent(string, number, number, number, string, string, string, string, string)
Ottenere un allegato dell'attività di rilascio.
function getReleaseTaskAttachmentContent(project: string, releaseId: number, environmentId: number, attemptId: number, planId: string, timelineId: string, recordId: string, type: string, name: string): Promise<ArrayBuffer>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
ID della versione.
- environmentId
-
number
ID dell'ambiente di rilascio.
- attemptId
-
number
Numero di tentativi di distribuzione.
- planId
-
string
ID piano della fase di distribuzione.
- timelineId
-
string
ID sequenza temporale dell'attività.
- recordId
-
string
ID record dell'allegato.
- type
-
string
Tipo dell'allegato.
- name
-
string
Nome dell'allegato.
Restituisce
Promise<ArrayBuffer>
getReleaseTaskAttachments(string, number, number, number, string, string)
Ottenere gli allegati dell'attività di rilascio.
function getReleaseTaskAttachments(project: string, releaseId: number, environmentId: number, attemptId: number, planId: string, type: string): Promise<ReleaseTaskAttachment[]>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
ID della versione.
- environmentId
-
number
ID dell'ambiente di rilascio.
- attemptId
-
number
Numero di tentativi di distribuzione.
- planId
-
string
ID piano della fase di distribuzione.
- type
-
string
Tipo dell'allegato.
Restituisce
Promise<ReleaseTaskAttachment[]>
getReleaseWorkItemsRefs(string, number, number, number, string)
function getReleaseWorkItemsRefs(project: string, releaseId: number, baseReleaseId?: number, top?: number, artifactAlias?: string): Promise<ReleaseWorkItemRef[]>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
- baseReleaseId
-
number
- top
-
number
- artifactAlias
-
string
Restituisce
Promise<ReleaseWorkItemRef[]>
getSourceBranches(string, number)
function getSourceBranches(project: string, definitionId: number): Promise<string[]>Parametri
- project
-
string
ID progetto o nome progetto
- definitionId
-
number
Restituisce
Promise<string[]>
getSummaryMailSections(string, number)
function getSummaryMailSections(project: string, releaseId: number): Promise<SummaryMailSection[]>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
Restituisce
Promise<SummaryMailSection[]>
getTags(string)
function getTags(project: string): Promise<string[]>Parametri
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<string[]>
getTaskAttachmentContent(string, number, number, number, string, string, string, string)
Ottenere un allegato di attività.
function getTaskAttachmentContent(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, recordId: string, type: string, name: string): Promise<ArrayBuffer>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
ID della versione.
- environmentId
-
number
ID dell'ambiente di rilascio.
- attemptId
-
number
Numero di tentativi di distribuzione.
- timelineId
-
string
ID sequenza temporale dell'attività.
- recordId
-
string
ID record dell'allegato.
- type
-
string
Tipo dell'allegato.
- name
-
string
Nome dell'allegato.
Restituisce
Promise<ArrayBuffer>
getTaskAttachments(string, number, number, number, string, string)
Ottenere gli allegati dell'attività.
function getTaskAttachments(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, type: string): Promise<ReleaseTaskAttachment[]>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
ID della versione.
- environmentId
-
number
ID dell'ambiente di rilascio.
- attemptId
-
number
Numero di tentativi di distribuzione.
- timelineId
-
string
ID sequenza temporale dell'attività.
- type
-
string
Tipo dell'allegato.
Restituisce
Promise<ReleaseTaskAttachment[]>
getTaskLog(string, number, number, number, number, number, number)
Ottiene il log attività di una versione come file di testo normale.
function getTaskLog(project: string, releaseId: number, environmentId: number, releaseDeployPhaseId: number, taskId: number, startLine?: number, endLine?: number): Promise<string>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
ID della versione.
- environmentId
-
number
ID dell'ambiente di rilascio.
- releaseDeployPhaseId
-
number
Id fase di distribuzione della versione.
- taskId
-
number
ReleaseTask ID per il log.
- startLine
-
number
Numero di riga iniziale per i log
- endLine
-
number
Numero di riga finale per i log
Restituisce
Promise<string>
getTaskLog2(string, number, number, number, string, number, number, number)
Ottiene il log attività di una versione come file di testo normale.
function getTaskLog2(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, taskId: number, startLine?: number, endLine?: number): Promise<string>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
ID della versione.
- environmentId
-
number
ID dell'ambiente di rilascio.
- attemptId
-
number
- timelineId
-
string
- taskId
-
number
ReleaseTask ID per il log.
- startLine
-
number
Numero di riga iniziale per i log
- endLine
-
number
Numero di riga finale per i log
Restituisce
Promise<string>
getTasks(string, number, number, number)
function getTasks(project: string, releaseId: number, environmentId: number, attemptId?: number): Promise<ReleaseTask[]>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
- environmentId
-
number
- attemptId
-
number
Restituisce
Promise<ReleaseTask[]>
getTasks2(string, number, number, number, string)
function getTasks2(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string): Promise<ReleaseTask[]>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
- environmentId
-
number
- attemptId
-
number
- timelineId
-
string
Restituisce
Promise<ReleaseTask[]>
getTasksForTaskGroup(string, number, number, number)
function getTasksForTaskGroup(project: string, releaseId: number, environmentId: number, releaseDeployPhaseId: number): Promise<ReleaseTask[]>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
- environmentId
-
number
- releaseDeployPhaseId
-
number
Restituisce
Promise<ReleaseTask[]>
listDefinitionEnvironmentTemplates(string, boolean)
Ottiene un elenco di modelli di ambiente di definizione
function listDefinitionEnvironmentTemplates(project: string, isDeleted?: boolean): Promise<ReleaseDefinitionEnvironmentTemplate[]>Parametri
- project
-
string
ID progetto o nome progetto
- isDeleted
-
boolean
'true' per ottenere i modelli di ambiente di definizione eliminati. Il valore predefinito è 'false'
Restituisce
Promise<ReleaseDefinitionEnvironmentTemplate[]>
sendSummaryMail(MailMessage, string, number)
function sendSummaryMail(mailMessage: MailMessage, project: string, releaseId: number): Promise<void>Parametri
- mailMessage
- MailMessage
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
Restituisce
Promise<void>
undeleteRelease(string, number, string)
Annullare l'eliminazione di una versione eliminata temporanea.
function undeleteRelease(project: string, releaseId: number, comment: string): Promise<void>Parametri
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
ID della versione da annullare.
- comment
-
string
Qualsiasi commento per l'annullamento dell'eliminazione.
Restituisce
Promise<void>
undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)
Annullare l'eliminazione di una definizione di versione.
function undeleteReleaseDefinition(releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter, project: string, definitionId: number): Promise<ReleaseDefinition>Parametri
- releaseDefinitionUndeleteParameter
- ReleaseDefinitionUndeleteParameter
Oggetto per la definizione di versione di annullamento dell'eliminazione.
- project
-
string
ID progetto o nome progetto
- definitionId
-
number
ID della definizione di versione da annullare
Restituisce
Promise<ReleaseDefinition>
undeleteReleaseDefinitionEnvironmentTemplate(string, string)
Annullare l'eliminazione di un modello di ambiente di definizione della versione.
function undeleteReleaseDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<ReleaseDefinitionEnvironmentTemplate>Parametri
- project
-
string
ID progetto o nome progetto
- templateId
-
string
ID del modello di ambiente di definizione da annullare
Restituisce
Promise<ReleaseDefinitionEnvironmentTemplate>
updateFolder(Folder, string, string)
Aggiorna una cartella esistente nel percorso esistente specificato.
function updateFolder(folder: Folder, project: string, path: string): Promise<Folder>Parametri
- folder
- Folder
cartella.
- project
-
string
ID progetto o nome progetto
- path
-
string
Percorso della cartella da aggiornare.
Restituisce
Promise<Folder>
updateGates(GateUpdateMetadata, string, number)
Aggiorna il gate per una distribuzione.
function updateGates(gateUpdateMetadata: GateUpdateMetadata, project: string, gateStepId: number): Promise<ReleaseGates>Parametri
- gateUpdateMetadata
- GateUpdateMetadata
Metadati per applicare patch a Release Gates.
- project
-
string
ID progetto o nome progetto
- gateStepId
-
number
ID passaggio gate.
Restituisce
Promise<ReleaseGates>
updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)
Aggiornare l'intervento manuale.
function updateManualIntervention(manualInterventionUpdateMetadata: ManualInterventionUpdateMetadata, project: string, releaseId: number, manualInterventionId: number): Promise<ManualIntervention>Parametri
- manualInterventionUpdateMetadata
- ManualInterventionUpdateMetadata
Metadati per aggiornare l'intervento manuale.
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
ID della versione.
- manualInterventionId
-
number
ID dell'intervento manuale.
Restituisce
Promise<ManualIntervention>
updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)
Aggiorna le impostazioni di rilascio della pipeline dell'organizzazione
function updateOrgPipelineReleaseSettings(newSettings: OrgPipelineReleaseSettingsUpdateParameters): Promise<OrgPipelineReleaseSettings>Parametri
- newSettings
- OrgPipelineReleaseSettingsUpdateParameters
Restituisce
Promise<OrgPipelineReleaseSettings>
updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)
Aggiorna le impostazioni di versione della pipeline
function updatePipelineReleaseSettings(newSettings: ProjectPipelineReleaseSettingsUpdateParameters, project: string): Promise<ProjectPipelineReleaseSettings>Parametri
- newSettings
- ProjectPipelineReleaseSettingsUpdateParameters
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<ProjectPipelineReleaseSettings>
updateRelease(Release, string, number)
Aggiornare un oggetto versione completo.
function updateRelease(release: Release, project: string, releaseId: number): Promise<Release>Parametri
- release
- Release
Oggetto release per l'aggiornamento.
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
ID della versione da aggiornare.
Restituisce
Promise<Release>
updateReleaseApproval(ReleaseApproval, string, number)
Aggiornare lo stato di un'approvazione
function updateReleaseApproval(approval: ReleaseApproval, project: string, approvalId: number): Promise<ReleaseApproval>Parametri
- approval
- ReleaseApproval
ReleaseApproval oggetto con stato, responsabile approvazione e commenti.
- project
-
string
ID progetto o nome progetto
- approvalId
-
number
ID dell'approvazione.
Restituisce
Promise<ReleaseApproval>
updateReleaseApprovals(ReleaseApproval[], string)
function updateReleaseApprovals(approvals: ReleaseApproval[], project: string): Promise<ReleaseApproval[]>Parametri
- approvals
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<ReleaseApproval[]>
updateReleaseDefinition(ReleaseDefinition, string, boolean)
Aggiornare una definizione di versione.
function updateReleaseDefinition(releaseDefinition: ReleaseDefinition, project: string, skipTasksValidation?: boolean): Promise<ReleaseDefinition>Parametri
- releaseDefinition
- ReleaseDefinition
Oggetto definizione di versione da aggiornare.
- project
-
string
ID progetto o nome progetto
- skipTasksValidation
-
boolean
Ignorare il flag booleano di convalida delle attività
Restituisce
Promise<ReleaseDefinition>
updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)
Aggiornare lo stato di un ambiente di rilascio
function updateReleaseEnvironment(environmentUpdateData: ReleaseEnvironmentUpdateMetadata, project: string, releaseId: number, environmentId: number): Promise<ReleaseEnvironment>Parametri
- environmentUpdateData
- ReleaseEnvironmentUpdateMetadata
Metadati di aggiornamento dell'ambiente.
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
ID della versione.
- environmentId
-
number
ID dell'ambiente di rilascio.
Restituisce
Promise<ReleaseEnvironment>
updateReleaseResource(ReleaseUpdateMetadata, string, number)
Aggiornare alcune proprietà di una versione.
function updateReleaseResource(releaseUpdateMetadata: ReleaseUpdateMetadata, project: string, releaseId: number): Promise<Release>Parametri
- releaseUpdateMetadata
- ReleaseUpdateMetadata
Proprietà della versione da aggiornare.
- project
-
string
ID progetto o nome progetto
- releaseId
-
number
ID della versione da aggiornare.
Restituisce
Promise<Release>
updateReleaseSettings(ReleaseSettings, string)
Aggiorna le impostazioni di versione
function updateReleaseSettings(releaseSettings: ReleaseSettings, project: string): Promise<ReleaseSettings>Parametri
- releaseSettings
- ReleaseSettings
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<ReleaseSettings>