Deploymentgroups - Add

Service:

Distributed Task

API Version:

7.1-preview.1

Créez un groupe de déploiement.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
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 « 7.1-preview.1 » pour utiliser cette version de l’API.

Corps de la demande

Nom	Type	Description
description	string	Description du groupe de déploiement.
name	string	Nom du groupe de déploiement.
poolId	integer	Identificateur du pool de déploiement dans lequel les agents de déploiement sont inscrits.

Réponses

Nom	Type	Description
200 OK	DeploymentGroup	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

Create a deployment group

Sample Request

HTTP

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

{
  "name": "MyDeploymentGroup1",
  "description": "This deployment group is created to demnostrate the client usage"
}

Sample Response

Status code:

200

{
  "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
DeploymentGroup	Groupe de déploiement.
DeploymentGroupCreateParameter	Propriétés pour créer un groupe de déploiement.
DeploymentMachine	Cible de déploiement.
IdentityRef
JObject	Représente un objet JSON.
JToken	Représente un jeton JSON abstrait.
PackageVersion
ProjectReference
PropertiesCollection	La classe représente un conteneur de propriétés sous la forme d’une collection de paires clé-valeur. Les valeurs de tous les types primitifs (tout type avec un TypeCode != TypeCode.Object) à l’exception de DBNull sont acceptées. Les valeurs de type Byte[], Int32, Double, DateType et String conservent leur type. Les autres primitives sont réinsérées sous forme de chaîne. Byte[] attendu sous forme de chaîne encodée en base64.
ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
TaskAgent	Un agent de tâche.
TaskAgentAuthorization	Fournit les données nécessaires pour autoriser l’agent à l’aide de flux d’authentification OAuth 2.0.
TaskAgentCloudRequest
TaskAgentJobRequest	Demande de travail pour un agent.
TaskAgentPoolOptions	Paramètres et détails supplémentaires du pool
TaskAgentPoolReference
TaskAgentPoolType	Obtient ou définit le type du pool
TaskAgentPublicKey	Représente la partie clé publique d’une clé asymétrique RSA.
TaskAgentReference	Référence à un agent.
TaskAgentStatus	Indique si l’agent est en ligne ou non.
TaskAgentUpdate	Détails sur une mise à jour de l’agent.
TaskAgentUpdateReason
TaskAgentUpdateReasonType
TaskOrchestrationOwner
TaskResult	Résultat de cette demande.

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 sur toutes les cibles de déploiement dans le groupe de déploiement.
machines	DeploymentMachine[]	Liste des cibles de déploiement dans le groupe de déploiement.
name	string	Nom du groupe de déploiement.
pool	TaskAgentPoolReference	Pool de déploiement dans lequel les agents de déploiement sont inscrits.
project	ProjectReference	Projet auquel appartient le groupe de déploiement.

DeploymentGroupCreateParameter

Propriétés pour créer un groupe de déploiement.

Nom	Type	Description
description	string	Description du groupe de déploiement.
name	string	Nom du groupe de déploiement.
poolId	integer	Identificateur du pool de déploiement dans lequel les agents de déploiement sont inscrits.

DeploymentMachine

Cible de déploiement.

Nom	Type	Description
agent	TaskAgent	Agent de déploiement.
id	integer	Identificateur de la cible de déploiement.
properties	PropertiesCollection	Propriétés de la cible de déploiement.
tags	string[]	Balises de la cible de déploiement.

IdentityRef

Nom	Type	Description
_links	ReferenceLinks	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	Déconseillé : peut être récupéré en interrogeant l’utilisateur Graph référencé dans l’entrée « auto » du dictionnaire IdentityRef « _links »
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	Déconseillé : disponible dans l’entrée « avatar » du dictionnaire IdentityRef « _links »
inactive	boolean	Déconseillé : peut être récupéré en interrogeant l’état d’appartenance Graph référencé dans l’entrée « membershipState » du dictionnaire GraphUser « _links »
isAadIdentity	boolean	Déconseillé : peut être déduit du type d’objet du descripteur (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Déconseillé : peut être déduit du type d’objet du descripteur (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Déconseillé : non utilisé dans la plupart des implémentations préexistantes de ToIdentityRef
uniqueName	string	Déconseillé : utilisez Domain+PrincipalName à la place
url	string	Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphique.

JObject

Représente un objet JSON.

Nom	Type	Description
item	JToken	Représente un jeton JSON abstrait.
type	string	Obtient le type de nœud pour ce JToken.

JToken

Représente un jeton JSON abstrait.

Nom	Type	Description
first	JToken	Obtenez le premier jeton enfant de ce jeton.
hasValues	boolean	Obtient une valeur indiquant si ce jeton a des jetons enfants.
item	JToken	Représente un jeton JSON abstrait.
last	JToken	Obtenez le dernier jeton enfant de ce jeton.
next	JToken	Obtient le jeton frère suivant de ce nœud.
parent	string	Obtient ou définit le parent.
path	string	Obtient le chemin du jeton JSON.
previous	JToken	Obtient le jeton frère précédent de ce nœud.
root	JToken	Obtient le JToken racine de ce JToken.
type	string	Obtient le type de nœud pour ce JToken.

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 sous la forme d’une collection de paires clé-valeur. Les valeurs de tous les types primitifs (tout type avec un TypeCode != TypeCode.Object) à l’exception de DBNull sont acceptées. Les valeurs de type Byte[], Int32, Double, DateType et String conservent leur type. Les autres primitives sont réinsérées sous forme de chaîne. Byte[] attendu sous forme de 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

Un agent de tâche.

Nom	Type	Description
_links	ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
accessPoint	string	Point d’accès de cet agent.
assignedAgentCloudRequest	TaskAgentCloudRequest	Demande cloud de l’agent actuellement associée à cet agent.
assignedRequest	TaskAgentJobRequest	Requête actuellement affectée à cet agent.
authorization	TaskAgentAuthorization	Informations d’autorisation pour cet agent.
createdOn	string	Date à laquelle cet agent a été créé.
enabled	boolean	Indique si cet agent doit exécuter des travaux.
id	integer	Identificateur de l’agent.
lastCompletedRequest	TaskAgentJobRequest	Dernière requête qui a été effectuée par cet agent.
maxParallelism	integer	Parallélisme maximal autorisé pour cet agent.
name	string	Nom de l'Agent.
osDescription	string	Système d’exploitation de l’agent.
pendingUpdate	TaskAgentUpdate	Mise à jour en attente pour cet agent.
properties	PropertiesCollection	La classe représente un conteneur de propriétés sous la forme d’une collection de paires clé-valeur. Les valeurs de tous les types primitifs (tout type avec un TypeCode != TypeCode.Object) à l’exception de DBNull sont acceptées. Les valeurs de type Byte[], Int32, Double, DateType et String conservent leur type. Les autres primitives sont réinsérées sous forme de chaîne. Byte[] attendu sous forme de chaîne encodée en base64.
provisioningState	string	État d’approvisionnement de cet agent.
status	TaskAgentStatus	Indique si l’agent est en ligne ou non.
statusChangedOn	string	Date à laquelle la dernière modification de connectivité status s’est produite.
systemCapabilities	object	Fonctionnalités définies par le système prises en charge par l’hôte de cet agent. Avertissement : Pour définir des fonctionnalités à l’aide de la méthode PUT, PUT remplace complètement les fonctionnalités existantes.
userCapabilities	object	Fonctionnalités définies par l’utilisateur prises en charge par l’hôte de cet agent. Avertissement : Pour définir des fonctionnalités à l’aide de la méthode PUT, PUT remplace complètement les fonctionnalités existantes.
version	string	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	Point de terminaison utilisé pour obtenir des jetons d’accès à partir du service de jeton configuré.
clientId	string	Identificateur client pour cet agent.
publicKey	TaskAgentPublicKey	Clé publique utilisée pour vérifier l’identité de cet agent.

TaskAgentCloudRequest

Nom	Type	Description
agent	TaskAgentReference	Référence à un agent.
agentCloudId	integer
agentConnectedTime	string
agentData	JObject	Représente un objet JSON.
agentSpecification	JObject	Représente un objet JSON.
pool	TaskAgentPoolReference
provisionRequestTime	string
provisionedTime	string
releaseRequestTime	string
requestId	string

TaskAgentJobRequest

Demande de travail pour un agent.

Nom	Type	Description
agentSpecification	JObject	Représente un objet JSON.
assignTime	string	Date/heure d’attribution de cette demande.
data	object	Données supplémentaires sur la demande.
definition	TaskOrchestrationOwner	Définition de pipeline associée à cette requête
demands	Demand[]	Liste des demandes requises pour répondre à cette demande.
finishTime	string	Date/heure de fin de cette demande.
hostId	string	Hôte qui a déclenché cette requête.
jobId	string	ID du travail résultant de cette requête.
jobName	string	Nom du travail résultant de cette demande.
lockedUntil	string	Date limite pour le renouvellement du verrou par l’agent.
matchedAgents	TaskAgentReference[]	Référence à un agent.
matchesAllAgentsInPool	boolean
orchestrationId	string
owner	TaskOrchestrationOwner	Pipeline associé à cette requête
planGroup	string
planId	string	ID interne du plan d’orchestration connecté à cette demande.
planType	string	Détails internes représentant le type de plan d’orchestration.
poolId	integer	ID du pool cible par cette requête
priority	integer
queueId	integer	ID de la file d’attente cible par cette requête
queueTime	string	Date/heure à laquelle cette demande a été mise en file d’attente.
receiveTime	string	Date/heure à laquelle cette demande a été récusée par un agent.
requestId	integer	ID de la demande.
reservedAgent	TaskAgentReference	Agent alloué pour cette requête.
result	TaskResult	Résultat de cette demande.
scopeId	string	Étendue du pipeline ; correspond à l’ID de projet.
serviceOwner	string	Service propriétaire de cette requête.
statusMessage	string
userDelayed	boolean

TaskAgentPoolOptions

Paramètres et détails supplémentaires du pool

Nom	Type	Description
elasticPool	string	TaskAgentPool soutenu par le service de pool élastique
none	string
preserveAgentOnJobFailure	string	Défini sur true si les agents sont conservés pour investigation après un échec taskAgentJobRequest
singleUseAgents	string	Définissez sur true si les agents sont réinitions après chaque TaskAgentJobRequest

TaskAgentPoolReference

Nom	Type	Description
id	integer
isHosted	boolean	Obtient ou définit une valeur indiquant si ce pool est géré par le service.
isLegacy	boolean	Détermine si le pool est hérité.
name	string
options	TaskAgentPoolOptions	Paramètres et détails supplémentaires du pool
poolType	TaskAgentPoolType	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	Un pool classique d’agents de tâches
deployment	string	Un pool de déploiement

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

Référence à un agent.

Nom	Type	Description
_links	ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
accessPoint	string	Point d’accès de cet agent.
enabled	boolean	Indique si cet agent doit ou non exécuter des travaux.
id	integer	Identificateur de l’agent.
name	string	Nom de l'Agent.
osDescription	string	Système d’exploitation de l’agent.
provisioningState	string	État d’approvisionnement de cet agent.
status	TaskAgentStatus	Indique si l’agent est en ligne ou non.
version	string	Version de l’agent.

TaskAgentStatus

Indique si l’agent est en ligne ou non.

Nom	Type	Description
offline	string
online	string

TaskAgentUpdate

Détails sur une mise à jour de l’agent.

Nom	Type	Description
currentState	string	État actuel de cette mise à jour de l’agent.
reason	TaskAgentUpdateReason	Raison de cette mise à jour.
requestTime	string	Date à laquelle cette mise à jour a été demandée.
requestedBy	IdentityRef	Identité qui a demandé cette mise à jour.
sourceVersion	PackageVersion	Version de l’agent source de la mise à jour.
targetVersion	PackageVersion	Version de l’agent cible de la mise à jour.

TaskAgentUpdateReason

Nom	Type	Description
code	TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

Nom	Type	Description
downgrade	string
manual	string
minAgentVersionRequired	string

TaskOrchestrationOwner

Nom	Type	Description
_links	ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
id	integer
name	string

TaskResult

Résultat de cette demande.

Nom	Type	Description
abandoned	string
canceled	string
failed	string
skipped	string
succeeded	string
succeededWithIssues	string