Releases - Update Release Environment

Service:

Release

API Version:

5.0-preview.6

Aktualizace stavu prostředí vydané verze

PATCH https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/environments/{environmentId}?api-version=5.0-preview.6

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
environmentId	path	True	integer int32	ID prostředí vydané verze.
organization	path	True	string	Název organizace Azure DevOps.
project	path	True	string	ID projektu nebo název projektu
releaseId	path	True	integer int32	ID vydané verze.
api-version	query	True	string	Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavená na 5.0-preview.6.

Text požadavku

Name	Typ	Description
comment	string	Získá nebo nastaví komentář.
scheduledDeploymentTime	string	Získá nebo nastaví naplánovaný čas nasazení.
status	EnvironmentStatus	Získá nebo nastaví stav prostředí.
variables	<string,  ConfigurationVariableValue>	Nastaví seznam proměnných prostředí, které se mají v době nasazení přepsat.

Odpovědi

Name	Typ	Description
200 OK	ReleaseEnvironment	úspěšná operace

Zabezpečení

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

Name	Description
vso.release_execute	Umožňuje číst a aktualizovat artefakty vydaných verzí, včetně vydaných verzí, definic vydaných verzí a envrionmentu vydaných verzí, a možnost zařadit novou verzi do fronty.

Definice

Name	Description
ApprovalExecutionOrder
ApprovalOptions
ApprovalStatus	Získá nebo nastaví stav schválení.
ApprovalType	Získá nebo nastaví typ schválení.
AuthorizationHeader
ConditionType	Získá nebo nastaví typ podmínky.
ConfigurationVariableValue
DataSourceBindingBase	Představuje vazbu zdroje dat pro požadavek koncového bodu služby.
Demand
DeploymentAttempt
DeploymentJob
DeploymentOperationStatus	Získá stav operace nasazení.
DeploymentReason	Získá důvod nasazení.
DeploymentStatus	Získá stav nasazení.
DeployPhase
DeployPhaseStatus
DeployPhaseTypes
EnvironmentOptions
EnvironmentStatus	Získá stav prostředí.
GateStatus
IdentityRef
IgnoredGate
Issue
ManualIntervention
ManualInterventionStatus	Získá nebo nastaví stav ručního zásahu.
ProcessParameters
ProjectReference
ReferenceLinks	Třída představující kolekci odkazů REST.
ReleaseApproval
ReleaseApprovalHistory
ReleaseCondition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDeployPhase
ReleaseEnvironment
ReleaseEnvironmentShallowReference
ReleaseEnvironmentUpdateMetadata
ReleaseGates
ReleaseSchedule
ReleaseShallowReference
ReleaseTask
ScheduleDays	Dny v týdnu do vydání
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
TaskStatus
VariableGroup
VariableGroupProviderData
VariableValue
WorkflowTask
WorkflowTaskReference

ApprovalExecutionOrder

Name	Typ	Description
afterGatesAlways	string
afterSuccessfulGates	string
beforeGates	string

ApprovalOptions

Name	Typ	Description
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped	boolean
enforceIdentityRevalidation	boolean
executionOrder	ApprovalExecutionOrder
releaseCreatorCanBeApprover	boolean
requiredApproverCount	integer
timeoutInMinutes	integer

ApprovalStatus

Získá nebo nastaví stav schválení.

Name	Typ	Description
approved	string
canceled	string
pending	string
reassigned	string
rejected	string
skipped	string
undefined	string

ApprovalType

Získá nebo nastaví typ schválení.

Name	Typ	Description
all	string
postDeploy	string
preDeploy	string
undefined	string

AuthorizationHeader

Name	Typ	Description
name	string
value	string

ConditionType

Získá nebo nastaví typ podmínky.

Name	Typ	Description
artifact	string	Typ podmínky je artefakt.
environmentState	string	Typ podmínky je stav prostředí.
event	string	Typ podmínky je událost.
undefined	string	Typ podmínky není definován.

ConfigurationVariableValue

Name	Typ	Description
allowOverride	boolean	Získá nebo nastaví, pokud proměnnou lze přepsat v době nasazení nebo ne.
isSecret	boolean	Získá nebo nastaví, protože proměnná je tajný nebo ne.
value	string	Získá nebo nastaví hodnotu konfigurační proměnné.

DataSourceBindingBase

Představuje vazbu zdroje dat pro požadavek koncového bodu služby.

Name	Typ	Description
callbackContextTemplate	string	Formát stránkování podporovaný tímto zdrojem dat(ContinuationToken/SkipTop).
callbackRequiredTemplate	string	Jsou potřeba další hovory?
dataSourceName	string	Získá nebo nastaví název zdroje dat.
endpointId	string	Získá nebo nastaví ID koncového bodu.
endpointUrl	string	Získá nebo nastaví adresu URL koncového bodu služby.
headers	AuthorizationHeader[]	Získá nebo nastaví autorizační hlavičky.
initialContextTemplate	string	Definuje počáteční hodnotu parametrů dotazu.
parameters	object	Získá nebo nastaví parametry pro zdroj dat.
resultSelector	string	Získá nebo nastaví selektor výsledků.
resultTemplate	string	Získá nebo nastaví šablonu výsledku.
target	string	Získá nebo nastaví cíl zdroje dat.

Demand

Name	Typ	Description
name	string
value	string

DeploymentAttempt

Name	Typ	Description
attempt	integer
deploymentId	integer
hasStarted	boolean	Určuje, jestli se nasazení spustilo, nebo ne.
id	integer
issues	Issue[]	Všechny problémy související s nasazením
job	ReleaseTask
lastModifiedBy	IdentityRef
lastModifiedOn	string
operationStatus	DeploymentOperationStatus
postDeploymentGates	ReleaseGates
preDeploymentGates	ReleaseGates
queuedOn	string
reason	DeploymentReason
releaseDeployPhases	ReleaseDeployPhase[]
requestedBy	IdentityRef
requestedFor	IdentityRef
runPlanId	string
status	DeploymentStatus
tasks	ReleaseTask[]

DeploymentJob

Name	Typ	Description
job	ReleaseTask
tasks	ReleaseTask[]

DeploymentOperationStatus

Získá stav operace nasazení.

Name	Typ	Description
all	string	Stav operace nasazení je vše.
approved	string	Stav operace nasazení je schválen.
canceled	string	Stav operace nasazení je zrušen.
cancelling	string	Stav operace nasazení se ruší.
deferred	string	Stav operace nasazení je odložen.
evaluatingGates	string	Stav operace nasazení je EvaluatingGates.
gateFailed	string	Stav operace nasazení je GateFailed.
manualInterventionPending	string	Stav operace nasazení je ručníintervention čeká na vyřízení.
pending	string	Stav operace nasazení čeká na vyřízení.
phaseCanceled	string	Stav operace nasazení je fáze zrušena.
phaseFailed	string	Stav operace nasazení je fáze selhání.
phaseInProgress	string	Stav operace nasazení je fáze inprogress.
phasePartiallySucceeded	string	Stav operace nasazení je fáze částečně úspěšná.
phaseSucceeded	string	Stav operace nasazení je fáze úspěšná.
queued	string	Stav operace nasazení je zařazen do fronty.
queuedForAgent	string	Stav operace nasazení je zařazen do fronty pro agenta.
queuedForPipeline	string	Stav operace nasazení je zařazen do fronty pro kanál.
rejected	string	Stav operace nasazení je odmítnut.
scheduled	string	Stav operace nasazení je naplánovaný.
undefined	string	Stav operace nasazení není definován.

DeploymentReason

Získá důvod nasazení.

Name	Typ	Description
automated	string	Důvod nasazení je automatizovaný.
manual	string	Důvod nasazení je ruční.
none	string	Důvod nasazení není žádný.
redeployTrigger	string	Důvodem nasazení je RedeployTrigger.
scheduled	string	Důvod nasazení je naplánovaný.

DeploymentStatus

Získá stav nasazení.

Name	Typ	Description
all	string	Stav nasazení je vše.
failed	string	Stav nasazení selhal.
inProgress	string	Stav nasazení je probíhající.
notDeployed	string	Stav nasazení není nasazený.
partiallySucceeded	string	Stav nasazení je částečně nastavený.
succeeded	string	Stav nasazení je úspěšný.
undefined	string	Stav nasazení není definován.

DeployPhase

Name	Typ	Description
name	string
phaseType	DeployPhaseTypes
rank	integer
refName	string
workflowTasks	WorkflowTask[]

DeployPhaseStatus

Name	Typ	Description
canceled	string
cancelling	string
failed	string
inProgress	string
notStarted	string
partiallySucceeded	string
skipped	string
succeeded	string
undefined	string

DeployPhaseTypes

Name	Typ	Description
agentBasedDeployment	string
deploymentGates	string	Typ fáze, který obsahuje úlohy, které fungují jako brány pro nasazení.
machineGroupBasedDeployment	string
runOnServer	string
undefined	string

EnvironmentOptions

Name	Typ	Description
autoLinkWorkItems	boolean
badgeEnabled	boolean
emailNotificationType	string
emailRecipients	string
enableAccessToken	boolean
publishDeploymentStatus	boolean
pullRequestDeploymentEnabled	boolean
skipArtifactsDownload	boolean
timeoutInMinutes	integer

EnvironmentStatus

Získá stav prostředí.

Name	Typ	Description
canceled	string
inProgress	string
notStarted	string
partiallySucceeded	string
queued	string
rejected	string
scheduled	string
succeeded	string
undefined	string

GateStatus

Name	Typ	Description
canceled	string
failed	string
inProgress	string
none	string
pending	string
succeeded	string

IdentityRef

Name	Typ	Description
_links	ReferenceLinks	Toto pole neobsahuje žádný nebo více zajímavých odkazů na téma grafu. Tyto odkazy mohou být vyvolány za účelem získání dalších relací nebo podrobnějších informací o tomto předmětu grafu.
descriptor	string	Popisovač je primárním způsobem, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejný předmět grafu v rámci účtů i organizací.
directoryAlias	string
displayName	string	Toto je jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém poskytovateli.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Tato adresa URL představuje úplnou trasu ke zdrojovému prostředku tohoto předmětu grafu.

IgnoredGate

Name	Typ	Description
lastModifiedOn	string	Získá datum, kdy je brána naposledy ignorována.
name	string	Název brány byl ignorován.

Issue

Name	Typ	Description
data	object
issueType	string
message	string

ManualIntervention

Name	Typ	Description
approver	IdentityRef	Získá nebo nastaví identitu, která by měla schválit.
comments	string	Získá nebo nastaví komentáře ke schválení.
createdOn	string	Získá datum, kdy byl vytvořen.
id	integer	Získá jedinečný identifikátor pro ruční zásah.
instructions	string	Získá nebo nastaví pokyny ke schválení.
modifiedOn	string	Získá datum, kdy došlo k úpravě.
name	string	Získá nebo nastaví název.
release	ReleaseShallowReference	Získá releaseReference pro ruční zásah.
releaseDefinition	ReleaseDefinitionShallowReference	Získá releaseDefinitionReference pro ruční zásah.
releaseEnvironment	ReleaseEnvironmentShallowReference	Získá releaseEnvironmentReference pro ruční zásah.
status	ManualInterventionStatus	Získá nebo nastaví stav ručního zásahu.
taskInstanceId	string	Získejte identifikátor instance úlohy.
url	string	Získá adresu URL pro přístup k ručnímu zásahu.

ManualInterventionStatus

Získá nebo nastaví stav ručního zásahu.

Name	Typ	Description
approved	string	Ruční zásah je schválen.
canceled	string	Ruční zásah se zruší.
pending	string	Ruční zásah čeká na vyřízení.
rejected	string	Ruční zásah je odmítnut.
unknown	string	Ruční zásah nemá nastavený stav.

ProcessParameters

Name	Typ	Description
dataSourceBindings	DataSourceBindingBase[]	Představuje vazbu zdroje dat pro požadavek koncového bodu služby.
inputs	TaskInputDefinitionBase[]
sourceDefinitions	TaskSourceDefinitionBase[]

ProjectReference

Name	Typ	Description
id	string	Získá jedinečný identifikátor tohoto pole.
name	string	Získá název projektu.

ReferenceLinks

Třída představující kolekci odkazů REST.

Name	Typ	Description
links	object	Zobrazení odkazů jen pro čtení. Vzhledem k tomu, že odkazy jsou jen pro čtení, chceme je zveřejnit jenom jako jen pro čtení.

ReleaseApproval

Name	Typ	Description
approvalType	ApprovalType	Získá nebo nastaví typ schválení.
approvedBy	IdentityRef	Získá identitu, která schválila.
approver	IdentityRef	Získá nebo nastaví identitu, která má schválit.
attempt	integer	Získá nebo nastaví pokus, který určuje, který pokus o nasazení patří.
comments	string	Získá nebo nastaví komentáře ke schválení.
createdOn	string	Získá datum, kdy byl vytvořen.
history	ReleaseApprovalHistory[]	Získá historii, která určuje všechna schválení přidružená k tomuto schválení.
id	integer	Získá jedinečný identifikátor tohoto pole.
isAutomated	boolean	Získá nebo nastaví, protože schválení je automatizované nebo ne.
isNotificationOn	boolean
modifiedOn	string	Získá datum, kdy došlo k úpravě.
rank	integer	Získá nebo nastaví pořadí, které určuje pořadí schválení. Například stejné pořadí označuje paralelní schválení.
release	ReleaseShallowReference	Získá releaseReference, který určuje odkaz na verzi, ke které je přidruženo toto schválení.
releaseDefinition	ReleaseDefinitionShallowReference	Získá releaseDefinitionReference určující odkaz na definici verze, ke které je přidruženo toto schválení.
releaseEnvironment	ReleaseEnvironmentShallowReference	Získá releaseEnvironmentReference určující odkaz na prostředí verze, ke kterému je přidruženo toto schválení.
revision	integer	Získá číslo revize.
status	ApprovalStatus	Získá nebo nastaví stav schválení.
trialNumber	integer
url	string	Získá adresu URL pro přístup ke schválení.

ReleaseApprovalHistory

Name	Typ	Description
approver	IdentityRef
changedBy	IdentityRef
comments	string
createdOn	string
modifiedOn	string
revision	integer

ReleaseCondition

Name	Typ	Description
conditionType	ConditionType	Získá nebo nastaví typ podmínky.
name	string	Získá nebo nastaví název podmínky. např. ReleaseStarted.
result	boolean
value	string	Získá nebo nastaví hodnotu podmínky.

ReleaseDefinitionApprovals

Name	Typ	Description
approvalOptions	ApprovalOptions
approvals	ReleaseDefinitionApprovalStep[]

ReleaseDefinitionApprovalStep

Name	Typ	Description
approver	IdentityRef
id	integer
isAutomated	boolean
isNotificationOn	boolean
rank	integer

ReleaseDefinitionGate

Name	Typ	Description
tasks	WorkflowTask[]

ReleaseDefinitionGatesOptions

Name	Typ	Description
isEnabled	boolean
minimumSuccessDuration	integer
samplingInterval	integer
stabilizationTime	integer
timeout	integer

ReleaseDefinitionGatesStep

Name	Typ	Description
gates	ReleaseDefinitionGate[]
gatesOptions	ReleaseDefinitionGatesOptions
id	integer

ReleaseDefinitionShallowReference

Name	Typ	Description
_links	ReferenceLinks	Získá odkazy na související prostředky, rozhraní API a zobrazení pro definici verze.
id	integer	Získá jedinečný identifikátor definice verze.
name	string	Získá nebo nastaví název definice verze.
path	string	Získá nebo nastaví cestu k definici verze.
projectReference	ProjectReference	Získá nebo nastaví odkaz na projekt.
url	string	Získá adresu URL rozhraní REST API pro přístup k definici verze.

ReleaseDeployPhase

Name	Typ	Description
deploymentJobs	DeploymentJob[]
errorLog	string
id	integer
manualInterventions	ManualIntervention[]
name	string
phaseId	string
phaseType	DeployPhaseTypes
rank	integer
runPlanId	string
startedOn	string	Čas zahájení fáze
status	DeployPhaseStatus

ReleaseEnvironment

Name	Typ	Description
conditions	ReleaseCondition[]	Získá seznam podmínek.
createdOn	string	Získá datum, kdy byl vytvořen.
definitionEnvironmentId	integer	Získá ID prostředí definice.
demands	Demand[]	Získá požadavky.
deployPhasesSnapshot	DeployPhase[]	Získá seznam fází nasazení snímek.
deploySteps	DeploymentAttempt[]	Získá kroky nasazení.
environmentOptions	EnvironmentOptions	Získá možnosti prostředí.
id	integer	Získá jedinečný identifikátor tohoto pole.
modifiedOn	string	Získá datum, kdy došlo k úpravě.
name	string	Získá název.
nextScheduledUtcTime	string	Získá další naplánovaný čas UTC.
owner	IdentityRef	Získá identitu, která je vlastníkem prostředí vydané verze.
postApprovalsSnapshot	ReleaseDefinitionApprovals	Získá seznam snímků schválení po nasazení.
postDeployApprovals	ReleaseApproval[]	Získá seznam schválení po nasazení.
postDeploymentGatesSnapshot	ReleaseDefinitionGatesStep
preApprovalsSnapshot	ReleaseDefinitionApprovals	Získá seznam snímků schválení před nasazením.
preDeployApprovals	ReleaseApproval[]	Získá seznam schválení před nasazením.
preDeploymentGatesSnapshot	ReleaseDefinitionGatesStep
processParameters	ProcessParameters	Získá parametry procesu.
queueId	integer	Získá ID fronty.
rank	integer	Získá pořadí.
release	ReleaseShallowReference	Získá odkaz na verzi, která určuje odkaz na verzi, ke které je přidružena tato verze prostředí.
releaseCreatedBy	IdentityRef	Získá identitu, která vytvořila verzi.
releaseDefinition	ReleaseDefinitionShallowReference	Získá releaseDefinitionReference určující odkaz na definici verze, ke které je přidružena tato verze prostředí.
releaseDescription	string	Získá popis verze.
releaseId	integer	Získá ID verze.
scheduledDeploymentTime	string	Získá plán nasazení prostředí vydané verze.
schedules	ReleaseSchedule[]	Získá seznam plánů.
status	EnvironmentStatus	Získá stav prostředí.
timeToDeploy	number	Získá čas k nasazení.
triggerReason	string	Získá důvod triggeru.
variableGroups	VariableGroup[]	Získá seznam skupin proměnných.
variables	<string,  ConfigurationVariableValue>	Získá slovník proměnných.
workflowTasks	WorkflowTask[]	Získá seznam úkolů pracovního postupu.

ReleaseEnvironmentShallowReference

Name	Typ	Description
_links	ReferenceLinks	Získá odkazy na související prostředky, rozhraní API a zobrazení pro prostředí vydané verze.
id	integer	Získá jedinečný identifikátor prostředí verze.
name	string	Získá nebo nastaví název prostředí vydané verze.
url	string	Získá adresu URL rozhraní REST API pro přístup k prostředí vydané verze.

ReleaseEnvironmentUpdateMetadata

Name	Typ	Description
comment	string	Získá nebo nastaví komentář.
scheduledDeploymentTime	string	Získá nebo nastaví naplánovaný čas nasazení.
status	EnvironmentStatus	Získá nebo nastaví stav prostředí.
variables	<string,  ConfigurationVariableValue>	Nastaví seznam proměnných prostředí, které se mají v době nasazení přepsat.

ReleaseGates

Name	Typ	Description
deploymentJobs	DeploymentJob[]
id	integer
ignoredGates	IgnoredGate[]
lastModifiedOn	string
runPlanId	string
stabilizationCompletedOn	string
startedOn	string
status	GateStatus
succeedingSince	string

ReleaseSchedule

Name	Typ	Description
daysToRelease	ScheduleDays	Dny v týdnu k vydání
jobId	string	ID úlohy definice úlohy Team Foundation
startHours	integer	Začátek hodiny místního časového pásma
startMinutes	integer	Minuta do začátku místního časového pásma
timeZoneId	string	ID časového pásma plánu vydání, například UTC

ReleaseShallowReference

Name	Typ	Description
_links	ReferenceLinks	Získá odkazy na související prostředky, rozhraní API a zobrazení pro verzi.
id	integer	Získá jedinečný identifikátor verze.
name	string	Získá nebo nastaví název verze.
url	string	Získá adresu URL rozhraní REST API pro přístup k verzi.

ReleaseTask

Name	Typ	Description
agentName	string
finishTime	string
id	integer
issues	Issue[]
lineCount	integer
logUrl	string
name	string
percentComplete	integer
rank	integer
resultCode	string
startTime	string
status	TaskStatus
task	WorkflowTaskReference
timelineRecordId	string

ScheduleDays

Dny v týdnu do vydání

Name	Typ	Description
all	string
friday	string
monday	string
none	string
saturday	string
sunday	string
thursday	string
tuesday	string
wednesday	string

TaskInputDefinitionBase

Name	Typ	Description
aliases	string[]
defaultValue	string
groupName	string
helpMarkDown	string
label	string
name	string
options	object
properties	object
required	boolean
type	string
validation	TaskInputValidation
visibleRule	string

TaskInputValidation

Name	Typ	Description
expression	string	Podmíněný výraz
message	string	Zpráva vysvětlující, jak může uživatel opravit, pokud se ověření nezdaří

TaskSourceDefinitionBase

Name	Typ	Description
authKey	string
endpoint	string
keySelector	string
selector	string
target	string

TaskStatus

Name	Typ	Description
canceled	string
failed	string
failure	string
inProgress	string
partiallySucceeded	string
pending	string
skipped	string
succeeded	string
success	string
unknown	string

VariableGroup

Name	Typ	Description
createdBy	IdentityRef	Získá nebo nastaví identitu, která vytvořila.
createdOn	string	Získá datum, kdy byl vytvořen.
description	string	Získá nebo nastaví popis.
id	integer	Získá jedinečný identifikátor tohoto pole.
isShared	boolean	Označuje, jestli se skupina proměnných sdílí s jiným projektem nebo ne.
modifiedBy	IdentityRef	Získá nebo nastaví identitu, která změnila.
modifiedOn	string	Získá datum, kdy došlo k úpravě.
name	string	Získá nebo nastaví název.
providerData	VariableGroupProviderData	Získá nebo nastaví data zprostředkovatele.
type	string	Získá nebo nastaví typ.
variables	<string,  VariableValue>

VariableGroupProviderData

VariableValue

Name	Typ	Description
isSecret	boolean
value	string

WorkflowTask

Name	Typ	Description
alwaysRun	boolean
condition	string
continueOnError	boolean
definitionType	string
enabled	boolean
environment	object
inputs	object
name	string
overrideInputs	object
refName	string
taskId	string
timeoutInMinutes	integer
version	string

WorkflowTaskReference

Name	Typ	Description
id	string
name	string
version	string