Deploymentgroups - Get

Service:

Task Agent

API Version:

5.0-preview.1

Obtenga un grupo de implementación por su identificador.

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

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?actionFilter={actionFilter}&$expand={$expand}&api-version=5.0-preview.1

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
deploymentGroupId	path	True	integer int32	Identificador del grupo de implementación.
organization	path	True	string	El nombre de la organización de Azure DevOps.
project	path	True	string	Id. de proyecto o nombre del proyecto
api-version	query	True	string	Versión de la API que se va a usar. Debe establecerse en "5.0-preview.1" para usar esta versión de la API.
$expand	query		DeploymentGroupExpands	Incluya estos detalles adicionales en el objeto devuelto.
actionFilter	query		DeploymentGroupActionFilter	Obtenga el grupo de implementación solo si esta acción se puede realizar en él.

Respuestas

Nombre	Tipo	Description
200 OK	DeploymentGroup	operación correcta

Seguridad

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

Nombre	Description
vso.machinegroup_manage	Proporciona la capacidad de administrar grupos de agentes y grupos de implementación.

Ejemplos

Get a deployment group by its ID

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "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
  }
}

Definiciones

Nombre	Description
Demand
DeploymentGroup	Grupo de implementación.
DeploymentGroupActionFilter	Obtenga el grupo de implementación solo si esta acción se puede realizar en él.
DeploymentGroupExpands	Incluya estos detalles adicionales en el objeto devuelto.
DeploymentMachine	Destino de implementación.
IdentityRef
JObject
JToken
PackageVersion
ProjectReference
PropertiesCollection	La clase representa un contenedor de propiedades como una colección de pares clave-valor. Se aceptan valores de todos los tipos primitivos (cualquier tipo con ) TypeCode != TypeCode.Objectexcepto .DBNull Los valores de tipo Byte[], Int32, Double, DateType y String conservan su tipo; otros primitivos se vuelven a ajustar como una cadena. Byte[] se esperaba como cadena codificada en base64.
ReferenceLinks	Clase que se va a representar una colección de vínculos de referencia de REST.
TaskAgent
TaskAgentAuthorization	Proporciona los datos necesarios para autorizar el agente mediante flujos de autenticación de OAuth 2.0.
TaskAgentCloudRequest
TaskAgentDelaySource
TaskAgentJobRequest
TaskAgentPoolReference
TaskAgentPoolType	Obtiene o establece el tipo del grupo.
TaskAgentPublicKey	Representa la parte de clave pública de una clave asimétrica RSA.
TaskAgentReference
TaskAgentStatus	Obtiene el estado de conectividad actual del agente.
TaskAgentUpdate
TaskAgentUpdateReason
TaskAgentUpdateReasonType
TaskOrchestrationOwner
TaskResult

Demand

Nombre	Tipo	Description
name	string
value	string

DeploymentGroup

Grupo de implementación.

Nombre	Tipo	Description
description	string	Descripción del grupo de implementación.
id	integer	Identificador del grupo de implementación.
machineCount	integer	Número de destinos de implementación en el grupo de implementación.
machineTags	string[]	Lista de etiquetas únicas en todos los destinos de implementación del grupo de implementación.
machines	DeploymentMachine[]	Lista de destinos de implementación en el grupo de implementación.
name	string	Nombre del grupo de implementación.
pool	TaskAgentPoolReference	Grupo de implementación en el que se registran los agentes de implementación.
project	ProjectReference	Proyecto al que pertenece el grupo de implementación.

DeploymentGroupActionFilter

Obtenga el grupo de implementación solo si esta acción se puede realizar en él.

Nombre	Tipo	Description
manage	string	Solo los grupos de implementación para los que el autor de la llamada tiene permiso de administración .
none	string	Todos los grupos de implementación.
use	string	Solo los grupos de implementación para los que el autor de la llamada tiene permiso de uso .

DeploymentGroupExpands

Incluya estos detalles adicionales en el objeto devuelto.

Nombre	Tipo	Description
machines	string	En desuso: incluya todos los destinos de implementación.
none	string	No hay propiedades adicionales.
tags	string	Incluya una lista única de etiquetas en todos los destinos de implementación.

DeploymentMachine

Destino de implementación.

Nombre	Tipo	Description
agent	TaskAgent	Agente de implementación.
id	integer	Identificador de destino de implementación.
tags	string[]	Etiquetas del destino de implementación.

IdentityRef

Nombre	Tipo	Description
_links	ReferenceLinks	Este campo contiene cero o más vínculos interesantes sobre el tema del grafo. Estos vínculos se pueden invocar para obtener relaciones adicionales o información más detallada sobre este tema del grafo.
descriptor	string	El descriptor es la forma principal de hacer referencia al asunto del grafo mientras se ejecuta el sistema. Este campo identificará de forma única el mismo asunto del grafo en cuentas y organizaciones.
directoryAlias	string
displayName	string	Este es el nombre para mostrar no único del asunto del grafo. Para cambiar este campo, debe modificar su valor en el proveedor de origen.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Esta dirección URL es la ruta completa al recurso de origen de este tema del grafo.

JObject

Nombre	Tipo	Description
item	JToken
type	string

JToken

Nombre	Tipo	Description
first	JToken
hasValues	boolean
item	JToken
last	JToken
next	JToken
parent	string
path	string
previous	JToken
root	JToken
type	string

PackageVersion

Nombre	Tipo	Description
major	integer
minor	integer
patch	integer

ProjectReference

Nombre	Tipo	Description
id	string
name	string

PropertiesCollection

La clase representa un contenedor de propiedades como una colección de pares clave-valor. Se aceptan valores de todos los tipos primitivos (cualquier tipo con ) TypeCode != TypeCode.Objectexcepto .DBNull Los valores de tipo Byte[], Int32, Double, DateType y String conservan su tipo; otros primitivos se vuelven a ajustar como una cadena. Byte[] se esperaba como cadena codificada en base64.

Nombre	Tipo	Description
count	integer	Recuento de propiedades de la colección.
item	object
keys	string[]	Conjunto de claves de la colección.
values	string[]	Conjunto de valores de la colección.

ReferenceLinks

Clase que se va a representar una colección de vínculos de referencia de REST.

Nombre	Tipo	Description
links	object	Vista de lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura.

TaskAgent

Nombre	Tipo	Description
_links	ReferenceLinks	Clase que se va a representar una colección de vínculos de referencia de REST.
accessPoint	string	Obtiene el punto de acceso del agente.
assignedAgentCloudRequest	TaskAgentCloudRequest	Obtiene la solicitud en la nube del agente que está asociada actualmente a este agente.
assignedRequest	TaskAgentJobRequest	Obtiene la solicitud que está asignada actualmente a este agente.
authorization	TaskAgentAuthorization	Obtiene o establece la información de autorización de este agente.
createdOn	string	Obtiene la fecha en la que se creó este agente.
enabled	boolean	Obtiene o establece un valor que indica si este agente debe habilitarse o no para la ejecución del trabajo.
id	integer	Obtiene el identificador del agente.
lastCompletedRequest	TaskAgentJobRequest	Obtiene la última solicitud completada por este agente.
maxParallelism	integer	Obtiene o establece el paralelismo de trabajo máximo permitido en este host.
name	string	Obtiene el nombre del agente.
oSDescription	string	Obtiene el sistema operativo del agente.
pendingUpdate	TaskAgentUpdate	Obtiene la actualización pendiente para este agente.
properties	PropertiesCollection	La clase representa un contenedor de propiedades como una colección de pares clave-valor. Se aceptan valores de todos los tipos primitivos (cualquier tipo con ) TypeCode != TypeCode.Objectexcepto .DBNull Los valores de tipo Byte[], Int32, Double, DateType y String conservan su tipo; otros primitivos se vuelven a ajustar como una cadena. Byte[] se esperaba como cadena codificada en base64.
provisioningState	string	Obtiene o establece el estado de aprovisionamiento actual de este agente.
status	TaskAgentStatus	Obtiene el estado de conectividad actual del agente.
statusChangedOn	string	Obtiene la fecha en la que se produjo el último cambio de estado de conectividad.
systemCapabilities	object
userCapabilities	object
version	string	Obtiene la versión del agente.

TaskAgentAuthorization

Proporciona los datos necesarios para autorizar el agente mediante flujos de autenticación de OAuth 2.0.

Nombre	Tipo	Description
authorizationUrl	string	Obtiene o establece el punto de conexión utilizado para obtener tokens de acceso del servicio de token configurado.
clientId	string	Obtiene o establece el identificador de cliente de este agente.
publicKey	TaskAgentPublicKey	Obtiene o establece la clave pública usada para comprobar la identidad de este agente.

TaskAgentCloudRequest

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

TaskAgentDelaySource

Nombre	Tipo	Description
delays	string[]
taskAgent	TaskAgentReference

TaskAgentJobRequest

Nombre	Tipo	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

Nombre	Tipo	Description
id	integer
isHosted	boolean	Obtiene o establece un valor que indica si el servicio administra o no este grupo.
name	string
poolType	TaskAgentPoolType	Obtiene o establece el tipo del grupo.
scope	string
size	integer	Obtiene el tamaño actual del grupo.

TaskAgentPoolType

Obtiene o establece el tipo del grupo.

Nombre	Tipo	Description
automation	string
deployment	string

TaskAgentPublicKey

Representa la parte de clave pública de una clave asimétrica RSA.

Nombre	Tipo	Description
exponent	string[]	Obtiene o establece el exponente de la clave pública.
modulus	string[]	Obtiene o establece el módulo de la clave pública.

TaskAgentReference

Nombre	Tipo	Description
_links	ReferenceLinks	Clase que se va a representar una colección de vínculos de referencia de REST.
accessPoint	string	Obtiene el punto de acceso del agente.
enabled	boolean	Obtiene o establece un valor que indica si este agente debe habilitarse o no para la ejecución del trabajo.
id	integer	Obtiene el identificador del agente.
name	string	Obtiene el nombre del agente.
oSDescription	string	Obtiene el sistema operativo del agente.
provisioningState	string	Obtiene o establece el estado de aprovisionamiento actual de este agente.
status	TaskAgentStatus	Obtiene el estado de conectividad actual del agente.
version	string	Obtiene la versión del agente.

TaskAgentStatus

Obtiene el estado de conectividad actual del agente.

Nombre	Tipo	Description
offline	string
online	string

TaskAgentUpdate

Nombre	Tipo	Description
currentState	string	Estado actual de esta actualización del agente
reason	TaskAgentUpdateReason	Motivo de esta actualización del agente
requestTime	string	Obtiene la fecha en la que se solicitó esta actualización del agente.
requestedBy	IdentityRef	Identidad que solicita la actualización del agente
sourceVersion	PackageVersion	Obtiene o establece la versión del agente de origen de la actualización del agente.
targetVersion	PackageVersion	Obtiene o establece la versión del agente de destino de la actualización del agente.

TaskAgentUpdateReason

Nombre	Tipo	Description
code	TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

Nombre	Tipo	Description
manual	string
minAgentVersionRequired	string

TaskOrchestrationOwner

Nombre	Tipo	Description
_links	ReferenceLinks	Clase que se va a representar una colección de vínculos de referencia de REST.
id	integer
name	string

TaskResult

Nombre	Tipo	Description
abandoned	string
canceled	string
failed	string
skipped	string
succeeded	string
succeededWithIssues	string