Deploymentgroups - Add

Service:

Distributed Task

API Version:

7.1-preview.1

Criar um grupo de implantação.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
organization	path	True	string	O nome da organização do Azure DevOps.
project	path	True	string	ID do projeto ou nome do projeto
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '7.1-preview.1' para usar essa versão da api.

Corpo da solicitação

Nome	Tipo	Description
description	string	Descrição do grupo de implantação.
name	string	Nome do grupo de implantação.
poolId	integer	Identificador do pool de implantação no qual os agentes de implantação são registrados.

Respostas

Nome	Tipo	Description
200 OK	DeploymentGroup	operação bem-sucedida

Segurança

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

Nome	Description
vso.machinegroup_manage	Fornece a capacidade de gerenciar pools de agentes e grupos de implantação

Exemplos

Create a deployment group

Sample Request

HTTP

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

{
  "name": "MyDeploymentGroup1",
  "description": "This deployment group is created to demnostrate the client usage"
}

Sample Response

Status code:

200

{
  "machineCount": 0,
  "description": "This deployment group is created to demnostrate the client usage",
  "id": 11,
  "project": {
    "id": "91879ed9-819b-46f3-9e0b-52ed4b20c04c",
    "name": "DeploymentGroupRESTSample"
  },
  "name": "MyDeploymentGroup1",
  "pool": {
    "id": 6,
    "scope": "86088ab1-30d8-4526-9663-3406752b8bc6",
    "name": "DeploymentGroupRESTSample-MyDeploymentGroup1",
    "isHosted": false,
    "poolType": "deployment",
    "size": 0
  }
}

Definições

Nome	Description
Demand
DeploymentGroup	Grupo de implantação.
DeploymentGroupCreateParameter	Propriedades para criar o grupo Implantação.
DeploymentMachine	Destino de implantação.
IdentityRef
JObject	Representa um objeto JSON.
JToken	Representa um token JSON abstrato.
PackageVersion
ProjectReference
PropertiesCollection	A classe representa um recipiente de propriedades como uma coleção de pares chave-valor. Valores de todos os tipos primitivos (qualquer tipo com um TypeCode != TypeCode.Object) exceto para DBNull são aceitos. Valores do tipo Byte[], Int32, Double, DateType e String preservam seu tipo, outros primitivos são reajustados como uma Cadeia de Caracteres. Byte[] esperado como cadeia de caracteres codificada em base64.
ReferenceLinks	A classe para representar uma coleção de links de referência REST.
TaskAgent	Um agente de tarefa.
TaskAgentAuthorization	Fornece dados necessários para autorizar o agente usando fluxos de autenticação do OAuth 2.0.
TaskAgentCloudRequest
TaskAgentJobRequest	Uma solicitação de trabalho para um agente.
TaskAgentPoolOptions	Configurações e detalhes adicionais do pool
TaskAgentPoolReference
TaskAgentPoolType	Obtém ou define o tipo do pool
TaskAgentPublicKey	Representa a parte de chave pública de uma chave assimétrica RSA.
TaskAgentReference	Uma referência a um agente.
TaskAgentStatus	Se o agente está online ou não.
TaskAgentUpdate	Detalhes sobre uma atualização de agente.
TaskAgentUpdateReason
TaskAgentUpdateReasonType
TaskOrchestrationOwner
TaskResult	O resultado dessa solicitação.

Demand

Nome	Tipo	Description
name	string
value	string

DeploymentGroup

Grupo de implantação.

Nome	Tipo	Description
description	string	Descrição do grupo de implantação.
id	integer	Identificador do grupo de implantação.
machineCount	integer	Número de destinos de implantação no grupo de implantação.
machineTags	string[]	Lista de marcas exclusivas em todos os destinos de implantação no grupo de implantação.
machines	DeploymentMachine[]	Lista de destinos de implantação no grupo de implantação.
name	string	Nome do grupo de implantação.
pool	TaskAgentPoolReference	Pool de implantação no qual os agentes de implantação são registrados.
project	ProjectReference	Projeto ao qual o grupo de implantação pertence.

DeploymentGroupCreateParameter

Propriedades para criar o grupo Implantação.

Nome	Tipo	Description
description	string	Descrição do grupo de implantação.
name	string	Nome do grupo de implantação.
poolId	integer	Identificador do pool de implantação no qual os agentes de implantação são registrados.

DeploymentMachine

Destino de implantação.

Nome	Tipo	Description
agent	TaskAgent	Agente de implantação.
id	integer	Identificador de destino de implantação.
properties	PropertiesCollection	Propriedades do destino de implantação.
tags	string[]	Marcas do destino de implantação.

IdentityRef

Nome	Tipo	Description
_links	ReferenceLinks	Esse campo contém zero ou mais links interessantes sobre o assunto do grafo. Esses links podem ser invocados para obter relações adicionais ou informações mais detalhadas sobre esse assunto do grafo.
descriptor	string	O descritor é a principal maneira de referenciar o assunto do grafo enquanto o sistema está em execução. Esse campo identificará exclusivamente o mesmo assunto de grafo entre contas e organizações.
directoryAlias	string	Preterido – pode ser recuperado consultando o usuário do Graph referenciado na entrada "self" do dicionário IdentityRef "_links"
displayName	string	Esse é o nome de exibição não exclusivo do assunto do grafo. Para alterar esse campo, você deve alterar seu valor no provedor de origem.
id	string
imageUrl	string	Preterido – Disponível na entrada "avatar" do dicionário IdentityRef "_links"
inactive	boolean	Preterido – pode ser recuperado consultando o estado de associação do Graph referenciado na entrada "membershipState" do dicionário "_links" do GraphUser
isAadIdentity	boolean	Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Preterido – não em uso na maioria das implementações preexistir de ToIdentityRef
uniqueName	string	Preterido – use Domain+PrincipalName em vez disso
url	string	Essa URL é a rota completa para o recurso de origem desta entidade de grafo.

JObject

Representa um objeto JSON.

Nome	Tipo	Description
item	JToken	Representa um token JSON abstrato.
type	string	Obtém o tipo de nó para este JToken.

JToken

Representa um token JSON abstrato.

Nome	Tipo	Description
first	JToken	Obtenha o primeiro token filho desse token.
hasValues	boolean	Obtém um valor que indica se esse token tem tokens filho.
item	JToken	Representa um token JSON abstrato.
last	JToken	Obtenha o último token filho desse token.
next	JToken	Obtém o próximo token irmão desse nó.
parent	string	Obtém ou define o pai.
path	string	Obtém o caminho do token JSON.
previous	JToken	Obtém o token irmão anterior desse nó.
root	JToken	Obtém o JToken raiz deste JToken.
type	string	Obtém o tipo de nó para este JToken.

PackageVersion

Nome	Tipo	Description
major	integer
minor	integer
patch	integer

ProjectReference

Nome	Tipo	Description
id	string
name	string

PropertiesCollection

A classe representa um recipiente de propriedades como uma coleção de pares chave-valor. Valores de todos os tipos primitivos (qualquer tipo com um TypeCode != TypeCode.Object) exceto para DBNull são aceitos. Valores do tipo Byte[], Int32, Double, DateType e String preservam seu tipo, outros primitivos são reajustados como uma Cadeia de Caracteres. Byte[] esperado como cadeia de caracteres codificada em base64.

Nome	Tipo	Description
count	integer	A contagem de propriedades na coleção.
item	object
keys	string[]	O conjunto de chaves na coleção.
values	string[]	O conjunto de valores na coleção.

ReferenceLinks

A classe para representar uma coleção de links de referência REST.

Nome	Tipo	Description
links	object	A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura.

TaskAgent

Um agente de tarefa.

Nome	Tipo	Description
_links	ReferenceLinks	A classe para representar uma coleção de links de referência REST.
accessPoint	string	O ponto de acesso desse agente.
assignedAgentCloudRequest	TaskAgentCloudRequest	A solicitação de nuvem do agente que está atualmente associada a esse agente.
assignedRequest	TaskAgentJobRequest	A solicitação que está atribuída atualmente a esse agente.
authorization	TaskAgentAuthorization	Informações de autorização para este agente.
createdOn	string	Data em que esse agente foi criado.
enabled	boolean	Se esse agente deve ou não executar trabalhos.
id	integer	Identificador do agente.
lastCompletedRequest	TaskAgentJobRequest	A última solicitação que foi concluída por esse agente.
maxParallelism	integer	Paralelismo máximo de trabalho permitido para esse agente.
name	string	O nome do agente.
osDescription	string	Sistema operacional do agente.
pendingUpdate	TaskAgentUpdate	Atualização pendente para este agente.
properties	PropertiesCollection	A classe representa um recipiente de propriedades como uma coleção de pares chave-valor. Valores de todos os tipos primitivos (qualquer tipo com um TypeCode != TypeCode.Object) exceto para DBNull são aceitos. Valores do tipo Byte[], Int32, Double, DateType e String preservam seu tipo, outros primitivos são reajustados como uma Cadeia de Caracteres. Byte[] esperado como cadeia de caracteres codificada em base64.
provisioningState	string	Estado de provisionamento deste agente.
status	TaskAgentStatus	Se o agente está online ou não.
statusChangedOn	string	Data em que a última alteração de status de conectividade ocorreu.
systemCapabilities	object	Funcionalidades definidas pelo sistema compatíveis com o host desse agente. Aviso: para definir recursos, use o método PUT, PUT substituirá completamente os recursos existentes.
userCapabilities	object	Recursos definidos pelo usuário compatíveis com o host deste agente. Aviso: para definir recursos, use o método PUT, PUT substituirá completamente os recursos existentes.
version	string	Versão do agente.

TaskAgentAuthorization

Fornece dados necessários para autorizar o agente usando fluxos de autenticação do OAuth 2.0.

Nome	Tipo	Description
authorizationUrl	string	Ponto de extremidade usado para obter tokens de acesso do serviço de token configurado.
clientId	string	Identificador de cliente para este agente.
publicKey	TaskAgentPublicKey	Chave pública usada para verificar a identidade desse agente.

TaskAgentCloudRequest

Nome	Tipo	Description
agent	TaskAgentReference	Uma referência a um agente.
agentCloudId	integer
agentConnectedTime	string
agentData	JObject	Representa um objeto JSON.
agentSpecification	JObject	Representa um objeto JSON.
pool	TaskAgentPoolReference
provisionRequestTime	string
provisionedTime	string
releaseRequestTime	string
requestId	string

TaskAgentJobRequest

Uma solicitação de trabalho para um agente.

Nome	Tipo	Description
agentSpecification	JObject	Representa um objeto JSON.
assignTime	string	A data/hora em que essa solicitação foi atribuída.
data	object	Dados adicionais sobre a solicitação.
definition	TaskOrchestrationOwner	A definição de pipeline associada a essa solicitação
demands	Demand[]	Uma lista de demandas necessárias para atender a essa solicitação.
finishTime	string	A data/hora em que essa solicitação foi concluída.
hostId	string	O host que disparou essa solicitação.
jobId	string	ID do trabalho resultante dessa solicitação.
jobName	string	Nome do trabalho resultante dessa solicitação.
lockedUntil	string	A data limite para o agente renovar o bloqueio.
matchedAgents	TaskAgentReference[]	Uma referência a um agente.
matchesAllAgentsInPool	boolean
orchestrationId	string
owner	TaskOrchestrationOwner	O pipeline associado a essa solicitação
planGroup	string
planId	string	ID interna do plano de orquestração conectado a essa solicitação.
planType	string	Detalhes internos que representam o tipo de plano de orquestração.
poolId	integer	A ID do pool que essa solicitação tem como destino
priority	integer
queueId	integer	A ID da fila que essa solicitação visa
queueTime	string	A data/hora em que essa solicitação foi enfileirada.
receiveTime	string	A data/hora em que essa solicitação foi recebida novamente por um agente.
requestId	integer	ID da solicitação.
reservedAgent	TaskAgentReference	O agente alocado para essa solicitação.
result	TaskResult	O resultado dessa solicitação.
scopeId	string	Escopo do pipeline; corresponde à ID do projeto.
serviceOwner	string	O serviço que possui essa solicitação.
statusMessage	string
userDelayed	boolean

TaskAgentPoolOptions

Configurações e detalhes adicionais do pool

Nome	Tipo	Description
elasticPool	string	TaskAgentPool apoiado pelo serviço de pool elástico
none	string
preserveAgentOnJobFailure	string	Defina como true se os agentes forem mantidos para investigação após uma falha taskAgentJobRequest
singleUseAgents	string	Defina como true se os agentes forem recriados após cada TaskAgentJobRequest

TaskAgentPoolReference

Nome	Tipo	Description
id	integer
isHosted	boolean	Obtém ou define um valor que indica se esse pool é gerenciado ou não pelo serviço.
isLegacy	boolean	Determina se o pool é herdado.
name	string
options	TaskAgentPoolOptions	Configurações e detalhes adicionais do pool
poolType	TaskAgentPoolType	Obtém ou define o tipo do pool
scope	string
size	integer	Obtém o tamanho atual do pool.

TaskAgentPoolType

Obtém ou define o tipo do pool

Nome	Tipo	Description
automation	string	Um pool típico de agentes de tarefa
deployment	string	Um pool de implantação

TaskAgentPublicKey

Representa a parte de chave pública de uma chave assimétrica RSA.

Nome	Tipo	Description
exponent	string[]	Obtém ou define o expoente para a chave pública.
modulus	string[]	Obtém ou define o módulo para a chave pública.

TaskAgentReference

Uma referência a um agente.

Nome	Tipo	Description
_links	ReferenceLinks	A classe para representar uma coleção de links de referência REST.
accessPoint	string	O ponto de acesso desse agente.
enabled	boolean	Se esse agente deve ou não executar trabalhos.
id	integer	Identificador do agente.
name	string	O nome do agente.
osDescription	string	Sistema operacional do agente.
provisioningState	string	Estado de provisionamento deste agente.
status	TaskAgentStatus	Se o agente está online ou não.
version	string	Versão do agente.

TaskAgentStatus

Se o agente está online ou não.

Nome	Tipo	Description
offline	string
online	string

TaskAgentUpdate

Detalhes sobre uma atualização de agente.

Nome	Tipo	Description
currentState	string	Estado atual desta atualização do agente.
reason	TaskAgentUpdateReason	Motivo para essa atualização.
requestTime	string	Data em que essa atualização foi solicitada.
requestedBy	IdentityRef	Identidade que solicitou essa atualização.
sourceVersion	PackageVersion	Versão do agente de origem da atualização.
targetVersion	PackageVersion	Versão do agente de destino da atualização.

TaskAgentUpdateReason

Nome	Tipo	Description
code	TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

Nome	Tipo	Description
downgrade	string
manual	string
minAgentVersionRequired	string

TaskOrchestrationOwner

Nome	Tipo	Description
_links	ReferenceLinks	A classe para representar uma coleção de links de referência REST.
id	integer
name	string

TaskResult

O resultado dessa solicitação.

Nome	Tipo	Description
abandoned	string
canceled	string
failed	string
skipped	string
succeeded	string
succeededWithIssues	string