Поделиться через

Definitions - Create

  • Ссылка
Service:
Release
API Version:
5.0

Создание определения выпуска

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

Параметры URI

Имя В Обязательно Тип Описание
organization
 path True

string

Название организации Azure DevOps.
project
 path True

string

Идентификатор или имя проекта
api-version
 query True

string

Используемая версия API. Для использования этой версии API необходимо задать значение "5.0".

Текст запроса

Имя Тип Описание
_links

ReferenceLinks

Возвращает ссылки на связанные ресурсы, API и представления для определения выпуска.
artifacts

Artifact[]

Возвращает или задает список артефактов.
comment

string

Возвращает или задает комментарий.
createdBy

IdentityRef

Возвращает или задает созданное удостоверение.
createdOn

string

Возвращает дату создания.
description

string

Возвращает или задает описание.
environments

ReleaseDefinitionEnvironment[]

Возвращает или задает список сред.
id

integer

Возвращает уникальный идентификатор определения выпуска.
isDeleted

boolean

Удаляется ли определение выпуска.
lastRelease

ReleaseReference

Возвращает ссылку на последний выпуск.
modifiedBy

IdentityRef

Возвращает или задает измененное удостоверение.
modifiedOn

string

Возвращает дату изменения.
name

string

Возвращает или задает имя определения выпуска.
path

string

Возвращает или задает путь к определению выпуска.
projectReference

ProjectReference

Возвращает или задает ссылку на проект.
properties

PropertiesCollection

Возвращает или задает свойства.
releaseNameFormat

string

Возвращает или задает формат имени выпуска.
revision

integer

Возвращает номер редакции.
source

ReleaseDefinitionSource

Возвращает или задает источник определения выпуска.
tags

string[]

Возвращает или задает список тегов.
triggers

ReleaseTriggerBase[]

Возвращает или задает список триггеров.
url

string

Возвращает URL-адрес REST API для доступа к определению выпуска.
variableGroups

integer[]

Возвращает или задает список групп переменных.
variables

<string,  ConfigurationVariableValue>

Возвращает или задает словарь переменных.

Ответы

Имя Тип Описание
200 OK

ReleaseDefinition

успешная операция

Безопасность

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

Имя Описание
vso.release_execute Предоставляет возможность считывания и обновления артефактов выпуска, включая выпуски, определения выпусков и включение выпуска, а также возможность постановки нового выпуска в очередь.

Определения

Имя Описание
ApprovalExecutionOrder
ApprovalOptions
Artifact
ArtifactSourceReference
AuthorizationHeader
Condition
ConditionType

Возвращает или задает тип условия.
ConfigurationVariableValue
DataSourceBindingBase

Представляет привязку источника данных для запроса конечной точки службы.
Demand
DeployPhase
DeployPhaseTypes
EnvironmentExecutionPolicy

Определяет политику для очередей среды в Release Management боковой очереди. Мы отправим в средство выполнения среды [создание предварительного развертывания и другие шаги], только если указанные политики выполнены.
EnvironmentOptions
EnvironmentRetentionPolicy
EnvironmentTrigger
EnvironmentTriggerType
IdentityRef
ProcessParameters
ProjectReference
PropertiesCollection

Класс представляет контейнер свойств в виде коллекции пар "ключ-значение". Принимаются значения всех примитивных типов (любого типа с TypeCode != TypeCode.Object), кроме DBNull . Значения типа Byte[], Int32, Double, DateType и String сохраняют свой тип, другие примитивы перенастраиваются как String. Byte[] — строка в кодировке Base64.
ReferenceLinks

Класс, представляющий коллекцию ссылок REST.
ReleaseDefinition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionDeployStep
ReleaseDefinitionEnvironment
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDefinitionSource

Возвращает или задает источник определения выпуска.
ReleaseReason

Возвращает причину выпуска.
ReleaseReference
ReleaseSchedule
ReleaseShallowReference
ReleaseTriggerBase
ReleaseTriggerType
ScheduleDays

Дни недели для выпуска
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
WorkflowTask

ApprovalExecutionOrder

Имя Тип Описание
afterGatesAlways

string

afterSuccessfulGates

string

beforeGates

string

ApprovalOptions

Имя Тип Описание
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped

boolean

enforceIdentityRevalidation

boolean

executionOrder

ApprovalExecutionOrder

releaseCreatorCanBeApprover

boolean

requiredApproverCount

integer

timeoutInMinutes

integer

Artifact

Имя Тип Описание
alias

string

Возвращает или задает псевдоним.
definitionReference

<string,  ArtifactSourceReference>

Возвращает или задает ссылку на определение. Например, {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5aa90a6c","name":"myProject"},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}}
isPrimary

boolean

Возвращает или задает как артефакт является основным или нет.
isRetained

boolean

type

string

Возвращает или задает тип. Он может иметь значение "Build", "Jenkins", "GitHub", "Nuget", "Team Build (external)", "ExternalTFSBuild", "Git", "TFVC", "ExternalTfsXamlBuild".

ArtifactSourceReference

Имя Тип Описание
id

string

name

string

AuthorizationHeader

Имя Тип Описание
name

string

value

string

Condition

Имя Тип Описание
conditionType

ConditionType

Возвращает или задает тип условия.
name

string

Возвращает или задает имя условия. Например, ReleaseStarted.
value

string

Возвращает или задает значение условия.

ConditionType

Возвращает или задает тип условия.

Имя Тип Описание
artifact

string

Тип условия — artifact.
environmentState

string

Тип условия — состояние среды.
event

string

Тип условия — event.
undefined

string

Тип условия не определен.

ConfigurationVariableValue

Имя Тип Описание
allowOverride

boolean

Возвращает или задает значение , если переменная может быть переопределена во время развертывания.
isSecret

boolean

Возвращает или задает значение , так как переменная является секретной или нет.
value

string

Возвращает или задает значение переменной конфигурации.

DataSourceBindingBase

Представляет привязку источника данных для запроса конечной точки службы.

Имя Тип Описание
callbackContextTemplate

string

Формат разбиения на страницы, поддерживаемый этим источником данных (ContinuationToken/SkipTop).
callbackRequiredTemplate

string

Требуются последующие вызовы?
dataSourceName

string

Возвращает или задает имя источника данных.
endpointId

string

Возвращает или задает идентификатор конечной точки.
endpointUrl

string

Возвращает или задает URL-адрес конечной точки службы.
headers

AuthorizationHeader[]

Возвращает или задает заголовки авторизации.
initialContextTemplate

string

Определяет начальное значение параметров запроса.
parameters

object

Возвращает или задает параметры для источника данных.
resultSelector

string

Возвращает или задает селектор результатов.
resultTemplate

string

Возвращает или задает шаблон результата.
target

string

Возвращает или задает целевой объект источника данных.

Demand

Имя Тип Описание
name

string

value

string

DeployPhase

Имя Тип Описание
name

string

phaseType

DeployPhaseTypes

rank

integer

refName

string

workflowTasks

WorkflowTask[]

DeployPhaseTypes

Имя Тип Описание
agentBasedDeployment

string

deploymentGates

string

Тип этапа, содержащий задачи, которые действуют как шлюзы для развертывания, чтобы идти вперед.
machineGroupBasedDeployment

string

runOnServer

string

undefined

string

EnvironmentExecutionPolicy

Определяет политику для очередей среды в Release Management боковой очереди. Мы отправим в средство выполнения среды [создание предварительного развертывания и другие шаги], только если указанные политики выполнены.

Имя Тип Описание
concurrencyCount

integer

Эта политика определяет, сколько сред будет использоваться в средстве выполнения среды.
queueDepthCount

integer

Глубина очереди в таблице EnvironmentQueue. Эта таблица сохраняет записи среды, пока средство выполнения среды не будет свободно (в зависимости от политики) принимать для выполнения другую среду.

EnvironmentOptions

Имя Тип Описание
autoLinkWorkItems

boolean

badgeEnabled

boolean

emailNotificationType

string

emailRecipients

string

enableAccessToken

boolean

publishDeploymentStatus

boolean

pullRequestDeploymentEnabled

boolean

skipArtifactsDownload

boolean

timeoutInMinutes

integer

EnvironmentRetentionPolicy

Имя Тип Описание
daysToKeep

integer

releasesToKeep

integer

retainBuild

boolean

EnvironmentTrigger

Имя Тип Описание
definitionEnvironmentId

integer

releaseDefinitionId

integer

triggerContent

string

triggerType

EnvironmentTriggerType

EnvironmentTriggerType

Имя Тип Описание
deploymentGroupRedeploy

string

rollbackRedeploy

string

undefined

string

IdentityRef

Имя Тип Описание
_links

ReferenceLinks

Это поле содержит ноль или более интересных ссылок на тему графа. Эти ссылки можно вызвать для получения дополнительных связей или более подробных сведений об этой теме графа.
descriptor

string

Дескриптор является основным способом ссылки на субъект графа во время работы системы. Это поле однозначно идентифицирует одну и ту же тему графа как в учетных записях, так и в организациях.
directoryAlias

string

displayName

string

Это неуникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в поставщике источника.
id

string

imageUrl

string

inactive

boolean

isAadIdentity

boolean

isContainer

boolean

isDeletedInOrigin

boolean

profileUrl

string

uniqueName

string

url

string

Этот URL-адрес является полным маршрутом к исходному ресурсу этого субъекта графа.

ProcessParameters

Имя Тип Описание
dataSourceBindings

DataSourceBindingBase[]

Представляет привязку источника данных для запроса конечной точки службы.
inputs

TaskInputDefinitionBase[]

sourceDefinitions

TaskSourceDefinitionBase[]

ProjectReference

Имя Тип Описание
id

string

Возвращает уникальный идентификатор этого поля.
name

string

Возвращает имя проекта.

PropertiesCollection

Класс представляет контейнер свойств в виде коллекции пар "ключ-значение". Принимаются значения всех примитивных типов (любого типа с TypeCode != TypeCode.Object), кроме DBNull . Значения типа Byte[], Int32, Double, DateType и String сохраняют свой тип, другие примитивы перенастраиваются как String. Byte[] — строка в кодировке Base64.

Имя Тип Описание
count

integer

Количество свойств в коллекции.
item

object

keys

string[]

Набор ключей в коллекции.
values

string[]

Набор значений в коллекции.

Класс, представляющий коллекцию ссылок REST.

Имя Тип Описание
links

object

Представление ссылок только для чтения. Так как ссылочные ссылки доступны только для чтения, мы хотим предоставить их только для чтения.

ReleaseDefinition

Имя Тип Описание
_links

ReferenceLinks

Возвращает ссылки на связанные ресурсы, API и представления для определения выпуска.
artifacts

Artifact[]

Возвращает или задает список артефактов.
comment

string

Возвращает или задает комментарий.
createdBy

IdentityRef

Возвращает или задает созданное удостоверение.
createdOn

string

Возвращает дату создания.
description

string

Возвращает или задает описание.
environments

ReleaseDefinitionEnvironment[]

Возвращает или задает список сред.
id

integer

Возвращает уникальный идентификатор определения выпуска.
isDeleted

boolean

Указывает, удаляется ли определение выпуска.
lastRelease

ReleaseReference

Возвращает ссылку на последний выпуск.
modifiedBy

IdentityRef

Возвращает или задает удостоверение, изменяющее.
modifiedOn

string

Возвращает дату изменения.
name

string

Возвращает или задает имя определения выпуска.
path

string

Возвращает или задает путь к определению выпуска.
projectReference

ProjectReference

Возвращает или задает ссылку на проект.
properties

PropertiesCollection

Возвращает или задает свойства.
releaseNameFormat

string

Возвращает или задает формат имени выпуска.
revision

integer

Возвращает номер редакции.
source

ReleaseDefinitionSource

Возвращает или задает источник определения выпуска.
tags

string[]

Возвращает или задает список тегов.
triggers

ReleaseTriggerBase[]

Возвращает или задает список триггеров.
url

string

Возвращает URL-адрес REST API для доступа к определению выпуска.
variableGroups

integer[]

Возвращает или задает список групп переменных.
variables

<string,  ConfigurationVariableValue>

Возвращает или задает словарь переменных.

ReleaseDefinitionApprovals

Имя Тип Описание
approvalOptions

ApprovalOptions

approvals

ReleaseDefinitionApprovalStep[]

ReleaseDefinitionApprovalStep

Имя Тип Описание
approver

IdentityRef

id

integer

isAutomated

boolean

isNotificationOn

boolean

rank

integer

ReleaseDefinitionDeployStep

Имя Тип Описание
id

integer

tasks

WorkflowTask[]

Список шагов для этого определения.

ReleaseDefinitionEnvironment

Имя Тип Описание
badgeUrl

string

conditions

Condition[]

currentRelease

ReleaseShallowReference

demands

Demand[]

deployPhases

DeployPhase[]

deployStep

ReleaseDefinitionDeployStep

environmentOptions

EnvironmentOptions

environmentTriggers

EnvironmentTrigger[]

executionPolicy

EnvironmentExecutionPolicy

Определяет политику для очередей среды в Release Management боковой очереди. Мы отправим в средство выполнения среды [создание предварительного развертывания и другие шаги], только если указанные политики выполнены.
id

integer

name

string

owner

IdentityRef

postDeployApprovals

ReleaseDefinitionApprovals

postDeploymentGates

ReleaseDefinitionGatesStep

preDeployApprovals

ReleaseDefinitionApprovals

preDeploymentGates

ReleaseDefinitionGatesStep

processParameters

ProcessParameters

properties

PropertiesCollection

Класс представляет контейнер свойств в виде коллекции пар "ключ-значение". Принимаются значения всех примитивных типов (любого типа с TypeCode != TypeCode.Object), кроме DBNull . Значения типа Byte[], Int32, Double, DateType и String сохраняют свой тип, другие примитивы перенастраиваются как String. Byte[] — строка в кодировке Base64.
queueId

integer

rank

integer

retentionPolicy

EnvironmentRetentionPolicy

schedules

ReleaseSchedule[]

variableGroups

integer[]

variables

<string,  ConfigurationVariableValue>

ReleaseDefinitionGate

Имя Тип Описание
tasks

WorkflowTask[]

ReleaseDefinitionGatesOptions

Имя Тип Описание
isEnabled

boolean

minimumSuccessDuration

integer

samplingInterval

integer

stabilizationTime

integer

timeout

integer

ReleaseDefinitionGatesStep

Имя Тип Описание
gates

ReleaseDefinitionGate[]

gatesOptions

ReleaseDefinitionGatesOptions

id

integer

ReleaseDefinitionShallowReference

Имя Тип Описание
_links

ReferenceLinks

Возвращает ссылки на связанные ресурсы, API и представления для определения выпуска.
id

integer

Возвращает уникальный идентификатор определения выпуска.
name

string

Возвращает или задает имя определения выпуска.
path

string

Возвращает или задает путь к определению выпуска.
projectReference

ProjectReference

Возвращает или задает ссылку на проект.
url

string

Возвращает URL-адрес REST API для доступа к определению выпуска.

ReleaseDefinitionSource

Возвращает или задает источник определения выпуска.

Имя Тип Описание
ibiza

string

portalExtensionApi

string

restApi

string

undefined

string

userInterface

string

ReleaseReason

Возвращает причину выпуска.

Имя Тип Описание
continuousIntegration

string

manual

string

none

string

pullRequest

string

schedule

string

ReleaseReference

Имя Тип Описание
_links

ReferenceLinks

Получает ссылки для доступа к выпуску.
artifacts

Artifact[]

Возвращает список артефактов.
createdBy

IdentityRef

Возвращает созданное удостоверение.
createdOn

string

Возвращает дату создания.
description

string

Возвращает описание.
id

integer

Возвращает уникальный идентификатор этого поля.
modifiedBy

IdentityRef

Возвращает удостоверение, измененное.
name

string

Возвращает имя выпуска.
reason

ReleaseReason

Возвращает причину выпуска.
releaseDefinition

ReleaseDefinitionShallowReference

Возвращает неглубокую ссылку на определение выпуска.

ReleaseSchedule

Имя Тип Описание
daysToRelease

ScheduleDays

Дни недели для выпуска
jobId

string

Идентификатор задания определения задания Team Foundation
startHours

integer

Время начала местного часового пояса
startMinutes

integer

Местный часовой пояс минуты для начала
timeZoneId

string

Идентификатор часового пояса расписания выпуска, например "UTC"

ReleaseShallowReference

Имя Тип Описание
_links

ReferenceLinks

Возвращает ссылки на связанные ресурсы, API и представления для выпуска.
id

integer

Возвращает уникальный идентификатор выпуска.
name

string

Возвращает или задает имя выпуска.
url

string

Возвращает URL-адрес REST API для доступа к выпуску.

ReleaseTriggerBase

Имя Тип Описание
triggerType

ReleaseTriggerType

ReleaseTriggerType

Имя Тип Описание
artifactSource

string

containerImage

string

package

string

pullRequest

string

schedule

string

sourceRepo

string

undefined

string

ScheduleDays

Дни недели для выпуска

Имя Тип Описание
all

string

friday

string

monday

string

none

string

saturday

string

sunday

string

thursday

string

tuesday

string

wednesday

string

TaskInputDefinitionBase

Имя Тип Описание
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

Имя Тип Описание
expression

string

Условное выражение
message

string

Сообщение, объясняющее, как пользователь может исправить ошибку при сбое проверки

TaskSourceDefinitionBase

Имя Тип Описание
authKey

string

endpoint

string

keySelector

string

selector

string

target

string

WorkflowTask

Имя Тип Описание
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