Partilhar via

Targets - Get

  • Referência
Serviço:
Task Agent
Versão da API:
5.0-preview.1

Obter um destino de implantação por sua ID em um grupo de implantação

GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}/targets/{targetId}?api-version=5.0-preview.1
Com parâmetros opcionais: 
GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}/targets/{targetId}?$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 ao qual o destino de implantação pertence.
organization
 path True

string

O nome da organização do Azure DevOps.
project
 path True

string

ID do projeto ou nome do projeto
targetId
 path True

integer

int32

ID do destino de implantação a ser retornado.
api-version
 query True

string

Versão da API a ser usada. Isso deve ser definido como '5.0-preview.1' para usar esta versão da API.
$expand
 query

DeploymentTargetExpands

Inclua esses detalhes adicionais nos objetos retornados.

Respostas

Nome Tipo Description
200 OK

DeploymentMachine

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 target by its ID

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
200 
{
  "tags": [
    "web"
  ],
  "id": 5,
  "agent": {
    "_links": {
      "self": {
        "href": "https://dev.azure.com/fabrikam/_apis/distributedtask/pools/17/agents/5"
      },
      "web": {
        "href": "https://dev.azure.com/fabrikam/_admin/_AgentPool#_a=agents&poolId=17&agentId=5"
      }
    },
    "maxParallelism": 1,
    "createdOn": "2018-02-19T09:19:41.053Z",
    "authorization": {
      "clientId": "0f386203-17f5-45a6-8c72-d35b54011fe3",
      "publicKey": {
        "exponent": "AQAB",
        "modulus": "6O7UGxhRniv3tmXJ/1kaEkZdbcNQabJBJxj3EhPNsBJuduYZt3OixVTI/X5r1C2ogAr0nQon2UP3HKNQ9bkY7fNAY8VfggOTytu4ZfFcTJABvc5X8pHefWfO2DVqOUJH6HpyOtP5C+b2OGuhzTlEJHv6FrJPWxbK1HEo0w6VQg4CI8VqyCY9pvT6ZTrZTSg1Hp4uGF/kDHtUk0GvYWA2hZJyk/VbX7hH1PhwpRHuIEUsT0TcJzrR+7n0gdLDGeNLYqBMmTXIMm6jv7pUdnOumI9FK9hChw3JbP44jVxlxGbV8kh+IKAX/S3+pdkCNOiKzkXIDtUu/3vWiqx6+v8mIQ=="
      }
    },
    "id": 5,
    "name": "demoTarget1",
    "version": "2.127.0",
    "osDescription": "Microsoft Windows 10.0.14393 ",
    "enabled": true,
    "status": "online"
  }
}

Definições

Nome Description
Demand
DeploymentMachine

Destino de implantação.
DeploymentTargetExpands

Inclua esses detalhes adicionais nos objetos retornados.
IdentityRef
JObject
JToken
PackageVersion
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
TaskAgentAuthorization

Fornece dados necessários para autorizar o agente usando fluxos de autenticação do OAuth 2.0.
TaskAgentCloudRequest
TaskAgentDelaySource
TaskAgentJobRequest
TaskAgentPoolReference
TaskAgentPoolType

Obtém ou define o tipo do pool
TaskAgentPublicKey

Representa a parte da 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

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.

DeploymentTargetExpands

Enumeration

Inclua esses detalhes adicionais nos objetos retornados.

Valor Description
assignedRequest

Inclua a solicitação de trabalho atribuída ao agente de implantação.
capabilities

Inclua recursos do agente de implantação.
lastCompletedRequest

Inclua a última solicitação de trabalho concluída do agente de implantação.
none

Nenhuma propriedade adicional.

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 do grafo entre contas e organizações.
directoryAlias

string

displayName

string

Este é 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

PropertiesCollection

Object

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.
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á atualmente associada 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. 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 do 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 da 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