Releases - Get Release Environment
Ottenere un ambiente di rilascio.
GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/environments/{environmentId}?api-version=7.1-preview.7
GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/environments/{environmentId}?$expand={$expand}&api-version=7.1-preview.7
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
environment
|
path | True |
integer int32 |
ID dell'ambiente di rilascio. |
organization
|
path | True |
string |
Nome dell'organizzazione di Azure DevOps. |
project
|
path | True |
string |
ID progetto o nome progetto |
release
|
path | True |
integer int32 |
ID della versione. |
api-version
|
query | True |
string |
Versione dell'API da usare. Questa opzione deve essere impostata su '7.1-preview.7' per usare questa versione dell'API. |
$expand
|
query |
Proprietà che deve essere espansa nell'ambiente. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
operazione riuscita |
Sicurezza
oauth2
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL:
https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
Scopes
Nome | Descrizione |
---|---|
vso.release | Concede la possibilità di leggere gli artefatti della versione, incluse cartelle, versioni, definizioni di versione e ambiente di rilascio. |
Definizioni
ApprovalExecutionOrder
Ordine di esecuzione approvazioni.
Nome | Tipo | Descrizione |
---|---|---|
afterGatesAlways |
string |
Le approvazioni visualizzate sempre dopo l'esecuzione dei cancelli. |
afterSuccessfulGates |
string |
Le approvazioni visualizzate dopo l'esecuzione riuscita dei cancelli. |
beforeGates |
string |
Approvazioni visualizzate prima dei cancelli. |
ApprovalOptions
Nome | Tipo | Descrizione |
---|---|---|
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped |
boolean |
Specificare se l'approvazione può essere ignorata se lo stesso responsabile approvazione ha approvato la fase precedente. |
enforceIdentityRevalidation |
boolean |
Specificare se riconvalidare l'identità del responsabile approvazione prima di completare l'approvazione. |
executionOrder |
Ordine di esecuzione approvazioni. |
|
releaseCreatorCanBeApprover |
boolean |
Specificare se l'utente che richiede una versione o una distribuzione deve consentire al responsabile approvazione. |
requiredApproverCount |
integer |
Numero di approvazioni necessarie per il rilascio in avanti. '0' indica tutte le approvazioni necessarie. |
timeoutInMinutes |
integer |
Timeout approvazione. Il timeout predefinito dell'approvazione è 30 giorni. Il timeout massimo consentito è 365 giorni. '0' indica il timeout predefinito, ad esempio 30 giorni. |
ApprovalStatus
Ottiene o imposta lo stato dell'approvazione.
Nome | Tipo | Descrizione |
---|---|---|
approved |
string |
Indica che l'approvazione è approvata. |
canceled |
string |
Indica che l'approvazione è stata annullata. |
pending |
string |
Indica che l'approvazione è in sospeso. |
reassigned |
string |
Indica che l'approvazione è riassegnata. |
rejected |
string |
Indica che l'approvazione è stata rifiutata. |
skipped |
string |
Indica che l'approvazione viene ignorata. |
undefined |
string |
Indica che l'approvazione non ha lo stato impostato. |
ApprovalType
Ottiene o imposta il tipo di approvazione.
Nome | Tipo | Descrizione |
---|---|---|
all |
string |
Indica tutte le approvazioni. |
postDeploy |
string |
Indica le approvazioni eseguite dopo la distribuzione. |
preDeploy |
string |
Indica le approvazioni eseguite prima della distribuzione. |
undefined |
string |
Indica che il tipo di approvazione non è impostato. |
AuthorizationHeader
Nome | Tipo | Descrizione |
---|---|---|
name |
string |
|
value |
string |
ConditionType
Ottiene o imposta il tipo di condizione.
Nome | Tipo | Descrizione |
---|---|---|
artifact |
string |
Il tipo di condizione è artefatto. |
environmentState |
string |
Il tipo di condizione è lo stato dell'ambiente. |
event |
string |
Il tipo di condizione è l'evento. |
undefined |
string |
Il tipo di condizione non è definito. |
ConfigurationVariableValue
Nome | Tipo | Descrizione |
---|---|---|
allowOverride |
boolean |
Ottiene e imposta se una variabile può essere sottoposta a override in fase di distribuzione o meno. |
isSecret |
boolean |
Ottiene o imposta come variabile è segreta o meno. |
value |
string |
Ottiene e imposta il valore della variabile di configurazione. |
DataSourceBindingBase
Rappresenta l'associazione dell'origine dati per la richiesta dell'endpoint di servizio.
Nome | Tipo | Descrizione |
---|---|---|
callbackContextTemplate |
string |
Formato di paginazione supportato da questa origine dati(ContinuationToken/SkipTop). |
callbackRequiredTemplate |
string |
Chiamate successive necessarie? |
dataSourceName |
string |
Ottiene o imposta il nome dell'origine dati. |
endpointId |
string |
Ottiene o imposta l'ID endpoint. |
endpointUrl |
string |
Ottiene o imposta l'URL dell'endpoint di servizio. |
headers |
Ottiene o imposta le intestazioni di autorizzazione. |
|
initialContextTemplate |
string |
Definisce il valore iniziale dei parametri della query |
parameters |
object |
Ottiene o imposta i parametri per l'origine dati. |
requestContent |
string |
Ottiene o imposta il corpo della richiesta HTTP |
requestVerb |
string |
Ottiene o imposta il verbo della richiesta HTTP |
resultSelector |
string |
Ottiene o imposta il selettore dei risultati. |
resultTemplate |
string |
Ottiene o imposta il modello di risultato. |
target |
string |
Ottiene o imposta la destinazione dell'origine dati. |
DeploymentAttempt
Nome | Tipo | Descrizione |
---|---|---|
attempt |
integer |
Tentativo di distribuzione. |
deploymentId |
integer |
ID della distribuzione. |
hasStarted |
boolean |
Specifica se la distribuzione è stata avviata o meno. |
id |
integer |
ID della distribuzione. |
issues |
Issue[] |
Tutti i problemi relativi alla distribuzione. |
lastModifiedBy |
Identità dell'ultima modifica di questa distribuzione. |
|
lastModifiedOn |
string |
Ora dell'ultima modifica della distribuzione. |
operationStatus |
Stato dell'operazione di distribuzione. |
|
postDeploymentGates |
Post-deployment gates che sono stati eseguiti in questa distribuzione. |
|
preDeploymentGates |
Controlli di pre-distribuzione eseguiti in questa distribuzione. |
|
queuedOn |
string |
Quando questa distribuzione è stata accodata. |
reason |
Motivo della distribuzione. |
|
releaseDeployPhases |
Elenco delle distribuzioni di versione eseguite in questa distribuzione. |
|
requestedBy |
Identità che ha richiesto questa distribuzione. |
|
requestedFor |
Identità per questa distribuzione richiesta. |
|
status |
stato della distribuzione. |
DeploymentJob
Nome | Tipo | Descrizione |
---|---|---|
job |
Attività padre di tutte le attività eseguite. |
|
tasks |
Elenco delle attività eseguite con nel processo. |
DeploymentOperationStatus
Ottiene lo stato dell'operazione di distribuzione.
Nome | Tipo | Descrizione |
---|---|---|
all |
string |
Lo stato dell'operazione di distribuzione è tutto. |
approved |
string |
Lo stato dell'operazione di distribuzione è approvato. |
canceled |
string |
Lo stato dell'operazione di distribuzione viene annullato. |
cancelling |
string |
Lo stato dell'operazione di distribuzione viene annullato. |
deferred |
string |
Lo stato dell'operazione di distribuzione viene posticipato. |
evaluatingGates |
string |
Lo stato dell'operazione di distribuzione è La valutazione diGate. |
gateFailed |
string |
Lo stato dell'operazione di distribuzione è GateFailed. |
manualInterventionPending |
string |
Lo stato dell'operazione di distribuzione è manuale in sospeso. |
pending |
string |
Lo stato dell'operazione di distribuzione è in sospeso. |
phaseCanceled |
string |
Lo stato dell'operazione di distribuzione viene annullata. |
phaseFailed |
string |
Lo stato dell'operazione di distribuzione non è riuscito. |
phaseInProgress |
string |
Lo stato dell'operazione di distribuzione è in corso. |
phasePartiallySucceeded |
string |
Lo stato dell'operazione di distribuzione è parzialmente riuscito. |
phaseSucceeded |
string |
Lo stato dell'operazione di distribuzione è stata completata. |
queued |
string |
Lo stato dell'operazione di distribuzione viene accodato. |
queuedForAgent |
string |
Lo stato dell'operazione di distribuzione viene accodato per l'agente. |
queuedForPipeline |
string |
Lo stato dell'operazione di distribuzione viene accodato per la pipeline. |
rejected |
string |
Lo stato dell'operazione di distribuzione viene rifiutato. |
scheduled |
string |
Lo stato dell'operazione di distribuzione è pianificato. |
undefined |
string |
Lo stato dell'operazione di distribuzione non è definito. |
DeploymentReason
Ottiene il motivo della distribuzione.
Nome | Tipo | Descrizione |
---|---|---|
automated |
string |
Il motivo della distribuzione è automatizzato. |
manual |
string |
Il motivo della distribuzione è manuale. |
none |
string |
Il motivo della distribuzione è nessuno. |
redeployTrigger |
string |
Il motivo della distribuzione è RedeployTrigger. |
scheduled |
string |
Il motivo della distribuzione è pianificato. |
DeploymentStatus
Ottiene lo stato della distribuzione.
Nome | Tipo | Descrizione |
---|---|---|
all |
string |
Lo stato della distribuzione è tutto. |
failed |
string |
Lo stato della distribuzione non è riuscito. |
inProgress |
string |
Lo stato della distribuzione è in corso. |
notDeployed |
string |
Lo stato della distribuzione non viene distribuito. |
partiallySucceeded |
string |
Lo stato della distribuzione è parzialmente riuscito. |
succeeded |
string |
Lo stato della distribuzione è riuscito. |
undefined |
string |
Lo stato della distribuzione non è definito. |
DeployPhase
Nome | Tipo | Descrizione |
---|---|---|
name |
string |
Ottiene e imposta il nome della fase di distribuzione. |
phaseType |
Indica il tipo di fase di distribuzione. |
|
rank |
integer |
Ottiene e imposta la classificazione della fase di distribuzione. |
refName |
string |
Ottiene e imposta il nome di riferimento della fase di distribuzione. |
workflowTasks |
Ottiene e imposta le attività del flusso di lavoro per la fase di distribuzione. |
DeployPhaseStatus
Stato della fase.
Nome | Tipo | Descrizione |
---|---|---|
canceled |
string |
Esecuzione della fase annullata. |
cancelling |
string |
La fase è in stato di annullamento. |
failed |
string |
L'esecuzione della fase non è riuscita. |
inProgress |
string |
Esecuzione in fase in corso. |
notStarted |
string |
L'esecuzione della fase non è stata avviata. |
partiallySucceeded |
string |
L'esecuzione in fase ha avuto esito parziale. |
skipped |
string |
Esecuzione in fase ignorata. |
succeeded |
string |
L'esecuzione della fase ha avuto esito positivo. |
undefined |
string |
Stato fase non impostato. |
DeployPhaseTypes
Indica il tipo di fase di distribuzione.
Nome | Tipo | Descrizione |
---|---|---|
agentBasedDeployment |
string |
Tipo di fase che contiene attività eseguite nell'agente. |
deploymentGates |
string |
Tipo di fase che contiene attività che fungono da Gates per la distribuzione in corso. |
machineGroupBasedDeployment |
string |
Tipo di fase che contiene attività eseguite nei computer del gruppo di distribuzione. |
runOnServer |
string |
Tipo di fase che contiene attività eseguite dal server. |
undefined |
string |
Tipo di fase non definito. Non usarla. |
EnvironmentOptions
Nome | Tipo | Descrizione |
---|---|---|
autoLinkWorkItems |
boolean |
Ottiene e imposta come elementi di lavoro di collegamento automatico o meno. |
badgeEnabled |
boolean |
Ottiene e imposta come badge abilitato o meno. |
publishDeploymentStatus |
boolean |
Ottiene e imposta come stato di distribuzione di pubblicazione o meno. |
pullRequestDeploymentEnabled |
boolean |
Ottiene e imposta come distribuzione della richiesta pull abilitata o meno. |
EnvironmentStatus
Ottiene lo stato dell'ambiente.
Nome | Tipo | Descrizione |
---|---|---|
canceled |
string |
L'ambiente è in stato annullato. |
inProgress |
string |
L'ambiente è in corso. |
notStarted |
string |
L'ambiente non è avviato. |
partiallySucceeded |
string |
L'ambiente è parzialmente riuscito. |
queued |
string |
L'ambiente è in coda. |
rejected |
string |
L'ambiente è in stato rifiutato. |
scheduled |
string |
L'ambiente è in stato pianificato. |
succeeded |
string |
L'ambiente è in stato riuscito. |
undefined |
string |
Stato dell'ambiente non impostato. |
GateStatus
Stato delle porte di rilascio.
Nome | Tipo | Descrizione |
---|---|---|
canceled |
string |
L'esecuzione del gate è stata annullata. |
failed |
string |
L'esecuzione del gate non è riuscita. |
inProgress |
string |
Il cancello è attualmente in corso. |
none |
string |
Il gate non ha il set di stato. |
pending |
string |
Il gate è in sospeso. |
succeeded |
string |
Il gate è stato completato correttamente. |
IdentityRef
Nome | Tipo | Descrizione |
---|---|---|
_links |
Questo campo contiene zero o più collegamenti interessanti sull'oggetto del grafico. Questi collegamenti possono essere richiamati per ottenere relazioni aggiuntive o informazioni più dettagliate su questo oggetto grafico. |
|
descriptor |
string |
Il descrittore è il modo principale per fare riferimento all'oggetto del grafo mentre il sistema è in esecuzione. Questo campo identificherà in modo univoco lo stesso oggetto grafico in account e organizzazioni. |
directoryAlias |
string |
Deprecato: può essere recuperato eseguendo una query sull'utente graph a cui si fa riferimento nella voce "self" del dizionario "_links" IdentityRef |
displayName |
string |
Si tratta del nome visualizzato non univoco dell'oggetto del grafico. Per modificare questo campo, è necessario modificarne il valore nel provider di origine. |
id |
string |
|
imageUrl |
string |
Deprecato : disponibile nella voce "avatar" del dizionario IdentityRef "_links" |
inactive |
boolean |
Deprecato: può essere recuperato eseguendo una query sullo stato di appartenenza graph a cui si fa riferimento nella voce "membershipState" del dizionario GraphUser "_links" |
isAadIdentity |
boolean |
Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
isContainer |
boolean |
Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descriptor.IsGroupType) |
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
Deprecato: non in uso nella maggior parte delle implementazioni preesistenti di ToIdentityRef |
uniqueName |
string |
Deprecato: usare invece Domain+PrincipalName |
url |
string |
Questo URL è la route completa alla risorsa di origine di questo oggetto grafico. |
IgnoredGate
Nome | Tipo | Descrizione |
---|---|---|
lastModifiedOn |
string |
Ottiene la data in cui l'ultimo cancello viene ignorato. |
name |
string |
Nome del gate ignorato. |
Issue
Nome | Tipo | Descrizione |
---|---|---|
data |
object |
Rilasciare i dati. |
issueType |
string |
Tipo di problema, ad esempio errore, avviso o info. |
message |
string |
Messaggio di problema. |
ManualIntervention
Nome | Tipo | Descrizione |
---|---|---|
approver |
Ottiene o imposta l'identità che deve approvare. |
|
comments |
string |
Ottiene o imposta commenti per l'approvazione. |
createdOn |
string |
Ottiene la data in cui è stata creata. |
id |
integer |
Ottiene l'identificatore univoco per l'intervento manuale. |
instructions |
string |
Ottiene o imposta le istruzioni per l'approvazione. |
modifiedOn |
string |
Ottiene la data in cui è stata modificata. |
name |
string |
Ottiene o imposta il nome. |
release |
Ottiene releaseReference per l'intervento manuale. |
|
releaseDefinition |
Ottiene releaseDefinitionReference per l'intervento manuale. |
|
releaseEnvironment |
Ottiene releaseEnvironmentReference per l'intervento manuale. |
|
status |
Ottiene o imposta lo stato dell'intervento manuale. |
|
taskInstanceId |
string |
Ottenere l'identificatore dell'istanza dell'attività. |
url |
string |
Ottiene l'URL per accedere all'intervento manuale. |
ManualInterventionStatus
Ottiene o imposta lo stato dell'intervento manuale.
Nome | Tipo | Descrizione |
---|---|---|
approved |
string |
L'intervento manuale viene approvato. |
canceled |
string |
L'intervento manuale viene annullato. |
pending |
string |
L'intervento manuale è in sospeso. |
rejected |
string |
L'intervento manuale viene rifiutato. |
unknown |
string |
L'intervento manuale non ha il set di stato. |
ProcessParameters
Nome | Tipo | Descrizione |
---|---|---|
dataSourceBindings |
Rappresenta l'associazione dell'origine dati per la richiesta dell'endpoint di servizio. |
|
inputs | ||
sourceDefinitions |
ProjectReference
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
Ottiene l'identificatore univoco di questo campo. |
name |
string |
Ottiene il nome del progetto. |
ReferenceLinks
Classe per rappresentare una raccolta di collegamenti di riferimento REST.
Nome | Tipo | Descrizione |
---|---|---|
links |
object |
Visualizzazione di sola lettura dei collegamenti. Poiché i collegamenti di riferimento sono di sola lettura, è consigliabile esporli solo come di sola lettura. |
ReleaseApproval
Nome | Tipo | Descrizione |
---|---|---|
approvalType |
Ottiene o imposta il tipo di approvazione. |
|
approvedBy |
Ottiene l'identità approvata. |
|
approver |
Ottiene o imposta l'identità che deve approvare. |
|
attempt |
integer |
Ottiene o imposta un tentativo che specifica il tentativo di distribuzione a cui appartiene. |
comments |
string |
Ottiene o imposta i commenti per l'approvazione. |
createdOn |
string |
Ottiene la data in cui è stata creata. |
history |
Ottiene la cronologia che specifica tutte le approvazioni associate all'approvazione. |
|
id |
integer |
Ottiene l'identificatore univoco di questo campo. |
isAutomated |
boolean |
Ottiene o imposta quando l'approvazione è automatizzata o meno. |
modifiedOn |
string |
Ottiene la data in cui è stata modificata. |
rank |
integer |
Ottiene o imposta la classificazione che specifica l'ordine dell'approvazione. Ad esempio, lo stesso rango indica l'approvazione parallela. |
release |
Ottiene releaseReference che specifica il riferimento della versione a cui è associata questa approvazione. |
|
releaseDefinition |
Ottiene releaseDefinitionReference che specifica il riferimento della definizione di versione a cui è associata l'approvazione. |
|
releaseEnvironment |
Ottiene releaseEnvironmentReference che specifica il riferimento dell'ambiente di versione a cui è associata questa approvazione. |
|
revision |
integer |
Ottiene il numero di revisione. |
status |
Ottiene o imposta lo stato dell'approvazione. |
|
url |
string |
Ottiene l'URL per accedere all'approvazione. |
ReleaseApprovalHistory
Nome | Tipo | Descrizione |
---|---|---|
approver |
Identità del responsabile approvazione. |
|
changedBy |
Identità dell'oggetto che ha modificato l'approvazione. |
|
comments |
string |
Commenti della cronologia delle approvazioni. |
createdOn |
string |
Ora di creazione dell'approvazione. |
modifiedOn |
string |
Ora di modifica dell'approvazione. |
revision |
integer |
Revisione della cronologia delle approvazioni. |
ReleaseCondition
Nome | Tipo | Descrizione |
---|---|---|
conditionType |
Ottiene o imposta il tipo di condizione. |
|
name |
string |
Ottiene o imposta il nome della condizione. ad esempio 'ReleaseStarted'. |
result |
boolean |
Risultato della condizione di rilascio. |
value |
string |
Ottiene o imposta il valore della condizione. |
ReleaseDefinitionApprovals
Nome | Tipo | Descrizione |
---|---|---|
approvalOptions |
Ottiene o imposta le opzioni di approvazione. |
|
approvals |
Ottiene o imposta le approvazioni. |
ReleaseDefinitionApprovalStep
Nome | Tipo | Descrizione |
---|---|---|
approver |
Ottiene e imposta il responsabile approvazione. |
|
id |
integer |
ID del passaggio di approvazione o distribuzione. |
isAutomated |
boolean |
Indica se l'approvazione è automatizzata. |
isNotificationOn |
boolean |
Indica se il set di notifiche di approvazione. |
rank |
integer |
Ottiene o imposta la classificazione del passaggio di approvazione. |
ReleaseDefinitionGate
Nome | Tipo | Descrizione |
---|---|---|
tasks |
Ottiene o imposta il flusso di lavoro gate. |
ReleaseDefinitionGatesOptions
Nome | Tipo | Descrizione |
---|---|---|
isEnabled |
boolean |
Ottiene o imposta come cancelli abilitati o meno. |
minimumSuccessDuration |
integer |
Ottiene o imposta la durata minima per i risultati stabili dopo una valutazione dei controlli completata. |
samplingInterval |
integer |
Ottiene o imposta il tempo tra la rivalutazione dei controlli. |
stabilizationTime |
integer |
Ottiene o imposta il ritardo prima della valutazione. |
timeout |
integer |
Ottiene o imposta il timeout dopo il quale i controlli hanno esito negativo. |
ReleaseDefinitionGatesStep
Nome | Tipo | Descrizione |
---|---|---|
gates |
Ottiene o imposta i cancelli. |
|
gatesOptions |
Ottiene o imposta le opzioni di controllo. |
|
id |
integer |
ID della versioneDefinitionGateStep. |
ReleaseDefinitionShallowReference
Nome | Tipo | Descrizione |
---|---|---|
_links |
Ottiene i collegamenti a risorse, API e viste correlate per la definizione della versione. |
|
id |
integer |
Ottiene l'identificatore univoco della definizione della versione. |
name |
string |
Ottiene o imposta il nome della definizione della versione. |
path |
string |
Ottiene o imposta il percorso della definizione della versione. |
projectReference |
Ottiene o imposta il riferimento al progetto. |
|
url |
string |
Ottiene l'URL dell'API REST per accedere alla definizione di versione. |
ReleaseDeployPhase
Nome | Tipo | Descrizione |
---|---|---|
deploymentJobs |
Processi di distribuzione della fase. |
|
errorLog |
string |
Log degli errori di esecuzione delle fasi. |
manualInterventions |
Elenco delle informazioni sull'esecuzione delle attività di intervento manuale in fase. |
|
name |
string |
Nome della fase. |
phaseId |
string |
ID della fase. |
phaseType |
Tipo della fase. |
|
rank |
integer |
Classificazione della fase. |
runPlanId |
string |
ID piano di esecuzione della fase. |
startedOn |
string |
Ora di inizio della fase. |
status |
Stato della fase. |
ReleaseEnvironment
Nome | Tipo | Descrizione |
---|---|---|
conditions |
Ottiene l'elenco di condizioni. |
|
createdOn |
string |
Ottiene la data in cui è stata creata. |
definitionEnvironmentId |
integer |
Ottiene l'ID dell'ambiente di definizione. |
deployPhasesSnapshot |
Ottiene l'elenco degli snapshot delle fasi di distribuzione. |
|
deploySteps |
Ottiene i passaggi di distribuzione. |
|
environmentOptions |
Ottiene le opzioni di ambiente. |
|
id |
integer |
Ottiene l'identificatore univoco di questo campo. |
modifiedOn |
string |
Ottiene la data in cui è stata modificata. |
name |
string |
Ottiene il nome. |
nextScheduledUtcTime |
string |
Ottiene l'ora UTC pianificata successiva. |
owner |
Ottiene l'identità proprietaria dell'ambiente di rilascio. |
|
postApprovalsSnapshot |
Ottiene l'elenco di snapshot post-distribuzione delle approvazioni. |
|
postDeployApprovals |
Ottiene l'elenco delle approvazioni post-distribuzione. |
|
postDeploymentGatesSnapshot |
Dati snapshot post-deployment gates. |
|
preApprovalsSnapshot |
Ottiene l'elenco di snapshot di approvazioni di pre-distribuzione. |
|
preDeployApprovals |
Ottiene l'elenco delle approvazioni di pre-distribuzione. |
|
preDeploymentGatesSnapshot |
Pre-deployment gates snapshot data .Pre deployment gates snapshot data.Pre deployment gates snapshot data. |
|
processParameters |
Ottiene i parametri del processo. |
|
rank |
integer |
Ottiene il rango. |
release |
Ottiene il riferimento alla versione che specifica il riferimento della versione a cui è associato questo ambiente di versione. |
|
releaseCreatedBy |
Ottiene l'identità che ha creato la versione. |
|
releaseDefinition |
Ottiene releaseDefinitionReference che specifica il riferimento della definizione di versione a cui è associato questo ambiente di versione. |
|
releaseId |
integer |
Ottiene l'ID versione. |
scheduledDeploymentTime |
string |
Ottiene l'ora di distribuzione pianificata dell'ambiente di rilascio. |
schedules |
Ottiene l'elenco delle pianificazioni. |
|
status |
Ottiene lo stato dell'ambiente. |
|
timeToDeploy |
number |
Ottiene il tempo necessario per la distribuzione. |
triggerReason |
string |
Ottiene il motivo del trigger. |
variableGroups |
Ottiene l'elenco di gruppi di variabili. |
|
variables |
<string,
Configuration |
Ottiene il dizionario delle variabili. |
ReleaseEnvironmentExpands
Proprietà che deve essere espansa nell'ambiente.
Nome | Tipo | Descrizione |
---|---|---|
none |
string |
Restituisce le proprietà di primo livello dell'oggetto. |
tasks |
string |
Espandere l'ambiente con le attività. |
ReleaseEnvironmentShallowReference
Nome | Tipo | Descrizione |
---|---|---|
_links |
Ottiene i collegamenti a risorse, API e viste correlate per l'ambiente di rilascio. |
|
id |
integer |
Ottiene l'identificatore univoco dell'ambiente di rilascio. |
name |
string |
Ottiene o imposta il nome dell'ambiente di rilascio. |
url |
string |
Ottiene l'URL dell'API REST per accedere all'ambiente di rilascio. |
ReleaseGates
Nome | Tipo | Descrizione |
---|---|---|
deploymentJobs |
Contiene i dettagli del processo gate di ogni valutazione. |
|
id |
integer |
ID delle porte di rilascio. |
ignoredGates |
Elenco di cancelli ignorati. |
|
lastModifiedOn |
string |
Gate ultima modificata. |
runPlanId |
string |
Eseguire l'ID piano dei cancelli. |
stabilizationCompletedOn |
string |
Stabilizzazione dei cancelli completata data e ora. |
startedOn |
string |
Tempo di inizio della valutazione di Gates. |
status |
Stato dei controlli di rilascio. |
|
succeedingSince |
string |
Data e ora in cui tutti i controlli vengono eseguiti correttamente. |
ReleaseSchedule
Nome | Tipo | Descrizione |
---|---|---|
daysToRelease |
Giorni della settimana da rilasciare. |
|
jobId |
string |
ID processo definizione processo Team Foundation. |
scheduleOnlyWithChanges |
boolean |
Contrassegno per determinare se questa pianificazione deve essere rilasciata solo se l'artefatto associato è stato modificato o la definizione della versione è stata modificata. |
startHours |
integer |
Ora di fuso orario locale da avviare. |
startMinutes |
integer |
Fuso orario locale per iniziare. |
timeZoneId |
string |
Id fuso orario della pianificazione della versione, ad esempio 'UTC'. |
ReleaseShallowReference
Nome | Tipo | Descrizione |
---|---|---|
_links |
Ottiene i collegamenti a risorse, API e viste correlate per la versione. |
|
id |
integer |
Ottiene l'identificatore univoco della versione. |
name |
string |
Ottiene o imposta il nome della versione. |
url |
string |
Ottiene l'URL dell'API REST per accedere alla versione. |
ReleaseTask
Nome | Tipo | Descrizione |
---|---|---|
agentName |
string |
Nome agente in cui è stata eseguita l'attività. |
finishTime |
string |
Fine dell'attività di rilascio. |
id |
integer |
ID dell'attività di rilascio. |
issues |
Issue[] |
Elenco di problemi durante l'esecuzione dell'attività. |
lineCount |
integer |
Numero di attività di rilascio del log delle righe. |
logUrl |
string |
URL di log dell'attività. |
name |
string |
Nome dell'attività. |
percentComplete |
integer |
Esecuzione attività completa precente. |
rank |
integer |
Classificazione dell'attività di rilascio. |
resultCode |
string |
Codice risultato dell'attività. |
startTime |
string |
ID dell'attività di rilascio. |
status |
Stato dell'attività di rilascio. |
|
task |
Informazioni di riferimento sulle attività del flusso di lavoro. |
|
timelineRecordId |
string |
ID record sequenza temporale dell'attività di rilascio. |
ScheduleDays
Giorni della settimana da rilasciare.
Nome | Tipo | Descrizione |
---|---|---|
all |
string |
Pianificato in tutti i giorni della settimana. |
friday |
string |
Programmato venerdì. |
monday |
string |
Programmato lunedì. |
none |
string |
Giorno pianificato non impostato. |
saturday |
string |
Programmato sabato. |
sunday |
string |
Programmata la domenica. |
thursday |
string |
Programmato giovedì. |
tuesday |
string |
Programmato martedì. |
wednesday |
string |
Programmato mercoledì. |
TaskInputDefinitionBase
Nome | Tipo | Descrizione |
---|---|---|
aliases |
string[] |
|
defaultValue |
string |
|
groupName |
string |
|
helpMarkDown |
string |
|
label |
string |
|
name |
string |
|
options |
object |
|
properties |
object |
|
required |
boolean |
|
type |
string |
|
validation | ||
visibleRule |
string |
TaskInputValidation
Nome | Tipo | Descrizione |
---|---|---|
expression |
string |
Espressione condizionale |
message |
string |
Messaggio che spiega come l'utente può correggere se la convalida ha esito negativo |
TaskSourceDefinitionBase
Nome | Tipo | Descrizione |
---|---|---|
authKey |
string |
|
endpoint |
string |
|
keySelector |
string |
|
selector |
string |
|
target |
string |
TaskStatus
Stato dell'attività di rilascio.
Nome | Tipo | Descrizione |
---|---|---|
canceled |
string |
L'esecuzione dell'attività annullata. |
failed |
string |
L'esecuzione dell'attività non è riuscita. |
failure |
string |
L'esecuzione dell'attività non è riuscita. |
inProgress |
string |
L'attività è attualmente in corso. |
partiallySucceeded |
string |
L'esecuzione dell'attività ha avuto esito parziale. |
pending |
string |
L'attività è in sospeso. |
skipped |
string |
Esecuzione dell'attività ignorata. |
succeeded |
string |
L'attività è stata completata correttamente. |
success |
string |
L'attività è stata completata correttamente. |
unknown |
string |
L'attività non ha il set di stato. |
VariableGroup
Nome | Tipo | Descrizione |
---|---|---|
createdBy |
Ottiene o imposta l'identità creata. |
|
createdOn |
string |
Ottiene la data in cui è stata creata. |
description |
string |
Ottiene o imposta la descrizione. |
id |
integer |
Ottiene l'identificatore univoco di questo campo. |
isShared |
boolean |
Indica se un gruppo di variabili è condiviso con un altro progetto o meno. |
modifiedBy |
Ottiene o imposta l'identità modificata. |
|
modifiedOn |
string |
Ottiene la data in cui è stata modificata. |
name |
string |
Ottiene o imposta il nome. |
providerData |
Ottiene o imposta i dati del provider. |
|
type |
string |
Ottiene o imposta il tipo. |
variableGroupProjectReferences |
tutti i riferimenti al progetto in cui il gruppo di variabili è condiviso con altri progetti. |
|
variables |
<string,
Variable |
Ottiene e imposta il dizionario delle variabili. |
VariableGroupProjectReference
Un riferimento a un gruppo di variabili è un riferimento superficiale al gruppo di variabili.
Nome | Tipo | Descrizione |
---|---|---|
description |
string |
Ottiene o imposta la descrizione del gruppo di variabili. |
name |
string |
Ottiene o imposta il nome del gruppo di variabili. |
projectReference |
Ottiene o imposta il riferimento al progetto del gruppo di variabili. |
VariableGroupProviderData
VariableValue
Nome | Tipo | Descrizione |
---|---|---|
isReadOnly |
boolean |
Ottiene o imposta se la variabile è di sola lettura o meno. |
isSecret |
boolean |
Ottiene o imposta come variabile è segreto o meno. |
value |
string |
Ottiene o imposta il valore. |
WorkflowTask
Nome | Tipo | Descrizione |
---|---|---|
alwaysRun |
boolean |
Ottiene o imposta come l'attività viene sempre eseguita o meno. |
condition |
string |
Ottiene o imposta la condizione dell'attività. |
continueOnError |
boolean |
Ottiene o imposta come l'attività continua l'esecuzione in caso di errore o meno. |
definitionType |
string |
Ottiene o imposta il tipo di definizione dell'attività. Esempio:- 'Agent', DeploymentGroup', 'Server' o 'ServerGate'. |
enabled |
boolean |
Ottiene o imposta come attività abilitata o meno. |
environment |
object |
Ottiene o imposta le variabili di ambiente dell'attività. |
inputs |
object |
Ottiene o imposta gli input dell'attività. |
name |
string |
Ottiene o imposta il nome dell'attività. |
overrideInputs |
object |
Ottiene o imposta gli input di override dell'attività. |
refName |
string |
Ottiene o imposta il nome di riferimento dell'attività. |
retryCountOnTaskFailure |
integer |
Ottiene o imposta l'attività retryCount. |
taskId |
string |
Ottiene o imposta l'ID dell'attività. |
timeoutInMinutes |
integer |
Ottiene o imposta il timeout dell'attività. |
version |
string |
Ottiene o imposta la versione dell'attività. |
WorkflowTaskReference
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
Identificatore dell'attività. |
name |
string |
Nome dell'attività. |
version |
string |
Versione dell'attività. |