Deploymentgroups - Update

Ссылка

Служба:: Distributed Task

Версия API:: 7.1

Обновите группу развертывания.

PATCH https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?api-version=7.1

Параметры URI

Имя	В	Обязательно	Тип	Описание
deploymentGroupId	path	True	integer (int32)	Идентификатор группы развертывания.
organization	path	True	string	Имя организации Azure DevOps.
project	path	True	string	Идентификатор проекта или имя проекта
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение "7.1".

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

Имя	Тип	Описание
description	string	Описание группы развертывания.
name	string	Имя группы развертывания.

Ответы

Имя	Тип	Описание
200 OK	DeploymentGroup	успешная операция

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

oauth2

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
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

Области

Имя	Описание
vso.machinegroup_manage	Предоставляет возможность управления пулами групп развертывания и агентов

Примеры

Update a deployment group

Образец запроса

HTTP

PATCH https://dev.azure.com/fabrikam/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?api-version=7.1

{
  "name": "MyDeploymentGroup1-Update1",
  "description": "Description of this deployment group is updated"
}

Пример ответа

Код состояния:: 200

{
  "machineCount": 0,
  "description": "Description of this deployment group is updated",
  "id": 11,
  "project": {
    "id": "91879ed9-819b-46f3-9e0b-52ed4b20c04c",
    "name": "DeploymentGroupRESTSample"
  },
  "name": "MyDeploymentGroup1-Update1",
  "pool": {
    "id": 6,
    "isHosted": false,
    "poolType": "deployment",
    "size": 0
  }
}

Определения

Имя	Описание
Demand
DeploymentGroup	Группа развертывания.
DeploymentGroupUpdateParameter	Параметр обновления группы развертывания.
DeploymentMachine	Целевой объект развертывания.
IdentityRef
JObject	Представляет объект JSON.
JToken	Представляет абстрактный токен JSON.
PackageVersion
ProjectReference
PropertiesCollection	Класс представляет контейнер свойств в виде коллекции пар "ключ-значение". Принимаются значения всех примитивных типов (любого типа с `TypeCode != TypeCode.Object`), кроме `DBNull`. Значения типа Byte[], Int32, Double, DateType и String сохраняют их тип, другие примитивы повторно настраиваются в виде строки. Byte[] ожидается как строка в кодировке Base64.
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
TaskAgent	Агент задачи.
TaskAgentAuthorization	Предоставляет данные, необходимые для авторизации агента с помощью потоков проверки подлинности OAuth 2.0.
TaskAgentCloudRequest
TaskAgentJobRequest	Запрос задания для агента.
TaskAgentPoolOptions	Дополнительные параметры и сведения о пуле
TaskAgentPoolReference
TaskAgentPoolType	Возвращает или задает тип пула
TaskAgentPublicKey	Представляет часть открытого ключа асимметричного ключа RSA.
TaskAgentReference	Ссылка на агент.
TaskAgentStatus	Независимо от того, находится ли агент в сети.
TaskAgentUpdate	Сведения об обновлении агента.
TaskAgentUpdateReason
TaskAgentUpdateReasonType
TaskOrchestrationOwner
TaskResult	Результат этого запроса.

Demand

Object

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

DeploymentGroup

Object

Группа развертывания.

Имя	Тип	Описание
description	string	Описание группы развертывания.
id	integer (int32)	Идентификатор группы развертывания.
machineCount	integer (int32)	Количество целевых объектов развертывания в группе развертывания.
machineTags	string[]	Список уникальных тегов во всех целевых объектах развертывания в группе развертывания.
machines	DeploymentMachine[]	Список целевых объектов развертывания в группе развертывания.
name	string	Имя группы развертывания.
pool	TaskAgentPoolReference	Пул развертывания, в котором регистрируются агенты развертывания.
project	ProjectReference	Проект, к которому принадлежит группа развертывания.

DeploymentGroupUpdateParameter

Object

Параметр обновления группы развертывания.

Имя	Тип	Описание
description	string	Описание группы развертывания.
name	string	Имя группы развертывания.

DeploymentMachine

Object

Целевой объект развертывания.

Имя	Тип	Описание
agent	TaskAgent	Агент развертывания.
id	integer (int32)	Идентификатор целевого объекта развертывания.
properties	PropertiesCollection	Свойства целевого объекта развертывания.
tags	string[]	Теги целевого объекта развертывания.

IdentityRef

Object

Имя	Тип	Описание
_links	ReferenceLinks	Это поле содержит нулевые или более интересные ссылки на тему графа. Эти ссылки могут вызываться для получения дополнительных связей или более подробных сведений об этой теме графа.
descriptor	string	Дескриптор является основным способом ссылки на тему графа во время выполнения системы. Это поле однозначно определяет одну и ту же тему графа как в учетных записях, так и в организациях.
directoryAlias	string	Нерекомендуемое. Можно получить, запросив пользователя Graph, на который ссылается пользователь 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	Не рекомендуется — вместо этого используйте domain+PrincipalName
url	string	Этот URL-адрес является полным маршрутом к исходному ресурсу данного субъекта графа.

JObject

Object

Представляет объект JSON.

Имя	Тип	Описание
item	JToken	Представляет абстрактный токен JSON.
type	string (JTokenType)	Возвращает тип узла для этого JToken.

JToken

Object

Представляет абстрактный токен JSON.

Имя	Тип	Описание
first	JToken	Получите первый дочерний маркер этого токена.
hasValues	boolean	Возвращает значение, указывающее, имеет ли этот маркер дочерние маркеры.
item	JToken	Представляет абстрактный токен JSON.
last	JToken	Получите последний дочерний маркер этого токена.
next	JToken	Возвращает следующий одноуровневый маркер этого узла.
parent	string (JContainer)	Возвращает или задает родительский объект.
path	string	Возвращает путь маркера JSON.
previous	JToken	Возвращает предыдущий одноуровневый маркер этого узла.
root	JToken	Возвращает корневой JToken этого JToken объекта JToken.
type	string (JTokenType)	Возвращает тип узла для этого JToken.

PackageVersion

Object

Имя	Тип	Описание
major	integer (int32)
minor	integer (int32)
patch	integer (int32)

ProjectReference

Object

Имя	Тип	Описание
id	string (uuid)
name	string

PropertiesCollection

Object

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

Имя	Тип	Описание
count	integer (int32)	Количество свойств в коллекции.
item	object
keys	string[]	Набор ключей в коллекции.
values	string[]	Набор значений в коллекции.

ReferenceLinks

Object

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

Имя	Тип	Описание
links	object	Режим чтения ссылок. Так как ссылки ссылки доступны только для чтения, мы хотим предоставлять их только как доступные только для чтения.

TaskAgent

Object

Агент задачи.

Имя	Тип	Описание
_links	ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
accessPoint	string	Точка доступа этого агента.
assignedAgentCloudRequest	TaskAgentCloudRequest	Облачный запрос агента, связанный с этим агентом.
assignedRequest	TaskAgentJobRequest	Запрос, который в настоящее время назначен этому агенту.
authorization	TaskAgentAuthorization	Сведения об авторизации для этого агента.
createdOn	string (date-time)	Дата создания этого агента.
enabled	boolean	Должен ли этот агент выполнять задания.
id	integer (int32)	Идентификатор агента.
lastCompletedRequest	TaskAgentJobRequest	Последний запрос, который был выполнен этим агентом.
maxParallelism	integer (int32)	Максимально допустимое параллелизм заданий для этого агента.
name	string	Имя агента.
osDescription	string	ОС агента.
pendingUpdate	TaskAgentUpdate	Ожидающие обновления для этого агента.
properties	PropertiesCollection	Класс представляет контейнер свойств в виде коллекции пар "ключ-значение". Принимаются значения всех примитивных типов (любого типа с `TypeCode != TypeCode.Object`), кроме `DBNull`. Значения типа Byte[], Int32, Double, DateType и String сохраняют их тип, другие примитивы повторно настраиваются в виде строки. Byte[] ожидается как строка в кодировке Base64.
provisioningState	string	Состояние подготовки этого агента.
status	TaskAgentStatus	Независимо от того, находится ли агент в сети.
statusChangedOn	string (date-time)	Дата, в которой произошло последнее изменение состояния подключения.
systemCapabilities	object	Системные возможности, поддерживаемые узлом этого агента. Предупреждение. Чтобы задать возможности, используйте метод PUT, PUT полностью перезаписывает существующие возможности.
userCapabilities	object	Определяемые пользователем возможности, поддерживаемые узлом этого агента. Предупреждение. Чтобы задать возможности, используйте метод PUT, PUT полностью перезаписывает существующие возможности.
version	string	Версия агента.

TaskAgentAuthorization

Object

Предоставляет данные, необходимые для авторизации агента с помощью потоков проверки подлинности OAuth 2.0.

Имя	Тип	Описание
authorizationUrl	string	Конечная точка, используемая для получения маркеров доступа из настроенной службы маркеров.
clientId	string (uuid)	Идентификатор клиента для этого агента.
publicKey	TaskAgentPublicKey	Открытый ключ, используемый для проверки удостоверения этого агента.

TaskAgentCloudRequest

Object

Имя	Тип	Описание
agent	TaskAgentReference	Ссылка на агент.
agentCloudId	integer (int32)
agentConnectedTime	string (date-time)
agentData	JObject	Представляет объект JSON.
agentSpecification	JObject	Представляет объект JSON.
pool	TaskAgentPoolReference
provisionRequestTime	string (date-time)
provisionedTime	string (date-time)
releaseRequestTime	string (date-time)
requestId	string (uuid)

TaskAgentJobRequest

Object

Запрос задания для агента.

Имя	Тип	Описание
agentSpecification	JObject	Представляет объект JSON.
assignTime	string (date-time)	Дата и время назначения этого запроса.
data	object	Дополнительные данные о запросе.
definition	TaskOrchestrationOwner	Определение конвейера, связанное с этим запросом
demands	Demand[]	Список требований, необходимых для выполнения этого запроса.
finishTime	string (date-time)	Дата и время завершения запроса.
hostId	string (uuid)	Узел, активировавший этот запрос.
jobId	string (uuid)	Идентификатор задания, полученного из этого запроса.
jobName	string	Имя задания, полученного из этого запроса.
lockedUntil	string (date-time)	Крайний срок обновления блокировки агентом.
matchedAgents	TaskAgentReference[]	Ссылка на агент.
matchesAllAgentsInPool	boolean
orchestrationId	string
owner	TaskOrchestrationOwner	Конвейер, связанный с этим запросом
planGroup	string
planId	string (uuid)	Внутренний идентификатор плана оркестрации, подключенного к этому запросу.
planType	string	Внутренняя информация, представляющая тип плана оркестрации.
poolId	integer (int32)	Идентификатор пула, целевого объекта запроса
priority	integer (int32)
queueId	integer (int32)	Идентификатор очереди, целевой объект запроса
queueTime	string (date-time)	Дата и время, когда запрос был помещен в очередь.
receiveTime	string (date-time)	Дата и время, когда этот запрос был извлечен агентом.
requestId	integer (int64)	Идентификатор запроса.
reservedAgent	TaskAgentReference	Агент, выделенный для этого запроса.
result	TaskResult	Результат этого запроса.
scopeId	string (uuid)	Область конвейера; соответствует идентификатору проекта.
serviceOwner	string (uuid)	Служба, которая владеет этим запросом.
statusMessage	string
userDelayed	boolean

TaskAgentPoolOptions

Перечисление

Дополнительные параметры и сведения о пуле

Значение	Описание
elasticPool	TaskAgentPool, поддерживаемая службой эластичного пула
none
preserveAgentOnJobFailure	Значение true, если агенты хранятся для расследования после сбоя TaskAgentJobRequest
singleUseAgents	Задайте значение true, если агенты повторно изображены после каждой задачи TaskAgentJobRequest

TaskAgentPoolReference

Object

Имя	Тип	Описание
id	integer (int32)
isHosted	boolean	Возвращает или задает значение, указывающее, управляется ли этот пул службой.
isLegacy	boolean	Определяет, является ли пул устаревшим.
name	string
options	TaskAgentPoolOptions	Дополнительные параметры и сведения о пуле
poolType	TaskAgentPoolType	Возвращает или задает тип пула
scope	string (uuid)
size	integer (int32)	Возвращает текущий размер пула.

TaskAgentPoolType

Перечисление

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

Значение	Описание
automation	Типичный пул агентов задач
deployment	Пул развертывания

TaskAgentPublicKey

Object

Представляет часть открытого ключа асимметричного ключа RSA.

Имя	Тип	Описание
exponent	string[] (byte)	Возвращает или задает экспонент для открытого ключа.
modulus	string[] (byte)	Возвращает или задает модулу для открытого ключа.

TaskAgentReference

Object

Ссылка на агент.

Имя	Тип	Описание
_links	ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
accessPoint	string	Точка доступа этого агента.
enabled	boolean	Должен ли этот агент выполнять задания.
id	integer (int32)	Идентификатор агента.
name	string	Имя агента.
osDescription	string	ОС агента.
provisioningState	string	Состояние подготовки этого агента.
status	TaskAgentStatus	Независимо от того, находится ли агент в сети.
version	string	Версия агента.

TaskAgentStatus

Перечисление

Независимо от того, находится ли агент в сети.

Значение	Описание
offline
online

TaskAgentUpdate

Object

Сведения об обновлении агента.

Имя	Тип	Описание
currentState	string	Текущее состояние этого обновления агента.
reason	TaskAgentUpdateReason	Причина этого обновления.
requestTime	string (date-time)	Дата запроса этого обновления.
requestedBy	IdentityRef	Удостоверение, запрашивающее это обновление.
sourceVersion	PackageVersion	Версия исходного агента обновления.
targetVersion	PackageVersion	Целевая версия агента обновления.

TaskAgentUpdateReason

Object

Имя	Тип	Описание
code	TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

Перечисление

Значение	Описание
downgrade
manual
minAgentVersionRequired

TaskOrchestrationOwner

Object

Имя	Тип	Описание
_links	ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
id	integer (int32)
name	string

TaskResult

Перечисление

Результат этого запроса.

Значение	Описание
abandoned
canceled
failed
skipped
succeeded
succeededWithIssues