Targets - List
Obtenha uma lista de destinos de implantação em um grupo de implantação.
GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}/targets?api-version=5.0-preview.1
GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}/targets?tags={tags}&name={name}&partialNameMatch={partialNameMatch}&$expand={$expand}&agentStatus={agentStatus}&agentJobResult={agentJobResult}&continuationToken={continuationToken}&$top={$top}&enabled={enabled}&api-version=5.0-preview.1
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
deployment
|
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 |
Inclua esses detalhes adicionais nos objetos retornados. |
||
$top
|
query |
integer int32 |
Número máximo de destinos de implantação a serem retornados. O padrão é 1000. |
|
agent
|
query |
Obtenha apenas os destinos de implantação que têm este último resultado de trabalho. |
||
agent
|
query |
Obtenha apenas os destinos de implantação que têm esse status. |
||
continuation
|
query |
string |
Obtenha destinos de implantação com nomes maiores que essa continuaçãoToken lexicograficamente. |
|
enabled
|
query |
boolean |
Obtenha apenas os destinos de implantação habilitados ou desabilitados. O padrão é 'null' que retorna todos os destinos. |
|
name
|
query |
string |
Padrão de nome dos destinos de implantação a serem retornados. |
|
partial
|
query |
boolean |
Quando definido como true, trata o nome como padrão. Caso contrário, trata-o como correspondência absoluta. O padrão é false. |
|
tags
|
query |
string array (string) |
Obtenha apenas os destinos de implantação que contêm todas essas listas de marcas separadas por vírgulas. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
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
Get deployment targets by partial name match
Sample Request
GET https://dev.azure.com/fabrikam/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}/targets?api-version=5.0-preview.1
Sample Response
{
"count": 1,
"value": [
{
"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",
"id": 5,
"name": "demoTarget1",
"version": "2.127.0",
"osDescription": "Microsoft Windows 10.0.14393 ",
"enabled": true,
"status": "online"
}
}
]
}
Get deployment targets filtered by agent status
Sample Request
GET https://dev.azure.com/fabrikam/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}/targets?api-version=5.0-preview.1
Sample Response
{
"count": 1,
"value": [
{
"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",
"id": 5,
"name": "demoTarget1",
"version": "2.127.0",
"osDescription": "Microsoft Windows 10.0.14393 ",
"enabled": true,
"status": "online"
}
}
]
}
Get deployment targets having given tags
Sample Request
GET https://dev.azure.com/fabrikam/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}/targets?api-version=5.0-preview.1
Sample Response
{
"count": 1,
"value": [
{
"tags": [
"db",
"web"
],
"id": 7,
"agent": {
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/_apis/distributedtask/pools/17/agents/7"
},
"web": {
"href": "https://dev.azure.com/fabrikam/_admin/_AgentPool#_a=agents&poolId=17&agentId=7"
}
},
"maxParallelism": 1,
"createdOn": "2018-02-19T09:26:48.11Z",
"id": 7,
"name": "demoTarget11",
"version": "2.127.0",
"osDescription": "Microsoft Windows 10.0.14393 ",
"enabled": true,
"status": "offline"
}
}
]
}
Get deployment targets in pages
Sample Request
GET https://dev.azure.com/fabrikam/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}/targets?api-version=5.0-preview.1
Sample Response
x-MS-ContinuationToken: demoTarget2
{
"count": 2,
"value": [
{
"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",
"id": 5,
"name": "demoTarget1",
"version": "2.127.0",
"osDescription": "Microsoft Windows 10.0.14393 ",
"enabled": true,
"status": "online"
}
},
{
"tags": [
"db",
"web"
],
"id": 7,
"agent": {
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/_apis/distributedtask/pools/17/agents/7"
},
"web": {
"href": "https://dev.azure.com/fabrikam/_admin/_AgentPool#_a=agents&poolId=17&agentId=7"
}
},
"maxParallelism": 1,
"createdOn": "2018-02-19T09:26:48.11Z",
"id": 7,
"name": "demoTarget11",
"version": "2.127.0",
"osDescription": "Microsoft Windows 10.0.14393 ",
"enabled": true,
"status": "offline"
}
}
]
}
Get deployment targets including their last job requests
Sample Request
GET https://dev.azure.com/fabrikam/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}/targets?api-version=5.0-preview.1
Sample Response
{
"count": 1,
"value": [
{
"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",
"lastCompletedRequest": {
"requestId": 1,
"queueTime": "2018-02-19T09:28:48.2633333Z",
"assignTime": "2018-02-19T09:28:48.2633333Z",
"receiveTime": "2018-02-19T09:28:52.2811279Z",
"finishTime": "2018-02-19T09:28:57.7333333Z",
"result": "succeeded",
"serviceOwner": "0000000d-0000-8888-8000-000000000000",
"hostId": "86088ab1-30d8-4526-9663-3406752b8bc6",
"scopeId": "91879ed9-819b-46f3-9e0b-52ed4b20c04c",
"planType": "Deployment",
"planId": "b7245fde-fb04-40f3-b187-78772599f522",
"jobId": "2fd39b55-daaa-499a-ad70-1896ac468a9f",
"demands": [
"DotNetFramework",
"Agent.Version -gtVersion 1.102"
],
"reservedAgent": {
"id": 5,
"name": "demoTarget1",
"version": "2.127.0",
"enabled": true,
"status": "online"
},
"definition": {
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/91879ed9-819b-46f3-9e0b-52ed4b20c04c/_release?definitionId=1"
},
"self": {
"href": "https://https://vsrm.dev.azure.com/fabrikam/91879ed9-819b-46f3-9e0b-52ed4b20c04c/_apis/Release/definitions/1"
}
},
"id": 1,
"name": "New Release Definition"
},
"owner": {
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/91879ed9-819b-46f3-9e0b-52ed4b20c04c/_release?releaseId=1&_a=release-summary"
},
"self": {
"href": "https://https://vsrm.dev.azure.com/fabrikam/91879ed9-819b-46f3-9e0b-52ed4b20c04c/_apis/Release/releases/1"
}
},
"id": 1,
"name": "Release-1 / Environment 1"
},
"data": {},
"agentDelays": []
},
"id": 5,
"name": "demoTarget1",
"version": "2.127.0",
"osDescription": "Microsoft Windows 10.0.14393 ",
"enabled": true,
"status": "online"
}
}
]
}
List all deployment targets in a deployment group
Sample Request
GET https://dev.azure.com/fabrikam/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}/targets?api-version=5.0-preview.1
Sample Response
{
"count": 3,
"value": [
{
"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",
"id": 5,
"name": "demoTarget1",
"version": "2.127.0",
"osDescription": "Microsoft Windows 10.0.14393 ",
"enabled": true,
"status": "online"
}
},
{
"tags": [
"db",
"web"
],
"id": 7,
"agent": {
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/_apis/distributedtask/pools/17/agents/7"
},
"web": {
"href": "https://dev.azure.com/fabrikam/_admin/_AgentPool#_a=agents&poolId=17&agentId=7"
}
},
"maxParallelism": 1,
"createdOn": "2018-02-19T09:26:48.11Z",
"id": 7,
"name": "demoTarget11",
"version": "2.127.0",
"osDescription": "Microsoft Windows 10.0.14393 ",
"enabled": true,
"status": "offline"
}
},
{
"tags": [
"db"
],
"id": 6,
"agent": {
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/_apis/distributedtask/pools/17/agents/6"
},
"web": {
"href": "https://dev.azure.com/fabrikam/_admin/_AgentPool#_a=agents&poolId=17&agentId=6"
}
},
"maxParallelism": 1,
"createdOn": "2018-02-19T09:23:58.267Z",
"id": 6,
"name": "demoTarget2",
"version": "2.127.0",
"osDescription": "Microsoft Windows 10.0.14393 ",
"enabled": true,
"status": "offline"
}
}
]
}
Definições
Nome | Description |
---|---|
Demand | |
Deployment |
Destino de implantação. |
Deployment |
Inclua esses detalhes adicionais nos objetos retornados. |
Identity |
|
JObject | |
JToken | |
Package |
|
Properties |
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 |
Reference |
A classe para representar uma coleção de links de referência REST. |
Task |
|
Task |
Fornece dados necessários para autorizar o agente usando fluxos de autenticação OAuth 2.0. |
Task |
|
Task |
|
Task |
|
Task |
Obtenha apenas os destinos de implantação que têm este último resultado de trabalho. |
Task |
|
Task |
Obtém ou define o tipo do pool |
Task |
Representa a parte de chave pública de uma chave assimétrica RSA. |
Task |
|
Task |
Obtém o status de conectividade atual do agente. |
Task |
Obtenha apenas os destinos de implantação que têm esse status. |
Task |
|
Task |
|
Task |
|
Task |
|
Task |
Demand
Nome | Tipo | Description |
---|---|---|
name |
string |
|
value |
string |
DeploymentMachine
Destino de implantação.
Nome | Tipo | Description |
---|---|---|
agent |
Agente de implantação. |
|
id |
integer |
Identificador de destino de implantação. |
tags |
string[] |
Marcas do destino de implantação. |
DeploymentTargetExpands
Inclua esses detalhes adicionais nos objetos retornados.
Nome | Tipo | Description |
---|---|---|
assignedRequest |
string |
Inclua a solicitação de trabalho atribuída ao agente de implantação. |
capabilities |
string |
Inclua recursos do agente de implantação. |
lastCompletedRequest |
string |
Inclua a última solicitação de trabalho concluída do agente de implantação. |
none |
string |
Nenhuma propriedade adicional. |
IdentityRef
Nome | Tipo | Description |
---|---|---|
_links |
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
Nome | Tipo | Description |
---|---|---|
item | ||
type |
string |
JToken
Nome | Tipo | Description |
---|---|---|
first | ||
hasValues |
boolean |
|
item | ||
last | ||
next | ||
parent |
string |
|
path |
string |
|
previous | ||
root | ||
type |
string |
PackageVersion
Nome | Tipo | Description |
---|---|---|
major |
integer |
|
minor |
integer |
|
patch |
integer |
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.
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
Nome | Tipo | Description |
---|---|---|
_links |
A classe para representar uma coleção de links de referência REST. |
|
accessPoint |
string |
Obtém o ponto de acesso do agente. |
assignedAgentCloudRequest |
Obtém a Solicitação de Nuvem do Agente que está associada atualmente a esse agente |
|
assignedRequest |
Obtém a solicitação que está atribuída atualmente a esse agente. |
|
authorization |
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 |
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 |
Obtém a atualização pendente para este agente. |
|
properties |
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 |
|
provisioningState |
string |
Obtém ou define o estado de provisionamento atual desse agente |
status |
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
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 |
Obtém ou define a chave pública usada para verificar a identidade desse agente. |
TaskAgentCloudRequest
Nome | Tipo | Description |
---|---|---|
agent | ||
agentCloudId |
integer |
|
agentConnectedTime |
string |
|
agentData | ||
agentSpecification | ||
pool | ||
provisionRequestTime |
string |
|
provisionedTime |
string |
|
releaseRequestTime |
string |
|
requestId |
string |
TaskAgentDelaySource
Nome | Tipo | Description |
---|---|---|
delays |
string[] |
|
taskAgent |
TaskAgentJobRequest
Nome | Tipo | Description |
---|---|---|
agentDelays | ||
agentSpecification | ||
assignTime |
string |
|
data |
object |
|
definition | ||
demands |
Demand[] |
|
expectedDuration |
string |
|
finishTime |
string |
|
hostId |
string |
|
jobId |
string |
|
jobName |
string |
|
lockedUntil |
string |
|
matchedAgents | ||
orchestrationId |
string |
|
owner | ||
planGroup |
string |
|
planId |
string |
|
planType |
string |
|
poolId |
integer |
|
queueId |
integer |
|
queueTime |
string |
|
receiveTime |
string |
|
requestId |
integer |
|
reservedAgent | ||
result | ||
scopeId |
string |
|
serviceOwner |
string |
TaskAgentJobResultFilter
Obtenha apenas os destinos de implantação que têm este último resultado de trabalho.
Nome | Tipo | Description |
---|---|---|
all |
string |
Todos os destinos de implantação. |
failed |
string |
Somente os destinos de implantação nos quais o último trabalho falhou (Abandonado, Cancelado, Com Falha, Ignorado). |
neverDeployed |
string |
Somente os destinos de implantação que nunca executaram um trabalho. |
passed |
string |
Somente os destinos de implantação nos quais o último trabalho foi aprovado (Êxito, Êxito com problemas). |
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. |
name |
string |
|
poolType |
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 |
|
deployment |
string |
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
Nome | Tipo | Description |
---|---|---|
_links |
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 |
Obtém o status de conectividade atual do agente. |
|
version |
string |
Obtém a versão do agente. |
TaskAgentStatus
Obtém o status de conectividade atual do agente.
Nome | Tipo | Description |
---|---|---|
offline |
string |
|
online |
string |
TaskAgentStatusFilter
Obtenha apenas os destinos de implantação que têm esse status.
Nome | Tipo | Description |
---|---|---|
all |
string |
Todos os destinos de implantação. |
offline |
string |
Somente destinos de implantação que estão offline. |
online |
string |
Somente destinos de implantação online. |
TaskAgentUpdate
Nome | Tipo | Description |
---|---|---|
currentState |
string |
O estado atual desta atualização do agente |
reason |
O motivo dessa atualização do agente |
|
requestTime |
string |
Obtém a data em que essa atualização do agente foi solicitada. |
requestedBy |
A identidade que solicita a atualização do agente |
|
sourceVersion |
Obtém ou define a versão do agente de origem da atualização do agente |
|
targetVersion |
Obtém ou define a versão do agente de destino da atualização do agente |
TaskAgentUpdateReason
Nome | Tipo | Description |
---|---|---|
code |
TaskAgentUpdateReasonType
Nome | Tipo | Description |
---|---|---|
manual |
string |
|
minAgentVersionRequired |
string |
TaskOrchestrationOwner
Nome | Tipo | Description |
---|---|---|
_links |
A classe para representar uma coleção de links de referência REST. |
|
id |
integer |
|
name |
string |
TaskResult
Nome | Tipo | Description |
---|---|---|
abandoned |
string |
|
canceled |
string |
|
failed |
string |
|
skipped |
string |
|
succeeded |
string |
|
succeededWithIssues |
string |
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de