Deploymentgroups - Update

Служба:
Task Agent
Версия API:
5.0-preview.1

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

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

Параметры URI

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

integer (int32)

Идентификатор группы развертывания.
organization
 path True

string

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

string

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

string

Используемая версия API. Для использования этой версии API необходимо задать значение 5.0-preview.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

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

PATCH https://dev.azure.com/fabrikam/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?api-version=5.0-preview.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
JToken
PackageVersion
ProjectReference
PropertiesCollection

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

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

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

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

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

Возвращает текущее состояние подключения агента.
TaskAgentUpdate
TaskAgentUpdateReason
TaskAgentUpdateReasonType
TaskOrchestrationOwner
TaskResult

Demand

Объект
Имя Тип Описание
name

string

value

string

DeploymentGroup

Объект

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

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

string

Описание группы развертывания.
id

integer

Идентификатор группы развертывания.
machineCount

integer

Число целевых объектов развертывания в группе развертывания.
machineTags

string[]

Список уникальных тегов для всех целевых объектов развертывания в группе развертывания.
machines

DeploymentMachine[]

Список целевых объектов развертывания в группе развертывания.
name

string

Имя группы развертывания.
pool

TaskAgentPoolReference

Пул развертывания, в котором зарегистрированы агенты развертывания.
project

ProjectReference

Проект, к которому принадлежит группа развертывания.

DeploymentGroupUpdateParameter

Объект

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

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

string

Описание группы развертывания.
name

string

Имя группы развертывания.

DeploymentMachine

Объект

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

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

TaskAgent

Агент развертывания.
id

integer

Идентификатор целевого объекта развертывания.
tags

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-адрес является полным маршрутом к исходному ресурсу этого субъекта графа.

JObject

Объект
Имя Тип Описание
item

JToken

type

string

JToken

Объект
Имя Тип Описание
first

JToken

hasValues

boolean

item

JToken

last

JToken

next

JToken

parent

string

path

string

previous

JToken

root

JToken

type

string

PackageVersion

Объект
Имя Тип Описание
major

integer

minor

integer

patch

integer

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

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

TaskAgent

Объект
Имя Тип Описание
_links

ReferenceLinks

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

string

Возвращает точку доступа агента.
assignedAgentCloudRequest

TaskAgentCloudRequest

Возвращает облачный запрос агента, связанный с этим агентом.
assignedRequest

TaskAgentJobRequest

Возвращает запрос, назначенный данному агенту.
authorization

TaskAgentAuthorization

Возвращает или задает сведения об авторизации для этого агента.
createdOn

string

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

boolean

Возвращает или задает значение, указывающее, должен ли этот агент быть включен для выполнения задания.
id

integer

Возвращает идентификатор агента.
lastCompletedRequest

TaskAgentJobRequest

Возвращает последний запрос, который был выполнен этим агентом.
maxParallelism

integer

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

string

Возвращает имя агента.
oSDescription

string

Возвращает ОС агента.
pendingUpdate

TaskAgentUpdate

Возвращает ожидающее обновление для этого агента.
properties

PropertiesCollection

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

string

Возвращает или задает текущее состояние подготовки этого агента.
status

TaskAgentStatus

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

string

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

object

userCapabilities

object

version

string

Возвращает версию агента.

TaskAgentAuthorization

Объект

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

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

string

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

string

Возвращает или задает идентификатор клиента для этого агента.
publicKey

TaskAgentPublicKey

Возвращает или задает открытый ключ, используемый для проверки удостоверения этого агента.

TaskAgentCloudRequest

Объект
Имя Тип Описание
agent

TaskAgentReference

agentCloudId

integer

agentConnectedTime

string

agentData

JObject

agentSpecification

JObject

pool

TaskAgentPoolReference

provisionRequestTime

string

provisionedTime

string

releaseRequestTime

string

requestId

string

TaskAgentDelaySource

Объект
Имя Тип Описание
delays

string[]

taskAgent

TaskAgentReference

TaskAgentJobRequest

Объект
Имя Тип Описание
agentDelays

TaskAgentDelaySource[]

agentSpecification

JObject

assignTime

string

data

object

definition

TaskOrchestrationOwner

demands

Demand[]

expectedDuration

string

finishTime

string

hostId

string

jobId

string

jobName

string

lockedUntil

string

matchedAgents

TaskAgentReference[]

orchestrationId

string

owner

TaskOrchestrationOwner

planGroup

string

planId

string

planType

string

poolId

integer

queueId

integer

queueTime

string

receiveTime

string

requestId

integer

reservedAgent

TaskAgentReference

result

TaskResult

scopeId

string

serviceOwner

string

TaskAgentPoolReference

Объект
Имя Тип Описание
id

integer

isHosted

boolean

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

string

poolType

TaskAgentPoolType

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

string

size

integer

Возвращает текущий размер пула.

TaskAgentPoolType

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

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

Значение Описание
automation
deployment

TaskAgentPublicKey

Объект

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

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

string[]

Возвращает или задает показатель экспоненты для открытого ключа.
modulus

string[]

Возвращает или задает модуль для открытого ключа.

TaskAgentReference

Объект
Имя Тип Описание
_links

ReferenceLinks

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

string

Возвращает точку доступа агента.
enabled

boolean

Возвращает или задает значение, указывающее, должен ли этот агент быть включен для выполнения задания.
id

integer

Возвращает идентификатор агента.
name

string

Возвращает имя агента.
oSDescription

string

Возвращает ОС агента.
provisioningState

string

Возвращает или задает текущее состояние подготовки этого агента.
status

TaskAgentStatus

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

string

Возвращает версию агента.

TaskAgentStatus

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

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

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

TaskAgentUpdate

Объект
Имя Тип Описание
currentState

string

Текущее состояние обновления агента
reason

TaskAgentUpdateReason

Причина обновления агента
requestTime

string

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

IdentityRef

Удостоверение, запрашивающее обновление агента
sourceVersion

PackageVersion

Возвращает или задает версию исходного агента обновления агента.
targetVersion

PackageVersion

Возвращает или задает версию целевого агента обновления агента.

TaskAgentUpdateReason

Объект
Имя Тип Описание
code

TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

Перечисление
Значение Описание
manual
minAgentVersionRequired

TaskOrchestrationOwner

Объект
Имя Тип Описание
_links

ReferenceLinks

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

integer

name

string

TaskResult

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