Targets - Get

Service:

Task Agent

API Version:

5.0-preview.1

Dağıtım grubundaki kimliğine göre dağıtım hedefi alma

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

With optional parameters:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
deploymentGroupId	path	True	integer int32	Dağıtım hedefinin ait olduğu dağıtım grubunun kimliği.
organization	path	True	string	Azure DevOps kuruluşunun adı.
project	path	True	string	Proje Kimliği veya proje adı
targetId	path	True	integer int32	Döndürülecek dağıtım hedefinin kimliği.
api-version	query	True	string	Kullanılacak API'nin sürümü. Bu, api'nin bu sürümünü kullanmak için '5.0-preview.1' olarak ayarlanmalıdır.
$expand	query		DeploymentTargetExpands	Döndürülen nesnelere bu ek ayrıntıları ekleyin.

Yanıtlar

Name	Tür	Description
200 OK	DeploymentMachine	başarılı işlem

Güvenlik

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	Dağıtım grubunu ve aracı havuzlarını yönetme olanağı sağlar

Örnekler

Get a deployment target by its ID

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "tags": [
    "web"
  ],
  "id": 5,
  "agent": {
    "_links": {
      "self": {
        "href": "https://dev.azure.com/fabrikam/_apis/distributedtask/pools/17/agents/5"
      },
      "web": {
        "href": "https://dev.azure.com/fabrikam/_admin/_AgentPool#_a=agents&poolId=17&agentId=5"
      }
    },
    "maxParallelism": 1,
    "createdOn": "2018-02-19T09:19:41.053Z",
    "authorization": {
      "clientId": "0f386203-17f5-45a6-8c72-d35b54011fe3",
      "publicKey": {
        "exponent": "AQAB",
        "modulus": "6O7UGxhRniv3tmXJ/1kaEkZdbcNQabJBJxj3EhPNsBJuduYZt3OixVTI/X5r1C2ogAr0nQon2UP3HKNQ9bkY7fNAY8VfggOTytu4ZfFcTJABvc5X8pHefWfO2DVqOUJH6HpyOtP5C+b2OGuhzTlEJHv6FrJPWxbK1HEo0w6VQg4CI8VqyCY9pvT6ZTrZTSg1Hp4uGF/kDHtUk0GvYWA2hZJyk/VbX7hH1PhwpRHuIEUsT0TcJzrR+7n0gdLDGeNLYqBMmTXIMm6jv7pUdnOumI9FK9hChw3JbP44jVxlxGbV8kh+IKAX/S3+pdkCNOiKzkXIDtUu/3vWiqx6+v8mIQ=="
      }
    },
    "id": 5,
    "name": "demoTarget1",
    "version": "2.127.0",
    "osDescription": "Microsoft Windows 10.0.14393 ",
    "enabled": true,
    "status": "online"
  }
}

Tanımlar

Name	Description
Demand
DeploymentMachine	Dağıtım hedefi.
DeploymentTargetExpands	Döndürülen nesnelere bu ek ayrıntıları ekleyin.
IdentityRef
JObject
JToken
PackageVersion
PropertiesCollection	sınıfı, anahtar-değer çiftleri koleksiyonu olarak bir özellik çantasını temsil eder. Dışındaki DBNull tüm ilkel türlerin (ile herhangi bir TypeCode != TypeCode.Objecttürü) değerleri kabul edilir. Byte[], Int32, Double, DateType ve String türündeki değerler türlerini korur, diğer temel öğeler Dize olarak döndürüler. Byte[] base64 kodlanmış dizesi olarak bekleniyor.
ReferenceLinks	REST başvuru bağlantılarının koleksiyonunu temsil eden sınıf.
TaskAgent
TaskAgentAuthorization	OAuth 2.0 kimlik doğrulama akışlarını kullanarak aracıyı yetkilendirmek için gereken verileri sağlar.
TaskAgentCloudRequest
TaskAgentDelaySource
TaskAgentJobRequest
TaskAgentPoolReference
TaskAgentPoolType	Havuzun türünü alır veya ayarlar
TaskAgentPublicKey	RSA asimetrik anahtarının ortak anahtar bölümünü temsil eder.
TaskAgentReference
TaskAgentStatus	Aracının geçerli bağlantı durumunu alır.
TaskAgentUpdate
TaskAgentUpdateReason
TaskAgentUpdateReasonType
TaskOrchestrationOwner
TaskResult

Demand

Name	Tür	Description
name	string
value	string

DeploymentMachine

Dağıtım hedefi.

Name	Tür	Description
agent	TaskAgent	Dağıtım aracısı.
id	integer	Dağıtım hedefi Tanımlayıcısı.
tags	string[]	Dağıtım hedefinin etiketleri.

DeploymentTargetExpands

Döndürülen nesnelere bu ek ayrıntıları ekleyin.

Name	Tür	Description
assignedRequest	string	Dağıtım aracısına atanan iş isteğini ekleyin.
capabilities	string	Dağıtım aracısının özelliklerini ekleyin.
lastCompletedRequest	string	Dağıtım aracısının son tamamlanan iş isteğini ekleyin.
none	string	Ek özellik yok.

IdentityRef

Name	Tür	Description
_links	ReferenceLinks	Bu alan, grafik konusuyla ilgili sıfır veya daha fazla ilgi çekici bağlantı içerir. Bu bağlantılar, bu grafik konusu hakkında ek ilişkiler veya daha ayrıntılı bilgi edinmek için çağrılabilir.
descriptor	string	Tanımlayıcı, sistem çalışırken graf konusuna başvurmanın birincil yoludur. Bu alan, hem Hesaplar hem de Kuruluşlar genelinde aynı graf konusunu benzersiz olarak tanımlar.
directoryAlias	string
displayName	string	Bu, grafik konusunun benzersiz olmayan görünen adıdır. Bu alanı değiştirmek için kaynak sağlayıcıdaki değerini değiştirmeniz gerekir.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Bu URL, bu grafik konusunun kaynak kaynağına giden tam yoldur.

JObject

Name	Tür	Description
item	JToken
type	string

JToken

Name	Tür	Description
first	JToken
hasValues	boolean
item	JToken
last	JToken
next	JToken
parent	string
path	string
previous	JToken
root	JToken
type	string

PackageVersion

Name	Tür	Description
major	integer
minor	integer
patch	integer

PropertiesCollection

sınıfı, anahtar-değer çiftleri koleksiyonu olarak bir özellik çantasını temsil eder. Dışındaki DBNull tüm ilkel türlerin (ile herhangi bir TypeCode != TypeCode.Objecttürü) değerleri kabul edilir. Byte[], Int32, Double, DateType ve String türündeki değerler türlerini korur, diğer temel öğeler Dize olarak döndürüler. Byte[] base64 kodlanmış dizesi olarak bekleniyor.

Name	Tür	Description
count	integer	Koleksiyondaki özelliklerin sayısı.
item	object
keys	string[]	Koleksiyondaki anahtar kümesi.
values	string[]	Koleksiyondaki değer kümesi.

ReferenceLinks

REST başvuru bağlantılarının koleksiyonunu temsil eden sınıf.

Name	Tür	Description
links	object	Bağlantıların salt okunur görünümü. Başvuru bağlantıları salt okunur olduğundan, bunları yalnızca salt okunur olarak kullanıma açmak istiyoruz.

TaskAgent

Name	Tür	Description
_links	ReferenceLinks	REST başvuru bağlantılarının koleksiyonunu temsil eden sınıf.
accessPoint	string	Aracının erişim noktasını alır.
assignedAgentCloudRequest	TaskAgentCloudRequest	Şu anda bu aracıyla ilişkilendirilmiş Olan Aracı Bulut İsteğini alır
assignedRequest	TaskAgentJobRequest	Şu anda bu aracıya atanmış olan isteği alır.
authorization	TaskAgentAuthorization	Bu aracı için yetkilendirme bilgilerini alır veya ayarlar.
createdOn	string	Bu aracının oluşturulduğu tarihi alır.
enabled	boolean	Bu aracının iş yürütmesi için etkinleştirilmesi gerekip gerekmediğini belirten bir değer alır veya ayarlar.
id	integer	Aracının tanımlayıcısını alır.
lastCompletedRequest	TaskAgentJobRequest	Bu aracı tarafından tamamlanan son isteği alır.
maxParallelism	integer	Bu konakta izin verilen iş paralelliği üst sınırını alır veya ayarlar.
name	string	Aracının adını alır.
oSDescription	string	Aracının işletim sistemini alır.
pendingUpdate	TaskAgentUpdate	Bu aracı için bekleyen güncelleştirmeyi alır.
properties	PropertiesCollection	sınıfı, anahtar-değer çiftleri koleksiyonu olarak bir özellik çantasını temsil eder. Dışındaki DBNull tüm ilkel türlerin (ile herhangi bir TypeCode != TypeCode.Objecttürü) değerleri kabul edilir. Byte[], Int32, Double, DateType ve String türündeki değerler türlerini korur, diğer temel öğeler Dize olarak döndürüler. Byte[] base64 kodlanmış dizesi olarak bekleniyor.
provisioningState	string	Bu aracının geçerli sağlama durumunu alır veya ayarlar
status	TaskAgentStatus	Aracının geçerli bağlantı durumunu alır.
statusChangedOn	string	Son bağlantı durumu değişikliğinin gerçekleştiği tarihi alır.
systemCapabilities	object
userCapabilities	object
version	string	Aracının sürümünü alır.

TaskAgentAuthorization

OAuth 2.0 kimlik doğrulama akışlarını kullanarak aracıyı yetkilendirmek için gereken verileri sağlar.

Name	Tür	Description
authorizationUrl	string	Yapılandırılan belirteç hizmetinden erişim belirteçlerini almak için kullanılan uç noktayı alır veya ayarlar.
clientId	string	Bu aracı için istemci tanımlayıcısını alır veya ayarlar.
publicKey	TaskAgentPublicKey	Bu aracının kimliğini doğrulamak için kullanılan ortak anahtarı alır veya ayarlar.

TaskAgentCloudRequest

Name	Tür	Description
agent	TaskAgentReference
agentCloudId	integer
agentConnectedTime	string
agentData	JObject
agentSpecification	JObject
pool	TaskAgentPoolReference
provisionRequestTime	string
provisionedTime	string
releaseRequestTime	string
requestId	string

TaskAgentDelaySource

Name	Tür	Description
delays	string[]
taskAgent	TaskAgentReference

TaskAgentJobRequest

Name	Tür	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	Tür	Description
id	integer
isHosted	boolean	Bu havuzun hizmet tarafından yönetilip yönetilmediğini belirten bir değer alır veya ayarlar.
name	string
poolType	TaskAgentPoolType	Havuzun türünü alır veya ayarlar
scope	string
size	integer	Havuzun geçerli boyutunu alır.

TaskAgentPoolType

Havuzun türünü alır veya ayarlar

Name	Tür	Description
automation	string
deployment	string

TaskAgentPublicKey

RSA asimetrik anahtarının ortak anahtar bölümünü temsil eder.

Name	Tür	Description
exponent	string[]	Ortak anahtar için üssü alır veya ayarlar.
modulus	string[]	Ortak anahtarın modüllerini alır veya ayarlar.

TaskAgentReference

Name	Tür	Description
_links	ReferenceLinks	REST başvuru bağlantılarının koleksiyonunu temsil eden sınıf.
accessPoint	string	Aracının erişim noktasını alır.
enabled	boolean	Bu aracının iş yürütmesi için etkinleştirilmesi gerekip gerekmediğini belirten bir değer alır veya ayarlar.
id	integer	Aracının tanımlayıcısını alır.
name	string	Aracının adını alır.
oSDescription	string	Aracının işletim sistemini alır.
provisioningState	string	Bu aracının geçerli sağlama durumunu alır veya ayarlar
status	TaskAgentStatus	Aracının geçerli bağlantı durumunu alır.
version	string	Aracının sürümünü alır.

TaskAgentStatus

Aracının geçerli bağlantı durumunu alır.

Name	Tür	Description
offline	string
online	string

TaskAgentUpdate

Name	Tür	Description
currentState	string	Bu aracı güncelleştirmesinin geçerli durumu
reason	TaskAgentUpdateReason	Bu aracı güncelleştirmesinin nedeni
requestTime	string	Bu aracı güncelleştirmesinin istendiği tarihi alır.
requestedBy	IdentityRef	Aracı güncelleştirmesini isteyen kimlik
sourceVersion	PackageVersion	Aracı güncelleştirmesinin kaynak aracı sürümünü alır veya ayarlar
targetVersion	PackageVersion	Aracı güncelleştirmesinin hedef aracı sürümünü alır veya ayarlar

TaskAgentUpdateReason

Name	Tür	Description
code	TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

Name	Tür	Description
manual	string
minAgentVersionRequired	string

TaskOrchestrationOwner

Name	Tür	Description
_links	ReferenceLinks	REST başvuru bağlantılarının koleksiyonunu temsil eden sınıf.
id	integer
name	string

TaskResult

Name	Tür	Description
abandoned	string
canceled	string
failed	string
skipped	string
succeeded	string
succeededWithIssues	string