Definitions - Get

Service:

Release

API Version:

5.0

Získejte definici vydané verze.

GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions/{definitionId}?api-version=5.0

With optional parameters:

GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions/{definitionId}?propertyFilters={propertyFilters}&api-version=5.0

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
definitionId	path	True	integer int32	ID definice vydané verze.
organization	path	True	string	Název organizace Azure DevOps.
project	path	True	string	ID projektu nebo název projektu
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 nastavena na hodnotu 5.0.
propertyFilters	query		string array (string)	Seznam rozšířených vlastností oddělených čárkami, které se mají načíst. Pokud je tato vlastnost nastavená, bude vrácená definice verze obsahovat hodnoty pro id zadané vlastnosti (pokud existují). Pokud není nastaveno, vlastnosti nebudou zahrnuty.

Odpovědi

Name	Typ	Description
200 OK	ReleaseDefinition	ú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	Umožňuje číst artefakty vydaných verzí, včetně verzí, definic vydaných verzí a prostředí vydaných verzí.

Definice

Name	Description
ApprovalExecutionOrder
ApprovalOptions
Artifact
ArtifactSourceReference
AuthorizationHeader
Condition
ConditionType	Získá nebo nastaví typ podmínky.
ConfigurationVariableValue
DataSourceBindingBase	Představuje vazbu zdroje dat pro požadavek koncového bodu služby.
Demand
DeployPhase
DeployPhaseTypes
EnvironmentExecutionPolicy	Definuje zásady pro řazení do front prostředí ve frontě na Release Management straně. Do Environment Runneru odešleme [vytvoření předběžného nasazení a další kroky] pouze v případech, kdy jsou uvedené zásady splněné.
EnvironmentOptions
EnvironmentRetentionPolicy
EnvironmentTrigger
EnvironmentTriggerType
IdentityRef
ProcessParameters
ProjectReference
PropertiesCollection	Třída představuje tašku vlastností jako kolekci párů klíč-hodnota. Jsou přijímány hodnoty všech primitivních typů (libovolný typ s TypeCode != TypeCode.Objectvýjimkou DBNull ). Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají svůj typ, ostatní primitivy se přelaďují jako String. Byte[] byl očekáván jako řetězec s kódováním base64.
ReferenceLinks	Třída představující kolekci odkazů REST.
ReleaseDefinition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionDeployStep
ReleaseDefinitionEnvironment
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDefinitionSource	Získá nebo nastaví zdroj definice verze.
ReleaseReason	Získá důvod pro vydání.
ReleaseReference
ReleaseSchedule
ReleaseShallowReference
ReleaseTriggerBase
ReleaseTriggerType
ScheduleDays	Dny v týdnu do vydání
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
WorkflowTask

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

Artifact

Name	Typ	Description
alias	string	Získá nebo nastaví alias.
definitionReference	<string,  ArtifactSourceReference>	Získá nebo nastaví odkaz definice. např. {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5aa90a6c","name":"myProject"},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}}
isPrimary	boolean	Získá nebo nastaví, protože artefakt je primární nebo ne.
isRetained	boolean
type	string	Získá nebo nastaví typ. Může mít hodnotu Build, Jenkins, GitHub, Nuget, Team Build (externí), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.

ArtifactSourceReference

Name	Typ	Description
id	string
name	string

AuthorizationHeader

Name	Typ	Description
name	string
value	string

Condition

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

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

DeployPhase

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

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

EnvironmentExecutionPolicy

Definuje zásady pro řazení do front prostředí ve frontě na Release Management straně. Do Environment Runneru odešleme [vytvoření předběžného nasazení a další kroky] pouze v případech, kdy jsou uvedené zásady splněné.

Name	Typ	Description
concurrencyCount	integer	Tato zásada rozhoduje o tom, kolik prostředí bude s nástrojem Environment Runner.
queueDepthCount	integer	Hloubka fronty v tabulce EnvironmentQueue– tato tabulka uchovává položky prostředí, dokud nebude mít nástroj Environment Runner (podle zásad) možnost použít pro spuštění jiné prostředí.

EnvironmentOptions

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

EnvironmentRetentionPolicy

Name	Typ	Description
daysToKeep	integer
releasesToKeep	integer
retainBuild	boolean

EnvironmentTrigger

Name	Typ	Description
definitionEnvironmentId	integer
releaseDefinitionId	integer
triggerContent	string
triggerType	EnvironmentTriggerType

EnvironmentTriggerType

Name	Typ	Description
deploymentGroupRedeploy	string
rollbackRedeploy	string
undefined	string

IdentityRef

Name	Typ	Description
_links	ReferenceLinks	Toto pole obsahuje nula nebo více zajímavých odkazů o předmětu 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 napříč účty i organizacemi.
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 je úplná trasa ke zdrojovému prostředku tohoto předmětu grafu.

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.

PropertiesCollection

Třída představuje tašku vlastností jako kolekci párů klíč-hodnota. Jsou přijímány hodnoty všech primitivních typů (libovolný typ s TypeCode != TypeCode.Objectvýjimkou DBNull ). Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají svůj typ, ostatní primitivy se přelaďují jako String. Byte[] byl očekáván jako řetězec s kódováním base64.

Name	Typ	Description
count	integer	Počet vlastností v kolekci.
item	object
keys	string[]	Sada klíčů v kolekci.
values	string[]	Sada hodnot v kolekci.

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

ReleaseDefinition

Name	Typ	Description
_links	ReferenceLinks	Získá odkazy na související prostředky, rozhraní API a zobrazení pro definici verze.
artifacts	Artifact[]	Získá nebo nastaví seznam artefaktů.
comment	string	Získá nebo nastaví komentář.
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.
environments	ReleaseDefinitionEnvironment[]	Získá nebo nastaví seznam prostředí.
id	integer	Získá jedinečný identifikátor definice verze.
isDeleted	boolean	Jestli je odstraněna definice vydané verze.
lastRelease	ReleaseReference	Získá odkaz na poslední verzi.
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 definice vydané verze.
path	string	Získá nebo nastaví cestu k definici vydané verze.
projectReference	ProjectReference	Získá nebo nastaví odkaz na projekt.
properties	PropertiesCollection	Získá nebo nastaví vlastnosti.
releaseNameFormat	string	Získá nebo nastaví formát názvu verze.
revision	integer	Získá číslo revize.
source	ReleaseDefinitionSource	Získá nebo nastaví zdroj definice verze.
tags	string[]	Získá nebo nastaví seznam značek.
triggers	ReleaseTriggerBase[]	Získá nebo nastaví seznam triggerů.
url	string	Získá adresu URL rozhraní REST API pro přístup k definici verze.
variableGroups	integer[]	Získá nebo nastaví seznam skupin proměnných.
variables	<string,  ConfigurationVariableValue>	Získá nebo nastaví slovník proměnných.

ReleaseDefinitionApprovals

Name	Typ	Description
approvalOptions	ApprovalOptions
approvals	ReleaseDefinitionApprovalStep[]

ReleaseDefinitionApprovalStep

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

ReleaseDefinitionDeployStep

Name	Typ	Description
id	integer
tasks	WorkflowTask[]	Seznam kroků pro tuto definici

ReleaseDefinitionEnvironment

Name	Typ	Description
badgeUrl	string
conditions	Condition[]
currentRelease	ReleaseShallowReference
demands	Demand[]
deployPhases	DeployPhase[]
deployStep	ReleaseDefinitionDeployStep
environmentOptions	EnvironmentOptions
environmentTriggers	EnvironmentTrigger[]
executionPolicy	EnvironmentExecutionPolicy	Definuje zásady pro řazení do front prostředí ve frontě na Release Management straně. Do Environment Runneru odešleme [vytvoření předběžného nasazení a další kroky] pouze v případech, kdy jsou uvedené zásady splněné.
id	integer
name	string
owner	IdentityRef
postDeployApprovals	ReleaseDefinitionApprovals
postDeploymentGates	ReleaseDefinitionGatesStep
preDeployApprovals	ReleaseDefinitionApprovals
preDeploymentGates	ReleaseDefinitionGatesStep
processParameters	ProcessParameters
properties	PropertiesCollection	Třída představuje tašku vlastností jako kolekci párů klíč-hodnota. Jsou přijímány hodnoty všech primitivních typů (libovolný typ s TypeCode != TypeCode.Objectvýjimkou DBNull ). Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají svůj typ, ostatní primitivy se přelaďují jako String. Byte[] byl očekáván jako řetězec s kódováním base64.
queueId	integer
rank	integer
retentionPolicy	EnvironmentRetentionPolicy
schedules	ReleaseSchedule[]
variableGroups	integer[]
variables	<string,  ConfigurationVariableValue>

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 vydané verze.
path	string	Získá nebo nastaví cestu k definici vydané 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.

ReleaseDefinitionSource

Získá nebo nastaví zdroj definice verze.

Name	Typ	Description
ibiza	string
portalExtensionApi	string
restApi	string
undefined	string
userInterface	string

ReleaseReason

Získá důvod pro vydání.

Name	Typ	Description
continuousIntegration	string
manual	string
none	string
pullRequest	string
schedule	string

ReleaseReference

Name	Typ	Description
_links	ReferenceLinks	Získá odkazy pro přístup k verzi.
artifacts	Artifact[]	Získá seznam artefaktů.
createdBy	IdentityRef	Získá identitu, která vytvořila.
createdOn	string	Získá datum, kdy byl vytvořen.
description	string	Získá popis.
id	integer	Získá jedinečný identifikátor tohoto pole.
modifiedBy	IdentityRef	Získá identitu, která změnila.
name	string	Získá název verze.
reason	ReleaseReason	Získá důvod pro vydání.
releaseDefinition	ReleaseDefinitionShallowReference	Získá plytký odkaz na definici verze.

ReleaseSchedule

Name	Typ	Description
daysToRelease	ScheduleDays	Dny v týdnu do 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 od 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 vydání.
id	integer	Získá jedinečný identifikátor vydané verze.
name	string	Získá nebo nastaví název vydané verze.
url	string	Získá adresu URL rozhraní REST API pro přístup k vydané verzi.

ReleaseTriggerBase

Name	Typ	Description
triggerType	ReleaseTriggerType

ReleaseTriggerType

Name	Typ	Description
artifactSource	string
containerImage	string
package	string
pullRequest	string
schedule	string
sourceRepo	string
undefined	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

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