Deploymentgroups - Get

  • Referenz
Service:
Task Agent
API Version:
5.0-preview.1

Rufen Sie eine Bereitstellungsgruppe nach ihrer ID ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
deploymentGroupId
 path True

integer

int32

ID der Bereitstellungsgruppe.
organization
 path True

string

Der Name der Azure DevOps-Organisation.
project
 path True

string

Projekt-ID oder Projektname
api-version
 query True

string

Version der zu verwendenden API. Dies sollte auf "5.0-preview.1" festgelegt werden, um diese Version der API zu verwenden.
$expand
 query

DeploymentGroupExpands

Fügen Sie diese zusätzlichen Details in das zurückgegebene Objekt ein.
actionFilter
 query

DeploymentGroupActionFilter

Rufen Sie die Bereitstellungsgruppe nur ab, wenn diese Aktion für sie ausgeführt werden kann.

Antworten

Name Typ Beschreibung
200 OK

DeploymentGroup

Erfolgreicher Vorgang

Sicherheit

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

Name Beschreibung
vso.machinegroup_manage Ermöglicht die Verwaltung von Bereitstellungsgruppen und Agentpools

Beispiele

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

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

Definitionen

Name Beschreibung
Demand
DeploymentGroup

Bereitstellungsgruppe.
DeploymentGroupActionFilter

Rufen Sie die Bereitstellungsgruppe nur ab, wenn diese Aktion für sie ausgeführt werden kann.
DeploymentGroupExpands

Fügen Sie diese zusätzlichen Details in das zurückgegebene Objekt ein.
DeploymentMachine

Bereitstellungsziel.
IdentityRef
JObject
JToken
PackageVersion
ProjectReference
PropertiesCollection

Die -Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüssel-Wert-Paaren dar. Werte aller primitiven Typen (jeder Typ mit einem TypeCode != TypeCode.Object) mit Ausnahme von DBNull werden akzeptiert. Werte vom Typ Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als String umgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.
ReferenceLinks

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
TaskAgent
TaskAgentAuthorization

Stellt Daten bereit, die für die Autorisierung des Agents mithilfe von OAuth 2.0-Authentifizierungsflows erforderlich sind.
TaskAgentCloudRequest
TaskAgentDelaySource
TaskAgentJobRequest
TaskAgentPoolReference
TaskAgentPoolType

Ruft den Typ des Pools ab oder legt den Typ des Pools fest.
TaskAgentPublicKey

Stellt den öffentlichen Schlüsselteil eines asymmetrischen RSA-Schlüssels dar.
TaskAgentReference
TaskAgentStatus

Ruft die aktuelle Konnektivität status des Agents ab.
TaskAgentUpdate
TaskAgentUpdateReason
TaskAgentUpdateReasonType
TaskOrchestrationOwner
TaskResult

Demand

Name Typ Beschreibung
name

string

value

string

DeploymentGroup

Bereitstellungsgruppe.

Name Typ Beschreibung
description

string

Beschreibung der Bereitstellungsgruppe.
id

integer

Bereitstellungsgruppenbezeichner.
machineCount

integer

Anzahl der Bereitstellungsziele in der Bereitstellungsgruppe.
machineTags

string[]

Liste der eindeutigen Tags für alle Bereitstellungsziele in der Bereitstellungsgruppe.
machines

DeploymentMachine[]

Liste der Bereitstellungsziele in der Bereitstellungsgruppe.
name

string

Name der Bereitstellungsgruppe.
pool

TaskAgentPoolReference

Bereitstellungspool, in dem Bereitstellungs-Agents registriert sind.
project

ProjectReference

Projekt, zu dem die Bereitstellungsgruppe gehört.

DeploymentGroupActionFilter

Rufen Sie die Bereitstellungsgruppe nur ab, wenn diese Aktion für sie ausgeführt werden kann.

Name Typ Beschreibung
manage

string

Nur Bereitstellungsgruppen, für die der Aufrufer über die Berechtigung "Verwalten" verfügt.
none

string

Alle Bereitstellungsgruppen.
use

string

Nur Bereitstellungsgruppen, für die der Aufrufer über die Verwendungsberechtigung verfügt.

DeploymentGroupExpands

Fügen Sie diese zusätzlichen Details in das zurückgegebene Objekt ein.

Name Typ Beschreibung
machines

string

Veraltet: Schließen Sie alle Bereitstellungsziele ein.
none

string

Keine zusätzlichen Eigenschaften.
tags

string

Schließen Sie eine eindeutige Liste von Tags für alle Bereitstellungsziele ein.

DeploymentMachine

Bereitstellungsziel.

Name Typ Beschreibung
agent

TaskAgent

Bereitstellungs-Agent.
id

integer

Bezeichner des Bereitstellungsziels.
tags

string[]

Tags des Bereitstellungsziels.

IdentityRef

Name Typ Beschreibung
_links

ReferenceLinks

Dieses Feld enthält null oder interessantere Links zum Diagrammthema. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Graph-Thema zu erhalten.
descriptor

string

Der Deskriptor ist die primäre Möglichkeit, auf den Graphengegenstand zu verweisen, während das System ausgeführt wird. In diesem Feld wird derselbe Graph-Betreff sowohl für Konten als auch für Organisationen eindeutig identifiziert.
directoryAlias

string

displayName

string

Dies ist der nicht eindeutige Anzeigename des Diagrammsubjekts. Um dieses Feld zu ändern, müssen Sie seinen Wert im Quellanbieter ändern.
id

string

imageUrl

string

inactive

boolean

isAadIdentity

boolean

isContainer

boolean

isDeletedInOrigin

boolean

profileUrl

string

uniqueName

string

url

string

Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

JObject

Name Typ Beschreibung
item

JToken

type

string

JToken

Name Typ Beschreibung
first

JToken

hasValues

boolean

item

JToken

last

JToken

next

JToken

parent

string

path

string

previous

JToken

root

JToken

type

string

PackageVersion

Name Typ Beschreibung
major

integer

minor

integer

patch

integer

ProjectReference

Name Typ Beschreibung
id

string

name

string

PropertiesCollection

Die -Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüssel-Wert-Paaren dar. Werte aller primitiven Typen (jeder Typ mit einem TypeCode != TypeCode.Object) mit Ausnahme von DBNull werden akzeptiert. Werte vom Typ Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als String umgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.

Name Typ Beschreibung
count

integer

Die Anzahl der Eigenschaften in der Auflistung.
item

object

keys

string[]

Der Schlüsselsatz in der Auflistung.
values

string[]

Der Wertsatz in der Auflistung.

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name Typ Beschreibung
links

object

Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

TaskAgent

Name Typ Beschreibung
_links

ReferenceLinks

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
accessPoint

string

Ruft den Zugriffspunkt des Agents ab.
assignedAgentCloudRequest

TaskAgentCloudRequest

Ruft die Agent-Cloudanforderung ab, die derzeit diesem Agent zugeordnet ist.
assignedRequest

TaskAgentJobRequest

Ruft die Anforderung ab, die diesem Agent derzeit zugewiesen ist.
authorization

TaskAgentAuthorization

Ruft die Autorisierungsinformationen für diesen Agent ab oder legt sie fest.
createdOn

string

Ruft das Datum ab, an dem dieser Agent erstellt wurde.
enabled

boolean

Ruft einen Wert ab, der angibt, ob dieser Agent für die Auftragsausführung aktiviert werden soll, oder legt diesen fest.
id

integer

Ruft den Bezeichner des Agents ab.
lastCompletedRequest

TaskAgentJobRequest

Ruft die letzte Anforderung ab, die von diesem Agent abgeschlossen wurde.
maxParallelism

integer

Ruft die maximale Auftragsparallelität ab, die auf diesem Host zulässig ist, oder legt diese fest.
name

string

Ruft den Namen des Agents ab.
oSDescription

string

Ruft das Betriebssystem des Agents ab.
pendingUpdate

TaskAgentUpdate

Ruft das ausstehende Update für diesen Agent ab.
properties

PropertiesCollection

Die -Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüssel-Wert-Paaren dar. Werte aller primitiven Typen (jeder Typ mit einem TypeCode != TypeCode.Object) mit Ausnahme von DBNull werden akzeptiert. Werte vom Typ Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als String umgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.
provisioningState

string

Ruft den aktuellen Bereitstellungsstatus dieses Agents ab oder legt diesen fest.
status

TaskAgentStatus

Ruft die aktuelle Konnektivität status des Agents ab.
statusChangedOn

string

Ruft das Datum ab, an dem die letzte Konnektivität status Änderung aufgetreten ist.
systemCapabilities

object

userCapabilities

object

version

string

Ruft die Version des Agents ab.

TaskAgentAuthorization

Stellt Daten bereit, die für die Autorisierung des Agents mithilfe von OAuth 2.0-Authentifizierungsflows erforderlich sind.

Name Typ Beschreibung
authorizationUrl

string

Ruft den Endpunkt ab, der zum Abrufen von Zugriffstoken vom konfigurierten Tokendienst verwendet wird, oder legt diesen fest.
clientId

string

Ruft den Clientbezeichner für diesen Agent ab oder legt diesen fest.
publicKey

TaskAgentPublicKey

Ruft den öffentlichen Schlüssel ab, der zum Überprüfen der Identität dieses Agents verwendet wird, oder legt diesen fest.

TaskAgentCloudRequest

Name Typ Beschreibung
agent

TaskAgentReference

agentCloudId

integer

agentConnectedTime

string

agentData

JObject

agentSpecification

JObject

pool

TaskAgentPoolReference

provisionRequestTime

string

provisionedTime

string

releaseRequestTime

string

requestId

string

TaskAgentDelaySource

Name Typ Beschreibung
delays

string[]

taskAgent

TaskAgentReference

TaskAgentJobRequest

Name Typ Beschreibung
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

Name Typ Beschreibung
id

integer

isHosted

boolean

Ruft einen Wert ab, der angibt, ob dieser Pool vom Dienst verwaltet wird, oder legt diesen fest.
name

string

poolType

TaskAgentPoolType

Ruft den Typ des Pools ab oder legt den Typ des Pools fest.
scope

string

size

integer

Ruft die aktuelle Größe des Pools ab.

TaskAgentPoolType

Ruft den Typ des Pools ab oder legt den Typ des Pools fest.

Name Typ Beschreibung
automation

string

deployment

string

TaskAgentPublicKey

Stellt den öffentlichen Schlüsselteil eines asymmetrischen RSA-Schlüssels dar.

Name Typ Beschreibung
exponent

string[]

Ruft den Exponenten für den öffentlichen Schlüssel ab oder legt diese fest.
modulus

string[]

Ruft das Modul für den öffentlichen Schlüssel ab oder legt dieses fest.

TaskAgentReference

Name Typ Beschreibung
_links

ReferenceLinks

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
accessPoint

string

Ruft den Zugriffspunkt des Agents ab.
enabled

boolean

Ruft einen Wert ab, der angibt, ob dieser Agent für die Auftragsausführung aktiviert werden soll, oder legt diesen fest.
id

integer

Ruft den Bezeichner des Agents ab.
name

string

Ruft den Namen des Agents ab.
oSDescription

string

Ruft das Betriebssystem des Agents ab.
provisioningState

string

Ruft den aktuellen Bereitstellungsstatus dieses Agents ab oder legt diesen fest.
status

TaskAgentStatus

Ruft die aktuelle Konnektivität status des Agents ab.
version

string

Ruft die Version des Agents ab.

TaskAgentStatus

Ruft die aktuelle Konnektivität status des Agents ab.

Name Typ Beschreibung
offline

string

online

string

TaskAgentUpdate

Name Typ Beschreibung
currentState

string

Der aktuelle Status dieses Agentupdates
reason

TaskAgentUpdateReason

Der Grund für dieses Agent-Update
requestTime

string

Ruft das Datum ab, an dem dieses Agent-Update angefordert wurde.
requestedBy

IdentityRef

Die Identität, die das Agentupdate anfordern
sourceVersion

PackageVersion

Ruft die Quell-Agent-Version des Agent-Updates ab oder legt sie fest.
targetVersion

PackageVersion

Ruft die Ziel-Agent-Version des Agentupdates ab oder legt sie fest.

TaskAgentUpdateReason

Name Typ Beschreibung
code

TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

Name Typ Beschreibung
manual

string

minAgentVersionRequired

string

TaskOrchestrationOwner

Name Typ Beschreibung
_links

ReferenceLinks

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
id

integer

name

string

TaskResult

Name Typ Beschreibung
abandoned

string

canceled

string

failed

string

skipped

string

succeeded

string

succeededWithIssues

string