Definitions - List

Ссылка

Service:: Release

API Version:: 7.1-preview.4

Получение списка определений выпусков.

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

With optional parameters:

GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions?searchText={searchText}&$expand={$expand}&artifactType={artifactType}&artifactSourceId={artifactSourceId}&$top={$top}&continuationToken={continuationToken}&queryOrder={queryOrder}&path={path}&isExactNameMatch={isExactNameMatch}&tagFilter={tagFilter}&propertyFilters={propertyFilters}&definitionIdFilter={definitionIdFilter}&isDeleted={isDeleted}&searchTextContainsFolderName={searchTextContainsFolderName}&api-version=7.1-preview.4

Параметры URI

Имя	В	Обязательно	Тип	Описание
organization	path	True	string	Название организации Azure DevOps.
project	path	True	string	Идентификатор проекта или имя проекта
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.4.
$expand	query		ReleaseDefinitionExpands	Свойства, которые следует развернуть в списке определений выпуска.
$top	query		integer int32	Количество определений выпуска, которые требуется получить.
artifactSourceId	query		string	Будут возвращены определения выпуска с заданным artifactSourceId. Например, для сборки это будет {projectGuid}:{BuildDefinitionId}, для Jenkins — {JenkinsConnectionId}:{JenkinsDefinitionId}, для TfsOnPrem — {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. Для сторонних артефактов, например TeamCity, BitBucket, можно ссылаться на uniqueSourceIdentifier в vss-extension.json по адресу https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.
artifactType	query		string	Будут возвращены определения выпуска с заданным artifactType. Возможные значения: Build, Jenkins, GitHub, NuGet, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.
continuationToken	query		string	Возвращает определения выпуска после предоставленного маркера продолжения.
definitionIdFilter	query		string array (string)	Список определений выпусков, разделенных запятыми для получения.
isDeleted	query		boolean	"true", чтобы получить определения выпуска, которые были удалены. Значение по умолчанию — false.
isExactNameMatch	query		boolean	"true", чтобы получить определения выпуска с точным совпадением, указанным в searchText. Значение по умолчанию — false.
path	query		string	Возвращает определения выпуска по указанному пути.
propertyFilters	query		string array (string)	Список извлекаемых расширенных свойств, разделенных запятыми. Если этот параметр задан, возвращаемые определения выпуска будут содержать значения для указанных идентификаторов свойств (если они существуют). Если значение не задано, свойства не будут включены. Обратите внимание, что при этом определение выпуска не отфильтровывается из результатов независимо от того, задано ли свойство.
queryOrder	query		ReleaseDefinitionQueryOrder	Возвращает результаты в определенном порядке. Значение по умолчанию — IdAscending.
searchText	query		string	Получение определений выпуска с именами, содержащими searchText.
searchTextContainsFolderName	query		boolean	"true", чтобы получить определения выпуска в папке с именем, указанным в searchText. Значение по умолчанию — false.
tagFilter	query		string array (string)	Разделенный запятыми список тегов. Будут возвращены только определения выпуска с этими тегами.

Ответы

Имя	Тип	Описание
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	Предоставляет возможность чтения артефактов выпуска, включая папки, выпуски, определения выпусков и среду выпуска.

Примеры

With artifacts details expanded

With environments details expanded

Sample Request

HTTP

GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/definitions?api-version=7.1-preview.4

Sample Response

Status code:: 200

{
  "count": 1,
  "value": [
    {
      "source": "userInterface",
      "id": 1,
      "revision": 3,
      "name": "MyShuttle.CD",
      "description": null,
      "createdBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "createdOn": "2017-05-31T16:39:04.883Z",
      "modifiedBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "modifiedOn": "2017-05-31T16:39:58.06Z",
      "lastRelease": {
        "id": 14,
        "name": "Release-14",
        "artifacts": [],
        "webAccessUri": null,
        "_links": {},
        "description": "",
        "releaseDefinition": {
          "id": 1,
          "_links": {}
        },
        "createdOn": "2017-06-01T09:42:15.273Z",
        "createdBy": {
          "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
          "displayName": "Chuck Reinhart",
          "uniqueName": "fabfiber@outlook.com",
          "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
          "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
        },
        "modifiedBy": null,
        "reason": "none"
      },
      "path": "\\",
      "variableGroups": null,
      "releaseNameFormat": "Release-$(rev:r)",
      "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
      "_links": {
        "self": {
          "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
        },
        "web": {
          "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
        }
      },
      "properties": {}
    }
  ]
}

With artifacts details expanded

Sample Request

HTTP

GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/definitions?$expand=Artifacts&api-version=7.1-preview.4

Sample Response

Status code:: 200

{
  "count": 1,
  "value": [
    {
      "source": "userInterface",
      "id": 1,
      "revision": 3,
      "name": "MyShuttle.CD",
      "description": null,
      "createdBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "createdOn": "2017-05-31T16:39:04.883Z",
      "modifiedBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "modifiedOn": "2017-05-31T16:39:58.06Z",
      "lastRelease": {
        "id": 14,
        "name": "Release-14",
        "artifacts": [],
        "webAccessUri": null,
        "_links": {},
        "description": "",
        "releaseDefinition": {
          "id": 1,
          "_links": {}
        },
        "createdOn": "2017-06-01T09:42:15.273Z",
        "createdBy": {
          "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
          "displayName": "Chuck Reinhart",
          "uniqueName": "fabfiber@outlook.com",
          "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
          "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
        },
        "modifiedBy": null,
        "reason": "none"
      },
      "path": "\\",
      "variableGroups": null,
      "artifacts": [],
      "releaseNameFormat": "Release-$(rev:r)",
      "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
      "_links": {
        "self": {
          "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
        },
        "web": {
          "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
        }
      },
      "properties": {}
    }
  ]
}

With environments details expanded

Sample Request

HTTP

GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/definitions?$expand=Environments&api-version=7.1-preview.4

Sample Response

Status code:: 200

{
  "count": 1,
  "value": [
    {
      "source": "userInterface",
      "id": 1,
      "revision": 3,
      "name": "MyShuttle.CD",
      "description": null,
      "createdBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "createdOn": "2017-05-31T16:39:04.883Z",
      "modifiedBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "modifiedOn": "2017-05-31T16:39:58.06Z",
      "lastRelease": {
        "id": 14,
        "name": "Release-14",
        "artifacts": [],
        "webAccessUri": null,
        "_links": {},
        "description": "",
        "releaseDefinition": {
          "id": 1,
          "_links": {}
        },
        "createdOn": "2017-06-01T09:42:15.273Z",
        "createdBy": {
          "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
          "displayName": "Chuck Reinhart",
          "uniqueName": "fabfiber@outlook.com",
          "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
          "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
        },
        "modifiedBy": null,
        "reason": "none"
      },
      "path": "\\",
      "variableGroups": null,
      "environments": [
        {
          "id": 1,
          "name": "Dev",
          "rank": 1,
          "schedules": [],
          "retentionPolicy": {
            "daysToKeep": 30,
            "releasesToKeep": 3,
            "retainBuild": true
          }
        },
        {
          "id": 2,
          "name": "QA",
          "rank": 2,
          "schedules": [],
          "retentionPolicy": {
            "daysToKeep": 30,
            "releasesToKeep": 3,
            "retainBuild": true
          }
        },
        {
          "id": 3,
          "name": "PPE",
          "rank": 3,
          "schedules": [],
          "retentionPolicy": {
            "daysToKeep": 30,
            "releasesToKeep": 3,
            "retainBuild": true
          }
        },
        {
          "id": 4,
          "name": "PROD",
          "rank": 4,
          "schedules": [],
          "retentionPolicy": {
            "daysToKeep": 30,
            "releasesToKeep": 3,
            "retainBuild": true
          }
        }
      ],
      "releaseNameFormat": "Release-$(rev:r)",
      "retentionPolicy": {
        "daysToKeep": 30
      },
      "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
      "_links": {
        "self": {
          "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
        },
        "web": {
          "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
        }
      },
      "properties": {}
    }
  ]
}

Определения

Имя	Описание
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
ReleaseDefinitionExpands	Свойства, которые следует развернуть в списке определений выпусков.
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionQueryOrder	Возвращает результаты в определенном порядке. Значение по умолчанию — "IdAscending".
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	Количество утверждений, необходимых для перехода к выпуску. "0" означает все необходимые утверждения.
timeoutInMinutes	integer	Время ожидания утверждения. Время ожидания утверждения по умолчанию составляет 30 дней. Максимально допустимое время ожидания — 365 дней. "0" означает время ожидания по умолчанию, т. е. 30 дней.

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	Возвращает или задает параметры для источника данных.
requestContent	string	Возвращает или задает текст HTTP-запроса.
requestVerb	string	Возвращает или задает команду HTTP-запроса.
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	Тип phase, содержащий задачи, выполняемые в агенте.
deploymentGates	string	Тип фазы, содержащий задачи, которые выступают в качестве шлюзов для продолжения развертывания.
machineGroupBasedDeployment	string	Тип фазы, содержащий задачи, выполняемые на компьютерах группы развертывания.
runOnServer	string	Тип phase, содержащий задачи, выполняемые сервером.
undefined	string	Тип фазы не определен. Не использует этот параметр.

EnvironmentExecutionPolicy

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

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

EnvironmentOptions

Имя	Тип	Описание
autoLinkWorkItems	boolean	Возвращает и задает в качестве рабочих элементов автоматической компоновки или нет.
badgeEnabled	boolean	Возвращает и задает как индикатор событий включен или не включен.
publishDeploymentStatus	boolean	Возвращает и задает состояние развертывания публикации или нет.
pullRequestDeploymentEnabled	boolean	Возвращает и задает как включенную или не включенную функцию развертывания запроса на вытягивание.

EnvironmentRetentionPolicy

Имя	Тип	Описание
daysToKeep	integer	Возвращает и задает количество дней для сохранения среды.
releasesToKeep	integer	Возвращает и задает количество сохраняемых выпусков.
retainBuild	boolean	Возвращает и задает в качестве сборки, для хранения или нет.

EnvironmentTrigger

Имя	Тип	Описание
definitionEnvironmentId	integer	Идентификатор среды определения, к которой применяется этот триггер.
releaseDefinitionId	integer	Идентификатор ReleaseDefinition, к которому применяется этот триггер.
triggerContent	string	Возвращает или задает содержимое триггера.
triggerType	EnvironmentTriggerType	Возвращает или задает тип триггера.

EnvironmentTriggerType

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

Имя	Тип	Описание
deploymentGroupRedeploy	string	Тип триггера среды — повторное развертывание группы развертывания.
rollbackRedeploy	string	Тип триггера среды — Rollback.
undefined	string	Тип триггера среды не определен.

IdentityRef

Имя	Тип	Описание
_links	ReferenceLinks	Это поле содержит ноль или более интересных ссылок на тему графа. Эти ссылки можно вызвать для получения дополнительных связей или более подробных сведений об этой теме графа.
descriptor	string	Дескриптор является основным способом ссылки на субъект графа во время работы системы. Это поле однозначно идентифицирует одну и ту же тему графа как в учетных записях, так и в организациях.
directoryAlias	string	Нерекомендуемое — можно получить запрос пользователя Graph, на который ссылается запись self словаря IdentityRef _links.
displayName	string	Это неуникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в поставщике источника.
id	string
imageUrl	string	Не рекомендуется — доступно в записи "аватар" словаря IdentityRef "_links"
inactive	boolean	Нерекомендуемое — можно получить запрос к состоянию членства Graph, на которое ссылается запись "membershipState" словаря GraphUser "_links".
isAadIdentity	boolean	Нерекомендуемый — может быть выведен из типа субъекта дескриптора (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Нерекомендуемый — может быть выведен из типа субъекта дескриптора (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Не рекомендуется — не используется в большинстве уже существовающих реализаций ToIdentityRef
uniqueName	string	Не рекомендуется использовать вместо него домен+principalName.
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[]	Набор значений в коллекции.

ReferenceLinks

Класс, представляющий коллекцию ссылок 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	Возвращает или задает BadgeUrl. BadgeUrl будет использоваться, когда эмблема будет включена в среде определения выпуска.
conditions	Condition[]	Возвращает или задает условия среды.
currentRelease	ReleaseShallowReference	Возвращает или задает текущую ссылку на выпуск.
demands	Demand[]	Возвращает или задает требования.
deployPhases	DeployPhase[]	Возвращает или задает этапы развертывания среды.
deployStep	ReleaseDefinitionDeployStep	Возвращает или задает шаг развертывания.
environmentOptions	EnvironmentOptions	Возвращает или задает параметры среды.
environmentTriggers	EnvironmentTrigger[]	Возвращает или задает триггеры в среде.
executionPolicy	EnvironmentExecutionPolicy	Возвращает или задает политику выполнения среды.
id	integer	Возвращает и задает идентификатор ReleaseDefinitionEnvironment.
name	string	Возвращает и задает имя ReleaseDefinitionEnvironment.
owner	IdentityRef	Возвращает и задает владельца releaseDefinitionEnvironment.
postDeployApprovals	ReleaseDefinitionApprovals	Возвращает или задает утверждения после развертывания.
postDeploymentGates	ReleaseDefinitionGatesStep	Возвращает или задает шлюзы после развертывания.
preDeployApprovals	ReleaseDefinitionApprovals	Возвращает или задает утверждения перед развертыванием.
preDeploymentGates	ReleaseDefinitionGatesStep	Возвращает или задает шлюзы перед развертыванием.
processParameters	ProcessParameters	Возвращает или задает параметры процесса среды.
properties	PropertiesCollection	Возвращает или задает свойства среды.
queueId	integer	Возвращает или задает идентификатор очереди.
rank	integer	Возвращает и задает ранг ReleaseDefinitionEnvironment.
retentionPolicy	EnvironmentRetentionPolicy	Возвращает или задает политику хранения среды.
schedules	ReleaseSchedule[]	Возвращает или задает расписания.
variableGroups	integer[]	Возвращает или задает группы переменных.
variables	<string, ConfigurationVariableValue>	Возвращает и задает переменные.

ReleaseDefinitionExpands

Свойства, которые следует развернуть в списке определений выпусков.

Имя	Тип	Описание
artifacts	string	Включите артефакты в возвращаемый объект.
environments	string	Включите среды в возвращаемый объект.
lastRelease	string	Включите последний выпуск в возвращаемый объект.
none	string	Возвращает свойства верхнего уровня объекта .
tags	string	Включите теги в возвращаемый объект.
triggers	string	Включите триггеры в возвращаемый объект.
variables	string	Включите переменные в возвращаемый объект.

ReleaseDefinitionGate

Имя	Тип	Описание
tasks	WorkflowTask[]	Возвращает или задает рабочий процесс шлюзов.

ReleaseDefinitionGatesOptions

Имя	Тип	Описание
isEnabled	boolean	Возвращает или задает в качестве вентили, включенные или нет.
minimumSuccessDuration	integer	Возвращает или задает минимальную продолжительность для устойчивых результатов после успешной оценки шлюзов.
samplingInterval	integer	Возвращает или задает время между повторной оценкой вентилей.
stabilizationTime	integer	Возвращает или задает задержку перед вычислением.
timeout	integer	Возвращает или задает время ожидания, после которого шлюзы завершаются ошибкой.

ReleaseDefinitionGatesStep

Имя	Тип	Описание
gates	ReleaseDefinitionGate[]	Возвращает или задает шлюзы.
gatesOptions	ReleaseDefinitionGatesOptions	Возвращает или задает параметры шлюза.
id	integer	Идентификатор шага ReleaseDefinitionGateStep.

ReleaseDefinitionQueryOrder

Возвращает результаты в определенном порядке. Значение по умолчанию — "IdAscending".

Имя	Тип	Описание
idAscending	string	Возвращает результаты на основе возрастания идентификатора определения выпуска.
idDescending	string	Возвращает результаты на основе порядка убывания идентификатора выпуска.
nameAscending	string	Возвращает результаты на основе возрастания имени определения выпуска.
nameDescending	string	Возвращает результаты на основе порядка убывания имени определения выпуска.

ReleaseDefinitionShallowReference

Имя	Тип	Описание
_links	ReferenceLinks	Возвращает ссылки на связанные ресурсы, API и представления для определения выпуска.
id	integer	Возвращает уникальный идентификатор определения выпуска.
name	string	Возвращает или задает имя определения выпуска.
path	string	Возвращает или задает путь к определению выпуска.
projectReference	ProjectReference	Возвращает или задает ссылку на проект.
url	string	Возвращает URL-адрес REST API для доступа к определению выпуска.

ReleaseDefinitionSource

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

Имя	Тип	Описание
ibiza	string	Указывает ReleaseDefinition, созданное на основе Ibiza.
portalExtensionApi	string	Указывает ReleaseDefinition, созданный из API PortalExtension.
restApi	string	Указывает ReleaseDefinition, созданный с помощью REST API.
undefined	string	Указывает, что источник ReleaseDefinition не определен.
userInterface	string	Указывает ReleaseDefinition, созданный с помощью пользовательского интерфейса.

ReleaseReason

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

Имя	Тип	Описание
continuousIntegration	string	Указывает выпуск, активироваемый непрерывной интеграцией.
manual	string	Указывает, что выпуск активируется вручную.
none	string	Указывает, что причина, активироваемая выпуском, не задана.
pullRequest	string	Указывает выпуск, активированный PullRequest.
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.
scheduleOnlyWithChanges	boolean	Флаг, чтобы определить, следует ли выпускать это расписание, только если связанный артефакт был изменен или определение выпуска изменено.
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	Возвращает или задает тип определения задачи. Пример: "Агент", DeploymentGroup", "Server" или "ServerGate".
enabled	boolean	Возвращает или задает как включенную или не включенную задачу.
environment	object	Возвращает или задает переменные среды задачи.
inputs	object	Возвращает или задает входные данные задачи.
name	string	Возвращает или задает имя задачи.
overrideInputs	object	Возвращает или задает переопределение входных данных задачи.
refName	string	Возвращает или задает имя ссылки задачи.
retryCountOnTaskFailure	integer	Возвращает или задает retryCount задачи.
taskId	string	Возвращает или задает идентификатор задачи.
timeoutInMinutes	integer	Возвращает или задает время ожидания задачи.
version	string	Возвращает или задает версию задачи.

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

Definitions - List

Параметры URI

Ответы

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

oauth2

Scopes

Примеры

Sample Request

Sample Response

With artifacts details expanded

Sample Request

Sample Response

With environments details expanded

Sample Request

Sample Response

Определения

ApprovalExecutionOrder

ApprovalOptions

Artifact

ArtifactSourceReference

AuthorizationHeader

Condition

ConditionType

ConfigurationVariableValue

DataSourceBindingBase

Demand

DeployPhase

DeployPhaseTypes

EnvironmentExecutionPolicy

EnvironmentOptions

EnvironmentRetentionPolicy

EnvironmentTrigger

EnvironmentTriggerType

IdentityRef

ProcessParameters

ProjectReference

PropertiesCollection

ReferenceLinks

ReleaseDefinition

ReleaseDefinitionApprovals

ReleaseDefinitionApprovalStep

ReleaseDefinitionDeployStep

ReleaseDefinitionEnvironment

ReleaseDefinitionExpands

ReleaseDefinitionGate

ReleaseDefinitionGatesOptions

ReleaseDefinitionGatesStep

ReleaseDefinitionQueryOrder

ReleaseDefinitionShallowReference

ReleaseDefinitionSource

ReleaseReason

ReleaseReference

ReleaseSchedule

ReleaseShallowReference

ReleaseTriggerBase

ReleaseTriggerType

ScheduleDays

TaskInputDefinitionBase

TaskInputValidation

TaskSourceDefinitionBase

WorkflowTask

Обратная связь

Дополнительные ресурсы