Aracılığıyla paylaş

Deploymentgroups - Add

  • Başvuru
Service:
Distributed Task
API Version:
7.1-preview.1

Dağıtım grubu oluşturun.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
organization
 path True

string

Azure DevOps kuruluşunun adı.
project
 path True

string

Proje Kimliği veya proje adı
api-version
 query True

string

Kullanılacak API'nin sürümü. Bu, api'nin bu sürümünü kullanmak için '7.1-preview.1' olarak ayarlanmalıdır.

İstek Gövdesi

Name Tür Description
description

string

Dağıtım grubunun açıklaması.
name

string

Dağıtım grubunun adı.
poolId

integer

Dağıtım aracılarının kaydedildiği dağıtım havuzunun tanımlayıcısı.

Yanıtlar

Name Tür Description
200 OK

DeploymentGroup

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

Create a deployment group

Sample Request

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

{
  "name": "MyDeploymentGroup1",
  "description": "This deployment group is created to demnostrate the client usage"
}

Sample Response

Status code:
200 
{
  "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
  }
}

Tanımlar

Name Description
Demand
DeploymentGroup

Dağıtım grubu.
DeploymentGroupCreateParameter

Dağıtım grubu oluşturmak için özellikler.
DeploymentMachine

Dağıtım hedefi.
IdentityRef
JObject

Bir JSON nesnesini temsil eder.
JToken

Soyut JSON belirtecini temsil eder.
PackageVersion
ProjectReference
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 retuned edilir. Byte[] base64 kodlanmış dize olarak bekleniyor.
ReferenceLinks

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

Bir görev aracısı.
TaskAgentAuthorization

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

Bir aracı için iş isteği.
TaskAgentPoolOptions

Ek havuz ayarları ve ayrıntıları
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

Bir aracıya başvuru.
TaskAgentStatus

Aracının çevrimiçi olup olmadığı.
TaskAgentUpdate

Aracı güncelleştirmesi hakkındaki ayrıntılar.
TaskAgentUpdateReason
TaskAgentUpdateReasonType
TaskOrchestrationOwner
TaskResult

Bu isteğin sonucu.

Demand

Name Tür Description
name

string

value

string

DeploymentGroup

Dağıtım grubu.

Name Tür Description
description

string

Dağıtım grubunun açıklaması.
id

integer

Dağıtım grubu tanımlayıcısı.
machineCount

integer

Dağıtım grubundaki dağıtım hedefi sayısı.
machineTags

string[]

Dağıtım grubundaki tüm dağıtım hedeflerindeki benzersiz etiketlerin listesi.
machines

DeploymentMachine[]

Dağıtım grubundaki dağıtım hedeflerinin listesi.
name

string

Dağıtım grubunun adı.
pool

TaskAgentPoolReference

Dağıtım aracılarının kaydedildiği dağıtım havuzu.
project

ProjectReference

Dağıtım grubunun ait olduğu proje.

DeploymentGroupCreateParameter

Dağıtım grubu oluşturmak için özellikler.

Name Tür Description
description

string

Dağıtım grubunun açıklaması.
name

string

Dağıtım grubunun adı.
poolId

integer

Dağıtım aracılarının kaydedildiği dağıtım havuzunun tanımlayıcısı.

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ı.
properties

PropertiesCollection

Dağıtım hedefinin özellikleri.
tags

string[]

Dağıtım hedefinin etiketleri.

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

Kullanım dışı - IdentityRef "_links" sözlüğündeki "self" girişinde başvuruda bulunılan Graph kullanıcısı sorgulanarak alınabilir
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

Kullanım dışı - IdentityRef "_links" sözlüğündeki "avatar" girişinde kullanılabilir
inactive

boolean

Kullanım dışı - GraphUser "_links" sözlüğündeki "membershipState" girdisinde başvurulan Graph üyelik durumu sorgulanarak alınabilir
isAadIdentity

boolean

Kullanım dışı - Tanımlayıcının konu türünden çıkarılabilir (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer

boolean

Kullanım dışı - Tanımlayıcının konu türünden çıkarılabilir (Descriptor.IsGroupType)
isDeletedInOrigin

boolean

profileUrl

string

Kullanım dışı - ToIdentityRef'in önceden var olan uygulamalarının çoğunda kullanımda değil
uniqueName

string

Kullanım dışı - bunun yerine Domain+PrincipalName kullanın
url

string

Bu URL, bu grafik konusunun kaynak kaynağına giden tam yoldur.

JObject

Bir JSON nesnesini temsil eder.

Name Tür Description
item

JToken

Soyut JSON belirtecini temsil eder.
type

string

Bu JToken için düğüm türünü alır.

JToken

Soyut JSON belirtecini temsil eder.

Name Tür Description
first

JToken

Bu belirtecin ilk alt belirtecini alın.
hasValues

boolean

Bu belirtecin alt belirteçleri olup olmadığını belirten bir değer alır.
item

JToken

Soyut JSON belirtecini temsil eder.
last

JToken

Bu belirtecin son alt belirtecini alın.
next

JToken

Bu düğümün bir sonraki eşdüzey belirtecini alır.
parent

string

Üst öğeyi alır veya ayarlar.
path

string

JSON belirtecinin yolunu alır.
previous

JToken

Bu düğümün önceki eşdüzey belirtecini alır.
root

JToken

Bu JToken'in kök JToken'ini alır.
type

string

Bu JToken için düğüm türünü alır.

PackageVersion

Name Tür Description
major

integer

minor

integer

patch

integer

ProjectReference

Name Tür Description
id

string

name

string

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 retuned edilir. Byte[] base64 kodlanmış dize 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.

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

Bir görev aracısı.

Name Tür Description
_links

ReferenceLinks

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

string

Bu aracının erişim noktası.
assignedAgentCloudRequest

TaskAgentCloudRequest

Şu anda bu aracıyla ilişkili aracı bulut isteği.
assignedRequest

TaskAgentJobRequest

Şu anda bu aracıya atanmış olan istek.
authorization

TaskAgentAuthorization

Bu aracı için yetkilendirme bilgileri.
createdOn

string

Bu aracının oluşturulduğu tarih.
enabled

boolean

Bu aracının işleri çalıştırıp çalıştırmaması.
id

integer

Aracının tanımlayıcısı.
lastCompletedRequest

TaskAgentJobRequest

Bu aracı tarafından tamamlanan son istek.
maxParallelism

integer

Bu aracı için izin verilen iş paralelliği üst sınırı.
name

string

Aracının adı.
osDescription

string

Aracı işletim sistemi.
pendingUpdate

TaskAgentUpdate

Bu aracı için güncelleştirme bekleniyor.
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 retuned edilir. Byte[] base64 kodlanmış dize olarak bekleniyor.
provisioningState

string

Bu aracının sağlama durumu.
status

TaskAgentStatus

Aracının çevrimiçi olup olmadığı.
statusChangedOn

string

Son bağlantı durumu değişikliğinin gerçekleştiği tarih.
systemCapabilities

object

Bu aracının konağı tarafından desteklenen sistem tanımlı özellikler. Uyarı: Özellikleri ayarlamak için PUT yöntemini kullanın, PUT tüm mevcut özelliklerin üzerine yazar.
userCapabilities

object

Bu aracının konağı tarafından desteklenen kullanıcı tanımlı özellikler. Uyarı: Özellikleri ayarlamak için PUT yöntemini kullanın, PUT tüm mevcut özelliklerin üzerine yazar.
version

string

Aracı sürümü.

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çleri almak için kullanılan uç nokta.
clientId

string

Bu aracı için istemci tanımlayıcısı.
publicKey

TaskAgentPublicKey

Bu aracının kimliğini doğrulamak için kullanılan ortak anahtar.

TaskAgentCloudRequest

Name Tür Description
agent

TaskAgentReference

Bir aracıya başvuru.
agentCloudId

integer

agentConnectedTime

string

agentData

JObject

JSON nesnesini temsil eder.
agentSpecification

JObject

JSON nesnesini temsil eder.
pool

TaskAgentPoolReference

provisionRequestTime

string

provisionedTime

string

releaseRequestTime

string

requestId

string

TaskAgentJobRequest

Bir aracı için iş isteği.

Name Tür Description
agentSpecification

JObject

JSON nesnesini temsil eder.
assignTime

string

Bu isteğin atandığı tarih/saat.
data

object

İstekle ilgili ek veriler.
definition

TaskOrchestrationOwner

Bu istekle ilişkili işlem hattı tanımı
demands

Demand[]

Bu isteği yerine getirmek için gereken taleplerin listesi.
finishTime

string

Bu isteğin tamamlandığı tarih/saat.
hostId

string

Bu isteği tetikleyen konak.
jobId

string

Bu istekten kaynaklanan işin kimliği.
jobName

string

Bu istekten kaynaklanan işin adı.
lockedUntil

string

Aracının kilidi yenilemesi için son tarih.
matchedAgents

TaskAgentReference[]

Bir aracıya başvuru.
matchesAllAgentsInPool

boolean

orchestrationId

string

owner

TaskOrchestrationOwner

Bu istekle ilişkili işlem hattı
planGroup

string

planId

string

Bu istekle bağlantılı düzenleme planının iç kimliği.
planType

string

Düzenleme planının türünü temsil eden iç ayrıntı.
poolId

integer

Bu isteğin hedef olduğu havuzun kimliği
priority

integer

queueId

integer

Bu isteğin hedefle istediği kuyruğun kimliği
queueTime

string

Bu isteğin kuyruğa alındığı tarih/saat.
receiveTime

string

Bu isteğin bir aracı tarafından alındığı tarih/saat.
requestId

integer

İsteğin kimliği.
reservedAgent

TaskAgentReference

Bu istek için ayrılan aracı.
result

TaskResult

Bu isteğin sonucu.
scopeId

string

İşlem hattının kapsamı; proje kimliğiyle eşleşir.
serviceOwner

string

Bu isteğin sahibi olan hizmet.
statusMessage

string

userDelayed

boolean

TaskAgentPoolOptions

Ek havuz ayarları ve ayrıntıları

Name Tür Description
elasticPool

string

Elastik havuz hizmeti tarafından yedeklenen TaskAgentPool
none

string

preserveAgentOnJobFailure

string

Bir TaskAgentJobRequest hatasından sonra aracılar araştırma için tutulursa true olarak ayarlayın
singleUseAgents

string

Aracılar her TaskAgentJobRequest sonrasında yeniden görüntüleniyorsa true olarak ayarlayın

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.
isLegacy

boolean

Havuzun eski olup olmadığını belirler.
name

string

options

TaskAgentPoolOptions

Ek havuz ayarları ve ayrıntıları
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

Tipik bir görev aracıları havuzu
deployment

string

Dağıtım havuzu

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

Bir aracıya başvuru.

Name Tür Description
_links

ReferenceLinks

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

string

Bu aracının erişim noktası.
enabled

boolean

Bu aracının işleri çalıştırıp çalıştırmayacağı.
id

integer

Aracının tanımlayıcısı.
name

string

Aracının adı.
osDescription

string

Aracı işletim sistemi.
provisioningState

string

Bu aracının sağlama durumu.
status

TaskAgentStatus

Aracının çevrimiçi olup olmadığı.
version

string

Aracı sürümü.

TaskAgentStatus

Aracının çevrimiçi olup olmadığı.

Name Tür Description
offline

string

online

string

TaskAgentUpdate

Aracı güncelleştirmesi hakkındaki ayrıntılar.

Name Tür Description
currentState

string

Bu aracı güncelleştirmesinin geçerli durumu.
reason

TaskAgentUpdateReason

Bu güncelleştirmenin nedeni.
requestTime

string

Bu güncelleştirmenin istendiği tarih.
requestedBy

IdentityRef

Bu güncelleştirmeyi istenen kimlik.
sourceVersion

PackageVersion

Güncelleştirmenin kaynak aracısı sürümü.
targetVersion

PackageVersion

Güncelleştirmenin hedef aracı sürümü.

TaskAgentUpdateReason

Name Tür Description
code

TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

Name Tür Description
downgrade

string

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

Bu isteğin sonucu.

Name Tür Description
abandoned

string

canceled

string

failed

string

skipped

string

succeeded

string

succeededWithIssues

string