Releases - Update Release Environment
Yayın ortamının durumunu güncelleştirme
PATCH https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/environments/{environmentId}?api-version=7.1-preview.7
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
environment
|
path | True |
integer int32 |
Yayın ortamının kimliği. |
organization
|
path | True |
string |
Azure DevOps kuruluşunun adı. |
project
|
path | True |
string |
Proje Kimliği veya proje adı |
release
|
path | True |
integer int32 |
Yayının kimliği. |
api-version
|
query | True |
string |
Kullanılacak API sürümü. Api'nin bu sürümünü kullanmak için bu değer '7.1-preview.7' olarak ayarlanmalıdır. |
İstek Gövdesi
Name | Tür | Description |
---|---|---|
comment |
string |
Açıklamayı alır veya ayarlar. |
scheduledDeploymentTime |
string |
Zamanlanmış dağıtım süresini alır veya ayarlar. |
status |
Ortamın durumunu alır veya ayarlar. |
|
variables |
<string,
Configuration |
Dağıtım zamanında geçersiz kılınacak ortam değişkenlerinin listesini ayarlar. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
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.release_execute | Klasörler, yayınlar, yayın tanımları ve yayın ortamı dahil olmak üzere yayın yapıtlarını okuma ve güncelleştirme ve yeni bir sürümü kuyruğa alma olanağı sağlar. |
Örnekler
Start deployment on an environment
Sample Request
PATCH https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/environments/{environmentId}?api-version=7.1-preview.7
{
"status": "inProgress",
"scheduledDeploymentTime": null,
"comment": null,
"variables": {}
}
Sample Response
{
"id": 45,
"releaseId": 45,
"name": "PROD",
"status": "queued",
"variables": {},
"variableGroups": [],
"preDeployApprovals": [],
"postDeployApprovals": [],
"preApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": false,
"isNotificationOn": false,
"approver": {
"displayName": "Chuck Reinhart",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
"_links": {
"avatar": {
"href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
}
},
"id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
"uniqueName": "fabfiber@outlook.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
"descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
},
"id": 0
}
],
"approvalOptions": {
"requiredApproverCount": 0,
"releaseCreatorCanBeApprover": true,
"autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
"enforceIdentityRevalidation": false,
"timeoutInMinutes": 0,
"executionOrder": "beforeGates"
}
},
"postApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"deploySteps": [],
"rank": 1,
"definitionEnvironmentId": 23,
"environmentOptions": {
"emailNotificationType": "OnlyOnFailure",
"emailRecipients": "release.environment.owner;release.creator",
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"enableAccessToken": false,
"publishDeploymentStatus": false,
"badgeEnabled": false,
"autoLinkWorkItems": false,
"pullRequestDeploymentEnabled": false
},
"demands": [],
"conditions": [],
"workflowTasks": [],
"deployPhasesSnapshot": [
{
"deploymentInput": {
"parallelExecution": {
"parallelExecutionType": "none"
},
"skipArtifactsDownload": false,
"artifactsDownloadInput": {
"downloadInputs": []
},
"queueId": 0,
"demands": [],
"enableAccessToken": false,
"timeoutInMinutes": 0,
"jobCancelTimeoutInMinutes": 1,
"condition": "succeeded()",
"overrideInputs": {}
},
"rank": 1,
"phaseType": "agentBasedDeployment",
"name": "Run on agent",
"refName": null,
"workflowTasks": []
}
],
"owner": {
"displayName": "Chuck Reinhart",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
"_links": {
"avatar": {
"href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
}
},
"id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
"uniqueName": "fabfiber@outlook.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
"descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
},
"schedules": [],
"release": {
"id": 45,
"name": "Release-2",
"url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/45",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?releaseId=45&_a=release-summary"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/45"
}
}
},
"releaseDefinition": {
"id": 23,
"name": "Fabrikam-web",
"path": "\\",
"projectReference": null,
"url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/23",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=23"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/23"
}
}
},
"releaseCreatedBy": {
"displayName": "Chuck Reinhart",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
"_links": {
"avatar": {
"href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
}
},
"id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
"uniqueName": "fabfiber@outlook.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
"descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
},
"triggerReason": "Manual",
"preDeploymentGatesSnapshot": {
"id": 0,
"gatesOptions": null,
"gates": []
},
"postDeploymentGatesSnapshot": {
"id": 0,
"gatesOptions": null,
"gates": []
}
}
Tanımlar
ApprovalExecutionOrder
Onay yürütme sırası.
Name | Tür | Description |
---|---|---|
afterGatesAlways |
string |
Geçitlerin yürütülmesinden sonra her zaman gösterilen onaylar. |
afterSuccessfulGates |
string |
Geçitlerin başarıyla yürütülmesinden sonra gösterilen onaylar. |
beforeGates |
string |
Geçitlerden önce gösterilen onaylar. |
ApprovalOptions
Name | Tür | Description |
---|---|---|
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped |
boolean |
Aynı onaylayan önceki aşamayı onaylarsa onayın atlanıp atlanmayacağını belirtin. |
enforceIdentityRevalidation |
boolean |
Onay tamamlanmadan önce onaylayan kimliğinin yeniden doğrulanıp doğrulanmayacağını belirtin. |
executionOrder |
Onay yürütme sırası. |
|
releaseCreatorCanBeApprover |
boolean |
Yayın veya dağıtım isteyen kullanıcının onaylayana izin verip vermeyeceğini belirtin. |
requiredApproverCount |
integer |
Yayını ileri taşımak için gereken onay sayısı. '0', tüm onayların gerekli olduğu anlamına gelir. |
timeoutInMinutes |
integer |
Onay zaman aşımı. Onay varsayılan zaman aşımı 30 gündür. İzin verilen en fazla zaman aşımı 365 gündür. '0', varsayılan zaman aşımı (30 gün) anlamına gelir. |
ApprovalStatus
Onay durumunu alır veya ayarlar.
Name | Tür | Description |
---|---|---|
approved |
string |
Onay onayını gösterir. |
canceled |
string |
Onayın iptal olduğunu gösterir. |
pending |
string |
Onayın beklemede olduğunu gösterir. |
reassigned |
string |
Onayın yeniden atandiğini gösterir. |
rejected |
string |
Onayın reddedildiğini gösterir. |
skipped |
string |
Onayın atlanmış olduğunu gösterir. |
undefined |
string |
Onayda durum ayarlanmadığını gösterir. |
ApprovalType
Onay türünü alır veya ayarlar.
Name | Tür | Description |
---|---|---|
all |
string |
Tüm onayları gösterir. |
postDeploy |
string |
Dağıtımdan sonra yürütülen onayları gösterir. |
preDeploy |
string |
Dağıtımdan önce yürütülen onayları gösterir. |
undefined |
string |
Onay türünün ayarlanmadığını gösterir. |
AuthorizationHeader
Name | Tür | Description |
---|---|---|
name |
string |
|
value |
string |
ConditionType
Koşul türünü alır veya ayarlar.
Name | Tür | Description |
---|---|---|
artifact |
string |
Koşul türü yapıttır. |
environmentState |
string |
Koşul türü ortam durumudur. |
event |
string |
Koşul türü olaydır. |
undefined |
string |
Koşul türü tanımlanmamış. |
ConfigurationVariableValue
Name | Tür | Description |
---|---|---|
allowOverride |
boolean |
Bir değişkenin dağıtım zamanında geçersiz kılınıp kılınamadığını alır ve ayarlar. |
isSecret |
boolean |
Değişken gizli veya gizli değil olarak alır veya ayarlar. |
value |
string |
Yapılandırma değişkeninin değerini alır ve ayarlar. |
DataSourceBindingBase
Hizmet uç noktası isteği için veri kaynağının bağlamasını temsil eder.
Name | Tür | Description |
---|---|---|
callbackContextTemplate |
string |
Bu veri kaynağı tarafından desteklenen sayfalandırma biçimi (ContinuationToken/SkipTop). |
callbackRequiredTemplate |
string |
Sonraki aramalar gerekli mi? |
dataSourceName |
string |
Veri kaynağının adını alır veya ayarlar. |
endpointId |
string |
Uç nokta kimliğini alır veya ayarlar. |
endpointUrl |
string |
Hizmet uç noktasının URL'sini alır veya ayarlar. |
headers |
Yetkilendirme üst bilgilerini alır veya ayarlar. |
|
initialContextTemplate |
string |
Sorgu parametrelerinin ilk değerini tanımlar |
parameters |
object |
Veri kaynağı için parametreleri alır veya ayarlar. |
requestContent |
string |
Http isteği gövdesini alır veya ayarlar |
requestVerb |
string |
Http isteği fiilini alır veya ayarlar |
resultSelector |
string |
Sonuç seçiciyi alır veya ayarlar. |
resultTemplate |
string |
Sonuç şablonunu alır veya ayarlar. |
target |
string |
Veri kaynağının hedefini alır veya ayarlar. |
DeploymentAttempt
Name | Tür | Description |
---|---|---|
attempt |
integer |
Dağıtım girişimi. |
deploymentId |
integer |
Dağıtımın kimliği. |
hasStarted |
boolean |
Dağıtımın başlatılıp başlatılmadığını belirtir. |
id |
integer |
Dağıtım kimliği. |
issues |
Issue[] |
Dağıtımla ilgili tüm sorunlar. |
lastModifiedBy |
Bu dağıtımı en son değiştiren kimlik. |
|
lastModifiedOn |
string |
Bu dağıtımın son değiştirildiği zaman. |
operationStatus |
Dağıtım işlemi durumu. |
|
postDeploymentGates |
Bu dağıtımda yürütülen dağıtım sonrası geçitleri. |
|
preDeploymentGates |
Bu dağıtımda yürütülen dağıtım öncesi geçitleri. |
|
queuedOn |
string |
Bu dağıtım kuyruğa alındığında. |
reason |
Dağıtımın nedeni. |
|
releaseDeployPhases |
Bu dağıtımda yürütülen yayın dağıtımlarının listesi. |
|
requestedBy |
Bu dağıtımı isteyen kimlik. |
|
requestedFor |
Bu dağıtım için kimlik istendi. |
|
status |
dağıtım durumu. |
DeploymentJob
Name | Tür | Description |
---|---|---|
job |
Yürütülen tüm görevlerin üst görevi. |
|
tasks |
İş içinde ile yürütülen görevlerin listesi. |
DeploymentOperationStatus
Dağıtımın işlem durumunu alır.
Name | Tür | Description |
---|---|---|
all |
string |
Dağıtım işlemi durumunun tamamıdır. |
approved |
string |
Dağıtım işlemi durumu onaylandı. |
canceled |
string |
Dağıtım işlemi durumu iptal edildi. |
cancelling |
string |
Dağıtım işlemi durumu iptal oluyor. |
deferred |
string |
Dağıtım işlemi durumu ertelenmiş. |
evaluatingGates |
string |
Dağıtım işlemi durumu EvaluatingGates'tir. |
gateFailed |
string |
Dağıtım işlemi durumu GateFailed şeklindedir. |
manualInterventionPending |
string |
Dağıtım işlemi durumu el ile etkileşim bekliyor. |
pending |
string |
Dağıtım işlemi durumu beklemede. |
phaseCanceled |
string |
Dağıtım işlemi durumu aşama iptal edildi. |
phaseFailed |
string |
Dağıtım işlemi durumu aşama başarısız oldu. |
phaseInProgress |
string |
Dağıtım işlemi durumu devam ediyor. |
phasePartiallySucceeded |
string |
Dağıtım işlemi durumu kısmen başarılı oldu. |
phaseSucceeded |
string |
Dağıtım işlemi durumu aşama başarılı oldu. |
queued |
string |
Dağıtım işlemi durumu kuyruğa alındı. |
queuedForAgent |
string |
Dağıtım işlemi durumu aracı için kuyruğa alındı. |
queuedForPipeline |
string |
Dağıtım işlemi durumu işlem hattı için kuyruğa alındı. |
rejected |
string |
Dağıtım işlemi durumu reddedilir. |
scheduled |
string |
Dağıtım işlemi durumu zamanlandı. |
undefined |
string |
Dağıtım işlemi durumu tanımlanmamış. |
DeploymentReason
Dağıtım nedenini alır.
Name | Tür | Description |
---|---|---|
automated |
string |
Dağıtım nedeni otomatiktir. |
manual |
string |
Dağıtım nedeni el iledir. |
none |
string |
Dağıtım nedeni yok. |
redeployTrigger |
string |
Dağıtım nedeni RedeployTrigger'dır. |
scheduled |
string |
Dağıtım nedeni zamanlanmıştır. |
DeploymentStatus
Dağıtımın durumunu alır.
Name | Tür | Description |
---|---|---|
all |
string |
Dağıtım durumu tamamıdır. |
failed |
string |
Dağıtım durumu başarısız oldu. |
inProgress |
string |
Dağıtım durumu devam ediyor. |
notDeployed |
string |
Dağıtım durumu dağıtılmaz. |
partiallySucceeded |
string |
Dağıtım durumu kısmen başarısız oldu. |
succeeded |
string |
Dağıtım durumu başarılı oldu. |
undefined |
string |
Dağıtım durumu tanımsız. |
DeployPhase
Name | Tür | Description |
---|---|---|
name |
string |
Dağıtım aşamasının adını alır ve ayarlar. |
phaseType |
Dağıtım aşaması türünü gösterir. |
|
rank |
integer |
Dağıtım aşamasının derecesini alır ve ayarlar. |
refName |
string |
Dağıtım aşamasının başvuru adını alır ve ayarlar. |
workflowTasks |
Dağıtım aşaması için iş akışı görevlerini alır ve ayarlar. |
DeployPhaseStatus
Aşamanın durumu.
Name | Tür | Description |
---|---|---|
canceled |
string |
Aşama yürütme iptal edildi. |
cancelling |
string |
Aşama iptal etme durumunda. |
failed |
string |
Aşama yürütme başarısız oldu. |
inProgress |
string |
Aşama yürütme devam ediyor. |
notStarted |
string |
Aşama yürütme başlatılmaz. |
partiallySucceeded |
string |
Aşama yürütme kısmen başarılı oldu. |
skipped |
string |
Aşama yürütmesi atlandı. |
succeeded |
string |
Aşama yürütme başarılı oldu. |
undefined |
string |
Aşama durumu ayarlanmadı. |
DeployPhaseTypes
Dağıtım aşaması türünü gösterir.
Name | Tür | Description |
---|---|---|
agentBasedDeployment |
string |
Aracıda yürütülen görevleri içeren aşama türü. |
deploymentGates |
string |
Dağıtımın ileriye gitmesi için Geçit görevi gören görevleri içeren aşama türü. |
machineGroupBasedDeployment |
string |
Dağıtım grubu makinelerinde yürütülen görevleri içeren aşama türü. |
runOnServer |
string |
Sunucu tarafından yürütülen görevleri içeren aşama türü. |
undefined |
string |
Aşama türü tanımlanmadı. Bunu kullanmayın. |
EnvironmentOptions
Name | Tür | Description |
---|---|---|
autoLinkWorkItems |
boolean |
Otomatik bağlantı çalışma öğesi olarak alır ve ayarlar. |
badgeEnabled |
boolean |
Rozet etkin veya değil olarak alır ve ayarlar. |
publishDeploymentStatus |
boolean |
Dağıtım yayımlama durumu olarak alır ve ayarlar veya almaz. |
pullRequestDeploymentEnabled |
boolean |
.pull isteği dağıtımı etkinleştirildi veya etkinleştirilmedi olarak alır ve ayarlar. |
EnvironmentStatus
Ortam durumunu alır.
Name | Tür | Description |
---|---|---|
canceled |
string |
Ortam iptal edildi durumunda. |
inProgress |
string |
Ortam devam ediyor durumunda. |
notStarted |
string |
Ortam başlatılmadi durumunda. |
partiallySucceeded |
string |
Ortam kısmen başarılı durumda. |
queued |
string |
Ortam kuyruğa alınmış durumda. |
rejected |
string |
Ortam reddedildi durumunda. |
scheduled |
string |
Ortam zamanlanmış durumda. |
succeeded |
string |
Ortam başarılı durumda. |
undefined |
string |
Ortam durumu ayarlanmadı. |
GateStatus
Yayın geçitlerinin durumu.
Name | Tür | Description |
---|---|---|
canceled |
string |
Geçit yürütmesi iptal edildi. |
failed |
string |
Geçit yürütmesi başarısız oldu. |
inProgress |
string |
Geçit şu anda devam ediyor. |
none |
string |
Geçitte durum ayarlanmadı. |
pending |
string |
Geçit bekleme durumunda. |
succeeded |
string |
Geçit başarıyla tamamlandı. |
IdentityRef
Name | Tür | Description |
---|---|---|
_links |
Bu alan, grafik konusu hakkında sıfır veya daha fazla ilgi çekici bağlantı içerir. Bu bağlantılar, bu grafik konusu hakkında daha fazla ilişki 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üğün "avatar" girişinde kullanılabilir |
inactive |
boolean |
Kullanım dışı - GraphUser "_links" sözlüğün "membershipState" girişinde 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. |
IgnoredGate
Name | Tür | Description |
---|---|---|
lastModifiedOn |
string |
Geçidin son yoksayıldığı tarihi alır. |
name |
string |
Geçidin adı yoksayıldı. |
Issue
Name | Tür | Description |
---|---|---|
data |
object |
Veri verme. |
issueType |
string |
Sorun türü, örneğin hata, uyarı veya bilgi. |
message |
string |
Sorun iletisi. |
ManualIntervention
Name | Tür | Description |
---|---|---|
approver |
Onaylaması gereken kimliği alır veya ayarlar. |
|
comments |
string |
Onay için açıklamaları alır veya ayarlar. |
createdOn |
string |
Oluşturulduğu tarihi alır. |
id |
integer |
El ile müdahale için benzersiz tanımlayıcıyı alır. |
instructions |
string |
Onay için yönergeleri alır veya ayarlar. |
modifiedOn |
string |
Değiştirildiği tarihi alır. |
name |
string |
Adı alır veya ayarlar. |
release |
El ile müdahale için releaseReference alır. |
|
releaseDefinition |
El ile müdahale için releaseDefinitionReference alır. |
|
releaseEnvironment |
El ile müdahale için releaseEnvironmentReference alır. |
|
status |
El ile müdahale durumunu alır veya ayarlar. |
|
taskInstanceId |
string |
Görev örneği tanımlayıcısı alma. |
url |
string |
El ile müdahaleye erişmek için URL'yi alır. |
ManualInterventionStatus
El ile müdahale durumunu alır veya ayarlar.
Name | Tür | Description |
---|---|---|
approved |
string |
El ile müdahale onaylanır. |
canceled |
string |
El ile müdahale iptal edilir. |
pending |
string |
El ile müdahale beklemede. |
rejected |
string |
El ile müdahale reddedilir. |
unknown |
string |
El ile müdahalede durum ayarlanmadı. |
ProcessParameters
Name | Tür | Description |
---|---|---|
dataSourceBindings |
Hizmet uç noktası isteği için veri kaynağının bağlamasını temsil eder. |
|
inputs | ||
sourceDefinitions |
ProjectReference
Name | Tür | Description |
---|---|---|
id |
string |
Bu alanın benzersiz tanımlayıcısını alır. |
name |
string |
Projenin adını alır. |
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. |
ReleaseApproval
Name | Tür | Description |
---|---|---|
approvalType |
Onay türünü alır veya ayarlar. |
|
approvedBy |
Onaylayan kimliği alır. |
|
approver |
Onaylaması gereken kimliği alır veya ayarlar. |
|
attempt |
integer |
Ait olduğu dağıtım girişimini belirten denemeyi alır veya ayarlar. |
comments |
string |
Onay için açıklamaları alır veya ayarlar. |
createdOn |
string |
Oluşturulduğu tarihi alır. |
history |
Bu onayla ilişkili tüm onayları belirten geçmişi alır. |
|
id |
integer |
Bu alanın benzersiz tanımlayıcısını alır. |
isAutomated |
boolean |
Onay otomatikleştirilmiş veya değil olarak alır veya ayarlar. |
modifiedOn |
string |
Değiştirildiği tarihi alır. |
rank |
integer |
Onayın sırasını belirten dereceyi alır veya ayarlar. Örneğin, aynı derece paralel onayı belirtir. |
release |
Bu onayın ilişkilendirildiği yayının başvurularını belirten releaseReference'ı alır. |
|
releaseDefinition |
Bu onayın ilişkilendirildiği yayın tanımının başvurularını belirten releaseDefinitionReference'ı alır. |
|
releaseEnvironment |
Bu onayın ilişkilendirildiği yayın ortamının başvurularını belirten releaseEnvironmentReference alır. |
|
revision |
integer |
Düzeltme numarasını alır. |
status |
Onay durumunu alır veya ayarlar. |
|
url |
string |
Onaya erişmek için URL'yi alır. |
ReleaseApprovalHistory
Name | Tür | Description |
---|---|---|
approver |
Onaylayanın kimliği. |
|
changedBy |
Onayını değiştiren nesnenin kimliği. |
|
comments |
string |
Onay geçmişi açıklamaları. |
createdOn |
string |
Bu onayın oluşturulduğu zaman. |
modifiedOn |
string |
Bu onayın değiştirildiği zaman. |
revision |
integer |
Onay geçmişi düzeltmesi. |
ReleaseCondition
Name | Tür | Description |
---|---|---|
conditionType |
Koşul türünü alır veya ayarlar. |
|
name |
string |
Koşulun adını alır veya ayarlar. Örneğin , 'ReleaseStarted'. |
result |
boolean |
Yayın koşulu sonucu. |
value |
string |
Koşulun değerini alır veya ayarlar. |
ReleaseDefinitionApprovals
Name | Tür | Description |
---|---|---|
approvalOptions |
Onay seçeneklerini alır veya ayarlar. |
|
approvals |
Onayları alır veya ayarlar. |
ReleaseDefinitionApprovalStep
Name | Tür | Description |
---|---|---|
approver |
Onaylayanı alır ve ayarlar. |
|
id |
integer |
Onay veya dağıtım adımının kimliği. |
isAutomated |
boolean |
Onayın otomatik olup olmadığını gösterir. |
isNotificationOn |
boolean |
Onay bildiriminin ayarlanıp ayarlanmadığını gösterir. |
rank |
integer |
Onay adımının derecesini alır veya ayarlar. |
ReleaseDefinitionGate
Name | Tür | Description |
---|---|---|
tasks |
Gates iş akışını alır veya ayarlar. |
ReleaseDefinitionGatesOptions
Name | Tür | Description |
---|---|---|
isEnabled |
boolean |
Geçitler etkinleştirildi veya etkinleştirilmedi olarak alır veya ayarlar. |
minimumSuccessDuration |
integer |
Başarılı bir geçit değerlendirmesinin ardından sabit sonuçlar için minimum süreyi alır veya ayarlar. |
samplingInterval |
integer |
Geçitlerin yeniden değerlendirilmesi arasındaki süreyi alır veya ayarlar. |
stabilizationTime |
integer |
Değerlendirmeden önce gecikmeyi alır veya ayarlar. |
timeout |
integer |
Geçitlerin başarısız olduğu zaman aşımını alır veya ayarlar. |
ReleaseDefinitionGatesStep
Name | Tür | Description |
---|---|---|
gates |
Kapıları alır veya ayarlar. |
|
gatesOptions |
Geçit seçeneklerini alır veya ayarlar. |
|
id |
integer |
ReleaseDefinitionGateStep kimliği. |
ReleaseDefinitionShallowReference
Name | Tür | Description |
---|---|---|
_links |
Yayın tanımı için ilgili kaynaklara, API'lere ve görünümlere bağlantıları alır. |
|
id |
integer |
Yayın tanımının benzersiz tanımlayıcısını alır. |
name |
string |
Yayın tanımının adını alır veya ayarlar. |
path |
string |
Yayın tanımının yolunu alır veya ayarlar. |
projectReference |
Proje başvurularını alır veya ayarlar. |
|
url |
string |
Yayın tanımına erişmek için REST API URL'sini alır. |
ReleaseDeployPhase
Name | Tür | Description |
---|---|---|
deploymentJobs |
Aşamanın dağıtım işleri. |
|
errorLog |
string |
Aşama yürütme hata günlükleri. |
manualInterventions |
Aşama içindeki el ile müdahale görevleri yürütme bilgilerinin listesi. |
|
name |
string |
Aşamanın adı. |
phaseId |
string |
Aşamanın kimliği. |
phaseType |
Aşamanın türü. |
|
rank |
integer |
Aşamanın sırası. |
runPlanId |
string |
Aşamanın Plan Kimliğini çalıştırma. |
startedOn |
string |
Aşama başlangıç zamanı. |
status |
Aşamanın durumu. |
ReleaseEnvironment
Name | Tür | Description |
---|---|---|
conditions |
Koşulların listesini alır. |
|
createdOn |
string |
Oluşturulduğu tarihi alır. |
definitionEnvironmentId |
integer |
Tanım ortam kimliğini alır. |
deployPhasesSnapshot |
Dağıtım aşamaları anlık görüntüsünün listesini alır. |
|
deploySteps |
Dağıtım adımlarını alır. |
|
environmentOptions |
Ortam seçeneklerini alır. |
|
id |
integer |
Bu alanın benzersiz tanımlayıcısını alır. |
modifiedOn |
string |
Değiştirildiği tarihi alır. |
name |
string |
Adı alır. |
nextScheduledUtcTime |
string |
Bir sonraki zamanlanmış UTC saatini alır. |
owner |
Yayın ortamının sahibi olan kimliği alır. |
|
postApprovalsSnapshot |
Dağıtım sonrası onay anlık görüntüsünün listesini alır. |
|
postDeployApprovals |
Dağıtım sonrası onayların listesini alır. |
|
postDeploymentGatesSnapshot |
Dağıtım geçitleri anlık görüntü verilerini gönderme. |
|
preApprovalsSnapshot |
Ön dağıtım onayları anlık görüntüsünün listesini alır. |
|
preDeployApprovals |
Dağıtım öncesi onayların listesini alır. |
|
preDeploymentGatesSnapshot |
Dağıtım öncesi geçitler anlık görüntü verileri. |
|
processParameters |
İşlem parametrelerini alır. |
|
rank |
integer |
Derece alır. |
release |
Bu yayın ortamının ilişkilendirildiği yayının başvurularını belirten yayın başvuruyu alır. |
|
releaseCreatedBy |
Yayını oluşturan kimliği alır. |
|
releaseDefinition |
Bu yayın ortamının ilişkilendirildiği yayın tanımının başvurularını belirten releaseDefinitionReference'ı alır. |
|
releaseId |
integer |
Yayın kimliğini alır. |
scheduledDeploymentTime |
string |
Yayın ortamının dağıtım zamanlamasını alır. |
schedules |
Zamanlamaların listesini alır. |
|
status |
Ortam durumunu alır. |
|
timeToDeploy |
number |
Dağıtım için zaman alır. |
triggerReason |
string |
Tetikleyici nedenini alır. |
variableGroups |
Değişken gruplarının listesini alır. |
|
variables |
<string,
Configuration |
Değişkenlerin sözlüğünü alır. |
ReleaseEnvironmentShallowReference
Name | Tür | Description |
---|---|---|
_links |
Yayın ortamı için ilgili kaynaklara, API'lere ve görünümlere bağlantıları alır. |
|
id |
integer |
Yayın ortamının benzersiz tanımlayıcısını alır. |
name |
string |
Yayın ortamının adını alır veya ayarlar. |
url |
string |
Yayın ortamına erişmek için REST API URL'sini alır. |
ReleaseEnvironmentUpdateMetadata
Name | Tür | Description |
---|---|---|
comment |
string |
Açıklamayı alır veya ayarlar. |
scheduledDeploymentTime |
string |
Zamanlanmış dağıtım süresini alır veya ayarlar. |
status |
Ortamın durumunu alır veya ayarlar. |
|
variables |
<string,
Configuration |
Dağıtım zamanında geçersiz kılınacak ortam değişkenlerinin listesini ayarlar. |
ReleaseGates
Name | Tür | Description |
---|---|---|
deploymentJobs |
Her değerlendirmenin gates iş ayrıntılarını içerir. |
|
id |
integer |
Yayın geçitlerinin kimliği. |
ignoredGates |
Yoksayılan geçitlerin listesi. |
|
lastModifiedOn |
string |
Gates son değiştirme zamanı. |
runPlanId |
string |
Geçitlerin plan kimliğini çalıştırın. |
stabilizationCompletedOn |
string |
Geçit dengelemesi tamamlandı tarih ve saat. |
startedOn |
string |
Gates değerlendirmesi başlama zamanı. |
status |
Yayın geçitlerinin durumu. |
|
succeedingSince |
string |
Tüm geçitlerin başarıyla yürütüldiği tarih ve saat. |
ReleaseSchedule
Name | Tür | Description |
---|---|---|
daysToRelease |
Yayınlanması için haftanın günleri. |
|
jobId |
string |
Team Foundation İş Tanımı İş Kimliği. |
scheduleOnlyWithChanges |
boolean |
Bu zamanlamanın yalnızca ilişkili yapıt değiştirildiyse mi yoksa yayın tanımı değiştirildiğinde mi yayınlanması gerektiğini belirlemek için bayrak. |
startHours |
integer |
Başlamak için yerel saat dilimi saati. |
startMinutes |
integer |
Başlamak için yerel saat dilimi dakikası. |
timeZoneId |
string |
Yayın zamanlamasının saat dilimi kimliği, örneğin 'UTC'. |
ReleaseShallowReference
Name | Tür | Description |
---|---|---|
_links |
Yayın için ilgili kaynaklara, API'lere ve görünümlere bağlantıları alır. |
|
id |
integer |
Yayının benzersiz tanımlayıcısını alır. |
name |
string |
Yayının adını alır veya ayarlar. |
url |
string |
Yayına erişmek için REST API URL'sini alır. |
ReleaseTask
Name | Tür | Description |
---|---|---|
agentName |
string |
Görevin yürütüldiği aracı adı. |
finishTime |
string |
Yayın görevinin bitiş saati. |
id |
integer |
Yayın görevinin kimliği. |
issues |
Issue[] |
Görev yürütülirken oluşan sorunların listesi. |
lineCount |
integer |
Günlük yayın görevinin sahip olduğu satır sayısı. |
logUrl |
string |
Görevin günlük URL'si. |
name |
string |
Görevin adı. |
percentComplete |
integer |
Görev yürütmesi tam öncül. |
rank |
integer |
Yayın görevinin sırası. |
resultCode |
string |
Görevin sonuç kodu. |
startTime |
string |
Yayın görevinin kimliği. |
status |
Yayın görevinin durumu. |
|
task |
İş akışı görev başvurusu. |
|
timelineRecordId |
string |
Yayın görevinin zaman çizelgesi kayıt kimliği. |
ScheduleDays
Yayınlanması için haftanın günleri.
Name | Tür | Description |
---|---|---|
all |
string |
Haftanın tüm günlerinde zamanlanır. |
friday |
string |
Cuma günü zamanlandı. |
monday |
string |
Pazartesi günü zamanlandı. |
none |
string |
Zamanlanan gün ayarlanmadı. |
saturday |
string |
Cumartesi günü zamanlandı. |
sunday |
string |
Pazar günü zamanlandı. |
thursday |
string |
Perşembe günü zamanlandı. |
tuesday |
string |
Salı günü zamanlandı. |
wednesday |
string |
Çarşamba günü zamanlandı. |
TaskInputDefinitionBase
Name | Tür | Description |
---|---|---|
aliases |
string[] |
|
defaultValue |
string |
|
groupName |
string |
|
helpMarkDown |
string |
|
label |
string |
|
name |
string |
|
options |
object |
|
properties |
object |
|
required |
boolean |
|
type |
string |
|
validation | ||
visibleRule |
string |
TaskInputValidation
Name | Tür | Description |
---|---|---|
expression |
string |
Koşullu ifade |
message |
string |
Doğrulama başarısız olursa kullanıcının nasıl düzeltebileceğini açıklayan ileti |
TaskSourceDefinitionBase
Name | Tür | Description |
---|---|---|
authKey |
string |
|
endpoint |
string |
|
keySelector |
string |
|
selector |
string |
|
target |
string |
TaskStatus
Yayın görevinin durumu.
Name | Tür | Description |
---|---|---|
canceled |
string |
Görev yürütmesi iptal edildi. |
failed |
string |
Görev yürütülemedi. |
failure |
string |
Görev yürütülemedi. |
inProgress |
string |
Görev şu anda devam ediyor. |
partiallySucceeded |
string |
Görev yürütme kısmen başarılı oldu. |
pending |
string |
Görev bekleme durumunda. |
skipped |
string |
Görev yürütmesi atlandı. |
succeeded |
string |
Görev başarıyla tamamlandı. |
success |
string |
Görev başarıyla tamamlandı. |
unknown |
string |
Görevin durum kümesi yok. |
VariableGroup
Name | Tür | Description |
---|---|---|
createdBy |
Oluşturan kimliği alır veya ayarlar. |
|
createdOn |
string |
Oluşturulduğu tarihi alır. |
description |
string |
Açıklamayı alır veya ayarlar. |
id |
integer |
Bu alanın benzersiz tanımlayıcısını alır. |
isShared |
boolean |
Değişken grubunun başka bir projeyle paylaşılıp paylaşılmadığını belirtir. |
modifiedBy |
Değiştiren kimliği alır veya ayarlar. |
|
modifiedOn |
string |
Değiştirildiği tarihi alır. |
name |
string |
Adı alır veya ayarlar. |
providerData |
Sağlayıcı verilerini alır veya ayarlar. |
|
type |
string |
Türü alır veya ayarlar. |
variableGroupProjectReferences |
değişken grubunun diğer projelerle paylaşıldığı tüm proje başvuruları. |
|
variables |
<string,
Variable |
Değişkenlerin sözlüğünü alır ve ayarlar. |
VariableGroupProjectReference
Değişken grubu başvurusu, değişken grubuna basit bir başvurudur.
Name | Tür | Description |
---|---|---|
description |
string |
Değişken grubunun açıklamasını alır veya ayarlar. |
name |
string |
Değişken grubunun adını alır veya ayarlar. |
projectReference |
Değişken grubunun proje başvurularını alır veya ayarlar. |
VariableGroupProviderData
VariableValue
Name | Tür | Description |
---|---|---|
isReadOnly |
boolean |
Değişkenin salt okunur olup olmadığını alır veya ayarlar. |
isSecret |
boolean |
Değişken gizli olduğundan veya olmadığı için alır veya ayarlar. |
value |
string |
Değeri alır veya ayarlar. |
WorkflowTask
Name | Tür | Description |
---|---|---|
alwaysRun |
boolean |
Görev her zaman çalıştırıldığından veya çalışmadığından alır veya ayarlar. |
condition |
string |
Görev koşulunu alır veya ayarlar. |
continueOnError |
boolean |
Görev hatayla çalışmaya devam ettikçe veya çalıştırılmadığında alır veya ayarlar. |
definitionType |
string |
Görev tanımı türünü alır veya ayarlar. Örnek:- 'Agent', DeploymentGroup', 'Server' veya 'ServerGate'. |
enabled |
boolean |
Görev etkinleştirildi veya etkinleştirilmedi olarak alır veya ayarlar. |
environment |
object |
Görev ortamı değişkenlerini alır veya ayarlar. |
inputs |
object |
Görev girişlerini alır veya ayarlar. |
name |
string |
Görevin adını alır veya ayarlar. |
overrideInputs |
object |
Görev geçersiz kılma girişlerini alır veya ayarlar. |
refName |
string |
Görevin başvuru adını alır veya ayarlar. |
retryCountOnTaskFailure |
integer |
RetryCount görevini alır veya ayarlar. |
taskId |
string |
Görevin kimliğini alır veya ayarlar. |
timeoutInMinutes |
integer |
Görev zaman aşımını alır veya ayarlar. |
version |
string |
Görevin sürümünü alır veya ayarlar. |
WorkflowTaskReference
Name | Tür | Description |
---|---|---|
id |
string |
Görev tanımlayıcısı. |
name |
string |
Görevin adı. |
version |
string |
Görevin sürümü. |