Releases - Create
Erstellen Sie ein Release.
POST https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases?api-version=7.1-preview.8
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
organization
|
path | True |
string |
Der Name der Azure DevOps-Organisation. |
project
|
path | True |
string |
Projekt-ID oder Projektname |
api-version
|
query | True |
string |
Version der zu verwendenden API. Dies sollte auf "7.1-preview.8" festgelegt werden, um diese Version der API zu verwenden. |
Anforderungstext
Name | Typ | Beschreibung |
---|---|---|
artifacts |
Legt die Liste des Artefakts fest, um ein Release zu erstellen. |
|
definitionId |
integer |
Legt die Definitions-ID fest, um ein Release zu erstellen. |
description |
string |
Legt die Beschreibung fest, um ein Release zu erstellen. |
environmentsMetadata |
Legt die Liste der Umgebungsmetadaten fest. |
|
isDraft |
boolean |
Legt "true" fest, um release im Entwurfsmodus zu erstellen, andernfalls "false". |
manualEnvironments |
string[] |
Legt die Liste der Umgebungen auf manuell als Bedingung fest. |
properties |
Die -Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüssel-Wert-Paaren dar. Werte aller primitiven Typen (jeder Typ mit einem |
|
reason |
Legt den Grund fest, um ein Release zu erstellen. |
|
variables |
<string,
Configuration |
Legt die Liste der Releasevariablen fest, die zum Zeitpunkt der Bereitstellung überschrieben werden sollen. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Erfolgreicher Vorgang |
Sicherheit
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 | Beschreibung |
---|---|
vso.release_execute | Ermöglicht das Lesen und Aktualisieren von Releaseartefakten, einschließlich Ordnern, Releases, Releasedefinitionen und Releaseumgebungen sowie die Möglichkeit, eine neue Version in die Warteschlange zu stellen. |
Beispiele
Sample Request
POST https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/releases?api-version=7.1-preview.8
{
"definitionId": 1,
"description": "Creating Sample release",
"artifacts": [
{
"alias": "Fabrikam.CI",
"instanceReference": {
"id": "2",
"name": null
}
}
],
"isDraft": false,
"reason": "none",
"manualEnvironments": null
}
Sample Response
{
"id": 19,
"name": "Release-19",
"status": "active",
"createdOn": "2017-06-16T01:53:32.777Z",
"modifiedOn": "2017-06-16T01:53:32.777Z",
"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"
},
"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"
},
"environments": [
{
"id": 73,
"releaseId": 19,
"name": "Dev",
"status": "notStarted",
"variables": {},
"preDeployApprovals": [],
"postDeployApprovals": [],
"preApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": false,
"isNotificationOn": false,
"approver": {
"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"
},
"id": 0
}
],
"approvalOptions": {
"requiredApproverCount": 0,
"releaseCreatorCanBeApprover": true,
"autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
"enforceIdentityRevalidation": false,
"timeoutInMintues": 43200
}
},
"postApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"deploySteps": [],
"rank": 1,
"definitionEnvironmentId": 1,
"environmentOptions": {
"emailNotificationType": "OnlyOnFailure",
"emailRecipients": "release.environment.owner;release.creator",
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"enableAccessToken": false,
"publishDeploymentStatus": false
},
"demands": [],
"conditions": [],
"workflowTasks": [],
"deployPhasesSnapshot": [
{
"deploymentInput": {
"parallelExecution": {
"parallelExecutionType": "none"
},
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"queueId": 2,
"demands": [],
"enableAccessToken": false
},
"rank": 1,
"phaseType": "agentBasedDeployment",
"name": "Run on agent",
"workflowTasks": [
{
"taskId": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"version": "1.*",
"name": "PowerShell Script",
"enabled": true,
"alwaysRun": false,
"continueOnError": false,
"timeoutInMinutes": 0,
"definitionType": "task",
"inputs": {
"scriptType": "inlineScript",
"scriptName": "",
"arguments": "",
"inlineScript": "# You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host \"Hello World\"",
"workingFolder": "",
"failOnStandardError": "true"
}
}
]
}
],
"owner": {
"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"
},
"schedules": [],
"release": {
"id": 19,
"name": "Release-19",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
}
}
},
"releaseDefinition": {
"id": 1,
"name": "MyShuttle.CD",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
}
}
},
"releaseCreatedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart"
},
"triggerReason": "Manual"
},
{
"id": 74,
"releaseId": 19,
"name": "QA",
"status": "notStarted",
"variables": {},
"preDeployApprovals": [],
"postDeployApprovals": [],
"preApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"postApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"deploySteps": [],
"rank": 2,
"definitionEnvironmentId": 2,
"environmentOptions": {
"emailNotificationType": "OnlyOnFailure",
"emailRecipients": "release.environment.owner;release.creator",
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"enableAccessToken": false,
"publishDeploymentStatus": false
},
"demands": [],
"conditions": [
{
"result": false,
"name": "Dev",
"conditionType": "environmentState",
"value": "4"
}
],
"workflowTasks": [],
"deployPhasesSnapshot": [
{
"deploymentInput": {
"parallelExecution": {
"parallelExecutionType": "none"
},
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"queueId": 2,
"demands": [],
"enableAccessToken": false
},
"rank": 1,
"phaseType": "agentBasedDeployment",
"name": "Run on agent",
"workflowTasks": [
{
"taskId": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"version": "1.*",
"name": "PowerShell Script",
"enabled": true,
"alwaysRun": false,
"continueOnError": false,
"timeoutInMinutes": 0,
"definitionType": "task",
"inputs": {
"scriptType": "inlineScript",
"scriptName": "",
"arguments": "",
"inlineScript": "# You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host \"Hello World\"",
"workingFolder": "",
"failOnStandardError": "true"
}
}
]
}
],
"owner": {
"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"
},
"schedules": [],
"release": {
"id": 19,
"name": "Release-19",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
}
}
},
"releaseDefinition": {
"id": 1,
"name": "MyShuttle.CD",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
}
}
},
"releaseCreatedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart"
},
"triggerReason": "After successful deployment of Dev"
},
{
"id": 75,
"releaseId": 19,
"name": "PPE",
"status": "notStarted",
"variables": {},
"preDeployApprovals": [],
"postDeployApprovals": [],
"preApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"postApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"deploySteps": [],
"rank": 3,
"definitionEnvironmentId": 3,
"environmentOptions": {
"emailNotificationType": "OnlyOnFailure",
"emailRecipients": "release.environment.owner;release.creator",
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"enableAccessToken": false,
"publishDeploymentStatus": false
},
"demands": [],
"conditions": [
{
"result": false,
"name": "QA",
"conditionType": "environmentState",
"value": "4"
}
],
"workflowTasks": [],
"deployPhasesSnapshot": [
{
"deploymentInput": {
"parallelExecution": {
"parallelExecutionType": "none"
},
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"queueId": 2,
"demands": [],
"enableAccessToken": false
},
"rank": 1,
"phaseType": "agentBasedDeployment",
"name": "Run on agent",
"workflowTasks": [
{
"taskId": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"version": "1.*",
"name": "PowerShell Script",
"enabled": true,
"alwaysRun": false,
"continueOnError": false,
"timeoutInMinutes": 0,
"definitionType": "task",
"inputs": {
"scriptType": "inlineScript",
"scriptName": "",
"arguments": "",
"inlineScript": "# You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host \"Hello World\"",
"workingFolder": "",
"failOnStandardError": "true"
}
}
]
}
],
"owner": {
"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"
},
"schedules": [],
"release": {
"id": 19,
"name": "Release-19",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
}
}
},
"releaseDefinition": {
"id": 1,
"name": "MyShuttle.CD",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
}
}
},
"releaseCreatedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart"
},
"triggerReason": "After successful deployment of QA"
},
{
"id": 76,
"releaseId": 19,
"name": "PROD",
"status": "notStarted",
"variables": {},
"preDeployApprovals": [],
"postDeployApprovals": [],
"preApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"postApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"deploySteps": [],
"rank": 4,
"definitionEnvironmentId": 4,
"environmentOptions": {
"emailNotificationType": "OnlyOnFailure",
"emailRecipients": "release.environment.owner;release.creator",
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"enableAccessToken": false,
"publishDeploymentStatus": false
},
"demands": [],
"conditions": [
{
"result": false,
"name": "PPE",
"conditionType": "environmentState",
"value": "4"
}
],
"workflowTasks": [],
"deployPhasesSnapshot": [
{
"deploymentInput": {
"parallelExecution": {
"parallelExecutionType": "none"
},
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"queueId": 2,
"demands": [],
"enableAccessToken": false
},
"rank": 1,
"phaseType": "agentBasedDeployment",
"name": "Run on agent",
"workflowTasks": [
{
"taskId": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"version": "1.*",
"name": "PowerShell Script",
"enabled": true,
"alwaysRun": false,
"continueOnError": false,
"timeoutInMinutes": 0,
"definitionType": "task",
"inputs": {
"scriptType": "inlineScript",
"scriptName": "",
"arguments": "",
"inlineScript": "# You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host \"Hello World\"",
"workingFolder": "",
"failOnStandardError": "true"
}
}
]
}
],
"owner": {
"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"
},
"schedules": [],
"release": {
"id": 19,
"name": "Release-19",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
}
}
},
"releaseDefinition": {
"id": 1,
"name": "MyShuttle.CD",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
}
}
},
"releaseCreatedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart"
},
"triggerReason": "After successful deployment of PPE"
}
],
"variables": {},
"variableGroups": [],
"artifacts": [
{
"sourceId": "d07908bc-118f-47d2-8a13-ff75601a6b1a:1",
"type": "Build",
"alias": "Fabrikam.CI",
"definitionReference": {
"artifactSourceDefinitionUrl": {
"id": "https://dev.azure.com/fabrikam/_permalink/_build/index?collectionId=13d3daac-03b8-4a23-9cc4-2c3de65dab63&projectId=d07908bc-118f-47d2-8a13-ff75601a6b1a&definitionId=1",
"name": ""
},
"defaultVersionBranch": {
"id": "",
"name": ""
},
"defaultVersionSpecific": {
"id": "",
"name": ""
},
"defaultVersionTags": {
"id": "",
"name": ""
},
"defaultVersionType": {
"id": "latestType",
"name": "Latest"
},
"definition": {
"id": "1",
"name": "Fabrikam.CI"
},
"project": {
"id": "d07908bc-118f-47d2-8a13-ff75601a6b1a",
"name": "MyFirstProject"
},
"version": {
"id": "2",
"name": ""
},
"artifactSourceVersionUrl": {
"id": "https://dev.azure.com/fabrikam/_permalink/_build/index?collectionId=13d3daac-03b8-4a23-9cc4-2c3de65dab63&projectId=d07908bc-118f-47d2-8a13-ff75601a6b1a&buildId=2",
"name": ""
}
},
"isPrimary": true
}
],
"releaseDefinition": {
"id": 1,
"name": "MyShuttle.CD",
"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"
}
}
},
"description": "Creating Sample release",
"reason": "manual",
"releaseNameFormat": "Release-$(rev:r)",
"keepForever": false,
"definitionSnapshotRevision": 1,
"logsContainerUrl": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19/logs",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
"_links": {
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
},
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
}
},
"tags": [],
"projectReference": {
"id": "d07908bc-118f-47d2-8a13-ff75601a6b1a",
"name": null
},
"properties": {}
}
Definitionen
Name | Beschreibung |
---|---|
Approval |
Ausführungsreihenfolge für Genehmigungen. |
Approval |
|
Approval |
Ruft den status der Genehmigung ab oder legt diese fest. |
Approval |
Ruft den Genehmigungstyp ab oder legt diese fest. |
Artifact | |
Artifact |
|
Artifact |
|
Authorization |
|
Build |
|
Condition |
Ruft den Bedingungstyp ab oder legt den Bedingungstyp fest. |
Configuration |
|
Data |
Stellt die Bindung der Datenquelle für die Dienstendpunktanforderung dar. |
Deployment |
|
Deployment |
|
Deployment |
Ruft den Vorgang status der Bereitstellung ab. |
Deployment |
Ruft den Grund der Bereitstellung ab. |
Deployment |
Ruft status der Bereitstellung ab. |
Deploy |
|
Deploy |
Status der Phase. |
Deploy |
Gibt den Typ der Bereitstellungsphase an. |
Environment |
|
Environment |
Ruft umgebungs status ab. |
Gate |
Status der Releasegates. |
Identity |
|
Ignored |
|
Issue | |
Manual |
|
Manual |
Ruft den status des manuellen Eingriffs ab oder legt diesen fest. |
Process |
|
Project |
|
Properties |
Die -Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüssel-Wert-Paaren dar. Werte aller primitiven Typen (jeder Typ mit einem |
Reference |
Die Klasse, die eine Auflistung von REST-Verweislinks darstellt. |
Release | |
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
Ruft den Grund für die Freigabe ab. |
Release |
|
Release |
|
Release |
|
Release |
|
Release |
Ruft status ab. |
Release |
|
Schedule |
Wochentage, die veröffentlicht werden sollen. |
Source |
|
Task |
|
Task |
|
Task |
|
Task |
Status der Freigabeaufgabe. |
Variable |
|
Variable |
Ein Variablengruppenverweis ist ein flacher Verweis auf die Variablengruppe. |
Variable |
|
Variable |
|
Workflow |
|
Workflow |
ApprovalExecutionOrder
Ausführungsreihenfolge für Genehmigungen.
Name | Typ | Beschreibung |
---|---|---|
afterGatesAlways |
string |
Genehmigungen werden immer nach der Ausführung von Gates angezeigt. |
afterSuccessfulGates |
string |
Genehmigungen, die nach erfolgreicher Ausführung von Gates angezeigt werden. |
beforeGates |
string |
Genehmigungen, die vor Gates angezeigt werden. |
ApprovalOptions
Name | Typ | Beschreibung |
---|---|---|
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped |
boolean |
Geben Sie an, ob die Genehmigung übersprungen werden kann, wenn derselbe genehmigende Benutzer die vorherige Phase genehmigt hat. |
enforceIdentityRevalidation |
boolean |
Geben Sie vor Abschluss der Genehmigung an, ob die Identität des genehmigenden Benutzers überprüft wird. |
executionOrder |
Ausführungsreihenfolge der Genehmigungen. |
|
releaseCreatorCanBeApprover |
boolean |
Geben Sie an, ob der Benutzer, der ein Release oder eine Bereitstellung anfordert, genehmigende Personen zulassen soll. |
requiredApproverCount |
integer |
Die Anzahl der Genehmigungen, die zum Verschieben der Freigabe erforderlich sind. "0" bezeichnet alle erforderlichen Genehmigungen. |
timeoutInMinutes |
integer |
Genehmigungstimeout. Das Standardzeitlimit für die Genehmigung beträgt 30 Tage. Das maximal zulässige Timeout beträgt 365 Tage. "0" bedeutet standardtimeout, d. h. 30 Tage. |
ApprovalStatus
Ruft den status der Genehmigung ab oder legt diese fest.
Name | Typ | Beschreibung |
---|---|---|
approved |
string |
Gibt an, dass die Genehmigung genehmigt wurde. |
canceled |
string |
Gibt an, dass die Genehmigung abgebrochen wurde. |
pending |
string |
Gibt an, dass die Genehmigung aussteht. |
reassigned |
string |
Gibt an, dass die Genehmigung neu zugewiesen wird. |
rejected |
string |
Gibt an, dass die Genehmigung abgelehnt wird. |
skipped |
string |
Gibt an, dass die Genehmigung übersprungen wird. |
undefined |
string |
Gibt an, dass für die Genehmigung die status nicht festgelegt ist. |
ApprovalType
Ruft den Genehmigungstyp ab oder legt diese fest.
Name | Typ | Beschreibung |
---|---|---|
all |
string |
Gibt alle Genehmigungen an. |
postDeploy |
string |
Gibt die Genehmigungen an, die nach der Bereitstellung ausgeführt wurden. |
preDeploy |
string |
Gibt die Genehmigungen an, die vor der Bereitstellung ausgeführt wurden. |
undefined |
string |
Gibt an, dass der Genehmigungstyp nicht festgelegt wird. |
Artifact
Name | Typ | Beschreibung |
---|---|---|
alias |
string |
Ruft alias ab oder legt den Alias fest. |
definitionReference |
<string,
Artifact |
Ruft den Definitionsverweis ab oder legt diese fest. z. B. {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5aa90a6c","name":"myProject"},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}}} |
isPrimary |
boolean |
Gibt an, ob es sich um ein primäres Artefakt handelt oder nicht. |
isRetained |
boolean |
Gibt an, ob das Artefakt nach release beibehalten wird oder nicht. |
type |
string |
Ruft den Typ ab oder legt diese fest. Es kann einen Wert wie "Build", "Jenkins", "GitHub", "Nuget", "Team Build (extern)", "ExternalTFSBuild", "Git", "TFVC", "ExternalTfsXamlBuild" aufweisen. |
ArtifactMetadata
Name | Typ | Beschreibung |
---|---|---|
alias |
string |
Legt den Alias des Artefakts fest. |
instanceReference |
Legt instance Verweis auf das Artefakt fest. z. B. beim Buildartefakt ist es die Buildnummer. |
ArtifactSourceReference
Name | Typ | Beschreibung |
---|---|---|
id |
string |
ID der Artefaktquelle. |
name |
string |
Name der Artefaktquelle. |
AuthorizationHeader
Name | Typ | Beschreibung |
---|---|---|
name |
string |
|
value |
string |
BuildVersion
Name | Typ | Beschreibung |
---|---|---|
commitMessage |
string |
Ruft die Commitnachricht für das Artefakt ab oder legt sie fest. |
definitionId |
string |
Ruft die Definitions-ID ab oder legt sie fest. |
definitionName |
string |
Ruft den Definitionsnamen ab oder legt diese fest. |
id |
string |
Ruft die Build-ID ab oder legt sie fest. |
isMultiDefinitionType |
boolean |
Ruft ab oder legt fest, ob das Artefakt mehrere Definitionen unterstützt. |
name |
string |
Ruft die Buildnummer ab oder legt diese fest. |
sourceBranch |
string |
Ruft den Quellbranch für das Artefakt ab oder legt diese fest. |
sourcePullRequestVersion |
Ruft die Quell-Pull Request-Version für das Artefakt ab oder legt diese fest. |
|
sourceRepositoryId |
string |
Ruft die Repository-ID für das Artefakt ab oder legt diese fest. |
sourceRepositoryType |
string |
Ruft den Repositorytyp für das Artefakt ab oder legt diese fest. |
sourceVersion |
string |
Ruft die Quellversion für das Artefakt ab oder legt diese fest. |
ConditionType
Ruft den Bedingungstyp ab oder legt den Bedingungstyp fest.
Name | Typ | Beschreibung |
---|---|---|
artifact |
string |
Der Bedingungstyp ist artefakt. |
environmentState |
string |
Der Bedingungstyp ist der Umgebungszustand. |
event |
string |
Der Bedingungstyp ist das Ereignis. |
undefined |
string |
Der Bedingungstyp ist nicht definiert. |
ConfigurationVariableValue
Name | Typ | Beschreibung |
---|---|---|
allowOverride |
boolean |
Ruft ab und legt fest, ob eine Variable zur Bereitstellungszeit überschrieben werden kann oder nicht. |
isSecret |
boolean |
Ruft ab oder legt sie fest, da die Variable geheim ist oder nicht. |
value |
string |
Ruft den Wert der Konfigurationsvariable ab und legt den Wert fest. |
DataSourceBindingBase
Stellt die Bindung der Datenquelle für die Dienstendpunktanforderung dar.
Name | Typ | Beschreibung |
---|---|---|
callbackContextTemplate |
string |
Paginierungsformat, das von dieser Datenquelle unterstützt wird (ContinuationToken/SkipTop). |
callbackRequiredTemplate |
string |
Nachfolgende Aufrufe erforderlich? |
dataSourceName |
string |
Ruft den Namen der Datenquelle ab oder legt den Namen fest. |
endpointId |
string |
Ruft die Endpunkt-ID ab oder legt diese fest. |
endpointUrl |
string |
Ruft die URL des Dienstendpunkts ab oder legt sie fest. |
headers |
Ruft die Autorisierungsheader ab oder legt diese fest. |
|
initialContextTemplate |
string |
Definiert den Anfangswert der Abfrageparameter |
parameters |
object |
Ruft die Parameter für die Datenquelle ab oder legt sie fest. |
requestContent |
string |
Ruft http-Anforderungstext ab oder legt den Text fest |
requestVerb |
string |
Ruft http-Anforderungsverb ab oder legt es fest |
resultSelector |
string |
Ruft den Ergebnisauswahlor ab oder legt diese fest. |
resultTemplate |
string |
Ruft die Ergebnisvorlage ab oder legt sie fest. |
target |
string |
Ruft das Ziel der Datenquelle ab oder legt es fest. |
DeploymentAttempt
Name | Typ | Beschreibung |
---|---|---|
attempt |
integer |
Bereitstellungsversuch. |
deploymentId |
integer |
ID der Bereitstellung. |
hasStarted |
boolean |
Gibt an, ob die Bereitstellung gestartet wurde. |
id |
integer |
ID der Bereitstellung. |
issues |
Issue[] |
Alle Probleme im Zusammenhang mit der Bereitstellung. |
lastModifiedBy |
Identität, die diese Bereitstellung zuletzt geändert hat. |
|
lastModifiedOn |
string |
Zeitpunkt der letzten Änderung dieser Bereitstellung. |
operationStatus |
Bereitstellungsvorgang status. |
|
postDeploymentGates |
Post-Bereitstellungsgates, die in dieser Bereitstellung ausgeführt wurden. |
|
preDeploymentGates |
Vorabbereitstellungsgates, die in dieser Bereitstellung ausgeführt wurden. |
|
queuedOn |
string |
Wenn diese Bereitstellung in die Warteschlange eingereiht wurde. |
reason |
Grund für die Bereitstellung. |
|
releaseDeployPhases |
Liste der Releasebereitstellungsphase, die in dieser Bereitstellung ausgeführt werden. |
|
requestedBy |
Identität, die diese Bereitstellung angefordert hat. |
|
requestedFor |
Die Identität für diese Bereitstellung wurde angefordert. |
|
status |
status der Bereitstellung. |
DeploymentJob
Name | Typ | Beschreibung |
---|---|---|
job |
Übergeordnete Aufgabe aller ausgeführten Aufgaben. |
|
tasks |
Liste der ausgeführten Aufgaben mit in Auftrag. |
DeploymentOperationStatus
Ruft den Vorgang status der Bereitstellung ab.
Name | Typ | Beschreibung |
---|---|---|
all |
string |
Der bereitstellungsvorgang status ist alles. |
approved |
string |
Der status Bereitstellungsvorgang wird genehmigt. |
canceled |
string |
Der Bereitstellungsvorgang status wird abgebrochen. |
cancelling |
string |
Der Bereitstellungsvorgang status wird abgebrochen. |
deferred |
string |
Der Bereitstellungsvorgang status wird zurückgestellt. |
evaluatingGates |
string |
Der bereitstellungsvorgang status ist EvaluatingGates. |
gateFailed |
string |
Der bereitstellungsvorgang status ist GateFailed. |
manualInterventionPending |
string |
Der Bereitstellungsvorgang status ist manuell ausstehend. |
pending |
string |
Der Bereitstellungsvorgang status steht aus. |
phaseCanceled |
string |
Der Bereitstellungsvorgang status wird phasenweise abgebrochen. |
phaseFailed |
string |
Beim Bereitstellungsvorgang status ist ein Fehler aufgetreten. |
phaseInProgress |
string |
Der Bereitstellungsvorgang status wird in der Phase ausgeführt. |
phasePartiallySucceeded |
string |
Der Bereitstellungsvorgang status ist teilweise erfolgreich. |
phaseSucceeded |
string |
Der Bereitstellungsvorgang status phase erfolgreich ist. |
queued |
string |
Der Bereitstellungsvorgang status wird in eine Warteschlange gestellt. |
queuedForAgent |
string |
Der Bereitstellungsvorgang status wird für den Agent in die Warteschlange gestellt. |
queuedForPipeline |
string |
Der Bereitstellungsvorgang status wird für die Pipeline in die Warteschlange gestellt. |
rejected |
string |
Der Bereitstellungsvorgang status wird abgelehnt. |
scheduled |
string |
Der Bereitstellungsvorgang status wird geplant. |
undefined |
string |
Der bereitstellungsvorgang status ist nicht definiert. |
DeploymentReason
Ruft den Grund der Bereitstellung ab.
Name | Typ | Beschreibung |
---|---|---|
automated |
string |
Der Bereitstellungsgrund ist automatisiert. |
manual |
string |
Der Bereitstellungsgrund ist manuell. |
none |
string |
Der Bereitstellungsgrund ist keiner. |
redeployTrigger |
string |
Der Bereitstellungsgrund ist RedeployTrigger. |
scheduled |
string |
Der Bereitstellungsgrund ist geplant. |
DeploymentStatus
Ruft status der Bereitstellung ab.
Name | Typ | Beschreibung |
---|---|---|
all |
string |
Die Bereitstellung status ist alles. |
failed |
string |
Fehler bei der Bereitstellung status. |
inProgress |
string |
Die Bereitstellung status wird ausgeführt. |
notDeployed |
string |
Die Bereitstellung status wird nicht bereitgestellt. |
partiallySucceeded |
string |
Die Bereitstellung status wird teilweise ausgeführt. |
succeeded |
string |
Die bereitstellung status ist erfolgreich. |
undefined |
string |
Die Bereitstellung status ist nicht definiert. |
DeployPhase
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Ruft den Namen der Bereitstellungsphase ab und legt den Namen der Bereitstellungsphase fest. |
phaseType |
Gibt den Typ der Bereitstellungsphase an. |
|
rank |
integer |
Ruft den Rang der Bereitstellungsphase ab und legt diese fest. |
refName |
string |
Ruft den Verweisnamen der Bereitstellungsphase ab und legt diese fest. |
workflowTasks |
Ruft die Workflowtasks für die Bereitstellungsphase ab und legt sie fest. |
DeployPhaseStatus
Status der Phase.
Name | Typ | Beschreibung |
---|---|---|
canceled |
string |
Die Phasenausführung wurde abgebrochen. |
cancelling |
string |
Phase befindet sich im Status "Abbrechen". |
failed |
string |
Fehler bei der Phasenausführung. |
inProgress |
string |
Die Phasenausführung wird ausgeführt. |
notStarted |
string |
Die Phasenausführung wurde nicht gestartet. |
partiallySucceeded |
string |
Die Phasenausführung war teilweise erfolgreich. |
skipped |
string |
Phasenausführung übersprungen. |
succeeded |
string |
Die Phasenausführung war erfolgreich. |
undefined |
string |
Phase status nicht festgelegt. |
DeployPhaseTypes
Gibt den Typ der Bereitstellungsphase an.
Name | Typ | Beschreibung |
---|---|---|
agentBasedDeployment |
string |
Phasentyp, der Aufgaben enthält, die für den Agent ausgeführt werden. |
deploymentGates |
string |
Phasentyp, der Aufgaben enthält, die als Gates für die Bereitstellung fungieren. |
machineGroupBasedDeployment |
string |
Phasentyp, der Aufgaben enthält, die auf Bereitstellungsgruppencomputern ausgeführt werden. |
runOnServer |
string |
Phasentyp, der Aufgaben enthält, die vom Server ausgeführt werden. |
undefined |
string |
Phasentyp nicht definiert. Bitte nicht verwenden. |
EnvironmentOptions
Name | Typ | Beschreibung |
---|---|---|
autoLinkWorkItems |
boolean |
Ruft ab und legt sie fest, ob die Arbeitselemente für die automatische Verknüpfung verwendet werden oder nicht. |
badgeEnabled |
boolean |
Ruft ab und legt es fest, wenn das Signal aktiviert ist oder nicht. |
publishDeploymentStatus |
boolean |
Ruft ab und legt sie fest, als die Veröffentlichungsbereitstellung status oder nicht. |
pullRequestDeploymentEnabled |
boolean |
Ruft die .pull request-Bereitstellung ab, die aktiviert ist oder nicht, und legt sie fest. |
EnvironmentStatus
Ruft umgebungs status ab.
Name | Typ | Beschreibung |
---|---|---|
canceled |
string |
Die Umgebung befindet sich im Abgebrochenen Zustand. |
inProgress |
string |
Die Umgebung befindet sich im Status "In Bearbeitung". |
notStarted |
string |
Die Umgebung befindet sich im Nicht gestarteten Zustand. |
partiallySucceeded |
string |
Die Umgebung befindet sich in einem teilweise erfolgreichen Zustand. |
queued |
string |
Die Umgebung befindet sich in der Warteschlange. |
rejected |
string |
Die Umgebung befindet sich im abgelehnten Zustand. |
scheduled |
string |
Die Umgebung befindet sich im geplanten Zustand. |
succeeded |
string |
Die Umgebung befindet sich im Status "Erfolgreich". |
undefined |
string |
Umgebung status nicht festgelegt. |
GateStatus
Status der Releasegates.
Name | Typ | Beschreibung |
---|---|---|
canceled |
string |
Die Gateausführung wurde abgebrochen. |
failed |
string |
Fehler bei der Gateausführung. |
inProgress |
string |
Das Gate wird derzeit ausgeführt. |
none |
string |
Für das Gate ist die status nicht festgelegt. |
pending |
string |
Das Gate befindet sich im Status "Ausstehend". |
succeeded |
string |
Das Gate wurde erfolgreich abgeschlossen. |
IdentityRef
Name | Typ | Beschreibung |
---|---|---|
_links |
Dieses Feld enthält null oder interessantere Links zum Diagrammthema. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Graph-Thema zu erhalten. |
|
descriptor |
string |
Der Deskriptor ist die primäre Möglichkeit, auf den Graphengegenstand zu verweisen, während das System ausgeführt wird. In diesem Feld wird derselbe Graph-Betreff sowohl für Konten als auch für Organisationen eindeutig identifiziert. |
directoryAlias |
string |
Veraltet: Kann abgerufen werden, indem der Graph-Benutzer abgefragt wird, auf den im Eintrag "selbst" des IdentityRef-Wörterbuchs "_links" verwiesen wird. |
displayName |
string |
Dies ist der nicht eindeutige Anzeigename des Diagrammsubjekts. Um dieses Feld zu ändern, müssen Sie seinen Wert im Quellanbieter ändern. |
id |
string |
|
imageUrl |
string |
Veraltet: Verfügbar im Eintrag "avatar" des IdentityRef-Wörterbuchs "_links" |
inactive |
boolean |
Veraltet: Kann durch Abfragen des Graph-Mitgliedschaftsstatus abgerufen werden, auf den im Eintrag "membershipState" des GraphUser-Wörterbuchs "_links" verwiesen wird. |
isAadIdentity |
boolean |
Veraltet: Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
isContainer |
boolean |
Veraltet: Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsGroupType) |
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
Veraltet: Wird in den meisten bereits vorhandenen Implementierungen von ToIdentityRef nicht verwendet. |
uniqueName |
string |
Veraltet: Verwenden Sie stattdessen Domain+PrincipalName. |
url |
string |
Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs. |
IgnoredGate
Name | Typ | Beschreibung |
---|---|---|
lastModifiedOn |
string |
Ruft das Datum ab, an dem das Gate zuletzt ignoriert wurde. |
name |
string |
Name des Gates wurde ignoriert. |
Issue
Name | Typ | Beschreibung |
---|---|---|
data |
object |
Problemdaten. |
issueType |
string |
Problemtyp, z. B. Fehler, Warnung oder Info. |
message |
string |
Problemmeldung. |
ManualIntervention
Name | Typ | Beschreibung |
---|---|---|
approver |
Ruft die Identität ab, die genehmigen soll, oder legt sie fest. |
|
comments |
string |
Ruft Kommentare zur Genehmigung ab oder legt diese fest. |
createdOn |
string |
Ruft das Erstellungsdatum ab. |
id |
integer |
Ruft den eindeutigen Bezeichner für den manuellen Eingriff ab. |
instructions |
string |
Ruft Anweisungen für die Genehmigung ab oder legt diese fest. |
modifiedOn |
string |
Ruft das Datum ab, an dem er geändert wurde. |
name |
string |
Ruft den Namen ab oder legt diesen fest. |
release |
Ruft releaseReference für den manuellen Eingriff ab. |
|
releaseDefinition |
Ruft releaseDefinitionReference für den manuellen Eingriff ab. |
|
releaseEnvironment |
Ruft releaseEnvironmentReference für den manuellen Eingriff ab. |
|
status |
Ruft den status des manuellen Eingriffs ab oder legt diesen fest. |
|
taskInstanceId |
string |
Ruft den Task instance Bezeichner ab. |
url |
string |
Ruft die URL für den Zugriff auf den manuellen Eingriff ab. |
ManualInterventionStatus
Ruft den status des manuellen Eingriffs ab oder legt diesen fest.
Name | Typ | Beschreibung |
---|---|---|
approved |
string |
Der manuelle Eingriff wird genehmigt. |
canceled |
string |
Der manuelle Eingriff wird abgebrochen. |
pending |
string |
Der manuelle Eingriff steht aus. |
rejected |
string |
Der manuelle Eingriff wird abgelehnt. |
unknown |
string |
Für den manuellen Eingriff ist die status nicht festgelegt. |
ProcessParameters
Name | Typ | Beschreibung |
---|---|---|
dataSourceBindings |
Stellt die Bindung der Datenquelle für die Dienstendpunktanforderung dar. |
|
inputs | ||
sourceDefinitions |
ProjectReference
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Ruft den eindeutigen Bezeichner dieses Felds ab. |
name |
string |
Ruft den Namen des Projekts ab. |
PropertiesCollection
Die -Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüssel-Wert-Paaren dar. Werte aller primitiven Typen (jeder Typ mit einem TypeCode != TypeCode.Object
) mit Ausnahme von DBNull
werden akzeptiert. Werte vom Typ Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als String umgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.
Name | Typ | Beschreibung |
---|---|---|
count |
integer |
Die Anzahl der Eigenschaften in der Auflistung. |
item |
object |
|
keys |
string[] |
Der Schlüsselsatz in der Auflistung. |
values |
string[] |
Der Wertsatz in der Auflistung. |
ReferenceLinks
Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
Name | Typ | Beschreibung |
---|---|---|
links |
object |
Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen. |
Release
Name | Typ | Beschreibung |
---|---|---|
_links |
Ruft Links für den Zugriff auf die Version ab. |
|
artifacts |
Artifact[] |
Ruft die Liste der Artefakte ab oder legt sie fest. |
comment |
string |
Ruft einen Kommentar ab oder legt diese fest. |
createdBy |
Ruft die Identität ab, die erstellt wurde, oder legt sie fest. |
|
createdFor |
Ruft die Identität ab, für die das Release erstellt wurde, oder legt sie fest. |
|
createdOn |
string |
Ruft das Datum ab, an dem sie erstellt wurde. |
definitionSnapshotRevision |
integer |
Ruft die Revisionsnummer der definition Momentaufnahme ab. |
description |
string |
Ruft die Beschreibung der Version ab oder legt diese fest. |
environments |
Ruft die Liste der Umgebungen ab. |
|
id |
integer |
Ruft den eindeutigen Bezeichner dieses Felds ab. |
keepForever |
boolean |
Gibt an, ob das Release von Aufbewahrungsrichtlinien ausgeschlossen werden soll. |
logsContainerUrl |
string |
Ruft die Container-URL für Protokolle ab. |
modifiedBy |
Ruft die Identität ab, die geändert wurde, oder legt sie fest. |
|
modifiedOn |
string |
Ruft das Datum ab, an dem sie geändert wurde. |
name |
string |
Ruft den Namen ab. |
poolName |
string |
Ruft den Poolnamen ab. |
projectReference |
Ruft den Projektverweis ab oder legt diese fest. |
|
properties |
Die -Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüssel-Wert-Paaren dar. Werte aller primitiven Typen (jeder Typ mit einem |
|
reason |
Ruft den Releasegrund ab. |
|
releaseDefinition |
Ruft releaseDefinitionReference ab, das den Verweis auf die Releasedefinition angibt, der dieses Release zugeordnet ist. |
|
releaseDefinitionRevision |
integer |
Ruft die Releasedefinitionsrevision ab oder legt sie fest. |
releaseNameFormat |
string |
Ruft das Format des Releasenamens ab. |
status |
Ruft status ab. |
|
tags |
string[] |
Ruft die Liste der Tags ab oder legt diese fest. |
triggeringArtifactAlias |
string |
|
variableGroups |
Ruft die Liste der Variablengruppen ab. |
|
variables |
<string,
Configuration |
Ruft das Wörterbuch der Variablen ab oder legt es fest. |
ReleaseApproval
Name | Typ | Beschreibung |
---|---|---|
approvalType |
Ruft den Genehmigungstyp ab oder legt diese fest. |
|
approvedBy |
Ruft die Identität ab, die genehmigt hat. |
|
approver |
Ruft die Identität ab, die genehmigen soll, oder legt sie fest. |
|
attempt |
integer |
Ruft den Versuch ab, der angibt, zu welchem Bereitstellungsversuch er gehört, oder legt ihn fest. |
comments |
string |
Ruft Kommentare zur Genehmigung ab oder legt diese fest. |
createdOn |
string |
Ruft das Erstellungsdatum ab. |
history |
Ruft den Verlauf ab, der alle Genehmigungen angibt, die dieser Genehmigung zugeordnet sind. |
|
id |
integer |
Ruft den eindeutigen Bezeichner dieses Felds ab. |
isAutomated |
boolean |
Ruft ab oder legt sie fest, wenn die Genehmigung automatisiert ist oder nicht. |
modifiedOn |
string |
Ruft das Datum ab, an dem sie geändert wurde. |
rank |
integer |
Ruft den Rang ab, der die Reihenfolge der Genehmigung angibt, oder legt diese fest. z. B. der gleiche Rang bezeichnet die parallele Genehmigung. |
release |
Ruft releaseReference ab, das den Verweis auf das Release angibt, dem diese Genehmigung zugeordnet ist. |
|
releaseDefinition |
Ruft releaseDefinitionReference ab, das den Verweis auf die Releasedefinition angibt, der diese Genehmigung zugeordnet ist. |
|
releaseEnvironment |
Ruft releaseEnvironmentReference ab, das den Verweis auf die Releaseumgebung angibt, der diese Genehmigung zugeordnet ist. |
|
revision |
integer |
Ruft die Revisionsnummer ab. |
status |
Ruft den status der Genehmigung ab oder legt diese fest. |
|
url |
string |
Ruft die URL ab, um auf die Genehmigung zuzugreifen. |
ReleaseApprovalHistory
Name | Typ | Beschreibung |
---|---|---|
approver |
Identität des genehmigenden Personen. |
|
changedBy |
Identität des Objekts, das die Genehmigung geändert hat. |
|
comments |
string |
Genehmigungsverlaufskommentare. |
createdOn |
string |
Zeitpunkt, zu dem diese Genehmigung erstellt wurde. |
modifiedOn |
string |
Zeitpunkt, zu dem diese Genehmigung geändert wurde. |
revision |
integer |
Überprüfung des Genehmigungsverlaufs. |
ReleaseCondition
Name | Typ | Beschreibung |
---|---|---|
conditionType |
Ruft den Bedingungstyp ab oder legt den Bedingungstyp fest. |
|
name |
string |
Ruft den Namen der Bedingung ab oder legt den Namen der Bedingung fest. z.B. "ReleaseStarted". |
result |
boolean |
Das Ergebnis der Releasebedingung. |
value |
string |
Ruft den Wert der Bedingung ab oder legt den Wert fest. |
ReleaseDefinitionApprovals
Name | Typ | Beschreibung |
---|---|---|
approvalOptions |
Ruft die Genehmigungsoptionen ab oder legt sie fest. |
|
approvals |
Ruft die Genehmigungen ab oder legt sie fest. |
ReleaseDefinitionApprovalStep
Name | Typ | Beschreibung |
---|---|---|
approver |
Ruft den genehmigenden Benutzer ab und legt ihn fest. |
|
id |
integer |
ID des Genehmigungs- oder Bereitstellungsschritts. |
isAutomated |
boolean |
Gibt an, ob die Genehmigung automatisiert ist. |
isNotificationOn |
boolean |
Gibt an, ob der Genehmigungsbenachrichtigungssatz festgelegt ist. |
rank |
integer |
Ruft den Rang des Genehmigungsschritts ab oder legt diese fest. |
ReleaseDefinitionGate
Name | Typ | Beschreibung |
---|---|---|
tasks |
Ruft den Gates-Workflow ab oder legt diese fest. |
ReleaseDefinitionGatesOptions
Name | Typ | Beschreibung |
---|---|---|
isEnabled |
boolean |
Ruft ab oder legt diese fest, wenn die Gates aktiviert sind oder nicht. |
minimumSuccessDuration |
integer |
Ruft die Mindestdauer für stabile Ergebnisse nach einer erfolgreichen Gatesauswertung ab oder legt diese fest. |
samplingInterval |
integer |
Ruft die Zeit zwischen der Neuauswertung von Gates ab oder legt diese fest. |
stabilizationTime |
integer |
Ruft die Verzögerung vor der Auswertung ab oder legt sie fest. |
timeout |
integer |
Ruft das Timeout ab, nach dem Gates fehlschlagen, oder legt dieses fest. |
ReleaseDefinitionGatesStep
Name | Typ | Beschreibung |
---|---|---|
gates |
Ruft die Gates ab oder legt sie fest. |
|
gatesOptions |
Ruft die Gateoptionen ab oder legt sie fest. |
|
id |
integer |
ID des ReleaseDefinitionGateStep. |
ReleaseDefinitionShallowReference
Name | Typ | Beschreibung |
---|---|---|
_links |
Ruft die Links zu verwandten Ressourcen, APIs und Ansichten für die Releasedefinition ab. |
|
id |
integer |
Ruft den eindeutigen Bezeichner der Releasedefinition ab. |
name |
string |
Ruft den Namen der Releasedefinition ab oder legt den Namen fest. |
path |
string |
Ruft den Pfad der Releasedefinition ab oder legt den Pfad fest. |
projectReference |
Ruft den Projektverweis ab oder legt diese fest. |
|
url |
string |
Ruft die REST-API-URL für den Zugriff auf die Releasedefinition ab. |
ReleaseDeployPhase
Name | Typ | Beschreibung |
---|---|---|
deploymentJobs |
Bereitstellungsaufträge der Phase. |
|
errorLog |
string |
Fehlerprotokolle für die Phasenausführung. |
manualInterventions |
Liste der Informationen zur Ausführung manueller Interventionsaufgaben in der Phase. |
|
name |
string |
Name der Phase. |
phaseId |
string |
ID der Phase. |
phaseType |
Typ der Phase. |
|
rank |
integer |
Rang der Phase. |
runPlanId |
string |
Führen Sie die Plan-ID der Phase aus. |
startedOn |
string |
Phasenstartzeit. |
status |
Status der Phase. |
ReleaseEnvironment
Name | Typ | Beschreibung |
---|---|---|
conditions |
Ruft die Liste der Bedingungen ab. |
|
createdOn |
string |
Ruft das Datum ab, an dem sie erstellt wurde. |
definitionEnvironmentId |
integer |
Ruft die Definitionsumgebungs-ID ab. |
deployPhasesSnapshot |
Ruft die Liste der Bereitstellungsphasen ab, die Momentaufnahme. |
|
deploySteps |
Ruft Bereitstellungsschritte ab. |
|
environmentOptions |
Ruft Umgebungsoptionen ab. |
|
id |
integer |
Ruft den eindeutigen Bezeichner dieses Felds ab. |
modifiedOn |
string |
Ruft das Datum ab, an dem sie geändert wurde. |
name |
string |
Ruft den Namen ab. |
nextScheduledUtcTime |
string |
Ruft die nächste geplante UTC-Zeit ab. |
owner |
Ruft die Identität ab, die Besitzer der Releaseumgebung ist. |
|
postApprovalsSnapshot |
Ruft die Liste der Genehmigungen nach der Bereitstellung Momentaufnahme ab. |
|
postDeployApprovals |
Ruft eine Liste der Genehmigungen nach der Bereitstellung ab. |
|
postDeploymentGatesSnapshot |
Nach der Bereitstellung Momentaufnahme Daten. |
|
preApprovalsSnapshot |
Ruft eine Liste der Vorabbereitstellungsgenehmigungen Momentaufnahme ab. |
|
preDeployApprovals |
Ruft eine Liste der Vorabbereitstellungsgenehmigungen ab. |
|
preDeploymentGatesSnapshot |
Vor der Bereitstellung Momentaufnahme Daten. |
|
processParameters |
Ruft Prozessparameter ab. |
|
rank |
integer |
Ruft den Rang ab. |
release |
Ruft einen Releaseverweis ab, der den Verweis auf das Release angibt, dem diese Releaseumgebung zugeordnet ist. |
|
releaseCreatedBy |
Ruft die Identität ab, die das Release erstellt hat. |
|
releaseDefinition |
Ruft releaseDefinitionReference ab, das den Verweis auf die Releasedefinition angibt, der diese Releaseumgebung zugeordnet ist. |
|
releaseId |
integer |
Ruft die Release-ID ab. |
scheduledDeploymentTime |
string |
Ruft die Geplante Bereitstellungszeit der Releaseumgebung ab. |
schedules |
Ruft eine Liste der Zeitpläne ab. |
|
status |
Ruft umgebungs-status ab. |
|
timeToDeploy |
number |
Ruft die Bereitstellungszeit ab. |
triggerReason |
string |
Ruft den Triggergrund ab. |
variableGroups |
Ruft die Liste der Variablengruppen ab. |
|
variables |
<string,
Configuration |
Ruft das Wörterbuch der Variablen ab. |
ReleaseEnvironmentShallowReference
Name | Typ | Beschreibung |
---|---|---|
_links |
Ruft die Links zu zugehörigen Ressourcen, APIs und Ansichten für die Releaseumgebung ab. |
|
id |
integer |
Ruft den eindeutigen Bezeichner der Releaseumgebung ab. |
name |
string |
Ruft den Namen der Releaseumgebung ab oder legt den Namen fest. |
url |
string |
Ruft die REST-API-URL für den Zugriff auf die Releaseumgebung ab. |
ReleaseGates
Name | Typ | Beschreibung |
---|---|---|
deploymentJobs |
Enthält die Details zu den Gates-Aufträgen der einzelnen Auswertungen. |
|
id |
integer |
ID der Releasegates. |
ignoredGates |
Liste der ignorierten Gates. |
|
lastModifiedOn |
string |
Zeitpunkt der letzten Änderung von Gates. |
runPlanId |
string |
Führen Sie die Plan-ID der Gates aus. |
stabilizationCompletedOn |
string |
Datum und Uhrzeit der Gates-Stabilisierung abgeschlossen. |
startedOn |
string |
Die Gates-Auswertung begann mit der Zeit. |
status |
Status der Releasegates. |
|
succeedingSince |
string |
Datum und Uhrzeit, zu der alle Gates erfolgreich ausgeführt wurden. |
ReleaseReason
Ruft den Grund für die Freigabe ab.
Name | Typ | Beschreibung |
---|---|---|
continuousIntegration |
string |
Gibt das Release an, das durch Continuous Integration ausgelöst wird. |
manual |
string |
Gibt das manuell ausgelöste Release an. |
none |
string |
Gibt an, warum der Releaseauslösungsgrund nicht festgelegt wurde. |
pullRequest |
string |
Gibt das durch PullRequest ausgelöste Release an. |
schedule |
string |
Gibt das Release an, das nach Zeitplan ausgelöst wird. |
ReleaseSchedule
Name | Typ | Beschreibung |
---|---|---|
daysToRelease |
Wochentage, die veröffentlicht werden sollen. |
|
jobId |
string |
Team Foundation-Auftragsdefinitions-Auftrags-ID. |
scheduleOnlyWithChanges |
boolean |
Flag, um zu bestimmen, ob dieser Zeitplan nur freigegeben werden soll, wenn das zugeordnete Artefakt geändert oder die Releasedefinition geändert wurde. |
startHours |
integer |
Lokale Zeitzonenstunde zu starten. |
startMinutes |
integer |
Lokale Zeitzonenminute für den Start. |
timeZoneId |
string |
Zeitzonen-ID des Releasezeitplans, z. B. "UTC". |
ReleaseShallowReference
Name | Typ | Beschreibung |
---|---|---|
_links |
Ruft die Links zu zugehörigen Ressourcen, APIs und Ansichten für das Release ab. |
|
id |
integer |
Ruft den eindeutigen Bezeichner der Freigabe ab. |
name |
string |
Ruft den Namen des Release ab oder legt den Namen fest. |
url |
string |
Ruft die REST-API-URL für den Zugriff auf das Release ab. |
ReleaseStartEnvironmentMetadata
Name | Typ | Beschreibung |
---|---|---|
definitionEnvironmentId |
integer |
Legt die Id der Releasedefinitionsumgebung fest. |
variables |
<string,
Configuration |
Legt die Liste der Umgebungsvariablen fest, die zur Bereitstellungszeit überschrieben werden sollen. |
ReleaseStartMetadata
Name | Typ | Beschreibung |
---|---|---|
artifacts |
Legt die Liste des Artefakts fest, um ein Release zu erstellen. |
|
definitionId |
integer |
Legt die Definitions-ID fest, um ein Release zu erstellen. |
description |
string |
Legt die Beschreibung fest, um ein Release zu erstellen. |
environmentsMetadata |
Legt die Liste der Umgebungsmetadaten fest. |
|
isDraft |
boolean |
Legt "true" fest, um die Version im Entwurfsmodus zu erstellen, andernfalls "false". |
manualEnvironments |
string[] |
Legt die Liste der Umgebungen als Bedingung auf manuell fest. |
properties |
Die -Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüssel-Wert-Paaren dar. Werte aller primitiven Typen (jeder Typ mit einem |
|
reason |
Legt den Grund fest, aus dem ein Release erstellt werden soll. |
|
variables |
<string,
Configuration |
Legt die Liste der Releasevariablen fest, die zur Bereitstellungszeit überschrieben werden sollen. |
ReleaseStatus
Ruft status ab.
Name | Typ | Beschreibung |
---|---|---|
abandoned |
string |
Release status ist nicht mehr vorhanden. |
active |
string |
Release status aktiv ist. |
draft |
string |
Release befindet sich im Entwurfszustand. |
undefined |
string |
Release status nicht festgelegt. |
ReleaseTask
Name | Typ | Beschreibung |
---|---|---|
agentName |
string |
Agentname, für den der Task ausgeführt wurde. |
finishTime |
string |
Endzeit des Releasetasks. |
id |
integer |
ID des Freigabetasks. |
issues |
Issue[] |
Liste der Probleme, die während der Ausführung des Tasks aufgetreten sind. |
lineCount |
integer |
Anzahl der Zeilen, über die der Protokollfreigabetask verfügt. |
logUrl |
string |
Protokoll-URL der Aufgabe. |
name |
string |
Der Name der Aufgabe. |
percentComplete |
integer |
Die Ausführung des Vorgangs wird abgeschlossen. |
rank |
integer |
Rang der Freigabeaufgabe. |
resultCode |
string |
Ergebniscode der Aufgabe. |
startTime |
string |
ID des Freigabetasks. |
status |
Status der Freigabeaufgabe. |
|
task |
Workflowaufgabenverweis. |
|
timelineRecordId |
string |
Zeitachsendatensatz-ID des Freigabetasks. |
ScheduleDays
Wochentage, die veröffentlicht werden sollen.
Name | Typ | Beschreibung |
---|---|---|
all |
string |
Geplant an allen Tagen in der Woche. |
friday |
string |
Geplant am Freitag. |
monday |
string |
Geplant am Montag. |
none |
string |
Geplanter Tag nicht festgelegt. |
saturday |
string |
Geplant am Samstag. |
sunday |
string |
Geplant am Sonntag. |
thursday |
string |
Geplant am Donnerstag. |
tuesday |
string |
Geplant am Dienstag. |
wednesday |
string |
Geplant am Mittwoch. |
SourcePullRequestVersion
Name | Typ | Beschreibung |
---|---|---|
iterationId |
string |
Die Iterations-ID für Pull Request, für die das Release status veröffentlicht. |
pullRequestId |
string |
Pull Request ID, für die das Release status veröffentlicht. |
pullRequestMergedAt |
string |
Datum und Uhrzeit der Erstellung des Pull Request-Merges. Es ist erforderlich, Zeitleiste Datensatz der durch Pull Request erstellten Releases zu führen. |
sourceBranch |
string |
Quellbranch des Pull Request. |
sourceBranchCommitId |
string |
Quellbranchcommit-ID des Pull Request, für den das Release status veröffentlicht. |
targetBranch |
string |
Zielbranch des Pull Request. |
TaskInputDefinitionBase
Name | Typ | Beschreibung |
---|---|---|
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 | Typ | Beschreibung |
---|---|---|
expression |
string |
Bedingter Ausdruck |
message |
string |
Meldung, die erläutert, wie der Benutzer korrigieren kann, wenn die Überprüfung fehlschlägt |
TaskSourceDefinitionBase
Name | Typ | Beschreibung |
---|---|---|
authKey |
string |
|
endpoint |
string |
|
keySelector |
string |
|
selector |
string |
|
target |
string |
TaskStatus
Status der Freigabeaufgabe.
Name | Typ | Beschreibung |
---|---|---|
canceled |
string |
Die Taskausführung wurde abgebrochen. |
failed |
string |
Fehler bei der Taskausführung. |
failure |
string |
Fehler bei der Taskausführung. |
inProgress |
string |
Die Aufgabe wird derzeit ausgeführt. |
partiallySucceeded |
string |
Die Taskausführung war teilweise erfolgreich. |
pending |
string |
Die Aufgabe ist ausstehend status. |
skipped |
string |
Die Taskausführung wurde übersprungen. |
succeeded |
string |
Die Aufgabe wurde erfolgreich abgeschlossen. |
success |
string |
Die Aufgabe wurde erfolgreich abgeschlossen. |
unknown |
string |
Für die Aufgabe ist die status nicht festgelegt. |
VariableGroup
Name | Typ | Beschreibung |
---|---|---|
createdBy |
Ruft die Identität ab, die erstellt wurde, oder legt sie fest. |
|
createdOn |
string |
Ruft das Erstellungsdatum ab. |
description |
string |
Ruft die Beschreibung ab oder legt sie fest. |
id |
integer |
Ruft den eindeutigen Bezeichner dieses Felds ab. |
isShared |
boolean |
Gibt an, ob eine Variablengruppe für ein anderes Projekt freigegeben wird oder nicht. |
modifiedBy |
Ruft die Identität ab, die geändert wurde, oder legt sie fest. |
|
modifiedOn |
string |
Ruft das Datum ab, an dem er geändert wurde. |
name |
string |
Ruft den Namen ab oder legt den Namen fest. |
providerData |
Ruft Anbieterdaten ab oder legt diese fest. |
|
type |
string |
Ruft den Typ ab oder legt den Typ fest. |
variableGroupProjectReferences |
alle Projektverweise, bei denen die Variablengruppe für andere Projekte freigegeben ist. |
|
variables |
<string,
Variable |
Ruft das Wörterbuch der Variablen ab und legt es fest. |
VariableGroupProjectReference
Ein Variablengruppenverweis ist ein flacher Verweis auf die Variablengruppe.
Name | Typ | Beschreibung |
---|---|---|
description |
string |
Ruft die Beschreibung der Variablengruppe ab oder legt diese fest. |
name |
string |
Ruft den Namen der Variablengruppe ab oder legt den Namen fest. |
projectReference |
Ruft den Projektverweis der Variablengruppe ab oder legt diese fest. |
VariableGroupProviderData
VariableValue
Name | Typ | Beschreibung |
---|---|---|
isReadOnly |
boolean |
Ruft ab oder legt fest, ob die Variable schreibgeschützt ist oder nicht. |
isSecret |
boolean |
Ruft ab oder legt sie fest, da die Variable geheim ist oder nicht. |
value |
string |
Ruft den Wert ab oder legt den Wert fest. |
WorkflowTask
Name | Typ | Beschreibung |
---|---|---|
alwaysRun |
boolean |
Ruft ab oder legt sie fest, da der Task immer ausgeführt wird oder nicht. |
condition |
string |
Ruft die Vorgangsbedingung ab oder legt sie fest. |
continueOnError |
boolean |
Ruft ab oder legt sie fest, wenn die Aufgabe weiterhin mit einem Fehler ausgeführt wird oder nicht. |
definitionType |
string |
Ruft den Aufgabendefinitionstyp ab oder legt diese fest. Beispiel: "Agent", DeploymentGroup", "Server" oder "ServerGate". |
enabled |
boolean |
Ruft ab oder legt sie fest, wenn die Aufgabe aktiviert ist oder nicht. |
environment |
object |
Ruft die Umgebungsvariablen der Aufgabe ab oder legt sie fest. |
inputs |
object |
Ruft die Aufgabeneingaben ab oder legt diese fest. |
name |
string |
Ruft den Namen des Tasks ab oder legt ihn fest. |
overrideInputs |
object |
Ruft die Aufgabeneingaben ab oder legt sie fest. |
refName |
string |
Ruft den Verweisnamen des Vorgangs ab oder legt diese fest. |
retryCountOnTaskFailure |
integer |
Ruft den Task retryCount ab oder legt ihn fest. |
taskId |
string |
Ruft die ID der Aufgabe ab oder legt sie fest. |
timeoutInMinutes |
integer |
Ruft das Tasktimeout ab oder legt es fest. |
version |
string |
Ruft die Version der Aufgabe ab oder legt sie fest. |
WorkflowTaskReference
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Vorgangsbezeichner. |
name |
string |
Der Name der Aufgabe. |
version |
string |
Version der Aufgabe. |