Targets - List
Obtenez la liste des cibles de déploiement dans un groupe de déploiement.
GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}/targets?api-version=5.0-preview.1GET 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.1Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
deployment
|
path | True |
integer int32 |
ID du groupe de déploiement. |
|
organization
|
path | True |
string |
Nom de l’organisation Azure DevOps. |
|
project
|
path | True |
string |
ID de projet ou nom du projet |
|
api-version
|
query | True |
string |
Version de l’API à utiliser. Cette valeur doit être définie sur « 5.0-preview.1 » pour utiliser cette version de l’API. |
|
$expand
|
query |
Incluez ces détails supplémentaires dans les objets retournés. |
||
|
$top
|
query |
integer int32 |
Nombre maximal d’objectifs de déploiement à retourner. La valeur par défaut est 1000. |
|
|
agent
|
query |
Obtenez uniquement les cibles de déploiement qui ont ce dernier résultat de travail. |
||
|
agent
|
query |
Obtenez uniquement les cibles de déploiement qui ont cette status. |
||
|
continuation
|
query |
string |
Obtenez des cibles de déploiement dont les noms sont supérieurs à cette continuationToken lexicographiquement. |
|
|
enabled
|
query |
boolean |
Obtenez uniquement les cibles de déploiement activées ou désactivées. La valeur par défaut est « null », qui retourne toutes les cibles. |
|
|
name
|
query |
string |
Modèle de nom des cibles de déploiement à retourner. |
|
|
partial
|
query |
boolean |
Lorsqu’il est défini sur true, traite name comme modèle. Sinon, il le traite comme une correspondance absolue. La valeur par défaut est false. |
|
|
tags
|
query |
string array (string) |
Obtenez uniquement les cibles de déploiement qui contiennent toutes ces listes de balises séparées par des virgules. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
opération réussie |
Sécurité
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
| Nom | Description |
|---|---|
| vso.machinegroup_manage | Offre la possibilité de gérer les pools de groupes de déploiement et d’agents |
Exemples
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"
}
}
]
}Définitions
| Nom | Description |
|---|---|
| Demand | |
|
Deployment |
Cible de déploiement. |
|
Deployment |
Incluez ces détails supplémentaires dans les objets retournés. |
|
Identity |
|
| JObject | |
| JToken | |
|
Package |
|
|
Properties |
La classe représente un conteneur de propriétés en tant que collection de paires clé-valeur. Les valeurs de tous les types primitifs (tout type avec un |
|
Reference |
Classe pour représenter une collection de liens de référence REST. |
|
Task |
|
|
Task |
Fournit les données nécessaires pour autoriser l’agent à l’aide de flux d’authentification OAuth 2.0. |
|
Task |
|
|
Task |
|
|
Task |
|
|
Task |
Obtenez uniquement les cibles de déploiement qui ont ce dernier résultat de travail. |
|
Task |
|
|
Task |
Obtient ou définit le type du pool |
|
Task |
Représente la partie clé publique d’une clé asymétrique RSA. |
|
Task |
|
|
Task |
Obtient la status de connectivité actuelle de l’agent. |
|
Task |
Obtenez uniquement les cibles de déploiement qui ont cette status. |
|
Task |
|
|
Task |
|
|
Task |
|
|
Task |
|
|
Task |
Demand
| Nom | Type | Description |
|---|---|---|
| name |
string |
|
| value |
string |
DeploymentMachine
Cible de déploiement.
| Nom | Type | Description |
|---|---|---|
| agent |
Agent de déploiement. |
|
| id |
integer |
Identificateur de cible de déploiement. |
| tags |
string[] |
Balises de la cible de déploiement. |
DeploymentTargetExpands
Incluez ces détails supplémentaires dans les objets retournés.
| Nom | Type | Description |
|---|---|---|
| assignedRequest |
string |
Incluez la demande de travail affectée à l’agent de déploiement. |
| capabilities |
string |
Inclure les fonctionnalités de l’agent de déploiement. |
| lastCompletedRequest |
string |
Incluez la dernière demande de travail terminée de l’agent de déploiement. |
| none |
string |
Aucune propriété supplémentaire. |
IdentityRef
| Nom | Type | Description |
|---|---|---|
| _links |
Ce champ contient zéro ou plus de liens intéressants sur le sujet du graphe. Ces liens peuvent être appelés pour obtenir des relations supplémentaires ou des informations plus détaillées sur ce sujet de graphique. |
|
| descriptor |
string |
Le descripteur est le principal moyen de référencer l’objet du graphe pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphe pour les comptes et les organisations. |
| directoryAlias |
string |
|
| displayName |
string |
Il s’agit du nom d’affichage non unique du sujet du graphique. Pour modifier ce champ, vous devez modifier sa valeur dans le fournisseur source. |
| id |
string |
|
| imageUrl |
string |
|
| inactive |
boolean |
|
| isAadIdentity |
boolean |
|
| isContainer |
boolean |
|
| isDeletedInOrigin |
boolean |
|
| profileUrl |
string |
|
| uniqueName |
string |
|
| url |
string |
Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphique. |
JObject
| Nom | Type | Description |
|---|---|---|
| item | ||
| type |
string |
JToken
| Nom | Type | Description |
|---|---|---|
| first | ||
| hasValues |
boolean |
|
| item | ||
| last | ||
| next | ||
| parent |
string |
|
| path |
string |
|
| previous | ||
| root | ||
| type |
string |
PackageVersion
| Nom | Type | Description |
|---|---|---|
| major |
integer |
|
| minor |
integer |
|
| patch |
integer |
PropertiesCollection
La classe représente un conteneur de propriétés en tant que collection de paires clé-valeur. Les valeurs de tous les types primitifs (tout type avec un TypeCode != TypeCode.Object) à l’exception de sont DBNull acceptées. Les valeurs de type Byte[], Int32, Double, DateType et String conservent leur type. D’autres primitives sont réintégés en tant que String. Byte[] attendu en tant que chaîne encodée en base64.
| Nom | Type | Description |
|---|---|---|
| count |
integer |
Nombre de propriétés dans la collection. |
| item |
object |
|
| keys |
string[] |
Ensemble de clés dans la collection. |
| values |
string[] |
Ensemble de valeurs dans la collection. |
ReferenceLinks
Classe pour représenter une collection de liens de référence REST.
| Nom | Type | Description |
|---|---|---|
| links |
object |
Vue en lecture seule des liens. Étant donné que les liens de référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule. |
TaskAgent
| Nom | Type | Description |
|---|---|---|
| _links |
Classe pour représenter une collection de liens de référence REST. |
|
| accessPoint |
string |
Obtient le point d’accès de l’agent. |
| assignedAgentCloudRequest |
Obtient la demande cloud de l’agent actuellement associée à cet agent |
|
| assignedRequest |
Obtient la requête actuellement affectée à cet agent. |
|
| authorization |
Obtient ou définit les informations d’autorisation pour cet agent. |
|
| createdOn |
string |
Obtient la date à laquelle cet agent a été créé. |
| enabled |
boolean |
Obtient ou définit une valeur indiquant si cet agent doit être activé pour l’exécution du travail. |
| id |
integer |
Obtient l’identificateur de l’agent. |
| lastCompletedRequest |
Obtient la dernière requête qui a été effectuée par cet agent. |
|
| maxParallelism |
integer |
Obtient ou définit le parallélisme de travail maximal autorisé sur cet hôte. |
| name |
string |
Obtient le nom de l’agent. |
| oSDescription |
string |
Obtient le système d’exploitation de l’agent. |
| pendingUpdate |
Obtient la mise à jour en attente pour cet agent. |
|
| properties |
La classe représente un conteneur de propriétés en tant que collection de paires clé-valeur. Les valeurs de tous les types primitifs (tout type avec un |
|
| provisioningState |
string |
Obtient ou définit l’état d’approvisionnement actuel de cet agent |
| status |
Obtient la status de connectivité actuelle de l’agent. |
|
| statusChangedOn |
string |
Obtient la date à laquelle la dernière modification status connectivité s’est produite. |
| systemCapabilities |
object |
|
| userCapabilities |
object |
|
| version |
string |
Obtient la version de l’agent. |
TaskAgentAuthorization
Fournit les données nécessaires pour autoriser l’agent à l’aide de flux d’authentification OAuth 2.0.
| Nom | Type | Description |
|---|---|---|
| authorizationUrl |
string |
Obtient ou définit le point de terminaison utilisé pour obtenir des jetons d’accès à partir du service de jeton configuré. |
| clientId |
string |
Obtient ou définit l’identificateur client de cet agent. |
| publicKey |
Obtient ou définit la clé publique utilisée pour vérifier l’identité de cet agent. |
TaskAgentCloudRequest
| Nom | Type | Description |
|---|---|---|
| agent | ||
| agentCloudId |
integer |
|
| agentConnectedTime |
string |
|
| agentData | ||
| agentSpecification | ||
| pool | ||
| provisionRequestTime |
string |
|
| provisionedTime |
string |
|
| releaseRequestTime |
string |
|
| requestId |
string |
TaskAgentDelaySource
| Nom | Type | Description |
|---|---|---|
| delays |
string[] |
|
| taskAgent |
TaskAgentJobRequest
| Nom | Type | 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
Obtenez uniquement les cibles de déploiement qui ont ce dernier résultat de travail.
| Nom | Type | Description |
|---|---|---|
| all |
string |
Toutes les cibles de déploiement. |
| failed |
string |
Seules les cibles de déploiement sur lesquelles le dernier travail a échoué (Abandonné, Annulé, Échec, Ignoré). |
| neverDeployed |
string |
Uniquement les cibles de déploiement qui n’ont jamais exécuté de travail. |
| passed |
string |
Seules les cibles de déploiement sur lesquelles le dernier travail a été passé (Réussi, Réussi avec des problèmes). |
TaskAgentPoolReference
| Nom | Type | Description |
|---|---|---|
| id |
integer |
|
| isHosted |
boolean |
Obtient ou définit une valeur indiquant si ce pool est géré ou non par le service. |
| name |
string |
|
| poolType |
Obtient ou définit le type du pool |
|
| scope |
string |
|
| size |
integer |
Obtient la taille actuelle du pool. |
TaskAgentPoolType
Obtient ou définit le type du pool
| Nom | Type | Description |
|---|---|---|
| automation |
string |
|
| deployment |
string |
TaskAgentPublicKey
Représente la partie clé publique d’une clé asymétrique RSA.
| Nom | Type | Description |
|---|---|---|
| exponent |
string[] |
Obtient ou définit l’exposant de la clé publique. |
| modulus |
string[] |
Obtient ou définit le module de la clé publique. |
TaskAgentReference
| Nom | Type | Description |
|---|---|---|
| _links |
Classe pour représenter une collection de liens de référence REST. |
|
| accessPoint |
string |
Obtient le point d’accès de l’agent. |
| enabled |
boolean |
Obtient ou définit une valeur indiquant si cet agent doit être activé pour l’exécution du travail. |
| id |
integer |
Obtient l’identificateur de l’agent. |
| name |
string |
Obtient le nom de l’agent. |
| oSDescription |
string |
Obtient le système d’exploitation de l’agent. |
| provisioningState |
string |
Obtient ou définit l’état d’approvisionnement actuel de cet agent |
| status |
Obtient la status de connectivité actuelle de l’agent. |
|
| version |
string |
Obtient la version de l’agent. |
TaskAgentStatus
Obtient la status de connectivité actuelle de l’agent.
| Nom | Type | Description |
|---|---|---|
| offline |
string |
|
| online |
string |
TaskAgentStatusFilter
Obtenez uniquement les cibles de déploiement qui ont cette status.
| Nom | Type | Description |
|---|---|---|
| all |
string |
Toutes les cibles de déploiement. |
| offline |
string |
Uniquement les cibles de déploiement hors connexion. |
| online |
string |
Uniquement les cibles de déploiement qui sont en ligne. |
TaskAgentUpdate
| Nom | Type | Description |
|---|---|---|
| currentState |
string |
État actuel de cette mise à jour de l’agent |
| reason |
Raison de cette mise à jour de l’agent |
|
| requestTime |
string |
Obtient la date à laquelle cette mise à jour de l’agent a été demandée. |
| requestedBy |
Identité qui demande la mise à jour de l’agent |
|
| sourceVersion |
Obtient ou définit la version de l’agent source de la mise à jour de l’agent |
|
| targetVersion |
Obtient ou définit la version de l’agent cible de la mise à jour de l’agent |
TaskAgentUpdateReason
| Nom | Type | Description |
|---|---|---|
| code |
TaskAgentUpdateReasonType
| Nom | Type | Description |
|---|---|---|
| manual |
string |
|
| minAgentVersionRequired |
string |
TaskOrchestrationOwner
| Nom | Type | Description |
|---|---|---|
| _links |
Classe pour représenter une collection de liens de référence REST. |
|
| id |
integer |
|
| name |
string |
TaskResult
| Nom | Type | Description |
|---|---|---|
| abandoned |
string |
|
| canceled |
string |
|
| failed |
string |
|
| skipped |
string |
|
| succeeded |
string |
|
| succeededWithIssues |
string |
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour