Freigeben über


Releases - Get Release

Abrufen eines Release

GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}?api-version=5.0
GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}?approvalFilters={approvalFilters}&propertyFilters={propertyFilters}&$expand={$expand}&$topGateRecords={$topGateRecords}&api-version=5.0

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

releaseId
path True

integer

int32

ID des Release.

api-version
query True

string

Version der zu verwendenden API. Dies sollte auf "5.0" festgelegt werden, um diese Version der API zu verwenden.

$expand
query

SingleReleaseExpands

Eine Eigenschaft, die in der Version erweitert werden soll.

$topGateRecords
query

integer

int32

Anzahl der abzurufenden Releasegatedatensätze. Der Standardwert ist 5.

approvalFilters
query

ApprovalFilters

Ein Filter, der das selektive Abrufen von Genehmigungsschritten basierend darauf ermöglicht, ob er automatisiert oder manuell erfolgt. Dies würde auch entscheiden, ob wir Momentaufnahmen vor und nach der Genehmigung abrufen sollten. Setzt standardmäßig alle voraus

propertyFilters
query

string

array (string)

Eine durch Trennzeichen getrennte Liste erweiterter Eigenschaften, die abgerufen werden sollen. Wenn festgelegt, enthält das zurückgegebene Release Werte für die angegebenen Eigenschafts-IDs (sofern vorhanden). Wenn sie nicht festgelegt ist, werden die Eigenschaften nicht eingeschlossen.

Antworten

Name Typ Beschreibung
200 OK

Release

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 Ermöglicht das Lesen von Releaseartefakten, einschließlich Releases, Releasedefinitionen und Releaseumgebung.

Beispiele

Sample Request

GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/releases/{releaseId}?api-version=5.0

Sample Response

{
  "id": 18,
  "name": "Release-18",
  "status": "abandoned",
  "createdOn": "2017-06-16T01:36:20.397Z",
  "modifiedOn": "2017-06-16T01:36:21.07Z",
  "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": 69,
      "releaseId": 18,
      "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": 18,
        "name": "Release-18",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=18&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18"
          }
        }
      },
      "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": 70,
      "releaseId": 18,
      "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": 18,
        "name": "Release-18",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=18&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18"
          }
        }
      },
      "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": 71,
      "releaseId": 18,
      "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": 18,
        "name": "Release-18",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=18&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18"
          }
        }
      },
      "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": 72,
      "releaseId": 18,
      "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": 18,
        "name": "Release-18",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=18&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18"
          }
        }
      },
      "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": "2"
        },
        "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": ""
        },
        "branch": {
          "id": "refs/heads/master",
          "name": "refs/heads/master"
        }
      },
      "isPrimary": true
    }
  ],
  "releaseDefinition": {
    "id": 1,
    "name": "MyShuttle.CD",
    "url": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
    "_links": {
      "self": {
        "href": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-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://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18/logs",
  "url": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18",
  "_links": {
    "self": {
      "href": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=18&_a=release-summary"
    }
  },
  "tags": [],
  "projectReference": {
    "id": "d07908bc-118f-47d2-8a13-ff75601a6b1a",
    "name": null
  },
  "properties": {}
}

Definitionen

Name Beschreibung
ApprovalExecutionOrder
ApprovalFilters

Ein Filter, der das selektive Abrufen von Genehmigungsschritten basierend darauf ermöglicht, ob er automatisiert oder manuell erfolgt. Dies würde auch entscheiden, ob wir Momentaufnahmen vor und nach der Genehmigung abrufen sollten. Setzt standardmäßig alle voraus

ApprovalOptions
ApprovalStatus

Ruft den status der Genehmigung ab oder legt diese fest.

ApprovalType

Ruft den Genehmigungstyp ab oder legt diese fest.

Artifact
ArtifactSourceReference
AuthorizationHeader
ConditionType

Ruft den Bedingungstyp ab oder legt den Bedingungstyp fest.

ConfigurationVariableValue
DataSourceBindingBase

Stellt die Bindung der Datenquelle für die Dienstendpunktanforderung dar.

Demand
DeploymentAttempt
DeploymentJob
DeploymentOperationStatus

Ruft den Vorgang status der Bereitstellung ab.

DeploymentReason

Ruft den Grund der Bereitstellung ab.

DeploymentStatus

Ruft status der Bereitstellung ab.

DeployPhase
DeployPhaseStatus
DeployPhaseTypes
EnvironmentOptions
EnvironmentStatus

Ruft umgebungs status ab.

GateStatus
IdentityRef
IgnoredGate
Issue
ManualIntervention
ManualInterventionStatus

Ruft den status des manuellen Eingriffs ab oder legt diesen fest.

ProcessParameters
ProjectReference
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) außer für DBNull werden akzeptiert. Werte des Typs Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als String umgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.

ReferenceLinks

Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Release
ReleaseApproval
ReleaseApprovalHistory
ReleaseCondition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDeployPhase
ReleaseEnvironment
ReleaseEnvironmentShallowReference
ReleaseGates
ReleaseReason

Ruft den Grund für die Freigabe ab.

ReleaseSchedule
ReleaseShallowReference
ReleaseStatus

Ruft status ab.

ReleaseTask
ScheduleDays

Zu veröffentlichende Wochentage

SingleReleaseExpands

Eine Eigenschaft, die in der Version erweitert werden soll.

TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
TaskStatus
VariableGroup
VariableGroupProviderData
VariableValue
WorkflowTask
WorkflowTaskReference

ApprovalExecutionOrder

Name Typ Beschreibung
afterGatesAlways

string

afterSuccessfulGates

string

beforeGates

string

ApprovalFilters

Ein Filter, der das selektive Abrufen von Genehmigungsschritten basierend darauf ermöglicht, ob er automatisiert oder manuell erfolgt. Dies würde auch entscheiden, ob wir Momentaufnahmen vor und nach der Genehmigung abrufen sollten. Setzt standardmäßig alle voraus

Name Typ Beschreibung
all

string

Alle Genehmigungsschritte und Genehmigungsmomentaufnahmen

approvalSnapshots

string

Keine Genehmigungsschritte, sondern Genehmigungsmomentaufnahmen (Verwenden Sie entweder mit ManualApprovals oder AutomatedApprovals für Genehmigungsschritte)

automatedApprovals

string

Automatisierte Genehmigungsschritte, aber keine Genehmigungsmomentaufnahmen (Verwenden mit ApprovalSnapshots für Momentaufnahmen)

manualApprovals

string

Manuelle Genehmigungsschritte, aber keine Genehmigungsmomentaufnahmen (Verwenden mit ApprovalSnapshots für Momentaufnahmen)

none

string

Keine Genehmigungen oder Genehmigungsmomentaufnahmen

ApprovalOptions

Name Typ Beschreibung
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped

boolean

enforceIdentityRevalidation

boolean

executionOrder

ApprovalExecutionOrder

releaseCreatorCanBeApprover

boolean

requiredApproverCount

integer

timeoutInMinutes

integer

ApprovalStatus

Ruft den status der Genehmigung ab oder legt diese fest.

Name Typ Beschreibung
approved

string

canceled

string

pending

string

reassigned

string

rejected

string

skipped

string

undefined

string

ApprovalType

Ruft den Genehmigungstyp ab oder legt diese fest.

Name Typ Beschreibung
all

string

postDeploy

string

preDeploy

string

undefined

string

Artifact

Name Typ Beschreibung
alias

string

Ruft den Alias ab oder legt den Alias fest.

definitionReference

<string,  ArtifactSourceReference>

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

Ruft ab oder legt fest, wenn das Artefakt primär ist oder nicht.

isRetained

boolean

type

string

Ruft den Typ ab oder legt den Typ fest. Der Wert kann als "Build", "Jenkins", "GitHub", "Nuget", "Team Build (external)", "ExternalTFSBuild", "Git", "TFVC", "ExternalTfsXamlBuild" angegeben werden.

ArtifactSourceReference

Name Typ Beschreibung
id

string

name

string

AuthorizationHeader

Name Typ Beschreibung
name

string

value

string

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 oder 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 Konfigurationsvariablen ab oder 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 der Datenquelle fest.

endpointId

string

Ruft die Endpunkt-ID ab oder legt sie fest.

endpointUrl

string

Ruft die URL des Dienstendpunkts ab oder legt sie fest.

headers

AuthorizationHeader[]

Ruft die Autorisierungsheader ab oder legt sie fest.

initialContextTemplate

string

Definiert den Anfangswert der Abfrageparameter.

parameters

object

Ruft die Parameter für die Datenquelle ab oder legt sie fest.

resultSelector

string

Ruft die Ergebnisauswahl 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.

Demand

Name Typ Beschreibung
name

string

value

string

DeploymentAttempt

Name Typ Beschreibung
attempt

integer

deploymentId

integer

hasStarted

boolean

Gibt an, ob die Bereitstellung gestartet wurde oder nicht

id

integer

issues

Issue[]

Alle Probleme im Zusammenhang mit der Bereitstellung

job

ReleaseTask

lastModifiedBy

IdentityRef

lastModifiedOn

string

operationStatus

DeploymentOperationStatus

postDeploymentGates

ReleaseGates

preDeploymentGates

ReleaseGates

queuedOn

string

reason

DeploymentReason

releaseDeployPhases

ReleaseDeployPhase[]

requestedBy

IdentityRef

requestedFor

IdentityRef

runPlanId

string

status

DeploymentStatus

tasks

ReleaseTask[]

DeploymentJob

Name Typ Beschreibung
job

ReleaseTask

tasks

ReleaseTask[]

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 ist phasenweise inprogress.

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 nicht 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

phaseType

DeployPhaseTypes

rank

integer

refName

string

workflowTasks

WorkflowTask[]

DeployPhaseStatus

Name Typ Beschreibung
canceled

string

cancelling

string

failed

string

inProgress

string

notStarted

string

partiallySucceeded

string

skipped

string

succeeded

string

undefined

string

DeployPhaseTypes

Name Typ Beschreibung
agentBasedDeployment

string

deploymentGates

string

Phasentyp, der Aufgaben enthält, die als Gates für die Bereitstellung fungieren.

machineGroupBasedDeployment

string

runOnServer

string

undefined

string

EnvironmentOptions

Name Typ Beschreibung
autoLinkWorkItems

boolean

badgeEnabled

boolean

emailNotificationType

string

emailRecipients

string

enableAccessToken

boolean

publishDeploymentStatus

boolean

pullRequestDeploymentEnabled

boolean

skipArtifactsDownload

boolean

timeoutInMinutes

integer

EnvironmentStatus

Ruft umgebungs status ab.

Name Typ Beschreibung
canceled

string

inProgress

string

notStarted

string

partiallySucceeded

string

queued

string

rejected

string

scheduled

string

succeeded

string

undefined

string

GateStatus

Name Typ Beschreibung
canceled

string

failed

string

inProgress

string

none

string

pending

string

succeeded

string

IdentityRef

Name Typ Beschreibung
_links

ReferenceLinks

Dieses Feld enthält null oder interessantere Links zum Graphthema. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Graphthema zu erhalten.

descriptor

string

Der Deskriptor ist die primäre Methode, um auf den Graph-Betreff 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

displayName

string

Dies ist der nicht eindeutige Anzeigename des Graph-Betreffs. Um dieses Feld zu ändern, müssen Sie seinen Wert im Quellanbieter ändern.

id

string

imageUrl

string

inactive

boolean

isAadIdentity

boolean

isContainer

boolean

isDeletedInOrigin

boolean

profileUrl

string

uniqueName

string

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

name

string

Name des Gates ignoriert.

Issue

Name Typ Beschreibung
data

object

issueType

string

message

string

ManualIntervention

Name Typ Beschreibung
approver

IdentityRef

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

ReleaseShallowReference

Ruft releaseReference für den manuellen Eingriff ab.

releaseDefinition

ReleaseDefinitionShallowReference

Ruft releaseDefinitionReference für den manuellen Eingriff ab.

releaseEnvironment

ReleaseEnvironmentShallowReference

Ruft releaseEnvironmentReference für den manuellen Eingriff ab.

status

ManualInterventionStatus

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

DataSourceBindingBase[]

Stellt die Bindung der Datenquelle für die Dienstendpunktanforderung dar.

inputs

TaskInputDefinitionBase[]

sourceDefinitions

TaskSourceDefinitionBase[]

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) außer für DBNull werden akzeptiert. Werte des Typs 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 Satz von Schlüsseln in der Auflistung.

values

string[]

Der Satz von Werten in der Auflistung.

Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name Typ Beschreibung
links

object

Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützter Sind, möchten wir sie nur als schreibgeschützter Link verfügbar machen.

Release

Name Typ Beschreibung
_links

ReferenceLinks

Ruft Links für den Zugriff auf das Release ab.

artifacts

Artifact[]

Ruft die Liste der Artefakte ab oder legt sie fest.

comment

string

Ruft einen Kommentar ab oder legt diese fest.

createdBy

IdentityRef

Ruft die Identität ab, die erstellt wurde, oder legt sie fest.

createdOn

string

Ruft das Erstellungsdatum ab.

definitionSnapshotRevision

integer

Ruft die Revisionsnummer der definition Momentaufnahme ab.

description

string

Ruft die Beschreibung des Release ab oder legt diese fest.

environments

ReleaseEnvironment[]

Ruft eine 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

IdentityRef

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.

poolName

string

Ruft den Poolnamen ab.

projectReference

ProjectReference

Ruft den Projektverweis ab oder legt diese fest.

properties

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) außer für DBNull werden akzeptiert. Werte des Typs Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als String umgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.

reason

ReleaseReason

Ruft den Grund der Freigabe ab.

releaseDefinition

ReleaseDefinitionShallowReference

Ruft releaseDefinitionReference ab, das den Verweis auf die Releasedefinition angibt, der dieses Release zugeordnet ist.

releaseNameFormat

string

Ruft das Format des Releasenamens ab.

status

ReleaseStatus

Ruft status ab.

tags

string[]

Ruft eine Liste von Tags ab oder legt sie fest.

triggeringArtifactAlias

string

variableGroups

VariableGroup[]

Ruft die Liste der Variablengruppen ab.

variables

<string,  ConfigurationVariableValue>

Ruft das Wörterbuch der Variablen ab oder legt es fest.

ReleaseApproval

Name Typ Beschreibung
approvalType

ApprovalType

Ruft den Genehmigungstyp ab oder legt diese fest.

approvedBy

IdentityRef

Ruft die Identität ab, die genehmigt hat.

approver

IdentityRef

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 diesen fest.

comments

string

Ruft Kommentare zur Genehmigung ab oder legt diese fest.

createdOn

string

Ruft das Datum ab, an dem sie erstellt wurde.

history

ReleaseApprovalHistory[]

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.

isNotificationOn

boolean

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

ReleaseShallowReference

Ruft releaseReference ab, das den Verweis auf das Release angibt, dem diese Genehmigung zugeordnet ist.

releaseDefinition

ReleaseDefinitionShallowReference

Ruft releaseDefinitionReference ab, das den Verweis auf die Releasedefinition angibt, der diese Genehmigung zugeordnet ist.

releaseEnvironment

ReleaseEnvironmentShallowReference

Ruft releaseEnvironmentReference ab, das den Verweis auf die Releaseumgebung angibt, der diese Genehmigung zugeordnet ist.

revision

integer

Ruft die Revisionsnummer ab.

status

ApprovalStatus

Ruft den status der Genehmigung ab oder legt diese fest.

trialNumber

integer

url

string

Ruft die URL ab, um auf die Genehmigung zuzugreifen.

ReleaseApprovalHistory

Name Typ Beschreibung
approver

IdentityRef

changedBy

IdentityRef

comments

string

createdOn

string

modifiedOn

string

revision

integer

ReleaseCondition

Name Typ Beschreibung
conditionType

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

value

string

Ruft den Wert der Bedingung ab oder legt den Wert fest.

ReleaseDefinitionApprovals

Name Typ Beschreibung
approvalOptions

ApprovalOptions

approvals

ReleaseDefinitionApprovalStep[]

ReleaseDefinitionApprovalStep

Name Typ Beschreibung
approver

IdentityRef

id

integer

isAutomated

boolean

isNotificationOn

boolean

rank

integer

ReleaseDefinitionGate

Name Typ Beschreibung
tasks

WorkflowTask[]

ReleaseDefinitionGatesOptions

Name Typ Beschreibung
isEnabled

boolean

minimumSuccessDuration

integer

samplingInterval

integer

stabilizationTime

integer

timeout

integer

ReleaseDefinitionGatesStep

Name Typ Beschreibung
gates

ReleaseDefinitionGate[]

gatesOptions

ReleaseDefinitionGatesOptions

id

integer

ReleaseDefinitionShallowReference

Name Typ Beschreibung
_links

ReferenceLinks

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

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

DeploymentJob[]

errorLog

string

id

integer

manualInterventions

ManualIntervention[]

name

string

phaseId

string

phaseType

DeployPhaseTypes

rank

integer

runPlanId

string

startedOn

string

Phasenstartzeit

status

DeployPhaseStatus

ReleaseEnvironment

Name Typ Beschreibung
conditions

ReleaseCondition[]

Ruft eine Liste der Bedingungen ab.

createdOn

string

Ruft das Erstellungsdatum ab.

definitionEnvironmentId

integer

Ruft die ID der Definitionsumgebung ab.

demands

Demand[]

Ruft Anforderungen ab.

deployPhasesSnapshot

DeployPhase[]

Ruft eine Liste der Bereitstellungsphasen Momentaufnahme ab.

deploySteps

DeploymentAttempt[]

Ruft Bereitstellungsschritte ab.

environmentOptions

EnvironmentOptions

Ruft Umgebungsoptionen ab.

id

integer

Ruft den eindeutigen Bezeichner dieses Felds ab.

modifiedOn

string

Ruft das Datum ab, an dem er geändert wurde.

name

string

Ruft den Namen ab.

nextScheduledUtcTime

string

Ruft die nächste geplante UTC-Zeit ab.

owner

IdentityRef

Ruft die Identität ab, die Besitzer der Releaseumgebung ist.

postApprovalsSnapshot

ReleaseDefinitionApprovals

Ruft die Liste der Genehmigungen nach der Bereitstellung Momentaufnahme ab.

postDeployApprovals

ReleaseApproval[]

Ruft eine Liste der Genehmigungen nach der Bereitstellung ab.

postDeploymentGatesSnapshot

ReleaseDefinitionGatesStep

preApprovalsSnapshot

ReleaseDefinitionApprovals

Ruft eine Liste der Vorabbereitstellungsgenehmigungen Momentaufnahme ab.

preDeployApprovals

ReleaseApproval[]

Ruft eine Liste der Vorabbereitstellungsgenehmigungen ab.

preDeploymentGatesSnapshot

ReleaseDefinitionGatesStep

processParameters

ProcessParameters

Ruft Prozessparameter ab.

queueId

integer

Ruft die Warteschlangen-ID ab.

rank

integer

Ruft den Rang ab.

release

ReleaseShallowReference

Ruft einen Releaseverweis ab, der den Verweis auf das Release angibt, dem diese Releaseumgebung zugeordnet ist.

releaseCreatedBy

IdentityRef

Ruft die Identität ab, die das Release erstellt hat.

releaseDefinition

ReleaseDefinitionShallowReference

Ruft releaseDefinitionReference ab, das den Verweis auf die Releasedefinition angibt, der diese Releaseumgebung zugeordnet ist.

releaseDescription

string

Ruft die Releasebeschreibung ab.

releaseId

integer

Ruft die Release-ID ab.

scheduledDeploymentTime

string

Ruft die Geplante Bereitstellungszeit der Releaseumgebung ab.

schedules

ReleaseSchedule[]

Ruft eine Liste der Zeitpläne ab.

status

EnvironmentStatus

Ruft umgebungs-status ab.

timeToDeploy

number

Ruft die Bereitstellungszeit ab.

triggerReason

string

Ruft den Triggergrund ab.

variableGroups

VariableGroup[]

Ruft die Liste der Variablengruppen ab.

variables

<string,  ConfigurationVariableValue>

Ruft das Wörterbuch der Variablen ab.

workflowTasks

WorkflowTask[]

Ruft eine Liste der Workflowaufgaben ab.

ReleaseEnvironmentShallowReference

Name Typ Beschreibung
_links

ReferenceLinks

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

DeploymentJob[]

id

integer

ignoredGates

IgnoredGate[]

lastModifiedOn

string

runPlanId

string

stabilizationCompletedOn

string

startedOn

string

status

GateStatus

succeedingSince

string

ReleaseReason

Ruft den Grund für die Freigabe ab.

Name Typ Beschreibung
continuousIntegration

string

manual

string

none

string

pullRequest

string

schedule

string

ReleaseSchedule

Name Typ Beschreibung
daysToRelease

ScheduleDays

Wochentage für die Veröffentlichung

jobId

string

Team Foundation-Auftragsdefinitions-Auftrags-ID

startHours

integer

Lokale Zeitzonenstunde zum Starten

startMinutes

integer

Minute für den Start der lokalen Zeitzone

timeZoneId

string

Zeitzonen-ID des Releasezeitplans, z. B. "UTC"

ReleaseShallowReference

Name Typ Beschreibung
_links

ReferenceLinks

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.

ReleaseStatus

Ruft status ab.

Name Typ Beschreibung
abandoned

string

active

string

draft

string

undefined

string

ReleaseTask

Name Typ Beschreibung
agentName

string

finishTime

string

id

integer

issues

Issue[]

lineCount

integer

logUrl

string

name

string

percentComplete

integer

rank

integer

resultCode

string

startTime

string

status

TaskStatus

task

WorkflowTaskReference

timelineRecordId

string

ScheduleDays

Zu veröffentlichende Wochentage

Name Typ Beschreibung
all

string

friday

string

monday

string

none

string

saturday

string

sunday

string

thursday

string

tuesday

string

wednesday

string

SingleReleaseExpands

Eine Eigenschaft, die in der Version erweitert werden soll.

Name Typ Beschreibung
none

string

tasks

string

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

TaskInputValidation

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

Name Typ Beschreibung
canceled

string

failed

string

failure

string

inProgress

string

partiallySucceeded

string

pending

string

skipped

string

succeeded

string

success

string

unknown

string

VariableGroup

Name Typ Beschreibung
createdBy

IdentityRef

Ruft die Identität ab, die erstellt wurde, oder legt sie fest.

createdOn

string

Ruft das Datum ab, an dem sie erstellt wurde.

description

string

Ruft eine Beschreibung ab oder legt diese 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

IdentityRef

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 oder legt den Namen fest.

providerData

VariableGroupProviderData

Ruft Anbieterdaten ab oder legt diese fest.

type

string

Ruft den Typ ab oder legt diese fest.

variables

<string,  VariableValue>

VariableGroupProviderData

VariableValue

Name Typ Beschreibung
isSecret

boolean

value

string

WorkflowTask

Name Typ Beschreibung
alwaysRun

boolean

condition

string

continueOnError

boolean

definitionType

string

enabled

boolean

environment

object

inputs

object

name

string

overrideInputs

object

refName

string

taskId

string

timeoutInMinutes

integer

version

string

WorkflowTaskReference

Name Typ Beschreibung
id

string

name

string

version

string