Freigeben über


Releases - Create

Erstellen Sie eine Version.

POST https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases?api-version=7.1

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" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name Typ Beschreibung
artifacts

ArtifactMetadata[]

Legt die Liste des Artefakts fest, um eine Freigabe zu erstellen.

definitionId

integer (int32)

Legt die Definitions-ID fest, um eine Version zu erstellen.

description

string

Legt die Beschreibung fest, um eine Version zu erstellen.

environmentsMetadata

ReleaseStartEnvironmentMetadata[]

Legt eine Liste der Umgebungsmetadaten fest.

isDraft

boolean

Legt "true" fest, um die Freigabe im Entwurfsmodus zu erstellen, andernfalls "false".

manualEnvironments

string[]

Legt die Liste der Umgebungen so fest, dass sie manuell als Bedingung festgelegt werden.

properties

PropertiesCollection

Die Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüsselwertpaaren dar. Werte aller Grundtypen (beliebiger 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 Zeichenfolge neu abgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.

reason

ReleaseReason

Legt den Grund fest, eine Version zu erstellen.

variables

<string,  ConfigurationVariableValue>

Legt die Liste der Releasevariablen fest, die zur Bereitstellungszeit außer Kraft gesetzt werden sollen.

Antworten

Name Typ Beschreibung
200 OK

Release

Erfolgreicher Vorgang

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-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

Bereiche

Name Beschreibung
vso.release_execute Gewährt die Möglichkeit zum Lesen und Aktualisieren von Releaseartefakten, einschließlich Ordnern, Versionen, Releasedefinitionen und Releaseumgebung sowie der Möglichkeit, eine neue Version in die Warteschlange zu stellen.

Beispiele

Beispielanforderung

POST https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/releases?api-version=7.1

{
  "definitionId": 1,
  "description": "Creating Sample release",
  "artifacts": [
    {
      "alias": "Fabrikam.CI",
      "instanceReference": {
        "id": "2",
        "name": null
      }
    }
  ],
  "isDraft": false,
  "reason": "none",
  "manualEnvironments": null
}

Beispiel für eine Antwort

{
  "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
ApprovalExecutionOrder

Genehmigungsausführungsreihenfolge.

ApprovalOptions
ApprovalStatus

Dient zum Abrufen oder Festlegen des Status der Genehmigung.

ApprovalType

Dient zum Abrufen oder Festlegen des Genehmigungstyps.

Artifact
ArtifactMetadata
ArtifactSourceReference
AuthorizationHeader
BuildVersion
ConditionType

Dient zum Abrufen oder Festlegen des Bedingungstyps.

ConfigurationVariableValue
DataSourceBindingBase

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

DeploymentAttempt
DeploymentJob
DeploymentOperationStatus

Ruft den Betriebsstatus der Bereitstellung ab.

DeploymentReason

Ruft den Grund der Bereitstellung ab.

DeploymentStatus

Ruft den Status der Bereitstellung ab.

DeployPhase
DeployPhaseStatus

Status der Phase.

DeployPhaseTypes

Gibt den Bereitstellungsphasentyp an.

EnvironmentOptions
EnvironmentStatus

Ruft den Umgebungsstatus ab.

GateStatus

Status der Freigabetore.

IdentityRef
IgnoredGate
Issue
ManualIntervention
ManualInterventionStatus

Dient zum Abrufen oder Festlegen des Status des manuellen Eingriffs.

ProcessParameters
ProjectReference
PropertiesCollection

Die Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüsselwertpaaren dar. Werte aller Grundtypen (beliebiger 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 Zeichenfolge neu abgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.

ReferenceLinks

Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.

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

Ruft den Grund für die Veröffentlichung ab.

ReleaseSchedule
ReleaseShallowReference
ReleaseStartEnvironmentMetadata
ReleaseStartMetadata
ReleaseStatus

Ruft den Status ab.

ReleaseTask
ScheduleDays

Tage der Woche, die veröffentlicht werden sollen.

SourcePullRequestVersion
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
TaskStatus

Status der Freigabeaufgabe.

VariableGroup
VariableGroupProjectReference

Ein Variablengruppenverweis ist ein flacher Verweis auf variablen Gruppen.

VariableGroupProviderData
VariableValue
WorkflowTask
WorkflowTaskReference

ApprovalExecutionOrder

Genehmigungsausführungsreihenfolge.

Wert Beschreibung
afterGatesAlways

Genehmigungen, die immer nach der Ausführung von Toren angezeigt werden.

afterSuccessfulGates

Genehmigungen nach erfolgreicher Ausführung von Toren gezeigt.

beforeGates

Genehmigungen vor Toren.

ApprovalOptions

Name Typ Beschreibung
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped

boolean

Geben Sie an, ob die Genehmigung übersprungen werden kann, wenn derselbe Genehmigende die vorherige Stufe genehmigt hat.

enforceIdentityRevalidation

boolean

Geben Sie an, ob die Identität der Genehmigende vor Abschluss der Genehmigung erneut überprüft wird.

executionOrder

ApprovalExecutionOrder

Genehmigungsausführungsreihenfolge.

releaseCreatorCanBeApprover

boolean

Geben Sie an, ob der Benutzer, der eine Freigabe oder Bereitstellung anfordert, genehmigende Personen zulassen soll.

requiredApproverCount

integer (int32)

Die Anzahl der Genehmigungen, die erforderlich sind, um die Freigabe vorwärts zu verschieben. "0" bezeichnet alle erforderlichen Genehmigungen.

timeoutInMinutes

integer (int32)

Genehmigungstimeout. Das Standardtimeout für die Genehmigung beträgt 30 Tage. Der maximal zulässige Timeout beträgt 365 Tage. "0" bedeutet Standardtimeout, d. h. 30 Tage.

ApprovalStatus

Dient zum Abrufen oder Festlegen des Status der Genehmigung.

Wert Beschreibung
approved

Gibt an, dass die Genehmigung genehmigt wurde.

canceled

Gibt an, dass die Genehmigung abgebrochen wird.

pending

Gibt an, dass die Genehmigung aussteht.

reassigned

Gibt an, dass die Genehmigung neu zugewiesen wird.

rejected

Gibt an, dass die Genehmigung abgelehnt wird.

skipped

Gibt an, dass die Genehmigung übersprungen wird.

undefined

Gibt an, dass die Genehmigung nicht über den Statussatz verfügt.

ApprovalType

Dient zum Abrufen oder Festlegen des Genehmigungstyps.

Wert Beschreibung
all

Gibt alle Genehmigungen an.

postDeploy

Gibt die Genehmigungen an, die nach der Bereitstellung ausgeführt wurden.

preDeploy

Gibt die Genehmigungen an, die vor der Bereitstellung ausgeführt wurden.

undefined

Gibt an, dass der Genehmigungstyp nicht festgelegt ist.

Artifact

Name Typ Beschreibung
alias

string

Dient zum Abrufen oder Festlegen des Alias.

definitionReference

<string,  ArtifactSourceReference>

Dient zum Abrufen oder Festlegen des Definitionsverweises. 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 das Artefakt primär ist oder nicht.

isRetained

boolean

Gibt an, ob das Artefakt durch Freigabe beibehalten wird oder nicht.

type

string

Dient zum Abrufen oder Festlegen des Typs. Der Wert kann als 'Build', 'Jenkins', 'GitHub', 'Nuget', 'Team Build (extern)', 'ExternalTFSBuild', 'Git', 'TFVC', 'ExternalTfsXamlBuild' verwendet werden.

ArtifactMetadata

Name Typ Beschreibung
alias

string

Legt den Alias des Artefakts fest.

instanceReference

BuildVersion

Legt den Instanzverweis des Artefakts fest. z. B. für buildartefakt ist es build number.

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 Commit-Nachricht für das Artefakt ab oder legt sie fest.

definitionId

string

Dient zum Abrufen oder Festlegen der Definitions-ID.

definitionName

string

Dient zum Abrufen oder Festlegen des Definitionsnamens.

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

sourceBranch

string

Dient zum Abrufen oder Festlegen des Quellzweigs für das Artefakt.

sourcePullRequestVersion

SourcePullRequestVersion

Ruft die Quell-Pullanforderungsversion für das Artefakt ab oder legt diese fest.

sourceRepositoryId

string

Ruft die Repository-ID für das Artefakt ab oder legt sie fest.

sourceRepositoryType

string

Dient zum Abrufen oder Festlegen des Repositorytyps für das Artefakt.

sourceVersion

string

Ruft die Quellversion für das Artefakt ab oder legt sie fest.

ConditionType

Dient zum Abrufen oder Festlegen des Bedingungstyps.

Wert Beschreibung
artifact

Der Bedingungstyp ist Artefakt.

environmentState

Der Bedingungstyp ist der Umgebungszustand.

event

Der Bedingungstyp ist ereignis.

undefined

Der Bedingungstyp ist nicht definiert.

ConfigurationVariableValue

Name Typ Beschreibung
allowOverride

boolean

Ruft ab und legt fest, ob eine Variable zur Bereitstellungszeit außer Kraft gesetzt werden kann.

isSecret

boolean

Dient zum Abrufen oder Festlegen als Variable ist geheim oder nicht.

value

string

Ruft den Wert der Konfigurationsvariablen ab und legt den Wert fest.

DataSourceBindingBase

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

Name Typ Beschreibung
callbackContextTemplate

string

Paginierungsformat, das von dieser Datenquelle unterstützt wird(Fortsetzungstoken/SkipTop).

callbackRequiredTemplate

string

Nachfolgende Aufrufe sind erforderlich?

dataSourceName

string

Dient zum Abrufen oder Festlegen des Namens der Datenquelle.

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.

requestContent

string

Dient zum Abrufen oder Festlegen des HTTP-Anforderungstexts.

requestVerb

string

Ruft das Http-Anforderungsverb ab oder legt es fest.

resultSelector

string

Ruft die Ergebnisauswahl ab oder legt sie fest.

resultTemplate

string

Ruft die Ergebnisvorlage ab oder legt sie fest.

target

string

Ruft ab oder legt das Ziel der Datenquelle fest.

DeploymentAttempt

Name Typ Beschreibung
attempt

integer (int32)

Bereitstellungsversuch.

deploymentId

integer (int32)

ID der Bereitstellung.

hasStarted

boolean

Gibt an, ob die Bereitstellung gestartet wurde oder nicht.

id

integer (int32)

ID der Bereitstellung.

issues

Issue[]

Alle Probleme im Zusammenhang mit der Bereitstellung.

lastModifiedBy

IdentityRef

Identität, die diese Bereitstellung zuletzt geändert hat.

lastModifiedOn

string (date-time)

Zeitpunkt, zu dem diese Bereitstellung zuletzt geändert wurde.

operationStatus

DeploymentOperationStatus

Bereitstellungsvorgangsstatus.

postDeploymentGates

ReleaseGates

Post deployment gates that executed in this deployment.

preDeploymentGates

ReleaseGates

Bereitstellungsgates, die in dieser Bereitstellung ausgeführt werden.

queuedOn

string (date-time)

Wenn diese Bereitstellung in die Warteschlange eingereiht wurde.

reason

DeploymentReason

Grund für die Bereitstellung.

releaseDeployPhases

ReleaseDeployPhase[]

Liste der in dieser Bereitstellung ausgeführten Releasebereitstellungsphasen.

requestedBy

IdentityRef

Identität, die diese Bereitstellung angefordert hat.

requestedFor

IdentityRef

Die Identität für diese Bereitstellung wurde angefordert.

status

DeploymentStatus

Status der Bereitstellung.

DeploymentJob

Name Typ Beschreibung
job

ReleaseTask

Übergeordnete Aufgabe aller ausgeführten Aufgaben.

tasks

ReleaseTask[]

Liste der ausgeführten Aufgaben im Auftrag.

DeploymentOperationStatus

Ruft den Betriebsstatus der Bereitstellung ab.

Wert Beschreibung
all

Der Status des Bereitstellungsvorgangs ist alles.

approved

Der Status des Bereitstellungsvorgangs wird genehmigt.

canceled

Der Status des Bereitstellungsvorgangs wird abgebrochen.

cancelling

Der Status des Bereitstellungsvorgangs wird abgebrochen.

deferred

Der Status des Bereitstellungsvorgangs wird zurückgestellt.

evaluatingGates

Der Status des Bereitstellungsvorgangs lautet "EvaluatingGates".

gateFailed

Der Status des Bereitstellungsvorgangs ist GateFailed.

manualInterventionPending

Der Status des Bereitstellungsvorgangs ist manuell ausstehend.

pending

Der Status des Bereitstellungsvorgangs steht aus.

phaseCanceled

Der Status des Bereitstellungsvorgangs wird in der Phase abgebrochen.

phaseFailed

Fehler beim Status des Bereitstellungsvorgangs.

phaseInProgress

Der Status des Bereitstellungsvorgangs ist phase in Bearbeitung.

phasePartiallySucceeded

Der Status des Bereitstellungsvorgangs ist phase teilweise erfolgreich.

phaseSucceeded

Der Status des Bereitstellungsvorgangs ist phase erfolgreich.

queued

Der Status des Bereitstellungsvorgangs wird in die Warteschlange gestellt.

queuedForAgent

Der Status des Bereitstellungsvorgangs wird für den Agent in die Warteschlange gestellt.

queuedForPipeline

Der Status des Bereitstellungsvorgangs wird für die Pipeline in die Warteschlange gestellt.

rejected

Der Status des Bereitstellungsvorgangs wird abgelehnt.

scheduled

Der Status des Bereitstellungsvorgangs wird geplant.

undefined

Der Status des Bereitstellungsvorgangs ist nicht definiert.

DeploymentReason

Ruft den Grund der Bereitstellung ab.

Wert Beschreibung
automated

Der Bereitstellungsgrund ist automatisiert.

manual

Der Bereitstellungsgrund ist manuell.

none

Der Bereitstellungsgrund ist keine.

redeployTrigger

Der Bereitstellungsgrund ist "RedeployTrigger".

scheduled

Der Bereitstellungsgrund ist geplant.

DeploymentStatus

Ruft den Status der Bereitstellung ab.

Wert Beschreibung
all

Der Bereitstellungsstatus ist alles.

failed

Fehler beim Bereitstellungsstatus.

inProgress

Der Bereitstellungsstatus wird ausgeführt.

notDeployed

Der Bereitstellungsstatus wird nicht bereitgestellt.

partiallySucceeded

Der Bereitstellungsstatus ist teilweise eingeschränkt.

succeeded

Der Bereitstellungsstatus ist erfolgreich.

undefined

Der Bereitstellungsstatus ist nicht definiert.

DeployPhase

Name Typ Beschreibung
name

string

Ruft den Namen der Bereitstellungsphase ab und legt den Namen fest.

phaseType

DeployPhaseTypes

Gibt den Bereitstellungsphasentyp an.

rank

integer (int32)

Ruft den Rang der Bereitstellungsphase ab und legt sie fest.

refName

string

Ruft den Referenznamen der Bereitstellungsphase ab und legt sie fest.

workflowTasks

WorkflowTask[]

Ruft die Workflowaufgaben für die Bereitstellungsphase ab und legt sie fest.

DeployPhaseStatus

Status der Phase.

Wert Beschreibung
canceled

Die Phasenausführung wurde abgebrochen.

cancelling

Phase befindet sich im Zustand "Abbrechen".

failed

Fehler bei der Phasenausführung.

inProgress

Phasenausführung wird ausgeführt.

notStarted

Die Phasenausführung wurde nicht gestartet.

partiallySucceeded

Die Phasenausführung war teilweise erfolgreich.

skipped

Die Phasenausführung wurde übersprungen.

succeeded

Die Phasenausführung war erfolgreich.

undefined

Phasenstatus nicht festgelegt.

DeployPhaseTypes

Gibt den Bereitstellungsphasentyp an.

Wert Beschreibung
agentBasedDeployment

Phasentyp, der Aufgaben enthält, die für den Agent ausgeführt werden.

deploymentGates

Phasentyp, der Aufgaben enthält, die als Gates fungieren, damit die Bereitstellung ausgeführt wird.

machineGroupBasedDeployment

Phasentyp, der Aufgaben enthält, die auf Bereitstellungsgruppencomputern ausgeführt werden.

runOnServer

Phasentyp, der Aufgaben enthält, die vom Server ausgeführt werden.

undefined

Phasentyp nicht definiert. Verwenden Sie dies nicht.

EnvironmentOptions

Name Typ Beschreibung
autoLinkWorkItems

boolean

Ruft die Arbeitselemente für die automatische Verknüpfung ab und legt sie fest.

badgeEnabled

boolean

Ruft ab und legt dieses fest, wenn das Signal aktiviert ist oder nicht.

publishDeploymentStatus

boolean

Ruft den Veröffentlichungsbereitstellungsstatus ab und legt diesen fest.

pullRequestDeploymentEnabled

boolean

Ruft ab und legt diese fest, da die Bereitstellung der Pull-Anforderung aktiviert ist oder nicht.

EnvironmentStatus

Ruft den Umgebungsstatus ab.

Wert Beschreibung
canceled

Die Umgebung befindet sich im Zustand "Abgebrochen".

inProgress

Die Umgebung ist in Bearbeitungszustand.

notStarted

Die Umgebung ist nicht gestartet.

partiallySucceeded

Die Umgebung ist teilweise erfolgreich.

queued

Die Umgebung befindet sich in der Warteschlange.

rejected

Die Umgebung befindet sich im Abgelehnten Zustand.

scheduled

Die Umgebung befindet sich im geplanten Zustand.

succeeded

Die Umgebung ist erfolgreich.

undefined

Der Umgebungsstatus ist nicht festgelegt.

GateStatus

Status der Freigabetore.

Wert Beschreibung
canceled

Die Torausführung wurde abgebrochen.

failed

Fehler bei der Torausführung.

inProgress

Das Tor ist derzeit in Bearbeitung.

none

Das Gate hat den Status nicht festgelegt.

pending

Das Tor befindet sich im ausstehenden Zustand.

succeeded

Das Tor wurde erfolgreich abgeschlossen.

IdentityRef

Name Typ Beschreibung
_links

ReferenceLinks

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

descriptor

string

Der Deskriptor ist die primäre Möglichkeit, auf den Diagrammbetreff zu verweisen, während das System ausgeführt wird. In diesem Feld wird dasselbe Diagrammthema sowohl in Firmen als auch in Organisationen eindeutig identifiziert.

directoryAlias

string

Veraltet – Kann abgerufen werden, indem der Graph-Benutzer abgefragt wird, auf den im "Self"-Eintrag des IdentityRef -Wörterbuchs "_links" verwiesen wird

displayName

string

Dies ist der nicht eindeutige Anzeigename des Diagrammbetreffs. Um dieses Feld zu ändern, müssen Sie den Wert im Quellanbieter ändern.

id

string

imageUrl

string

Veraltet – Verfügbar im "Avatar"-Eintrag des IdentityRef-Wörterbuchs "_links"

inactive

boolean

Veraltet – Kann abgerufen werden, indem der Graph-Mitgliedschaftsstatus abgefragt wird, 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 – nicht in den meisten bereits vorhandenen Implementierungen von ToIdentityRef 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 (date-time)

Ruft das Datum ab, an dem das Gate zuletzt ignoriert wird.

name

string

Name des ignorierten Gates.

Issue

Name Typ Beschreibung
data

object

Ausgeben von Daten.

issueType

string

Problemtyp, z. B. Fehler, Warnung oder Informationen.

message

string

Problemmeldung.

ManualIntervention

Name Typ Beschreibung
approver

IdentityRef

Ruft die Identität ab, die genehmigt werden soll, oder legt sie fest.

comments

string

Ruft Kommentare zur Genehmigung ab oder legt sie fest.

createdOn

string (date-time)

Ruft das Datum ab, an dem es erstellt wurde.

id

integer (int32)

Ruft den eindeutigen Bezeichner für manuelle Eingriffe ab.

instructions

string

Dient zum Abrufen oder Festlegen von Anweisungen für die Genehmigung.

modifiedOn

string (date-time)

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

name

string

Ruft den Namen ab oder legt den Namen fest.

release

ReleaseShallowReference

Ruft releaseReference für manuelle Eingriffe ab.

releaseDefinition

ReleaseDefinitionShallowReference

Ruft releaseDefinitionReference für manuelle Eingriffe ab.

releaseEnvironment

ReleaseEnvironmentShallowReference

Ruft releaseEnvironmentReference für manuelle Eingriffe ab.

status

ManualInterventionStatus

Dient zum Abrufen oder Festlegen des Status des manuellen Eingriffs.

taskInstanceId

string (uuid)

Abrufen des Vorgangsinstanzbezeichners.

url

string

Ruft die URL für den Zugriff auf den manuellen Eingriff ab.

ManualInterventionStatus

Dient zum Abrufen oder Festlegen des Status des manuellen Eingriffs.

Wert Beschreibung
approved

Der manuelle Eingriff wird genehmigt.

canceled

Der manuelle Eingriff wird abgebrochen.

pending

Der manuelle Eingriff steht aus.

rejected

Der manuelle Eingriff wird abgelehnt.

unknown

Für den manuellen Eingriff ist der Status nicht festgelegt.

ProcessParameters

Name Typ Beschreibung
dataSourceBindings

DataSourceBindingBase[]

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

inputs

TaskInputDefinitionBase[]

sourceDefinitions

TaskSourceDefinitionBase[]

ProjectReference

Name Typ Beschreibung
id

string (uuid)

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üsselwertpaaren dar. Werte aller Grundtypen (beliebiger 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 Zeichenfolge neu abgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.

Name Typ Beschreibung
count

integer (int32)

Die Anzahl der Eigenschaften in der Auflistung.

item

object

keys

string[]

Der Satz von Schlüsseln in der Auflistung.

values

string[]

Der Wertesatz in der Auflistung.

Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.

Name Typ Beschreibung
links

object

Die schreibgeschützte Ansicht der Links. Da Referenzlinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

Release

Name Typ Beschreibung
_links

ReferenceLinks

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

createdBy

IdentityRef

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

createdFor

IdentityRef

Ruft die Identität ab, für die die Version erstellt wurde, oder legt diese fest.

createdOn

string (date-time)

Ruft das Datum ab, an dem es erstellt wurde.

definitionSnapshotRevision

integer (int32)

Ruft die Revisionsnummer der Definitionsmomentaufnahme ab.

description

string

Ruft die Beschreibung der Freigabe ab oder legt sie fest.

environments

ReleaseEnvironment[]

Ruft eine Liste der Umgebungen ab.

id

integer (int32)

Ruft den eindeutigen Bezeichner dieses Felds ab.

keepForever

boolean

Gibt an, ob die Freigabe von Aufbewahrungsrichtlinien ausgeschlossen werden soll.

logsContainerUrl

string

Ruft die Url des Protokollcontainers ab.

modifiedBy

IdentityRef

Dient zum Abrufen oder Festlegen der Identität, die geändert wurde.

modifiedOn

string (date-time)

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

name

string

Ruft den Namen ab.

poolName

string

Ruft den Poolnamen ab.

projectReference

ProjectReference

Ruft den Projektverweis ab oder legt den Projektverweis fest.

properties

PropertiesCollection

Die Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüsselwertpaaren dar. Werte aller Grundtypen (beliebiger 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 Zeichenfolge neu abgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.

reason

ReleaseReason

Ruft den Grund der Veröffentlichung ab.

releaseDefinition

ReleaseDefinitionShallowReference

Ruft releaseDefinitionReference ab, die den Verweis der Releasedefinition angibt, der diese Version zugeordnet ist.

releaseDefinitionRevision

integer (int32)

Ruft die Versionsdefinitionsrevision ab oder legt sie fest.

releaseNameFormat

string

Ruft das Veröffentlichungsnamenformat ab.

status

ReleaseStatus

Ruft den Status ab.

tags

string[]

Ruft die Liste der Tags ab oder legt sie fest.

triggeringArtifactAlias

string

variableGroups

VariableGroup[]

Ruft die Liste der Variablengruppen ab.

variables

<string,  ConfigurationVariableValue>

Dient zum Abrufen oder Festlegen des Wörterbuchs von Variablen.

ReleaseApproval

Name Typ Beschreibung
approvalType

ApprovalType

Dient zum Abrufen oder Festlegen des Genehmigungstyps.

approvedBy

IdentityRef

Ruft die Identität ab, die genehmigt wurde.

approver

IdentityRef

Ruft die Identität ab, die genehmigt werden soll, oder legt sie fest.

attempt

integer (int32)

Ruft den Versuch ab, der angibt, zu welchem Bereitstellungsversuch es gehört, oder legt den Versuch fest.

comments

string

Ruft Kommentare zur Genehmigung ab oder legt sie fest.

createdOn

string (date-time)

Ruft das Datum ab, an dem es erstellt wurde.

history

ReleaseApprovalHistory[]

Ruft den Verlauf ab, der alle Genehmigungen angibt, die dieser Genehmigung zugeordnet sind.

id

integer (int32)

Ruft den eindeutigen Bezeichner dieses Felds ab.

isAutomated

boolean

Ruft ab oder legt diese fest, da die Genehmigung automatisiert ist oder nicht.

modifiedOn

string (date-time)

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

rank

integer (int32)

Dient zum Abrufen oder Festlegen des Rangs, der die Reihenfolge der Genehmigung angibt. z. B. die gleiche Rangfolge kennzeichnet die parallele Genehmigung.

release

ReleaseShallowReference

Ruft releaseReference ab, das den Verweis auf die Version angibt, der diese Genehmigung zugeordnet ist.

releaseDefinition

ReleaseDefinitionShallowReference

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

releaseEnvironment

ReleaseEnvironmentShallowReference

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

revision

integer (int32)

Ruft die Revisionsnummer ab.

status

ApprovalStatus

Dient zum Abrufen oder Festlegen des Status der Genehmigung.

url

string

Ruft die URL für den Zugriff auf die Genehmigung ab.

ReleaseApprovalHistory

Name Typ Beschreibung
approver

IdentityRef

Identität der genehmigende Person.

changedBy

IdentityRef

Die Identität des Objekts, das die Genehmigung geändert hat.

comments

string

Genehmigungsverlaufskommentare.

createdOn

string (date-time)

Zeitpunkt, zu dem diese Genehmigung erstellt wurde.

modifiedOn

string (date-time)

Zeitpunkt, zu dem diese Genehmigung geändert wurde.

revision

integer (int32)

Überarbeitung des Genehmigungsverlaufs.

ReleaseCondition

Name Typ Beschreibung
conditionType

ConditionType

Dient zum Abrufen oder Festlegen des Bedingungstyps.

name

string

Dient zum Abrufen oder Festlegen des Namens der Bedingung. z. B. "ReleaseStarted".

result

boolean

Das Ergebnis der Veröffentlichungsbedingung.

value

string

Dient zum Abrufen oder Festlegen des Werts der Bedingung.

ReleaseDefinitionApprovals

Name Typ Beschreibung
approvalOptions

ApprovalOptions

Ruft die Genehmigungsoptionen ab oder legt sie fest.

approvals

ReleaseDefinitionApprovalStep[]

Ruft die Genehmigungen ab oder legt sie fest.

ReleaseDefinitionApprovalStep

Name Typ Beschreibung
approver

IdentityRef

Ruft die genehmigende Person ab und legt sie fest.

id

integer (int32)

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 (int32)

Dient zum Abrufen oder Festlegen des Rangs des Genehmigungsschritts.

ReleaseDefinitionGate

Name Typ Beschreibung
tasks

WorkflowTask[]

Dient zum Abrufen oder Festlegen des Gates-Workflows.

ReleaseDefinitionGatesOptions

Name Typ Beschreibung
isEnabled

boolean

Ruft ab oder legt diese fest, wenn die Tore aktiviert sind oder nicht.

minimumSuccessDuration

integer (int32)

Ruft die Mindestdauer für konstante Ergebnisse nach einer erfolgreichen Bewertung der Tore ab oder legt sie fest.

samplingInterval

integer (int32)

Ruft die Zeit zwischen der erneuten Auswertung von Toren ab oder legt sie fest.

stabilizationTime

integer (int32)

Ruft die Verzögerung vor der Auswertung ab oder legt sie fest.

timeout

integer (int32)

Ruft das Timeout ab, nach dem Tore fehlschlagen, oder legt diesen fest.

ReleaseDefinitionGatesStep

Name Typ Beschreibung
gates

ReleaseDefinitionGate[]

Ruft die Tore ab oder legt sie fest.

gatesOptions

ReleaseDefinitionGatesOptions

Ruft die Gate-Optionen ab oder legt sie fest.

id

integer (int32)

ID des ReleaseDefinitionGateStep.

ReleaseDefinitionShallowReference

Name Typ Beschreibung
_links

ReferenceLinks

Ruft die Links zu verwandten Ressourcen, APIs und Ansichten für die Releasedefinition ab.

id

integer (int32)

Ruft den eindeutigen Bezeichner der Releasedefinition ab.

name

string

Dient zum Abrufen oder Festlegen des Namens der Releasedefinition.

path

string

Dient zum Abrufen oder Festlegen des Pfads der Releasedefinition.

projectReference

ProjectReference

Ruft den Projektverweis ab oder legt den Projektverweis fest.

url

string

Ruft die REST-API-URL für den Zugriff auf die Releasedefinition ab.

ReleaseDeployPhase

Name Typ Beschreibung
deploymentJobs

DeploymentJob[]

Bereitstellungsaufträge der Phase.

errorLog

string

Fehlerprotokolle zur Phasenausführung.

manualInterventions

ManualIntervention[]

Liste der Informationen zur Ausführung manueller Interventionsaufgaben in der Phase.

name

string

Name der Phase.

phaseId

string

ID der Phase.

phaseType

DeployPhaseTypes

Typ der Phase.

rank

integer (int32)

Rang der Phase.

runPlanId

string (uuid)

Führen Sie die Plan-ID der Phase aus.

startedOn

string (date-time)

Startzeit der Phase.

status

DeployPhaseStatus

Status der Phase.

ReleaseEnvironment

Name Typ Beschreibung
conditions

ReleaseCondition[]

Ruft eine Liste der Bedingungen ab.

createdOn

string (date-time)

Ruft das Datum ab, an dem es erstellt wurde.

definitionEnvironmentId

integer (int32)

Ruft die Definitionsumgebungs-ID ab.

deployPhasesSnapshot

DeployPhase[]

Ruft eine Liste der Bereitstellungsphasenmomentaufnahmen ab.

deploySteps

DeploymentAttempt[]

Ruft die Bereitstellungsschritte ab.

environmentOptions

EnvironmentOptions

Ruft Umgebungsoptionen ab.

id

integer (int32)

Ruft den eindeutigen Bezeichner dieses Felds ab.

modifiedOn

string (date-time)

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

name

string

Ruft den Namen ab.

nextScheduledUtcTime

string (date-time)

Ruft die nächste geplante UTC-Zeit ab.

owner

IdentityRef

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

postApprovalsSnapshot

ReleaseDefinitionApprovals

Ruft eine Liste der Momentaufnahmen nach der Bereitstellung von Genehmigungen ab.

postDeployApprovals

ReleaseApproval[]

Ruft eine Liste der Genehmigungen nach der Bereitstellung ab.

postDeploymentGatesSnapshot

ReleaseDefinitionGatesStep

Snapshot-Daten nach bereitstellungsgates.

preApprovalsSnapshot

ReleaseDefinitionApprovals

Ruft eine Liste der Snapshots für vorab bereitgestellte Genehmigungen ab.

preDeployApprovals

ReleaseApproval[]

Ruft eine Liste der Vorabbereitstellungsgenehmigungen ab.

preDeploymentGatesSnapshot

ReleaseDefinitionGatesStep

Snapshot-Daten vor der Bereitstellung gates.

processParameters

ProcessParameters

Ruft Prozessparameter ab.

rank

integer (int32)

Ruft rang ab.

release

ReleaseShallowReference

Ruft release reference, which specifies the reference of the release to which this release environment is associated.

releaseCreatedBy

IdentityRef

Ruft die Identität ab, die version erstellt hat.

releaseDefinition

ReleaseDefinitionShallowReference

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

releaseId

integer (int32)

Ruft die Release-ID ab.

scheduledDeploymentTime

string (date-time)

Ruft die Bereitstellungszeit der Releaseumgebung ab.

schedules

ReleaseSchedule[]

Ruft eine Liste der Zeitpläne ab.

status

EnvironmentStatus

Ruft den Umgebungsstatus ab.

timeToDeploy

number (double)

Ruft Zeit für die Bereitstellung 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.

ReleaseEnvironmentShallowReference

Name Typ Beschreibung
_links

ReferenceLinks

Ruft die Links zu verwandten Ressourcen, APIs und Ansichten für die Releaseumgebung ab.

id

integer (int32)

Ruft den eindeutigen Bezeichner der Releaseumgebung ab.

name

string

Dient zum Abrufen oder Festlegen des Namens der Releaseumgebung.

url

string

Ruft die REST-API-URL für den Zugriff auf die Releaseumgebung ab.

ReleaseGates

Name Typ Beschreibung
deploymentJobs

DeploymentJob[]

Enthält die Auftragsdetails der einzelnen Bewertungen.

id

integer (int32)

ID der Freigabetore.

ignoredGates

IgnoredGate[]

Liste der ignorierten Tore.

lastModifiedOn

string (date-time)

Tore zuletzt geändert.

runPlanId

string (uuid)

Führen Sie die Plan-ID der Tore aus.

stabilizationCompletedOn

string (date-time)

Gates-Stabilisierung abgeschlossen Datum und Uhrzeit.

startedOn

string (date-time)

Die Bewertung von Gates begann Zeit.

status

GateStatus

Status der Freigabetore.

succeedingSince

string (date-time)

Datum und Uhrzeit, zu der alle Tore erfolgreich ausgeführt wurden.

ReleaseReason

Ruft den Grund für die Veröffentlichung ab.

Wert Beschreibung
continuousIntegration

Gibt die durch kontinuierliche Integration ausgelöste Freigabe an.

manual

Gibt die manuell ausgelöste Freigabe an.

none

Gibt den auslösungsauslösten Grund an, der nicht festgelegt wurde.

pullRequest

Gibt die von PullRequest ausgelöste Version an.

schedule

Gibt die vom Zeitplan ausgelöste Veröffentlichung an.

ReleaseSchedule

Name Typ Beschreibung
daysToRelease

ScheduleDays

Tage der Woche, die veröffentlicht werden sollen.

jobId

string (uuid)

Auftrags-ID der Team Foundation-Auftragsdefinition.

scheduleOnlyWithChanges

boolean

Kennzeichnen Sie, um zu ermitteln, ob dieser Zeitplan nur freigegeben werden soll, wenn das zugeordnete Artefakt geändert oder die Releasedefinition geändert wurde.

startHours

integer (int32)

Lokale Zeitzonenstunde, die gestartet werden soll.

startMinutes

integer (int32)

Minute der lokalen Zeitzone, die gestartet werden soll.

timeZoneId

string

Zeitzonen-ID des Veröffentlichungszeitplans, z. B. "UTC".

ReleaseShallowReference

Name Typ Beschreibung
_links

ReferenceLinks

Ruft die Links zu verwandten Ressourcen, APIs und Ansichten für die Version ab.

id

integer (int32)

Ruft den eindeutigen Bezeichner der Version ab.

name

string

Ruft den Namen der Version ab oder legt den Namen fest.

url

string

Ruft die REST-API-URL für den Zugriff auf die Version ab.

ReleaseStartEnvironmentMetadata

Name Typ Beschreibung
definitionEnvironmentId

integer (int32)

Legt die ID der Releasedefinitionsumgebung fest.

variables

<string,  ConfigurationVariableValue>

Legt die Liste der Umgebungsvariablen fest, die zur Bereitstellungszeit außer Kraft gesetzt werden sollen.

ReleaseStartMetadata

Name Typ Beschreibung
artifacts

ArtifactMetadata[]

Legt die Liste des Artefakts fest, um eine Freigabe zu erstellen.

definitionId

integer (int32)

Legt die Definitions-ID fest, um eine Version zu erstellen.

description

string

Legt die Beschreibung fest, um eine Version zu erstellen.

environmentsMetadata

ReleaseStartEnvironmentMetadata[]

Legt eine Liste der Umgebungsmetadaten fest.

isDraft

boolean

Legt "true" fest, um die Freigabe im Entwurfsmodus zu erstellen, andernfalls "false".

manualEnvironments

string[]

Legt die Liste der Umgebungen so fest, dass sie manuell als Bedingung festgelegt werden.

properties

PropertiesCollection

Die Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüsselwertpaaren dar. Werte aller Grundtypen (beliebiger 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 Zeichenfolge neu abgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.

reason

ReleaseReason

Legt den Grund fest, eine Version zu erstellen.

variables

<string,  ConfigurationVariableValue>

Legt die Liste der Releasevariablen fest, die zur Bereitstellungszeit außer Kraft gesetzt werden sollen.

ReleaseStatus

Ruft den Status ab.

Wert Beschreibung
abandoned

Der Freigabestatus ist abgebrochen.

active

Der Versionsstatus ist aktiv.

draft

Release befindet sich im Entwurfszustand.

undefined

Veröffentlichungsstatus nicht festgelegt.

ReleaseTask

Name Typ Beschreibung
agentName

string

Agentname, auf dem die Aufgabe ausgeführt wurde.

finishTime

string (date-time)

Endzeit des Freigabevorgangs.

id

integer (int32)

ID der Freigabeaufgabe.

issues

Issue[]

Liste der Probleme beim Ausführen der Aufgabe.

lineCount

integer (int64)

Die Anzahl der Zeilenprotokollveröffentlichungsaufgabe hat.

logUrl

string

Protokoll-URL der Aufgabe.

name

string

Name des Vorgangs.

percentComplete

integer (int32)

Die Ausführung der Aufgabe ist abgeschlossen.

rank

integer (int32)

Rang des Freigabevorgangs.

resultCode

string

Ergebniscode des Vorgangs.

startTime

string (date-time)

ID der Freigabeaufgabe.

status

TaskStatus

Status der Freigabeaufgabe.

task

WorkflowTaskReference

Workflowaufgabenreferenz.

timelineRecordId

string (uuid)

Zeitachsendatensatz-ID der Freigabeaufgabe.

ScheduleDays

Tage der Woche, die veröffentlicht werden sollen.

Wert Beschreibung
all

Geplant an allen Tagen in der Woche.

friday

Geplant am Freitag.

monday

Geplant am Montag.

none

Geplanter Tag nicht festgelegt.

saturday

Geplant am Samstag.

sunday

Geplant am Sonntag.

thursday

Geplant am Donnerstag.

tuesday

Geplant am Dienstag.

wednesday

Geplant am Mittwoch.

SourcePullRequestVersion

Name Typ Beschreibung
iterationId

string

Iterations-ID der Pull-Anforderung, für die die Version den Status veröffentlicht.

pullRequestId

string

Pull-Anforderungs-ID, für die die Version den Status veröffentlicht.

pullRequestMergedAt

string (date-time)

Datum und Uhrzeit der Erstellung der Pullanforderungszusammenführung. Es ist erforderlich, den Zeitachsendatensatz von Versionen beizubehalten, die von pull-Anforderung erstellt wurden.

sourceBranch

string

Quellzweig der Pullanforderung.

sourceBranchCommitId

string

Quell-Verzweigungs-COMMIT-ID der Pullanforderung, für die die Version den Status veröffentlicht.

targetBranch

string

Zielzweig der Pullanforderung.

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, in der erläutert wird, 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.

Wert Beschreibung
canceled

Die Ausführung der Aufgabe wurde abgebrochen.

failed

Fehler bei der Ausführung der Aufgabe.

failure

Fehler bei der Ausführung der Aufgabe.

inProgress

Der Vorgang wird derzeit ausgeführt.

partiallySucceeded

Die Aufgabenausführung war teilweise erfolgreich.

pending

Der Vorgang befindet sich im Status "Ausstehend".

skipped

Die Aufgabenausführung wurde übersprungen.

succeeded

Die Aufgabe wurde erfolgreich abgeschlossen.

success

Die Aufgabe wurde erfolgreich abgeschlossen.

unknown

Für den Vorgang ist der Status nicht festgelegt.

VariableGroup

Name Typ Beschreibung
createdBy

IdentityRef

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

createdOn

string (date-time)

Ruft das Datum ab, an dem es erstellt wurde.

description

string

Ruft die Beschreibung ab oder legt diese fest.

id

integer (int32)

Ruft den eindeutigen Bezeichner dieses Felds ab.

isShared

boolean

Gibt an, ob eine Variablegruppe für ein anderes Projekt freigegeben wird oder nicht.

modifiedBy

IdentityRef

Dient zum Abrufen oder Festlegen der Identität, die geändert wurde.

modifiedOn

string (date-time)

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

name

string

Ruft den Namen ab oder legt den Namen fest.

providerData

VariableGroupProviderData

Ruft Anbieterdaten ab oder legt sie fest.

type

string

Dient zum Abrufen oder Festlegen des Typs.

variableGroupProjectReferences

VariableGroupProjectReference[]

alle Projektverweise, in denen die Variablengruppe für andere Projekte freigegeben wird.

variables

<string,  VariableValue>

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

VariableGroupProjectReference

Ein Variablengruppenverweis ist ein flacher Verweis auf variablen Gruppen.

Name Typ Beschreibung
description

string

Ruft die Beschreibung der Variablengruppe ab oder legt sie fest.

name

string

Dient zum Abrufen oder Festlegen des Namens der Variablengruppe.

projectReference

ProjectReference

Ruft den Projektverweis der Variablengruppe ab oder legt sie 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 fest, als die Variable geheim ist oder nicht.

value

string

Dient zum Abrufen oder Festlegen des Werts.

WorkflowTask

Name Typ Beschreibung
alwaysRun

boolean

Ruft ab oder legt diese fest, wenn die Aufgabe immer ausgeführt wird oder nicht.

condition

string

Ruft die Vorgangsbedingung ab oder legt sie fest.

continueOnError

boolean

Ruft ab oder legt fest, wenn die Aufgabe weiterhin auf Fehler ausgeführt wird oder nicht.

definitionType

string

Dient zum Abrufen oder Festlegen des Vorgangsdefinitionstyps. Beispiel:- 'Agent', DeploymentGroup', 'Server' oder 'ServerGate'.

enabled

boolean

Ruft ab oder legt diese fest, wenn die Aufgabe aktiviert ist oder nicht.

environment

object

Dient zum Abrufen oder Festlegen der Vorgangsumgebungsvariablen.

inputs

object

Ruft die Vorgangseingaben ab oder legt sie fest.

name

string

Dient zum Abrufen oder Festlegen des Namens des Vorgangs.

overrideInputs

object

Dient zum Abrufen oder Festlegen der Vorgangsüberschreibungseingaben.

refName

string

Dient zum Abrufen oder Festlegen des Verweisnamens des Vorgangs.

retryCountOnTaskFailure

integer (int32)

Dient zum Abrufen oder Festlegen des Vorgangs retryCount.

taskId

string (uuid)

Dient zum Abrufen oder Festlegen der ID des Vorgangs.

timeoutInMinutes

integer (int32)

Dient zum Abrufen oder Festlegen des Vorgangstimeouts.

version

string

Ruft die Version des Vorgangs ab oder legt sie fest.

WorkflowTaskReference

Name Typ Beschreibung
id

string (uuid)

Vorgangsbezeichner.

name

string

Name des Vorgangs.

version

string

Version der Aufgabe.