Deploymentgroups - Get

참조

Service:: Distributed Task

API Version:: 7.1-preview.1

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

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

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?actionFilter={actionFilter}&$expand={$expand}&api-version=7.1-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를 사용하려면 '7.1-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=7.1-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	JSON 개체를 나타냅니다.
JToken	추상 JSON 토큰을 나타냅니다.
PackageVersion
ProjectReference
PropertiesCollection	클래스는 속성 모음을 키-값 쌍의 컬렉션으로 나타냅니다. 를 제외한 `DBNull` 모든 기본 형식의 값(가 있는 `TypeCode != TypeCode.Object`모든 형식)이 허용됩니다. Byte[], Int32, Double, DateType 및 String 형식의 값은 해당 형식을 유지하며, 다른 기본 형식은 String으로 다시 조정됩니다. base64로 인코딩된 문자열로 예상되는 바이트[]
ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
TaskAgent	작업 에이전트입니다.
TaskAgentAuthorization	OAuth 2.0 인증 흐름을 사용하여 에이전트에 권한을 부여하는 데 필요한 데이터를 제공합니다.
TaskAgentCloudRequest
TaskAgentJobRequest	에이전트에 대한 작업 요청입니다.
TaskAgentPoolOptions	추가 풀 설정 및 세부 정보
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	배포 대상 식별자입니다.
properties	PropertiesCollection	배포 대상의 속성입니다.
tags	string[]	배포 대상의 태그입니다.

IdentityRef

Name	형식	Description
_links	ReferenceLinks	이 필드에는 그래프 제목에 대한 0개 이상의 흥미로운 링크가 포함되어 있습니다. 이러한 링크를 호출하여 이 그래프 제목에 대한 추가 관계 또는 자세한 정보를 얻을 수 있습니다.
descriptor	string	설명자는 시스템이 실행되는 동안 그래프 제목을 참조하는 기본 방법입니다. 이 필드는 계정과 조직 모두에서 동일한 그래프 제목을 고유하게 식별합니다.
directoryAlias	string	사용되지 않음 - IdentityRef "_links" 사전의 "자체" 항목에서 참조된 Graph 사용자를 쿼리하여 검색할 수 있습니다.
displayName	string	그래프 주체의 고유하지 않은 표시 이름입니다. 이 필드를 변경하려면 원본 공급자에서 해당 값을 변경해야 합니다.
id	string
imageUrl	string	사용되지 않음 - IdentityRef "_links" 사전의 "아바타" 항목에서 사용할 수 있습니다.
inactive	boolean	사용되지 않음 - GraphUser "_links" 사전의 "membershipState" 항목에서 참조되는 Graph 멤버 자격 상태를 쿼리하여 검색할 수 있습니다.
isAadIdentity	boolean	사용되지 않음 - 설명자의 주체 형식(Descriptor.IsAadUserType/Descriptor.IsAadGroupType)에서 유추할 수 있습니다.
isContainer	boolean	사용되지 않음 - 설명자의 주체 형식에서 유추할 수 있음(Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	사용되지 않음 - ToIdentityRef의 대부분의 기존 구현에서 사용되지 않음
uniqueName	string	사용되지 않음 - 대신 Domain+PrincipalName 사용
url	string	이 URL은 이 그래프 주체의 원본 리소스에 대한 전체 경로입니다.

JObject

JSON 개체를 나타냅니다.

Name	형식	Description
item	JToken	추상 JSON 토큰을 나타냅니다.
type	string	이 JToken의 노드 형식을 가져옵니다.

JToken

추상 JSON 토큰을 나타냅니다.

Name	형식	Description
first	JToken	이 토큰의 첫 번째 자식 토큰을 가져옵니다.
hasValues	boolean	이 토큰에 자식 토큰이 있는지 여부를 나타내는 값을 가져옵니다.
item	JToken	추상 JSON 토큰을 나타냅니다.
last	JToken	이 토큰의 마지막 자식 토큰을 가져옵니다.
next	JToken	이 노드의 다음 형제 토큰을 가져옵니다.
parent	string	부모를 가져오거나 설정합니다.
path	string	JSON 토큰의 경로를 가져옵니다.
previous	JToken	이 노드의 이전 형제 토큰을 가져옵니다.
root	JToken	이 JToken의 루트 JToken을 가져옵니다.
type	string	이 JToken의 노드 형식을 가져옵니다.

PackageVersion

Name	형식	Description
major	integer
minor	integer
patch	integer

ProjectReference

Name	형식	Description
id	string
name	string

PropertiesCollection

클래스는 속성 모음을 키-값 쌍의 컬렉션으로 나타냅니다. 를 제외한 DBNull 모든 기본 형식의 값(가 있는 TypeCode != TypeCode.Object모든 형식)이 허용됩니다. Byte[], Int32, Double, DateType 및 String 형식의 값은 해당 형식을 유지하며, 다른 기본 형식은 String으로 다시 조정됩니다. 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	클래스는 속성 모음을 키-값 쌍의 컬렉션으로 나타냅니다. 를 제외한 `DBNull` 모든 기본 형식의 값(가 있는 `TypeCode != TypeCode.Object`모든 형식)이 허용됩니다. Byte[], Int32, Double, DateType 및 String 형식의 값은 해당 형식을 유지하며, 다른 기본 형식은 String으로 다시 조정됩니다. base64로 인코딩된 문자열로 예상되는 바이트[]
provisioningState	string	이 에이전트의 프로비전 상태입니다.
status	TaskAgentStatus	에이전트가 온라인인지 여부입니다.
statusChangedOn	string	마지막 연결 상태 변경된 날짜입니다.
systemCapabilities	object	이 에이전트의 호스트에서 지원하는 시스템 정의 기능입니다. 경고: PUT 메서드를 사용하여 기능을 설정하려면 PUT에서 기존 기능을 완전히 덮어씁 수 있습니다.
userCapabilities	object	이 에이전트의 호스트에서 지원하는 사용자 정의 기능입니다. 경고: PUT 메서드를 사용하여 기능을 설정하려면 PUT에서 기존 기능을 완전히 덮어씁 수 있습니다.
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	JSON 개체를 나타냅니다.
agentSpecification	JObject	JSON 개체를 나타냅니다.
pool	TaskAgentPoolReference
provisionRequestTime	string
provisionedTime	string
releaseRequestTime	string
requestId	string

TaskAgentJobRequest

에이전트에 대한 작업 요청입니다.

Name	형식	Description
agentSpecification	JObject	JSON 개체를 나타냅니다.
assignTime	string	이 요청이 할당된 날짜/시간입니다.
data	object	요청에 대한 추가 데이터입니다.
definition	TaskOrchestrationOwner	이 요청과 연결된 파이프라인 정의
demands	Demand[]	이 요청을 수행하는 데 필요한 요구 목록입니다.
finishTime	string	이 요청이 완료된 날짜/시간입니다.
hostId	string	이 요청을 트리거한 호스트입니다.
jobId	string	이 요청으로 인해 발생한 작업의 ID입니다.
jobName	string	이 요청에서 생성된 작업의 이름입니다.
lockedUntil	string	에이전트가 잠금을 갱신하는 마감일입니다.
matchedAgents	TaskAgentReference[]	에이전트에 대한 참조입니다.
matchesAllAgentsInPool	boolean
orchestrationId	string
owner	TaskOrchestrationOwner	이 요청과 연결된 파이프라인
planGroup	string
planId	string	이 요청과 연결된 오케스트레이션 계획의 내부 ID입니다.
planType	string	오케스트레이션 계획의 유형을 나타내는 내부 세부 정보입니다.
poolId	integer	이 요청이 대상으로 하는 풀의 ID
priority	integer
queueId	integer	이 요청이 대상으로 하는 큐의 ID
queueTime	string	이 요청이 큐에 대기된 날짜/시간입니다.
receiveTime	string	에이전트가 이 요청을 회수한 날짜/시간입니다.
requestId	integer	요청의 ID입니다.
reservedAgent	TaskAgentReference	이 요청에 할당된 에이전트입니다.
result	TaskResult	이 요청의 결과입니다.
scopeId	string	파이프라인의 범위입니다. 는 프로젝트 ID와 일치합니다.
serviceOwner	string	이 요청을 소유하는 서비스입니다.
statusMessage	string
userDelayed	boolean

TaskAgentPoolOptions

추가 풀 설정 및 세부 정보

Name	형식	Description
elasticPool	string	탄력적 풀 서비스에서 지원되는 TaskAgentPool
none	string
preserveAgentOnJobFailure	string	TaskAgentJobRequest 실패 후 에이전트가 조사를 위해 유지되는 경우 true로 설정
singleUseAgents	string	각 TaskAgentJobRequest 다음에 에이전트가 다시 이미지화되면 true로 설정

TaskAgentPoolReference

Name	형식	Description
id	integer
isHosted	boolean	서비스에서 이 풀을 관리하는지 여부를 나타내는 값을 가져오거나 설정합니다.
isLegacy	boolean	풀이 레거시인지 여부를 확인합니다.
name	string
options	TaskAgentPoolOptions	추가 풀 설정 및 세부 정보
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
downgrade	string
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

다음을 통해 공유