Deploymentgroups - Get
Obtenez un groupe de déploiement par son ID.
GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?api-version=5.0-preview.1
GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?actionFilter={actionFilter}&$expand={$expand}&api-version=5.0-preview.1
Paramè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 l’objet retourné. |
||
action
|
query |
Obtenez le groupe de déploiement uniquement si cette action peut être effectuée sur celui-ci. |
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 a deployment group by its ID
Sample Request
GET https://dev.azure.com/fabrikam/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?api-version=5.0-preview.1
Sample Response
{
"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
}
}
Définitions
Nom | Description |
---|---|
Demand | |
Deployment |
Groupe de déploiement. |
Deployment |
Obtenez le groupe de déploiement uniquement si cette action peut être effectuée sur celui-ci. |
Deployment |
Incluez ces détails supplémentaires dans l’objet retourné. |
Deployment |
Cible de déploiement. |
Identity |
|
JObject | |
JToken | |
Package |
|
Project |
|
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 |
|
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 |
|
Task |
|
Task |
|
Task |
|
Task |
Demand
Nom | Type | Description |
---|---|---|
name |
string |
|
value |
string |
DeploymentGroup
Groupe de déploiement.
Nom | Type | Description |
---|---|---|
description |
string |
Description du groupe de déploiement. |
id |
integer |
Identificateur du groupe de déploiement. |
machineCount |
integer |
Nombre de cibles de déploiement dans le groupe de déploiement. |
machineTags |
string[] |
Liste des étiquettes uniques pour toutes les cibles de déploiement dans le groupe de déploiement. |
machines |
Liste des cibles de déploiement dans le groupe de déploiement. |
|
name |
string |
Nom du groupe de déploiement. |
pool |
Pool de déploiement dans lequel les agents de déploiement sont inscrits. |
|
project |
Projet auquel appartient le groupe de déploiement. |
DeploymentGroupActionFilter
Obtenez le groupe de déploiement uniquement si cette action peut être effectuée sur celui-ci.
Nom | Type | Description |
---|---|---|
manage |
string |
Seuls les groupes de déploiement pour lesquels l’appelant a l’autorisation de gérer . |
none |
string |
Tous les groupes de déploiement. |
use |
string |
Seuls les groupes de déploiement pour lesquels l’appelant a l’autorisation d’utiliser . |
DeploymentGroupExpands
Incluez ces détails supplémentaires dans l’objet retourné.
Nom | Type | Description |
---|---|---|
machines |
string |
Déconseillé : incluez toutes les cibles de déploiement. |
none |
string |
Aucune propriété supplémentaire. |
tags |
string |
Incluez une liste unique d’étiquettes pour toutes les cibles de déploiement. |
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. |
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 |
ProjectReference
Nom | Type | Description |
---|---|---|
id |
string |
|
name |
string |
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 |
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 |
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 |