Definitions - List

Başvuru

Service:: Release

API Version:: 6.0

Yayın tanımlarının listesini alın.

GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions?api-version=6.0

With optional parameters:

GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions?searchText={searchText}&$expand={$expand}&artifactType={artifactType}&artifactSourceId={artifactSourceId}&$top={$top}&continuationToken={continuationToken}&queryOrder={queryOrder}&path={path}&isExactNameMatch={isExactNameMatch}&tagFilter={tagFilter}&propertyFilters={propertyFilters}&definitionIdFilter={definitionIdFilter}&isDeleted={isDeleted}&searchTextContainsFolderName={searchTextContainsFolderName}&api-version=6.0

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 sürümü. Api'nin bu sürümünü kullanmak için bu değer '6.0' olarak ayarlanmalıdır.
$expand	query		ReleaseDefinitionExpands	Yayın tanımları listesinde genişletilmesi gereken özellikler.
$top	query		integer int32	Alınacak yayın tanımlarının sayısı.
artifactSourceId	query		string	Verilen artifactSourceId ile yayın tanımları döndürülür. Örneğin derleme için {projectGuid}:{BuildDefinitionId}, Jenkins için {JenkinsConnectionId}:{JenkinsDefinitionId}, TfsOnPrem için {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. TeamCity, BitBucket gibi üçüncü taraf yapıtlar için vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensionsdosyasında 'uniqueSourceIdentifier' öğesine başvurabilirsiniz.
artifactType	query		string	Verilen artifactType ile yayın tanımları döndürülür. Değerler Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild olabilir.
continuationToken	query		string	Sağlanan devamlılık belirtecinin ardından yayın tanımlarını alır.
definitionIdFilter	query		string array (string)	Alınacak yayın tanımlarının virgülle ayrılmış listesi.
isDeleted	query		boolean	Silinen yayın tanımlarını almak için 'true'. Varsayılan değer 'false'
isExactNameMatch	query		boolean	'true', searchText içinde belirtilen tam eşleşme ile yayın tanımlarını alır. Varsayılan değer 'false'tur.
path	query		string	Belirtilen yolun altındaki yayın tanımlarını alır.
propertyFilters	query		string array (string)	Alınacak genişletilmiş özelliklerin virgülle ayrılmış listesi. Ayarlanırsa, döndürülen Yayın Tanımları belirtilen özellik kimlikleri (varsa) için değerler içerir. Ayarlanmadıysa, özellikler dahil edilmeyecektir. Bunun, özellik kümesine sahip olup olmamasına bakılmaksızın sonuçlardan herhangi bir Yayın Tanımını filtrelemeyeceğini unutmayın.
queryOrder	query		ReleaseDefinitionQueryOrder	Sonuçları tanımlı sırada alır. Varsayılan değer :'IdAscending'.
searchText	query		string	searchText içeren adlara sahip yayın tanımlarını alın.
searchTextContainsFolderName	query		boolean	searchText'te belirtilen adla klasörün altındaki yayın tanımlarını almak için 'true'. Varsayılan değer 'false'tur.
tagFilter	query		string array (string)	Virgülle ayrılmış etiket listesi. Yalnızca bu etiketlere sahip sürüm tanımları döndürülür.

Yanıtlar

Name	Tür	Description
200 OK	ReleaseDefinition[]	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	Klasörler, yayınlar, yayın tanımları ve yayın ortamı dahil olmak üzere yayın yapıtlarını okuma yeteneği verir.

Örnekler

With artifacts details expanded

With environments details expanded

Sample Request

HTTP

GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/definitions?api-version=6.0

Sample Response

Status code:: 200

{
  "count": 1,
  "value": [
    {
      "source": "userInterface",
      "id": 1,
      "revision": 3,
      "name": "MyShuttle.CD",
      "description": null,
      "createdBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "createdOn": "2017-05-31T16:39:04.883Z",
      "modifiedBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "modifiedOn": "2017-05-31T16:39:58.06Z",
      "lastRelease": {
        "id": 14,
        "name": "Release-14",
        "artifacts": [],
        "webAccessUri": null,
        "_links": {},
        "description": "",
        "releaseDefinition": {
          "id": 1,
          "_links": {}
        },
        "createdOn": "2017-06-01T09:42:15.273Z",
        "createdBy": {
          "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
          "displayName": "Chuck Reinhart",
          "uniqueName": "fabfiber@outlook.com",
          "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
          "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
        },
        "modifiedBy": null,
        "reason": "none"
      },
      "path": "\\",
      "variableGroups": null,
      "releaseNameFormat": "Release-$(rev:r)",
      "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
      "_links": {
        "self": {
          "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
        },
        "web": {
          "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
        }
      },
      "properties": {}
    }
  ]
}

With artifacts details expanded

Sample Request

HTTP

GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/definitions?$expand=Artifacts&api-version=6.0

Sample Response

Status code:: 200

{
  "count": 1,
  "value": [
    {
      "source": "userInterface",
      "id": 1,
      "revision": 3,
      "name": "MyShuttle.CD",
      "description": null,
      "createdBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "createdOn": "2017-05-31T16:39:04.883Z",
      "modifiedBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "modifiedOn": "2017-05-31T16:39:58.06Z",
      "lastRelease": {
        "id": 14,
        "name": "Release-14",
        "artifacts": [],
        "webAccessUri": null,
        "_links": {},
        "description": "",
        "releaseDefinition": {
          "id": 1,
          "_links": {}
        },
        "createdOn": "2017-06-01T09:42:15.273Z",
        "createdBy": {
          "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
          "displayName": "Chuck Reinhart",
          "uniqueName": "fabfiber@outlook.com",
          "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
          "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
        },
        "modifiedBy": null,
        "reason": "none"
      },
      "path": "\\",
      "variableGroups": null,
      "artifacts": [],
      "releaseNameFormat": "Release-$(rev:r)",
      "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
      "_links": {
        "self": {
          "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
        },
        "web": {
          "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
        }
      },
      "properties": {}
    }
  ]
}

With environments details expanded

Sample Request

HTTP

GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/definitions?$expand=Environments&api-version=6.0

Sample Response

Status code:: 200

{
  "count": 1,
  "value": [
    {
      "source": "userInterface",
      "id": 1,
      "revision": 3,
      "name": "MyShuttle.CD",
      "description": null,
      "createdBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "createdOn": "2017-05-31T16:39:04.883Z",
      "modifiedBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "modifiedOn": "2017-05-31T16:39:58.06Z",
      "lastRelease": {
        "id": 14,
        "name": "Release-14",
        "artifacts": [],
        "webAccessUri": null,
        "_links": {},
        "description": "",
        "releaseDefinition": {
          "id": 1,
          "_links": {}
        },
        "createdOn": "2017-06-01T09:42:15.273Z",
        "createdBy": {
          "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
          "displayName": "Chuck Reinhart",
          "uniqueName": "fabfiber@outlook.com",
          "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
          "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
        },
        "modifiedBy": null,
        "reason": "none"
      },
      "path": "\\",
      "variableGroups": null,
      "environments": [
        {
          "id": 1,
          "name": "Dev",
          "rank": 1,
          "schedules": [],
          "retentionPolicy": {
            "daysToKeep": 30,
            "releasesToKeep": 3,
            "retainBuild": true
          }
        },
        {
          "id": 2,
          "name": "QA",
          "rank": 2,
          "schedules": [],
          "retentionPolicy": {
            "daysToKeep": 30,
            "releasesToKeep": 3,
            "retainBuild": true
          }
        },
        {
          "id": 3,
          "name": "PPE",
          "rank": 3,
          "schedules": [],
          "retentionPolicy": {
            "daysToKeep": 30,
            "releasesToKeep": 3,
            "retainBuild": true
          }
        },
        {
          "id": 4,
          "name": "PROD",
          "rank": 4,
          "schedules": [],
          "retentionPolicy": {
            "daysToKeep": 30,
            "releasesToKeep": 3,
            "retainBuild": true
          }
        }
      ],
      "releaseNameFormat": "Release-$(rev:r)",
      "retentionPolicy": {
        "daysToKeep": 30
      },
      "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
      "_links": {
        "self": {
          "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
        },
        "web": {
          "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
        }
      },
      "properties": {}
    }
  ]
}

Tanımlar

Name	Description
ApprovalExecutionOrder	Onay yürütme sırası.
ApprovalOptions
Artifact
ArtifactSourceReference
AuthorizationHeader
Condition
ConditionType	Koşul türünü alır veya ayarlar.
ConfigurationVariableValue
DataSourceBindingBase	Hizmet uç noktası isteği için veri kaynağının bağlamasını temsil eder.
Demand
DeployPhase
DeployPhaseTypes	Dağıtım aşaması türünü gösterir.
EnvironmentExecutionPolicy	Release Management tarafındaki kuyrukta ortam kuyruğa alma ilkesini tanımlar. Yalnızca belirtilen ilkeler karşılandığında Ortam Çalıştırıcısı'na [önceden dağıtım ve diğer adımlar oluşturma] göndereceğiz.
EnvironmentOptions
EnvironmentRetentionPolicy
EnvironmentTrigger
EnvironmentTriggerType	Tetikleyici türünü alır veya ayarlar.
IdentityRef
ProcessParameters
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.Object`tü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.
ReleaseDefinition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionDeployStep
ReleaseDefinitionEnvironment
ReleaseDefinitionExpands	Yayın tanımları listesinde genişletilmesi gereken özellikler.
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionQueryOrder	Sonuçları tanımlı sırada alır. Varsayılan değer :'IdAscending'.
ReleaseDefinitionShallowReference
ReleaseDefinitionSource	Yayın tanımının kaynağını alır veya ayarlar.
ReleaseReason	Sürüm nedenini alır.
ReleaseReference
ReleaseSchedule
ReleaseShallowReference
ReleaseTriggerBase
ReleaseTriggerType	Yayın tetikleyicisinin türü.
ScheduleDays	Yayınlanmak için haftanın günleri.
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
WorkflowTask

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ın kimliğinin yeniden doğrulanıp doğrulanmayacağını belirtin.
executionOrder	ApprovalExecutionOrder	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.

Artifact

Name	Tür	Description
alias	string	Diğer adı alır veya ayarlar.
definitionReference	<string, ArtifactSourceReference>	Tanım başvurularını alır veya ayarlar. örneğin, {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5aa90a6c","name":"myProject"},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}}.
isPrimary	boolean	Yapıtın birincil olup olmadığını gösterir.
isRetained	boolean	Yapıtın yayına göre korunup korunmadığını gösterir.
type	string	Türü alır veya ayarlar. 'Build', 'Jenkins', 'GitHub', 'Nuget', 'Team Build (external)', 'ExternalTFSBuild', 'Git', 'TFVC', 'ExternalTfsXamlBuild' gibi değerlere sahip olabilir.

ArtifactSourceReference

Name	Tür	Description
id	string	Yapıt kaynağının kimliği.
name	string	Yapıt kaynağının adı.

AuthorizationHeader

Name	Tür	Description
name	string
value	string

Condition

Name	Tür	Description
conditionType	ConditionType	Koşul türünü alır veya ayarlar.
name	string	Koşulun adını alır veya ayarlar. Örneğin , 'ReleaseStarted'.
value	string	Koşulun değerini alır veya ayarlar.

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 olarak alır veya ayarlar gizlidir veya değildir.
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	AuthorizationHeader[]	Yetkilendirme üst bilgilerini alır veya ayarlar.
initialContextTemplate	string	Sorgu parametrelerinin ilk değerini tanımlar
parameters	object	Veri kaynağının parametrelerini 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.

Demand

Name	Tür	Description
name	string	Talebin adını alır ve ayarlar.
value	string	Talebin değerini alır ve ayarlar.

DeployPhase

Name	Tür	Description
name	string	Dağıtım aşamasının adını alır ve ayarlar.
phaseType	DeployPhaseTypes	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	WorkflowTask[]	Dağıtım aşaması için iş akışı görevlerini alır ve ayarlar.

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.

EnvironmentExecutionPolicy

Release Management tarafındaki kuyrukta ortam kuyruğa alma ilkesini tanımlar. Yalnızca belirtilen ilkeler karşılandığında Ortam Çalıştırıcısı'na [önceden dağıtım ve diğer adımlar oluşturma] göndereceğiz.

Name	Tür	Description
concurrencyCount	integer	Bu ilke, Ortam Çalıştırıcısı ile kaç ortam olacağına karar verir.
queueDepthCount	integer	EnvironmentQueue tablosundaki kuyruk derinliği, ortam girdilerini Ortam Çalıştırıcısı çalıştırılana kadar [ilkeye göre] başka bir ortamı çalıştırmak üzere serbest tutana kadar tutar.

EnvironmentOptions

Name	Tür	Description
autoLinkWorkItems	boolean	Otomatik bağlantı çalışma öğeleri olarak alır ve ayarlar veya ayarlanmaz.
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 değildir.
pullRequestDeploymentEnabled	boolean	.pull isteği dağıtımının etkinleştirilip etkinleştirilmediğini alır ve ayarlar.

EnvironmentRetentionPolicy

Name	Tür	Description
daysToKeep	integer	Ortamın tutulacak gün sayısını alır ve ayarlar.
releasesToKeep	integer	Tutulacak yayın sayısını alır ve ayarlar.
retainBuild	boolean	Korunacak veya tutulmayacak derleme olarak alır ve ayarlar.

EnvironmentTrigger

Name	Tür	Description
definitionEnvironmentId	integer	Bu tetikleyicinin geçerli olduğu tanım ortamı kimliği.
releaseDefinitionId	integer	Bu tetikleyicinin geçerli olduğu ReleaseDefinition Kimliği.
triggerContent	string	Tetikleyici içeriğini alır veya ayarlar.
triggerType	EnvironmentTriggerType	Tetikleyici türünü alır veya ayarlar.

EnvironmentTriggerType

Tetikleyici türünü alır veya ayarlar.

Name	Tür	Description
deploymentGroupRedeploy	string	Ortam tetikleyici türü dağıtım grubu yeniden dağıtımıdır.
rollbackRedeploy	string	Ortam tetikleyici türü Geri Alma'dır.
undefined	string	Ortam tetikleyici türü tanımsız.

IdentityRef

Name	Tür	Description
_links	ReferenceLinks	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.

ProcessParameters

Name	Tür	Description
dataSourceBindings	DataSourceBindingBase[]	Hizmet uç noktası isteği için veri kaynağının bağlamasını temsil eder.
inputs	TaskInputDefinitionBase[]
sourceDefinitions	TaskSourceDefinitionBase[]

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.

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.

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.

ReleaseDefinition

Name	Tür	Description
_links	ReferenceLinks	Yayın tanımı için ilgili kaynaklara, API'lere ve görünümlere bağlantıları alır.
artifacts	Artifact[]	Yapıt listesini alır veya ayarlar.
comment	string	Açıklamayı alır veya ayarlar.
createdBy	IdentityRef	Oluşturan kimliği alır veya ayarlar.
createdOn	string	Oluşturulduğu tarihi alır.
description	string	Açıklamayı alır veya ayarlar.
environments	ReleaseDefinitionEnvironment[]	Ortamların listesini alır veya ayarlar.
id	integer	Yayın tanımının benzersiz tanımlayıcısını alır.
isDeleted	boolean	Yayın tanımının silinip silinmeyeceği.
lastRelease	ReleaseReference	Son sürümün başvuruyu alır.
modifiedBy	IdentityRef	Değiştiren kimliği alır veya ayarlar.
modifiedOn	string	Değiştirildiği tarihi 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	ProjectReference	Proje başvurularını alır veya ayarlar.
properties	PropertiesCollection	Özellikleri alır veya ayarlar.
releaseNameFormat	string	Yayın adı biçimini alır veya ayarlar.
revision	integer	Düzeltme numarasını alır.
source	ReleaseDefinitionSource	Yayın tanımının kaynağını alır veya ayarlar.
tags	string[]	Etiket listesini alır veya ayarlar.
triggers	ReleaseTriggerBase[]	Tetikleyici listesini alır veya ayarlar.
url	string	Yayın tanımına erişmek için REST API URL'sini alır.
variableGroups	integer[]	Değişken gruplarının listesini alır veya ayarlar.
variables	<string, ConfigurationVariableValue>	Değişkenlerin sözlüğünü alır veya ayarlar.

ReleaseDefinitionApprovals

Name	Tür	Description
approvalOptions	ApprovalOptions	Onay seçeneklerini alır veya ayarlar.
approvals	ReleaseDefinitionApprovalStep[]	Onayları alır veya ayarlar.

ReleaseDefinitionApprovalStep

Name	Tür	Description
approver	IdentityRef	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.

ReleaseDefinitionDeployStep

Name	Tür	Description
id	integer	Onay veya dağıtım adımının kimliği.
tasks	WorkflowTask[]	Bu tanımın adım listesi.

ReleaseDefinitionEnvironment

Name	Tür	Description
badgeUrl	string	BadgeUrl'i alır veya ayarlar. BadgeUrl, Yayın Tanımı Ortamı'nda Rozet etkinleştirildiğinde kullanılır.
conditions	Condition[]	Ortam koşullarını alır veya ayarlar.
currentRelease	ReleaseShallowReference	Geçerli sürüm başvuruyu alır veya ayarlar.
demands	Demand[]	Talepleri alır veya ayarlar.
deployPhases	DeployPhase[]	Ortamın dağıtım aşamalarını alır veya ayarlar.
deployStep	ReleaseDefinitionDeployStep	Deploystep değerini alır veya ayarlar.
environmentOptions	EnvironmentOptions	Ortam seçeneklerini alır veya ayarlar.
environmentTriggers	EnvironmentTrigger[]	Ortamda tetikleyicileri alır veya ayarlar.
executionPolicy	EnvironmentExecutionPolicy	Ortam yürütme ilkesini alır veya ayarlar.
id	integer	ReleaseDefinitionEnvironment kimliğini alır ve ayarlar.
name	string	ReleaseDefinitionEnvironment adını alır ve ayarlar.
owner	IdentityRef	ReleaseDefinitionEnvironment Sahibini alır ve ayarlar.
postDeployApprovals	ReleaseDefinitionApprovals	Dağıtım sonrası onayları alır veya ayarlar.
postDeploymentGates	ReleaseDefinitionGatesStep	Dağıtım sonrası geçitleri alır veya ayarlar.
preDeployApprovals	ReleaseDefinitionApprovals	Dağıtım öncesi onayları alır veya ayarlar.
preDeploymentGates	ReleaseDefinitionGatesStep	Dağıtım öncesi geçitleri alır veya ayarlar.
processParameters	ProcessParameters	Ortam işlemi parametrelerini alır veya ayarlar.
properties	PropertiesCollection	Ortamdaki özellikleri alır veya ayarlar.
queueId	integer	Kuyruk kimliğini alır veya ayarlar.
rank	integer	ReleaseDefinitionEnvironment değerini alır ve ayarlar.
retentionPolicy	EnvironmentRetentionPolicy	Ortam saklama ilkesini alır veya ayarlar.
schedules	ReleaseSchedule[]	Zamanlamaları alır veya ayarlar
variableGroups	integer[]	Değişken gruplarını alır veya ayarlar.
variables	<string, ConfigurationVariableValue>	Değişkenleri alır ve ayarlar.

ReleaseDefinitionExpands

Yayın tanımları listesinde genişletilmesi gereken özellikler.

Name	Tür	Description
artifacts	string	Dönüş nesnesine yapıtları ekleyin.
environments	string	Ortamları dönüş nesnesine dahil edin.
lastRelease	string	Dönüş nesnesine son sürümü dahil et.
none	string	Nesnenin en üst düzey özelliklerini döndürür.
tags	string	Dönüş nesnesine etiketleri ekleyin.
triggers	string	Dönüş nesnesine tetikleyicileri dahil edin.
variables	string	Dönüş nesnesine değişkenleri dahil edin.

ReleaseDefinitionGate

Name	Tür	Description
tasks	WorkflowTask[]	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ğerlendirmesi sonrasında 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	ReleaseDefinitionGate[]	Kapıları alır veya ayarlar.
gatesOptions	ReleaseDefinitionGatesOptions	Geçit seçeneklerini alır veya ayarlar.
id	integer	ReleaseDefinitionGateStep kimliği.

ReleaseDefinitionQueryOrder

Sonuçları tanımlı sırada alır. Varsayılan değer :'IdAscending'.

Name	Tür	Description
idAscending	string	Yayın tanımı kimliğine göre sonuçları artan düzende döndürür.
idDescending	string	Yayın tanımı kimliği azalan sırasına göre sonuçları döndürür.
nameAscending	string	Yayın tanımı adına göre sonuçları artan düzende döndürür.
nameDescending	string	Yayın tanımı adı azalan sırasına göre sonuçları döndürür.

ReleaseDefinitionShallowReference

Name	Tür	Description
_links	ReferenceLinks	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	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.

ReleaseDefinitionSource

Yayın tanımının kaynağını alır veya ayarlar.

Name	Tür	Description
ibiza	string	Ibiza'dan oluşturulan ReleaseDefinition öğesini gösterir.
portalExtensionApi	string	PortalExtension API'sinden oluşturulan ReleaseDefinition'i gösterir.
restApi	string	REST API kullanılarak oluşturulan ReleaseDefinition öğesini gösterir.
undefined	string	ReleaseDefinition kaynağının tanımlanmadığını gösterir.
userInterface	string	Kullanıcı arabirimi kullanılarak oluşturulan ReleaseDefinition öğesini gösterir.

ReleaseReason

Sürüm nedenini alır.

Name	Tür	Description
continuousIntegration	string	Sürekli tümleştirme tarafından tetiklenen yayını gösterir.
manual	string	El ile tetiklenen yayını gösterir.
none	string	Yayın tetiklenen nedenin ayarlanmadığını gösterir.
pullRequest	string	PullRequest tarafından tetiklenen sürümü gösterir.
schedule	string	Zamanlama tarafından tetiklenen sürümü gösterir.

ReleaseReference

Name	Tür	Description
_links	ReferenceLinks	Yayına erişmek için bağlantılar alır.
artifacts	Artifact[]	Yapıtların listesini alır.
createdBy	IdentityRef	Yayını oluşturan kimliği alır.
createdOn	string	Bu sürümün oluşturulduğu tarihi alır.
description	string	Açıklamayı alır.
id	integer	Yayın kimliği.
modifiedBy	IdentityRef	Sürümü değiştiren kimliği alır.
name	string	Yayın adını alır.
reason	ReleaseReason	Sürüm nedenini alır.
releaseDefinition	ReleaseDefinitionShallowReference	Yayın tanımı sığ başvuru alır.

ReleaseSchedule

Name	Tür	Description
daysToRelease	ScheduleDays	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	ReferenceLinks	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.

ReleaseTriggerBase

Name	Tür	Description
triggerType	ReleaseTriggerType	Yayın tetikleyicisinin türü.

ReleaseTriggerType

Yayın tetikleyicisinin türü.

Name	Tür	Description
artifactSource	string	Yapıt tabanlı yayın tetikleyicisi.
containerImage	string	Kapsayıcı görüntüsü tabanlı yayın tetikleyicisi.
package	string	Paket tabanlı yayın tetikleyicisi.
pullRequest	string	Çekme isteği tabanlı yayın tetikleyicisi.
schedule	string	Zamanlama tabanlı yayın tetikleyicisi.
sourceRepo	string	Kaynak depo tabanlı yayın tetikleyicisi.
undefined	string	Yayın tetikleyici türü ayarlanmadı.

ScheduleDays

Yayınlanmak 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	TaskInputValidation
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

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 etkin veya değil 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.
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.

Definitions - List

URI Parametreleri

Yanıtlar

Güvenlik

oauth2

Scopes

Örnekler

Sample Request

Sample Response

With artifacts details expanded

Sample Request

Sample Response

With environments details expanded

Sample Request

Sample Response

Tanımlar

ApprovalExecutionOrder

ApprovalOptions

Artifact

ArtifactSourceReference

AuthorizationHeader

Condition

ConditionType

ConfigurationVariableValue

DataSourceBindingBase

Demand

DeployPhase

DeployPhaseTypes

EnvironmentExecutionPolicy

EnvironmentOptions

EnvironmentRetentionPolicy

EnvironmentTrigger

EnvironmentTriggerType

IdentityRef

ProcessParameters

ProjectReference

PropertiesCollection

ReferenceLinks

ReleaseDefinition

ReleaseDefinitionApprovals

ReleaseDefinitionApprovalStep

ReleaseDefinitionDeployStep

ReleaseDefinitionEnvironment

ReleaseDefinitionExpands

ReleaseDefinitionGate

ReleaseDefinitionGatesOptions

ReleaseDefinitionGatesStep

ReleaseDefinitionQueryOrder

ReleaseDefinitionShallowReference

ReleaseDefinitionSource

ReleaseReason

ReleaseReference

ReleaseSchedule

ReleaseShallowReference

ReleaseTriggerBase

ReleaseTriggerType

ScheduleDays

TaskInputDefinitionBase

TaskInputValidation

TaskSourceDefinitionBase

WorkflowTask

Geri Bildirim

Ek kaynaklar