Deploymentgroups - Add

Référence

Service:: Task Agent

API Version:: 5.0-preview.1

Créez un groupe de déploiement.

POST https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups?api-version=5.0-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 « 5.0-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=5.0-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
JToken
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
TaskAgentAuthorization	Fournit les données nécessaires pour autoriser l’agent à l’aide de flux d’authentification OAuth 2.0.
TaskAgentCloudRequest
TaskAgentDelaySource
TaskAgentJobRequest
TaskAgentPoolReference
TaskAgentPoolType	Obtient ou définit le type du pool
TaskAgentPublicKey	Représente la partie clé publique d’une clé asymétrique RSA.
TaskAgentReference
TaskAgentStatus	Obtient la connectivité actuelle status de l’agent.
TaskAgentUpdate
TaskAgentUpdateReason
TaskAgentUpdateReasonType
TaskOrchestrationOwner
TaskResult

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.
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 l’objet du graphique. 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 graphique pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphique dans les comptes et les organisations.
directoryAlias	string
displayName	string	Il s’agit du nom d’affichage non unique de l’objet 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	JToken
type	string

JToken

Nom	Type	Description
first	JToken
hasValues	boolean
item	JToken
last	JToken
next	JToken
parent	string
path	string
previous	JToken
root	JToken
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 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 référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.

TaskAgent

Nom	Type	Description
_links	ReferenceLinks	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	TaskAgentCloudRequest	Obtient la demande cloud de l’agent qui est actuellement associée à cet agent
assignedRequest	TaskAgentJobRequest	Obtient la requête actuellement affectée à cet agent.
authorization	TaskAgentAuthorization	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	TaskAgentJobRequest	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	TaskAgentUpdate	Obtient la 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	Obtient ou définit l’état d’approvisionnement actuel de cet agent
status	TaskAgentStatus	Obtient la connectivité actuelle status de l’agent.
statusChangedOn	string	Obtient la date à laquelle la dernière modification de connectivité status 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 du client pour cet agent.
publicKey	TaskAgentPublicKey	Obtient ou définit la clé publique utilisée pour vérifier l’identité de cet agent.

TaskAgentCloudRequest

Nom	Type	Description
agent	TaskAgentReference
agentCloudId	integer
agentConnectedTime	string
agentData	JObject
agentSpecification	JObject
pool	TaskAgentPoolReference
provisionRequestTime	string
provisionedTime	string
releaseRequestTime	string
requestId	string

TaskAgentDelaySource

Nom	Type	Description
delays	string[]
taskAgent	TaskAgentReference

TaskAgentJobRequest

Nom	Type	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

Nom	Type	Description
id	integer
isHosted	boolean	Obtient ou définit une valeur indiquant si ce pool est géré par le service.
name	string
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
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	ReferenceLinks	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	TaskAgentStatus	Obtient la connectivité actuelle status de l’agent.
version	string	Obtient la version de l’agent.

TaskAgentStatus

Obtient la connectivité actuelle status 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	TaskAgentUpdateReason	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	IdentityRef	Identité qui demande la mise à jour de l’agent
sourceVersion	PackageVersion	Obtient ou définit la version de l’agent source de la mise à jour de l’agent
targetVersion	PackageVersion	Obtient ou définit la version de l’agent cible de la mise à jour de l’agent

TaskAgentUpdateReason

Nom	Type	Description
code	TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

Nom	Type	Description
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

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

Partager via