Deploymentgroups - Get

Referência

Serviço:: Task Agent

Versão da API:: 5.0-preview.1

Obtenha um grupo de implantação por sua ID.

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

Com parâmetros opcionais:

GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?actionFilter={actionFilter}&$expand={$expand}&api-version=5.0-preview.1

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
deploymentGroupId	path	True	integer int32	ID do grupo de implantação.
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 '5.0-preview.1' para usar essa versão da api.
$expand	query		DeploymentGroupExpands	Inclua esses detalhes adicionais no objeto retornado.
actionFilter	query		DeploymentGroupActionFilter	Obtenha o grupo de implantação somente se essa ação puder ser executada nele.

Respostas

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

Segurança

oauth2

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL do Token: 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

Escopos

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

Exemplos

Get a deployment group by its ID

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

{
  "machines": [],
  "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.
DeploymentGroupActionFilter	Obtenha o grupo de implantação somente se essa ação puder ser executada nele.
DeploymentGroupExpands	Inclua esses detalhes adicionais no objeto retornado.
DeploymentMachine	Destino de implantação.
IdentityRef
JObject
JToken
PackageVersion
ProjectReference
PropertiesCollection	A classe representa um recipiente de propriedades como uma coleção de pares chave-valor. Os 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
TaskAgentAuthorization	Fornece dados necessários para autorizar o agente usando fluxos de autenticação OAuth 2.0.
TaskAgentCloudRequest
TaskAgentDelaySource
TaskAgentJobRequest
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
TaskAgentStatus	Obtém o status de conectividade atual do agente.
TaskAgentUpdate
TaskAgentUpdateReason
TaskAgentUpdateReasonType
TaskOrchestrationOwner
TaskResult

Demand

Object

Nome	Tipo	Description
name	string
value	string

DeploymentGroup

Object

Grupo de implantação.

Nome	Tipo	Description
description	string	Descrição do grupo de implantação.
id	integer	Identificador de 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.

DeploymentGroupActionFilter

Enumeration

Obtenha o grupo de implantação somente se essa ação puder ser executada nele.

Valor	Description
manage	Somente grupos de implantação para os quais o chamador tem permissão de gerenciamento .
none	Todos os grupos de implantação.
use	Somente grupos de implantação para os quais o chamador tem permissão de uso .

DeploymentGroupExpands

Enumeration

Inclua esses detalhes adicionais no objeto retornado.

Valor	Description
machines	Preterido: inclua todos os destinos de implantação.
none	Nenhuma propriedade adicional.
tags	Inclua uma lista exclusiva de marcas em todos os destinos de implantação.

DeploymentMachine

Object

Destino de implantação.

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

IdentityRef

Object

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
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
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Essa URL é a rota completa para o recurso de origem desta entidade de grafo.

JObject

Object

Nome	Tipo	Description
item	JToken
type	string

JToken

Object

Nome	Tipo	Description
first	JToken
hasValues	boolean
item	JToken
last	JToken
next	JToken
parent	string
path	string
previous	JToken
root	JToken
type	string

PackageVersion

Object

Nome	Tipo	Description
major	integer
minor	integer
patch	integer

ProjectReference

Object

Nome	Tipo	Description
id	string
name	string

PropertiesCollection

Object

A classe representa um recipiente de propriedades como uma coleção de pares chave-valor. Os 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

Object

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

Object

Nome	Tipo	Description
_links	ReferenceLinks	A classe para representar uma coleção de links de referência REST.
accessPoint	string	Obtém o ponto de acesso do agente.
assignedAgentCloudRequest	TaskAgentCloudRequest	Obtém a Solicitação de Nuvem do Agente que está associada atualmente a esse agente
assignedRequest	TaskAgentJobRequest	Obtém a solicitação que está atribuída atualmente a esse agente.
authorization	TaskAgentAuthorization	Obtém ou define as informações de autorização para esse agente.
createdOn	string	Obtém a data em que esse agente foi criado.
enabled	boolean	Obtém ou define um valor que indica se esse agente deve ou não ser habilitado para execução do trabalho.
id	integer	Obtém o identificador do agente.
lastCompletedRequest	TaskAgentJobRequest	Obtém a última solicitação que foi concluída por esse agente.
maxParallelism	integer	Obtém ou define o paralelismo máximo de trabalho permitido neste host.
name	string	Obtém o nome do agente.
oSDescription	string	Obtém o sistema operacional do agente.
pendingUpdate	TaskAgentUpdate	Obtém a atualização pendente para este agente.
properties	PropertiesCollection	A classe representa um recipiente de propriedades como uma coleção de pares chave-valor. Os 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	Obtém ou define o estado de provisionamento atual desse agente
status	TaskAgentStatus	Obtém o status de conectividade atual do agente.
statusChangedOn	string	Obtém a data em que a última alteração de status de conectividade ocorreu.
systemCapabilities	object
userCapabilities	object
version	string	Obtém a versão do agente.

TaskAgentAuthorization

Object

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

Nome	Tipo	Description
authorizationUrl	string	Obtém ou define o ponto de extremidade usado para obter tokens de acesso do serviço de token configurado.
clientId	string	Obtém ou define o identificador do cliente para esse agente.
publicKey	TaskAgentPublicKey	Obtém ou define a chave pública usada para verificar a identidade desse agente.

TaskAgentCloudRequest

Object

Nome	Tipo	Description
agent	TaskAgentReference
agentCloudId	integer
agentConnectedTime	string
agentData	JObject
agentSpecification	JObject
pool	TaskAgentPoolReference
provisionRequestTime	string
provisionedTime	string
releaseRequestTime	string
requestId	string

TaskAgentDelaySource

Object

Nome	Tipo	Description
delays	string[]
taskAgent	TaskAgentReference

TaskAgentJobRequest

Object

Nome	Tipo	Description
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

Object

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.
name	string
poolType	TaskAgentPoolType	Obtém ou define o tipo do pool
scope	string
size	integer	Obtém o tamanho atual do pool.

TaskAgentPoolType

Enumeration

Obtém ou define o tipo do pool

Valor	Description
automation
deployment

TaskAgentPublicKey

Object

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

Object

Nome	Tipo	Description
_links	ReferenceLinks	A classe para representar uma coleção de links de referência REST.
accessPoint	string	Obtém o ponto de acesso do agente.
enabled	boolean	Obtém ou define um valor que indica se esse agente deve ou não ser habilitado para execução do trabalho.
id	integer	Obtém o identificador do agente.
name	string	Obtém o nome do agente.
oSDescription	string	Obtém o sistema operacional do agente.
provisioningState	string	Obtém ou define o estado de provisionamento atual desse agente
status	TaskAgentStatus	Obtém o status de conectividade atual do agente.
version	string	Obtém a versão do agente.

TaskAgentStatus

Enumeration

Obtém o status de conectividade atual do agente.

Valor	Description
offline
online

TaskAgentUpdate

Object

Nome	Tipo	Description
currentState	string	O estado atual desta atualização do agente
reason	TaskAgentUpdateReason	O motivo dessa atualização do agente
requestTime	string	Obtém a data em que essa atualização do agente foi solicitada.
requestedBy	IdentityRef	A identidade que solicita a atualização do agente
sourceVersion	PackageVersion	Obtém ou define a versão do agente de origem da atualização do agente
targetVersion	PackageVersion	Obtém ou define a versão do agente de destino da atualização do agente

TaskAgentUpdateReason

Object

Nome	Tipo	Description
code	TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

Enumeration

Valor	Description
manual
minAgentVersionRequired

TaskOrchestrationOwner

Object

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

TaskResult

Enumeration

Valor	Description
abandoned
canceled
failed
skipped
succeeded
succeededWithIssues

Partilhar via

Deploymentgroups - Get

Parâmetros de URI

Respostas

Segurança

oauth2

Escopos

Exemplos

Get a deployment group by its ID

Solicitação de exemplo

Resposta de exemplo

Definições

Demand

DeploymentGroup

DeploymentGroupActionFilter

DeploymentGroupExpands

DeploymentMachine

IdentityRef

JObject

JToken

PackageVersion

ProjectReference

PropertiesCollection

ReferenceLinks

TaskAgent

TaskAgentAuthorization

TaskAgentCloudRequest

TaskAgentDelaySource

TaskAgentJobRequest

TaskAgentPoolReference

TaskAgentPoolType

TaskAgentPublicKey

TaskAgentReference

TaskAgentStatus

TaskAgentUpdate

TaskAgentUpdateReason

TaskAgentUpdateReasonType

TaskOrchestrationOwner

TaskResult