Deploymentgroups - Get

  • Riferimento
Servizio:
Distributed Task
Versione API:
7.1

Ottenere un gruppo di distribuzione in base al relativo ID.

GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?api-version=7.1
Con parametri facoltativi: 
GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?actionFilter={actionFilter}&$expand={$expand}&api-version=7.1

Parametri dell'URI

Nome In Necessario Tipo Descrizione
deploymentGroupId
 path True

integer (int32)

ID del gruppo di distribuzione.
organization
 path True

string

Nome dell'organizzazione di Azure DevOps.
project
 path True

string

ID progetto o nome progetto
api-version
 query True

string

Versione dell'API da usare. Deve essere impostato su '7.1' per usare questa versione dell'API.
$expand
 query

DeploymentGroupExpands

Includere questi dettagli aggiuntivi nell'oggetto restituito.
actionFilter
 query

DeploymentGroupActionFilter

Ottenere il gruppo di distribuzione solo se questa azione può essere eseguita su di essa.

Risposte

Nome Tipo Descrizione
200 OK

DeploymentGroup

operazione riuscita

Sicurezza

oauth2

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL token: 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

Ambiti

Nome Descrizione
vso.machinegroup_manage Consente di gestire pool di agenti e gruppi di distribuzione

Esempio

Get a deployment group by its ID

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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
  }
}

Definizioni

Nome Descrizione
Demand
DeploymentGroup

Gruppo di distribuzione.
DeploymentGroupActionFilter

Ottenere il gruppo di distribuzione solo se questa azione può essere eseguita su di essa.
DeploymentGroupExpands

Includere questi dettagli aggiuntivi nell'oggetto restituito.
DeploymentMachine

Destinazione di distribuzione.
IdentityRef
JObject

Rappresenta un oggetto JSON.
JToken

Rappresenta un token JSON astratto.
PackageVersion
ProjectReference
PropertiesCollection

La classe rappresenta un contenitore di proprietà come raccolta di coppie chiave-valore. I valori di tutti i tipi primitivi (qualsiasi tipo con un TypeCode != TypeCode.Object) ad eccezione di DBNull vengono accettati. I valori di tipo Byte[], Int32, Double, DateType e String mantengono il tipo, le altre primitive vengono ricreate come String. Byte[] previsto come stringa con codifica Base64.
ReferenceLinks

Classe per rappresentare una raccolta di collegamenti di riferimento REST.
TaskAgent

Agente attività.
TaskAgentAuthorization

Fornisce i dati necessari per autorizzare l'agente usando i flussi di autenticazione OAuth 2.0.
TaskAgentCloudRequest
TaskAgentJobRequest

Richiesta di processo per un agente.
TaskAgentPoolOptions

Impostazioni e dettagli aggiuntivi del pool
TaskAgentPoolReference
TaskAgentPoolType

Ottiene o imposta il tipo del pool
TaskAgentPublicKey

Rappresenta la parte chiave pubblica di una chiave asimmetrica RSA.
TaskAgentReference

Riferimento a un agente.
TaskAgentStatus

Indica se l'agente è online o meno.
TaskAgentUpdate

Dettagli su un aggiornamento dell'agente.
TaskAgentUpdateReason
TaskAgentUpdateReasonType
TaskOrchestrationOwner
TaskResult

Risultato di questa richiesta.

Demand

Object
Nome Tipo Descrizione
name

string

value

string

DeploymentGroup

Object

Gruppo di distribuzione.

Nome Tipo Descrizione
description

string

Descrizione del gruppo di distribuzione.
id

integer (int32)

Identificatore del gruppo di distribuzione.
machineCount

integer (int32)

Numero di destinazioni di distribuzione nel gruppo di distribuzione.
machineTags

string[]

Elenco di tag univoci in tutte le destinazioni di distribuzione nel gruppo di distribuzione.
machines

DeploymentMachine[]

Elenco delle destinazioni di distribuzione nel gruppo di distribuzione.
name

string

Nome del gruppo di distribuzione.
pool

TaskAgentPoolReference

Pool di distribuzione in cui vengono registrati gli agenti di distribuzione.
project

ProjectReference

Progetto a cui appartiene il gruppo di distribuzione.

DeploymentGroupActionFilter

Enumerazione

Ottenere il gruppo di distribuzione solo se questa azione può essere eseguita su di essa.

Valore Descrizione
manage

Solo i gruppi di distribuzione per i quali il chiamante ha gestire autorizzazione.
none

Tutti i gruppi di distribuzione.
use

Solo i gruppi di distribuzione per i quali il chiamante ha l'autorizzazione.

DeploymentGroupExpands

Enumerazione

Includere questi dettagli aggiuntivi nell'oggetto restituito.

Valore Descrizione
machines

Deprecato: includere tutte le destinazioni di distribuzione.
none

Nessuna proprietà aggiuntiva.
tags

Includere un elenco univoco di tag in tutte le destinazioni di distribuzione.

DeploymentMachine

Object

Destinazione di distribuzione.

Nome Tipo Descrizione
agent

TaskAgent

Agente di distribuzione.
id

integer (int32)

Identificatore di destinazione della distribuzione.
properties

PropertiesCollection

Proprietà della destinazione di distribuzione.
tags

string[]

Tag della destinazione di distribuzione.

IdentityRef

Object
Nome Tipo Descrizione
_links

ReferenceLinks

Questo campo contiene zero o più collegamenti interessanti sull'oggetto grafico. Questi collegamenti possono essere richiamati per ottenere relazioni aggiuntive o informazioni più dettagliate sull'oggetto grafico.
descriptor

string

Il descrittore è il modo principale per fare riferimento all'oggetto del grafo mentre il sistema è in esecuzione. Questo campo identificherà in modo univoco lo stesso soggetto del grafico in account e organizzazioni.
directoryAlias

string

Deprecato: può essere recuperato eseguendo una query sull'utente graph a cui si fa riferimento nella voce "self" del dizionario IdentityRef "_links"
displayName

string

Si tratta del nome visualizzato non univoco dell'oggetto del grafico. Per modificare questo campo, è necessario modificarne il valore nel provider di origine.
id

string

imageUrl

string

Deprecato : disponibile nella voce "avatar" del dizionario IdentityRef "_links"
inactive

boolean

Deprecato: può essere recuperato eseguendo una query sullo stato di appartenenza graph a cui si fa riferimento nella voce "membershipState" del dizionario "_links" GraphUser
isAadIdentity

boolean

Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer

boolean

Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descriptor.IsGroupType)
isDeletedInOrigin

boolean

profileUrl

string

Deprecato: non in uso nella maggior parte delle implementazioni preesistenti di ToIdentityRef
uniqueName

string

Deprecato: usare invece Domain+PrincipalName
url

string

Questo URL è la route completa alla risorsa di origine di questo oggetto grafico.

JObject

Object

Rappresenta un oggetto JSON.

Nome Tipo Descrizione
item

JToken

Rappresenta un token JSON astratto.
type

string (JTokenType)

Ottiene il tipo di nodo per questo JToken.

JToken

Object

Rappresenta un token JSON astratto.

Nome Tipo Descrizione
first

JToken

Ottenere il primo token figlio di questo token.
hasValues

boolean

Ottiene un valore che indica se il token dispone di token figlio.
item

JToken

Rappresenta un token JSON astratto.
last

JToken

Ottenere l'ultimo token figlio di questo token.
next

JToken

Ottiene il token di pari livello successivo di questo nodo.
parent

string (JContainer)

Ottiene o imposta l'elemento padre.
path

string

Ottiene il percorso del token JSON.
previous

JToken

Ottiene il token di pari livello precedente di questo nodo.
root

JToken

Ottiene il JToken radice di questo JToken.
type

string (JTokenType)

Ottiene il tipo di nodo per questo JToken.

PackageVersion

Object
Nome Tipo Descrizione
major

integer (int32)

minor

integer (int32)

patch

integer (int32)

ProjectReference

Object
Nome Tipo Descrizione
id

string (uuid)

name

string

PropertiesCollection

Object

La classe rappresenta un contenitore di proprietà come raccolta di coppie chiave-valore. I valori di tutti i tipi primitivi (qualsiasi tipo con un TypeCode != TypeCode.Object) ad eccezione di DBNull vengono accettati. I valori di tipo Byte[], Int32, Double, DateType e String mantengono il tipo, le altre primitive vengono ricreate come String. Byte[] previsto come stringa con codifica Base64.

Nome Tipo Descrizione
count

integer (int32)

Conteggio delle proprietà nell'insieme.
item

object

keys

string[]

Set di chiavi nella raccolta.
values

string[]

Set di valori nell'insieme.
Object

Classe per rappresentare una raccolta di collegamenti di riferimento REST.

Nome Tipo Descrizione
links

object

Visualizzazione di sola lettura dei collegamenti. Poiché i collegamenti di riferimento sono di sola lettura, è consigliabile esporli solo come di sola lettura.

TaskAgent

Object

Agente attività.

Nome Tipo Descrizione
_links

ReferenceLinks

Classe per rappresentare una raccolta di collegamenti di riferimento REST.
accessPoint

string

Punto di accesso dell'agente.
assignedAgentCloudRequest

TaskAgentCloudRequest

Richiesta cloud agente attualmente associata a questo agente.
assignedRequest

TaskAgentJobRequest

Richiesta attualmente assegnata all'agente.
authorization

TaskAgentAuthorization

Informazioni di autorizzazione per questo agente.
createdOn

string (date-time)

Data di creazione dell'agente.
enabled

boolean

Indica se l'agente deve eseguire o meno i processi.
id

integer (int32)

Identificatore dell'agente.
lastCompletedRequest

TaskAgentJobRequest

Ultima richiesta completata dall'agente.
maxParallelism

integer (int32)

Parallelismo massimo consentito per questo agente.
name

string

Nome dell'agente.
osDescription

string

Sistema operativo agente.
pendingUpdate

TaskAgentUpdate

Aggiornamento in sospeso per questo agente.
properties

PropertiesCollection

La classe rappresenta un contenitore di proprietà come raccolta di coppie chiave-valore. I valori di tutti i tipi primitivi (qualsiasi tipo con un TypeCode != TypeCode.Object) ad eccezione di DBNull vengono accettati. I valori di tipo Byte[], Int32, Double, DateType e String mantengono il tipo, le altre primitive vengono ricreate come String. Byte[] previsto come stringa con codifica Base64.
provisioningState

string

Stato di provisioning dell'agente.
status

TaskAgentStatus

Indica se l'agente è online o meno.
statusChangedOn

string (date-time)

Data in cui si è verificata l'ultima modifica dello stato della connettività.
systemCapabilities

object

Funzionalità definite dal sistema supportate dall'host dell'agente. Avviso: per impostare le funzionalità usare il metodo PUT, PUT sovrascriverà completamente le funzionalità esistenti.
userCapabilities

object

Funzionalità definite dall'utente supportate dall'host dell'agente. Avviso: per impostare le funzionalità usare il metodo PUT, PUT sovrascriverà completamente le funzionalità esistenti.
version

string

Versione dell'agente.

TaskAgentAuthorization

Object

Fornisce i dati necessari per autorizzare l'agente usando i flussi di autenticazione OAuth 2.0.

Nome Tipo Descrizione
authorizationUrl

string

Endpoint usato per ottenere i token di accesso dal servizio token configurato.
clientId

string (uuid)

Identificatore client per questo agente.
publicKey

TaskAgentPublicKey

Chiave pubblica usata per verificare l'identità di questo agente.

TaskAgentCloudRequest

Object
Nome Tipo Descrizione
agent

TaskAgentReference

Riferimento a un agente.
agentCloudId

integer (int32)

agentConnectedTime

string (date-time)

agentData

JObject

Rappresenta un oggetto JSON.
agentSpecification

JObject

Rappresenta un oggetto JSON.
pool

TaskAgentPoolReference

provisionRequestTime

string (date-time)

provisionedTime

string (date-time)

releaseRequestTime

string (date-time)

requestId

string (uuid)

TaskAgentJobRequest

Object

Richiesta di processo per un agente.

Nome Tipo Descrizione
agentSpecification

JObject

Rappresenta un oggetto JSON.
assignTime

string (date-time)

Data/ora in cui è stata assegnata la richiesta.
data

object

Dati aggiuntivi sulla richiesta.
definition

TaskOrchestrationOwner

Definizione della pipeline associata a questa richiesta
demands

Demand[]

Elenco di richieste necessarie per soddisfare questa richiesta.
finishTime

string (date-time)

Data/ora di fine della richiesta.
hostId

string (uuid)

Host che ha attivato questa richiesta.
jobId

string (uuid)

ID del processo risultante da questa richiesta.
jobName

string

Nome del processo risultante dalla richiesta.
lockedUntil

string (date-time)

Scadenza per il rinnovo del blocco da parte dell'agente.
matchedAgents

TaskAgentReference[]

Riferimento a un agente.
matchesAllAgentsInPool

boolean

orchestrationId

string

owner

TaskOrchestrationOwner

Pipeline associata a questa richiesta
planGroup

string

planId

string (uuid)

ID interno per il piano di orchestrazione connesso a questa richiesta.
planType

string

Dettagli interni che rappresentano il tipo di piano di orchestrazione.
poolId

integer (int32)

ID del pool di destinazione della richiesta
priority

integer (int32)

queueId

integer (int32)

ID della coda di destinazione della richiesta
queueTime

string (date-time)

Data/ora in cui è stata accodata la richiesta.
receiveTime

string (date-time)

Data/ora in cui la richiesta è stata ricevuta da un agente.
requestId

integer (int64)

ID della richiesta.
reservedAgent

TaskAgentReference

Agente allocato per questa richiesta.
result

TaskResult

Risultato di questa richiesta.
scopeId

string (uuid)

Ambito della pipeline; corrisponde all'ID del progetto.
serviceOwner

string (uuid)

Servizio proprietario di questa richiesta.
statusMessage

string

userDelayed

boolean

TaskAgentPoolOptions

Enumerazione

Impostazioni e dettagli aggiuntivi del pool

Valore Descrizione
elasticPool

TaskAgentPool supportato dal servizio pool elastico
none
preserveAgentOnJobFailure

Impostare su true se gli agenti vengono mantenuti per l'indagine dopo un errore taskAgentJobRequest
singleUseAgents

Impostare su true se gli agenti vengono ricreati dopo ogni TaskAgentJobRequest

TaskAgentPoolReference

Object
Nome Tipo Descrizione
id

integer (int32)

isHosted

boolean

Ottiene o imposta un valore che indica se il pool è gestito dal servizio o meno.
isLegacy

boolean

Determina se il pool è legacy.
name

string

options

TaskAgentPoolOptions

Impostazioni e dettagli aggiuntivi del pool
poolType

TaskAgentPoolType

Ottiene o imposta il tipo del pool
scope

string (uuid)

size

integer (int32)

Ottiene le dimensioni correnti del pool.

TaskAgentPoolType

Enumerazione

Ottiene o imposta il tipo del pool

Valore Descrizione
automation

Un pool tipico di agenti attività
deployment

Un pool di distribuzione

TaskAgentPublicKey

Object

Rappresenta la parte chiave pubblica di una chiave asimmetrica RSA.

Nome Tipo Descrizione
exponent

string[] (byte)

Ottiene o imposta l'esponente per la chiave pubblica.
modulus

string[] (byte)

Ottiene o imposta il modulo per la chiave pubblica.

TaskAgentReference

Object

Riferimento a un agente.

Nome Tipo Descrizione
_links

ReferenceLinks

Classe per rappresentare una raccolta di collegamenti di riferimento REST.
accessPoint

string

Punto di accesso dell'agente.
enabled

boolean

Indica se l'agente deve eseguire o meno i processi.
id

integer (int32)

Identificatore dell'agente.
name

string

Nome dell'agente.
osDescription

string

Sistema operativo agente.
provisioningState

string

Stato di provisioning dell'agente.
status

TaskAgentStatus

Indica se l'agente è online o meno.
version

string

Versione dell'agente.

TaskAgentStatus

Enumerazione

Indica se l'agente è online o meno.

Valore Descrizione
offline
online

TaskAgentUpdate

Object

Dettagli su un aggiornamento dell'agente.

Nome Tipo Descrizione
currentState

string

Stato corrente dell'aggiornamento dell'agente.
reason

TaskAgentUpdateReason

Motivo dell'aggiornamento.
requestTime

string (date-time)

Data in cui è stato richiesto l'aggiornamento.
requestedBy

IdentityRef

Identità che ha richiesto questo aggiornamento.
sourceVersion

PackageVersion

Versione dell'agente di origine dell'aggiornamento.
targetVersion

PackageVersion

Versione dell'agente di destinazione dell'aggiornamento.

TaskAgentUpdateReason

Object
Nome Tipo Descrizione
code

TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

Enumerazione
Valore Descrizione
downgrade
manual
minAgentVersionRequired

TaskOrchestrationOwner

Object
Nome Tipo Descrizione
_links

ReferenceLinks

Classe per rappresentare una raccolta di collegamenti di riferimento REST.
id

integer (int32)

name

string

TaskResult

Enumerazione

Risultato di questa richiesta.

Valore Descrizione
abandoned
canceled
failed
skipped
succeeded
succeededWithIssues