Deploymentgroups - Get

Service:

Task Agent

API Version:

5.0-preview.1

ID로 배포 그룹을 가져옵니다.

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 매개 변수

Name	In(다음 안에)	필수	형식	Description
deploymentGroupId	path	True	integer int32	배포 그룹의 ID입니다.
organization	path	True	string	Azure DevOps 조직의 이름입니다.
project	path	True	string	프로젝트 ID 또는 프로젝트 이름
api-version	query	True	string	사용할 API의 버전입니다. 이 버전의 API를 사용하려면 '5.0-preview.1'로 설정해야 합니다.
$expand	query		DeploymentGroupExpands	반환된 개체에 이러한 추가 세부 정보를 포함합니다.
actionFilter	query		DeploymentGroupActionFilter	이 작업을 수행할 수 있는 경우에만 배포 그룹을 가져옵니다.

응답

Name	형식	Description
200 OK	DeploymentGroup	성공적인 작업

보안

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	Description
vso.machinegroup_manage	배포 그룹 및 에이전트 풀을 관리하는 기능을 제공합니다.

예제

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

정의

Name	Description
Demand
DeploymentGroup	배포 그룹.
DeploymentGroupActionFilter	이 작업을 수행할 수 있는 경우에만 배포 그룹을 가져옵니다.
DeploymentGroupExpands	반환된 개체에 이러한 추가 세부 정보를 포함합니다.
DeploymentMachine	배포 대상입니다.
IdentityRef
JObject
JToken
PackageVersion
ProjectReference
PropertiesCollection	클래스는 키-값 쌍의 컬렉션으로 속성 모음을 나타냅니다. 를 제외한 모든 기본 형식의 값(을 TypeCode != TypeCode.Object제외한 DBNull 모든 형식)이 허용됩니다. Byte[], Int32, Double, DateType 및 String 형식의 값은 해당 형식을 유지하며 다른 기본 형식은 String으로 다시 조정됩니다. byte[] base64로 인코딩된 문자열로 예상됩니다.
ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
TaskAgent
TaskAgentAuthorization	OAuth 2.0 인증 흐름을 사용하여 에이전트에 권한을 부여하는 데 필요한 데이터를 제공합니다.
TaskAgentCloudRequest
TaskAgentDelaySource
TaskAgentJobRequest
TaskAgentPoolReference
TaskAgentPoolType	풀의 형식을 가져오거나 설정합니다.
TaskAgentPublicKey	RSA 비대칭 키의 공개 키 부분을 나타냅니다.
TaskAgentReference
TaskAgentStatus	에이전트의 현재 연결 상태 가져옵니다.
TaskAgentUpdate
TaskAgentUpdateReason
TaskAgentUpdateReasonType
TaskOrchestrationOwner
TaskResult

Demand

Name	형식	Description
name	string
value	string

DeploymentGroup

배포 그룹.

Name	형식	Description
description	string	배포 그룹에 대한 설명입니다.
id	integer	배포 그룹 식별자입니다.
machineCount	integer	배포 그룹의 배포 대상 수입니다.
machineTags	string[]	배포 그룹의 모든 배포 대상에서 고유한 태그 목록입니다.
machines	DeploymentMachine[]	배포 그룹의 배포 대상 목록입니다.
name	string	배포 그룹의 이름입니다.
pool	TaskAgentPoolReference	배포 에이전트가 등록된 배포 풀입니다.
project	ProjectReference	배포 그룹이 속한 프로젝트입니다.

DeploymentGroupActionFilter

이 작업을 수행할 수 있는 경우에만 배포 그룹을 가져옵니다.

Name	형식	Description
manage	string	호출자에게 관리 권한이 있는 배포 그룹만 있습니다.
none	string	모든 배포 그룹.
use	string	호출자에게 사용 권한이 있는 배포 그룹만 해당 합니다.

DeploymentGroupExpands

반환된 개체에 이러한 추가 세부 정보를 포함합니다.

Name	형식	Description
machines	string	사용되지 않음: 모든 배포 대상을 포함합니다.
none	string	추가 속성이 없습니다.
tags	string	모든 배포 대상에 고유한 태그 목록을 포함합니다.

DeploymentMachine

배포 대상입니다.

Name	형식	Description
agent	TaskAgent	배포 에이전트.
id	integer	배포 대상 식별자입니다.
tags	string[]	배포 대상의 태그입니다.

IdentityRef

Name	형식	Description
_links	ReferenceLinks	이 필드에는 그래프 제목에 대한 0개 이상의 흥미로운 링크가 포함되어 있습니다. 이러한 링크를 호출하여 이 그래프 제목에 대한 추가 관계 또는 자세한 정보를 얻을 수 있습니다.
descriptor	string	설명자는 시스템이 실행되는 동안 그래프 제목을 참조하는 기본 방법입니다. 이 필드는 계정과 조직 모두에서 동일한 그래프 제목을 고유하게 식별합니다.
directoryAlias	string
displayName	string	그래프 주체의 고유하지 않은 표시 이름입니다. 이 필드를 변경하려면 원본 공급자에서 해당 값을 변경해야 합니다.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	이 URL은 이 그래프 주체의 원본 리소스에 대한 전체 경로입니다.

JObject

Name	형식	Description
item	JToken
type	string

JToken

Name	형식	Description
first	JToken
hasValues	boolean
item	JToken
last	JToken
next	JToken
parent	string
path	string
previous	JToken
root	JToken
type	string

PackageVersion

Name	형식	Description
major	integer
minor	integer
patch	integer

ProjectReference

Name	형식	Description
id	string
name	string

PropertiesCollection

클래스는 키-값 쌍의 컬렉션으로 속성 모음을 나타냅니다. 를 제외한 모든 기본 형식의 값(을 TypeCode != TypeCode.Object제외한 DBNull 모든 형식)이 허용됩니다. Byte[], Int32, Double, DateType 및 String 형식의 값은 해당 형식을 유지하며 다른 기본 형식은 String으로 다시 조정됩니다. byte[] base64로 인코딩된 문자열로 예상됩니다.

Name	형식	Description
count	integer	컬렉션의 속성 수입니다.
item	object
keys	string[]	컬렉션의 키 집합입니다.
values	string[]	컬렉션의 값 집합입니다.

ReferenceLinks

REST 참조 링크의 컬렉션을 나타내는 클래스입니다.

Name	형식	Description
links	object	링크의 읽기 전용 보기입니다. 참조 링크는 읽기 전용이므로 읽기 전용으로만 노출하려고 합니다.

TaskAgent

Name	형식	Description
_links	ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
accessPoint	string	에이전트의 액세스 지점을 가져옵니다.
assignedAgentCloudRequest	TaskAgentCloudRequest	현재 이 에이전트와 연결된 에이전트 클라우드 요청을 가져옵니다.
assignedRequest	TaskAgentJobRequest	현재 이 에이전트에 할당된 요청을 가져옵니다.
authorization	TaskAgentAuthorization	이 에이전트에 대한 권한 부여 정보를 가져오거나 설정합니다.
createdOn	string	이 에이전트가 만들어진 날짜를 가져옵니다.
enabled	boolean	이 에이전트를 작업 실행에 사용하도록 설정해야 하는지 여부를 나타내는 값을 가져오거나 설정합니다.
id	integer	에이전트의 식별자를 가져옵니다.
lastCompletedRequest	TaskAgentJobRequest	이 에이전트가 완료한 마지막 요청을 가져옵니다.
maxParallelism	integer	이 호스트에 허용되는 최대 작업 병렬 처리를 가져오거나 설정합니다.
name	string	에이전트의 이름을 가져옵니다.
oSDescription	string	에이전트의 OS를 가져옵니다.
pendingUpdate	TaskAgentUpdate	이 에이전트에 대한 보류 중인 업데이트를 가져옵니다.
properties	PropertiesCollection	클래스는 키-값 쌍의 컬렉션으로 속성 모음을 나타냅니다. 를 제외한 모든 기본 형식의 값(을 TypeCode != TypeCode.Object제외한 DBNull 모든 형식)이 허용됩니다. Byte[], Int32, Double, DateType 및 String 형식의 값은 해당 형식을 유지하며 다른 기본 형식은 String으로 다시 조정됩니다. byte[] base64로 인코딩된 문자열로 예상됩니다.
provisioningState	string	이 에이전트의 현재 프로비전 상태를 가져오거나 설정합니다.
status	TaskAgentStatus	에이전트의 현재 연결 상태 가져옵니다.
statusChangedOn	string	마지막 연결 상태 변경이 발생한 날짜를 가져옵니다.
systemCapabilities	object
userCapabilities	object
version	string	에이전트의 버전을 가져옵니다.

TaskAgentAuthorization

OAuth 2.0 인증 흐름을 사용하여 에이전트에 권한을 부여하는 데 필요한 데이터를 제공합니다.

Name	형식	Description
authorizationUrl	string	구성된 토큰 서비스에서 액세스 토큰을 가져오는 데 사용되는 엔드포인트를 가져오거나 설정합니다.
clientId	string	이 에이전트의 클라이언트 식별자를 가져오거나 설정합니다.
publicKey	TaskAgentPublicKey	이 에이전트의 ID를 확인하는 데 사용되는 공개 키를 가져오거나 설정합니다.

TaskAgentCloudRequest

Name	형식	Description
agent	TaskAgentReference
agentCloudId	integer
agentConnectedTime	string
agentData	JObject
agentSpecification	JObject
pool	TaskAgentPoolReference
provisionRequestTime	string
provisionedTime	string
releaseRequestTime	string
requestId	string

TaskAgentDelaySource

Name	형식	Description
delays	string[]
taskAgent	TaskAgentReference

TaskAgentJobRequest

Name	형식	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

Name	형식	Description
id	integer
isHosted	boolean	이 풀이 서비스에서 관리되는지 여부를 나타내는 값을 가져오거나 설정합니다.
name	string
poolType	TaskAgentPoolType	풀의 형식을 가져오거나 설정합니다.
scope	string
size	integer	풀의 현재 크기를 가져옵니다.

TaskAgentPoolType

풀의 형식을 가져오거나 설정합니다.

Name	형식	Description
automation	string
deployment	string

TaskAgentPublicKey

RSA 비대칭 키의 공개 키 부분을 나타냅니다.

Name	형식	Description
exponent	string[]	공개 키의 지수를 가져오거나 설정합니다.
modulus	string[]	공개 키의 모듈러스를 가져오거나 설정합니다.

TaskAgentReference

Name	형식	Description
_links	ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
accessPoint	string	에이전트의 액세스 지점을 가져옵니다.
enabled	boolean	이 에이전트를 작업 실행에 사용하도록 설정해야 하는지 여부를 나타내는 값을 가져오거나 설정합니다.
id	integer	에이전트의 식별자를 가져옵니다.
name	string	에이전트의 이름을 가져옵니다.
oSDescription	string	에이전트의 OS를 가져옵니다.
provisioningState	string	이 에이전트의 현재 프로비전 상태를 가져오거나 설정합니다.
status	TaskAgentStatus	에이전트의 현재 연결 상태 가져옵니다.
version	string	에이전트의 버전을 가져옵니다.

TaskAgentStatus

에이전트의 현재 연결 상태 가져옵니다.

Name	형식	Description
offline	string
online	string

TaskAgentUpdate

Name	형식	Description
currentState	string	이 에이전트 업데이트의 현재 상태
reason	TaskAgentUpdateReason	이 에이전트 업데이트의 이유
requestTime	string	이 에이전트 업데이트가 요청된 날짜를 가져옵니다.
requestedBy	IdentityRef	에이전트 업데이트를 요청하는 ID
sourceVersion	PackageVersion	에이전트 업데이트의 원본 에이전트 버전을 가져오거나 설정합니다.
targetVersion	PackageVersion	에이전트 업데이트의 대상 에이전트 버전을 가져오거나 설정합니다.

TaskAgentUpdateReason

Name	형식	Description
code	TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

Name	형식	Description
manual	string
minAgentVersionRequired	string

TaskOrchestrationOwner

Name	형식	Description
_links	ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
id	integer
name	string

TaskResult

Name	형식	Description
abandoned	string
canceled	string
failed	string
skipped	string
succeeded	string
succeededWithIssues	string