Releases - Update Release Resource

リファレンス

サービス:: Release

API バージョン:: 7.1

リリースのいくつかのプロパティを更新します。

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

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前。
project	path	True	string	プロジェクト ID またはプロジェクト名
releaseId	path	True	integer (int32)	更新するリリースの ID。
api-version	query	True	string	使用する API のバージョン。このバージョンの API を使用するには、これを '7.1' に設定する必要があります。

要求本文

名前	型	説明
comment	string	リリースのコメントを設定します。
keepForever	boolean	アイテム保持ポリシーからリリースを除外するには、'true' を設定します。
manualEnvironments	string[]	手動環境の一覧を設定します。
name	string	リリースの名前を設定します。
status	ReleaseStatus	リリースの状態を設定します。

応答

名前	型	説明
200 OK	Release	成功した操作

セキュリティ

oauth2

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL (トークン 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

スコープ

名前	説明
vso.release_execute	フォルダー、リリース、リリース定義、リリース環境、新しいリリースをキューに登録する機能など、リリース成果物の読み取りと更新を行う機能を付与します。

例

Abandoning an active release

要求のサンプル

HTTP

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

{
  "status": "abandoned",
  "manualEnvironments": null,
  "comment": "Abandon the release"
}

応答のサンプル

状態コード:: 200

{
  "id": 21,
  "name": "Release-21",
  "status": "abandoned",
  "createdOn": "2017-06-16T01:53:35.667Z",
  "modifiedOn": "2017-06-16T01:53:36.37Z",
  "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": 81,
      "releaseId": 21,
      "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": 21,
        "name": "Release-21",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=21&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21"
          }
        }
      },
      "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": 82,
      "releaseId": 21,
      "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": 21,
        "name": "Release-21",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=21&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21"
          }
        }
      },
      "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": 83,
      "releaseId": 21,
      "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": 21,
        "name": "Release-21",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=21&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21"
          }
        }
      },
      "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": 84,
      "releaseId": 21,
      "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": 21,
        "name": "Release-21",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=21&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21"
          }
        }
      },
      "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://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/21/logs",
  "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=21&_a=release-summary"
    }
  },
  "tags": [],
  "projectReference": {
    "id": "d07908bc-118f-47d2-8a13-ff75601a6b1a",
    "name": null
  },
  "properties": {}
}

定義

名前	説明
ApprovalExecutionOrder	承認の実行順序。
ApprovalOptions
ApprovalStatus	承認の状態を取得または設定します。
ApprovalType	承認の種類を取得または設定します。
Artifact
ArtifactSourceReference
AuthorizationHeader
ConditionType	条件の種類を取得または設定します。
ConfigurationVariableValue
DataSourceBindingBase	サービスエンドポイント要求のデータソースのバインドを表します。
DeploymentAttempt
DeploymentJob
DeploymentOperationStatus	デプロイの操作状態を取得します。
DeploymentReason	デプロイの理由を取得します。
DeploymentStatus	デプロイの状態を取得します。
DeployPhase
DeployPhaseStatus	フェーズの状態。
DeployPhaseTypes	展開フェーズの種類を示します。
EnvironmentOptions
EnvironmentStatus	環境の状態を取得します。
GateStatus	リリースゲートの状態。
IdentityRef
IgnoredGate
Issue
ManualIntervention
ManualInterventionStatus	手動介入の状態を取得または設定します。
ProcessParameters
ProjectReference
PropertiesCollection	このクラスは、キーと値のペアのコレクションとしてプロパティバッグを表します。 `DBNull` を除くすべてのプリミティブ型 (`TypeCode != TypeCode.Object`を持つ任意の型) の値が受け入れられます。 Byte[]、Int32、Double、DateType、String 型の値は型を保持し、他のプリミティブは文字列として再調整されます。 Byte[] は base64 でエンコードされた文字列として必要です。
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
Release
ReleaseApproval
ReleaseApprovalHistory
ReleaseCondition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDeployPhase
ReleaseEnvironment
ReleaseEnvironmentShallowReference
ReleaseGates
ReleaseReason	リリースの理由を取得します。
ReleaseSchedule
ReleaseShallowReference
ReleaseStatus	状態を取得します。
ReleaseTask
ReleaseUpdateMetadata
ScheduleDays	リリースする曜日。
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
TaskStatus	リリースタスクの状態。
VariableGroup
VariableGroupProjectReference	変数グループ参照は、変数グループへの浅い参照です。
VariableGroupProviderData
VariableValue
WorkflowTask
WorkflowTaskReference

ApprovalExecutionOrder

列挙

承認の実行順序。

値	説明
afterGatesAlways	ゲートの実行後に常に表示される承認。
afterSuccessfulGates	ゲートの正常な実行後に表示される承認。
beforeGates	ゲートの前に表示される承認。

ApprovalOptions

Object

名前	型	説明
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped	boolean	同じ承認者が前のステージを承認した場合に、承認をスキップできるかどうかを指定します。
enforceIdentityRevalidation	boolean	承認を完了する前に、承認者の ID を再検証するかどうかを指定します。
executionOrder	ApprovalExecutionOrder	承認の実行順序。
releaseCreatorCanBeApprover	boolean	リリースまたは展開を要求するユーザーが承認者に許可するかどうかを指定します。
requiredApproverCount	integer (int32)	リリースを先に進めるために必要な承認の数。 '0' は、すべての承認が必要です。
timeoutInMinutes	integer (int32)	承認タイムアウト。承認の既定のタイムアウトは 30 日です。許容される最大タイムアウトは 365 日です。 '0' は、既定のタイムアウト (つまり 30 日) を意味します。

ApprovalStatus

列挙

承認の状態を取得または設定します。

値	説明
approved	承認が承認されたことを示します。
canceled	承認が取り消されたことを示します。
pending	承認が保留中であることを示します。
reassigned	承認が再割り当てされたことを示します。
rejected	承認が拒否されたことを示します。
skipped	承認がスキップされたことを示します。
undefined	承認に状態が設定されていないことを示します。

ApprovalType

列挙

承認の種類を取得または設定します。

値	説明
all	すべての承認を示します。
postDeploy	デプロイ後に実行された承認を示します。
preDeploy	デプロイ前に実行された承認を示します。
undefined	承認の種類が設定されていないことを示します。

Artifact

Object

名前	型	説明
alias	string	エイリアスを取得または設定します。
definitionReference	<string, ArtifactSourceReference>	定義参照を取得または設定します。例: {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5aa90a6c","name":"myProject"},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}}
isPrimary	boolean	成果物がプライマリかどうかを示します。
isRetained	boolean	成果物がリリースによって保持されるかどうかを示します。
type	string	型を取得または設定します。値には、'Build'、'Jenkins'、'GitHub'、'Nuget'、'Team Build (external)'、'ExternalTFSBuild'、'Git'、'TFVC'、'ExternalTfsXamlBuild' を指定できます。

ArtifactSourceReference

Object

名前	型	説明
id	string	成果物ソースの ID。
name	string	成果物ソースの名前。

AuthorizationHeader

Object

名前	型	説明
name	string
value	string

ConditionType

列挙

条件の種類を取得または設定します。

値	説明
artifact	条件の種類は成果物です。
environmentState	条件の種類は環境の状態です。
event	条件の種類はイベントです。
undefined	条件の種類は未定義です。

ConfigurationVariableValue

Object

名前	型	説明
allowOverride	boolean	デプロイ時に変数をオーバーライドできるかどうかを取得および設定します。
isSecret	boolean	変数がシークレットかどうかを取得または設定します。
value	string	構成変数の値を取得および設定します。

DataSourceBindingBase

Object

サービスエンドポイント要求のデータソースのバインドを表します。

名前	型	説明
callbackContextTemplate	string	このデータソースでサポートされている改ページ位置の形式 (ContinuationToken/SkipTop)。
callbackRequiredTemplate	string	後続の呼び出しが必要ですか?
dataSourceName	string	データソースの名前を取得または設定します。
endpointId	string	エンドポイント ID を取得または設定します。
endpointUrl	string	サービスエンドポイントの URL を取得または設定します。
headers	AuthorizationHeader[]	承認ヘッダーを取得または設定します。
initialContextTemplate	string	クエリパラメーターの初期値を定義します
parameters	object	データソースのパラメーターを取得または設定します。
requestContent	string	http 要求本文を取得または設定します。
requestVerb	string	http 要求動詞を取得または設定します。
resultSelector	string	結果セレクターを取得または設定します。
resultTemplate	string	結果テンプレートを取得または設定します。
target	string	データソースのターゲットを取得または設定します。

DeploymentAttempt

Object

名前	型	説明
attempt	integer (int32)	デプロイの試行。
deploymentId	integer (int32)	デプロイの ID。
hasStarted	boolean	デプロイが開始されたかどうかを指定します。
id	integer (int32)	デプロイの ID。
issues	Issue[]	デプロイに関連するすべての問題。
lastModifiedBy	IdentityRef	このデプロイを最後に変更した ID。
lastModifiedOn	string (date-time)	このデプロイが最後に変更された時刻。
operationStatus	DeploymentOperationStatus	デプロイ操作の状態。
postDeploymentGates	ReleaseGates	このデプロイで実行されたデプロイゲートの後。
preDeploymentGates	ReleaseGates	このデプロイで実行されたデプロイ前ゲート。
queuedOn	string (date-time)	このデプロイがキューに登録されたとき。
reason	DeploymentReason	デプロイの理由。
releaseDeployPhases	ReleaseDeployPhase[]	このデプロイで実行されるリリース展開フェーズの一覧。
requestedBy	IdentityRef	このデプロイを要求した ID。
requestedFor	IdentityRef	要求されたこのデプロイの ID。
status	DeploymentStatus	展開の状態。

DeploymentJob

Object

名前	型	説明
job	ReleaseTask	実行されたすべてのタスクの親タスク。
tasks	ReleaseTask[]	ジョブ内で実行されたタスクの一覧。

DeploymentOperationStatus

列挙

デプロイの操作状態を取得します。

値	説明
all	デプロイ操作の状態がすべてです。
approved	デプロイ操作の状態が承認されます。
canceled	デプロイ操作の状態が取り消されます。
cancelling	デプロイ操作の状態が取り消されています。
deferred	デプロイ操作の状態は遅延されます。
evaluatingGates	デプロイ操作の状態は EvaluatingGates です。
gateFailed	デプロイ操作の状態は GateFailed です。
manualInterventionPending	デプロイ操作の状態は、手動による発明が保留中です。
pending	デプロイ操作の状態が保留中です。
phaseCanceled	デプロイ操作の状態はフェーズによって取り消されます。
phaseFailed	デプロイ操作の状態がフェーズに失敗しました。
phaseInProgress	デプロイ操作の状態は、進行中のフェーズです。
phasePartiallySucceeded	デプロイ操作の状態は、部分的に成功したフェーズです。
phaseSucceeded	デプロイ操作の状態はフェーズに成功しました。
queued	デプロイ操作の状態はキューに登録されます。
queuedForAgent	デプロイ操作の状態は、エージェントのキューに登録されます。
queuedForPipeline	デプロイ操作の状態は、パイプラインのキューに登録されます。
rejected	デプロイ操作の状態は拒否されます。
scheduled	デプロイ操作の状態がスケジュールされています。
undefined	デプロイ操作の状態は未定義です。

DeploymentReason

列挙

デプロイの理由を取得します。

値	説明
automated	デプロイの理由は自動化されています。
manual	デプロイの理由は手動です。
none	デプロイの理由は何もありません。
redeployTrigger	デプロイの理由は RedeployTrigger です。
scheduled	デプロイの理由がスケジュールされています。

DeploymentStatus

列挙

デプロイの状態を取得します。

値	説明
all	デプロイの状態がすべてです。
failed	デプロイの状態が失敗しました。
inProgress	デプロイの状態が進行中です。
notDeployed	デプロイの状態はデプロイされていません。
partiallySucceeded	デプロイの状態が部分的に確認されます。
succeeded	デプロイの状態が成功しました。
undefined	デプロイの状態は未定義です。

DeployPhase

Object

名前	型	説明
name	string	展開フェーズの名前を取得および設定します。
phaseType	DeployPhaseTypes	展開フェーズの種類を示します。
rank	integer (int32)	デプロイフェーズのランクを取得および設定します。
refName	string	展開フェーズの参照名を取得および設定します。
workflowTasks	WorkflowTask[]	展開フェーズのワークフロータスクを取得および設定します。

DeployPhaseStatus

列挙

フェーズの状態。

値	説明
canceled	フェーズの実行が取り消されました。
cancelling	フェーズが取り消し状態です。
failed	フェーズの実行に失敗しました。
inProgress	フェーズの実行が進行中です。
notStarted	フェーズの実行が開始されていません。
partiallySucceeded	フェーズの実行が部分的に成功しました。
skipped	フェーズの実行がスキップされました。
succeeded	フェーズの実行に成功しました。
undefined	フェーズの状態が設定されていません。

DeployPhaseTypes

列挙

展開フェーズの種類を示します。

値	説明
agentBasedDeployment	エージェントで実行されるタスクを含むフェーズの種類。
deploymentGates	展開を進めるゲートとして機能するタスクを含むフェーズの種類。
machineGroupBasedDeployment	展開グループコンピューターで実行されるタスクを含むフェーズの種類。
runOnServer	サーバーによって実行されるタスクを含むフェーズの種類。
undefined	フェーズの種類が定義されていません。これを使用しないでください。

EnvironmentOptions

Object

名前	型	説明
autoLinkWorkItems	boolean	自動リンク作業項目として取得および設定します。
badgeEnabled	boolean	バッジが有効かどうかを取得および設定します。
publishDeploymentStatus	boolean	発行デプロイの状態として取得および設定します。
pullRequestDeploymentEnabled	boolean	取得し、有効になっているかどうか、.pull request 展開として設定します。

EnvironmentStatus

列挙

環境の状態を取得します。

値	説明
canceled	環境が取り消された状態です。
inProgress	環境が進行中の状態です。
notStarted	環境が開始されていない状態です。
partiallySucceeded	環境が部分的に成功した状態です。
queued	環境がキューに入った状態です。
rejected	環境が拒否された状態です。
scheduled	環境はスケジュールされた状態です。
succeeded	環境が成功した状態です。
undefined	環境の状態が設定されていません。

GateStatus

列挙

リリースゲートの状態。

値	説明
canceled	ゲートの実行が取り消されました。
failed	ゲートの実行に失敗しました。
inProgress	ゲートは現在進行中です。
none	ゲートにはステータスが設定されていません。
pending	ゲートは保留中の状態です。
succeeded	ゲートは正常に完了しました。

IdentityRef

Object

名前	型	説明
_links	ReferenceLinks	このフィールドには、グラフの件名に関する興味深いリンクが 0 個以上含まれています。これらのリンクを呼び出して、このグラフの件名に関する追加のリレーションシップや詳細情報を取得できます。
descriptor	string	記述子は、システムの実行中にグラフの件名を参照する主な方法です。このフィールドは、アカウントと組織の両方で同じグラフの件名を一意に識別します。
directoryAlias	string	非推奨 - IdentityRef "_links" ディクショナリの "自己" エントリで参照されている Graph ユーザーにクエリを実行することで取得できます
displayName	string	これは、グラフの件名の一意でない表示名です。このフィールドを変更するには、ソースプロバイダーでその値を変更する必要があります。
id	string
imageUrl	string	非推奨 - IdentityRef "_links" ディクショナリの "アバター" エントリで使用できます
inactive	boolean	非推奨 - GraphUser "_links" ディクショナリの "membershipState" エントリで参照されている Graph メンバーシップの状態を照会することで取得できます
isAadIdentity	boolean	非推奨 - 記述子のサブジェクト型 (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) から推論できます
isContainer	boolean	非推奨 - 記述子のサブジェクト型 (Descriptor.IsGroupType) から推論できます
isDeletedInOrigin	boolean
profileUrl	string	非推奨 - ToIdentityRef の既存のほとんどの実装では使用されていません
uniqueName	string	非推奨 - 代わりに Domain+PrincipalName を使用する
url	string	この URL は、このグラフの件名のソースリソースへの完全なルートです。

IgnoredGate

Object

名前	型	説明
lastModifiedOn	string (date-time)	ゲートが最後に無視される日付を取得します。
name	string	ゲートの名前は無視されます。

Issue

Object

名前	型	説明
data	object	データを発行します。
issueType	string	問題の種類 (エラー、警告、情報など)。
message	string	問題メッセージ。

ManualIntervention

Object

名前	型	説明
approver	IdentityRef	承認する必要がある ID を取得または設定します。
comments	string	承認のコメントを取得または設定します。
createdOn	string (date-time)	作成日を取得します。
id	integer (int32)	手動介入の一意識別子を取得します。
instructions	string	承認の手順を取得または設定します。
modifiedOn	string (date-time)	変更された日付を取得します。
name	string	名前を取得または設定します。
release	ReleaseShallowReference	手動操作の releaseReference を取得します。
releaseDefinition	ReleaseDefinitionShallowReference	手動操作用の releaseDefinitionReference を取得します。
releaseEnvironment	ReleaseEnvironmentShallowReference	手動操作用の releaseEnvironmentReference を取得します。
status	ManualInterventionStatus	手動介入の状態を取得または設定します。
taskInstanceId	string (uuid)	タスクインスタンス識別子を取得します。
url	string	手動介入にアクセスするための URL を取得します。

ManualInterventionStatus

列挙

手動介入の状態を取得または設定します。

値	説明
approved	手動による介入が承認されます。
canceled	手動による介入は取り消されます。
pending	手動による介入は保留中です。
rejected	手動による介入は拒否されます。
unknown	手動介入には、状態が設定されていません。

ProcessParameters

Object

名前	型	説明
dataSourceBindings	DataSourceBindingBase[]	サービスエンドポイント要求のデータソースのバインドを表します。
inputs	TaskInputDefinitionBase[]
sourceDefinitions	TaskSourceDefinitionBase[]

ProjectReference

Object

名前	型	説明
id	string (uuid)	このフィールドの一意識別子を取得します。
name	string	プロジェクトの名前を取得します。

PropertiesCollection

Object

このクラスは、キーと値のペアのコレクションとしてプロパティバッグを表します。 DBNull を除くすべてのプリミティブ型 (TypeCode != TypeCode.Objectを持つ任意の型) の値が受け入れられます。 Byte[]、Int32、Double、DateType、String 型の値は型を保持し、他のプリミティブは文字列として再調整されます。 Byte[] は base64 でエンコードされた文字列として必要です。

名前	型	説明
count	integer (int32)	コレクション内のプロパティの数。
item	object
keys	string[]	コレクション内のキーのセット。
values	string[]	コレクション内の値のセット。

ReferenceLinks

Object

REST 参照リンクのコレクションを表すクラス。

名前	型	説明
links	object	リンクの読み取りビュー。参照リンクは読み取り専用であるため、読み取り専用として公開する必要があります。

Release

Object

名前	型	説明
_links	ReferenceLinks	リリースにアクセスするためのリンクを取得します。
artifacts	Artifact[]	成果物の一覧を取得または設定します。
comment	string	コメントを取得または設定します。
createdBy	IdentityRef	作成した ID を取得または設定します。
createdFor	IdentityRef	リリースが作成された ID を取得または設定します。
createdOn	string (date-time)	作成日を取得します。
definitionSnapshotRevision	integer (int32)	定義スナップショットのリビジョン番号を取得します。
description	string	リリースの説明を取得または設定します。
environments	ReleaseEnvironment[]	環境の一覧を取得します。
id	integer (int32)	このフィールドの一意識別子を取得します。
keepForever	boolean	アイテム保持ポリシーからリリースを除外するかどうかを指定します。
logsContainerUrl	string	ログコンテナーの URL を取得します。
modifiedBy	IdentityRef	変更した ID を取得または設定します。
modifiedOn	string (date-time)	変更された日付を取得します。
name	string	名前を取得します。
poolName	string	プール名を取得します。
projectReference	ProjectReference	プロジェクト参照を取得または設定します。
properties	PropertiesCollection	このクラスは、キーと値のペアのコレクションとしてプロパティバッグを表します。 `DBNull` を除くすべてのプリミティブ型 (`TypeCode != TypeCode.Object`を持つ任意の型) の値が受け入れられます。 Byte[]、Int32、Double、DateType、String 型の値は型を保持し、他のプリミティブは文字列として再調整されます。 Byte[] は base64 でエンコードされた文字列として必要です。
reason	ReleaseReason	リリースの理由を取得します。
releaseDefinition	ReleaseDefinitionShallowReference	このリリースが関連付けられているリリース定義の参照を指定する releaseDefinitionReference を取得します。
releaseDefinitionRevision	integer (int32)	リリース定義のリビジョンを取得または設定します。
releaseNameFormat	string	リリース名の形式を取得します。
status	ReleaseStatus	状態を取得します。
tags	string[]	タグの一覧を取得または設定します。
triggeringArtifactAlias	string
variableGroups	VariableGroup[]	変数グループの一覧を取得します。
variables	<string, ConfigurationVariableValue>	変数のディクショナリを取得または設定します。

ReleaseApproval

Object

名前	型	説明
approvalType	ApprovalType	承認の種類を取得または設定します。
approvedBy	IdentityRef	承認した ID を取得します。
approver	IdentityRef	承認する必要がある ID を取得または設定します。
attempt	integer (int32)	どのデプロイ試行が属するかを指定する試行を取得または設定します。
comments	string	承認のコメントを取得または設定します。
createdOn	string (date-time)	作成日を取得します。
history	ReleaseApprovalHistory[]	この承認に関連付けられているすべての承認を指定する履歴を取得します。
id	integer (int32)	このフィールドの一意識別子を取得します。
isAutomated	boolean	承認が自動化されているかどうかを取得または設定します。
modifiedOn	string (date-time)	変更された日付を取得します。
rank	integer (int32)	承認の順序を指定するランクを取得または設定します。たとえば、同じランクは並列承認を表します。
release	ReleaseShallowReference	この承認が関連付けられているリリースの参照を指定する releaseReference を取得します。
releaseDefinition	ReleaseDefinitionShallowReference	この承認が関連付けられているリリース定義の参照を指定する releaseDefinitionReference を取得します。
releaseEnvironment	ReleaseEnvironmentShallowReference	この承認が関連付けられているリリース環境の参照を指定する releaseEnvironmentReference を取得します。
revision	integer (int32)	リビジョン番号を取得します。
status	ApprovalStatus	承認の状態を取得または設定します。
url	string	承認にアクセスするための URL を取得します。

ReleaseApprovalHistory

Object

名前	型	説明
approver	IdentityRef	承認者の ID。
changedBy	IdentityRef	承認を変更したオブジェクトの ID。
comments	string	承認履歴のコメント。
createdOn	string (date-time)	この承認が作成された時刻。
modifiedOn	string (date-time)	この承認が変更された時刻。
revision	integer (int32)	承認履歴のリビジョン。

ReleaseCondition

Object

名前	型	説明
conditionType	ConditionType	条件の種類を取得または設定します。
name	string	条件の名前を取得または設定します。例: 'ReleaseStarted'。
result	boolean	リリース条件の結果。
value	string	条件の値を取得または設定します。

ReleaseDefinitionApprovals

Object

名前	型	説明
approvalOptions	ApprovalOptions	承認オプションを取得または設定します。
approvals	ReleaseDefinitionApprovalStep[]	承認を取得または設定します。

ReleaseDefinitionApprovalStep

Object

名前	型	説明
approver	IdentityRef	承認者を取得および設定します。
id	integer (int32)	承認またはデプロイ手順の ID。
isAutomated	boolean	承認が自動化されているかどうかを示します。
isNotificationOn	boolean	承認通知が設定されているかどうかを示します。
rank	integer (int32)	承認ステップのランクを取得または設定します。

ReleaseDefinitionGate

Object

名前	型	説明
tasks	WorkflowTask[]	ゲートワークフローを取得または設定します。

ReleaseDefinitionGatesOptions

Object

名前	型	説明
isEnabled	boolean	ゲートが有効かどうかを取得または設定します。
minimumSuccessDuration	integer (int32)	ゲートの評価が成功した後の安定した結果の最小期間を取得または設定します。
samplingInterval	integer (int32)	ゲートの再評価の間隔を取得または設定します。
stabilizationTime	integer (int32)	評価前の遅延を取得または設定します。
timeout	integer (int32)	ゲートが失敗した後のタイムアウトを取得または設定します。

ReleaseDefinitionGatesStep

Object

名前	型	説明
gates	ReleaseDefinitionGate[]	ゲートを取得または設定します。
gatesOptions	ReleaseDefinitionGatesOptions	ゲートオプションを取得または設定します。
id	integer (int32)	ReleaseDefinitionGateStep の ID。

ReleaseDefinitionShallowReference

Object

名前	型	説明
_links	ReferenceLinks	リリース定義の関連リソース、API、およびビューへのリンクを取得します。
id	integer (int32)	リリース定義の一意識別子を取得します。
name	string	リリース定義の名前を取得または設定します。
path	string	リリース定義のパスを取得または設定します。
projectReference	ProjectReference	プロジェクト参照を取得または設定します。
url	string	リリース定義にアクセスするための REST API URL を取得します。

ReleaseDeployPhase

Object

名前	型	説明
deploymentJobs	DeploymentJob[]	フェーズのデプロイジョブ。
errorLog	string	フェーズ実行エラーログ。
manualInterventions	ManualIntervention[]	手動介入タスクの実行情報の一覧 (フェーズ)。
name	string	フェーズの名前。
phaseId	string	フェーズの ID。
phaseType	DeployPhaseTypes	フェーズの種類。
rank	integer (int32)	フェーズのランク。
runPlanId	string (uuid)	フェーズのプラン ID を実行します。
startedOn	string (date-time)	フェーズの開始時刻。
status	DeployPhaseStatus	フェーズの状態。

ReleaseEnvironment

Object

名前	型	説明
conditions	ReleaseCondition[]	条件の一覧を取得します。
createdOn	string (date-time)	作成日を取得します。
definitionEnvironmentId	integer (int32)	定義環境 ID を取得します。
deployPhasesSnapshot	DeployPhase[]	デプロイフェーズスナップショットの一覧を取得します。
deploySteps	DeploymentAttempt[]	デプロイ手順を取得します。
environmentOptions	EnvironmentOptions	環境オプションを取得します。
id	integer (int32)	このフィールドの一意識別子を取得します。
modifiedOn	string (date-time)	変更された日付を取得します。
name	string	名前を取得します。
nextScheduledUtcTime	string (date-time)	次にスケジュールされた UTC 時刻を取得します。
owner	IdentityRef	リリース環境の所有者である ID を取得します。
postApprovalsSnapshot	ReleaseDefinitionApprovals	デプロイ後の承認スナップショットの一覧を取得します。
postDeployApprovals	ReleaseApproval[]	配置後の承認の一覧を取得します。
postDeploymentGatesSnapshot	ReleaseDefinitionGatesStep	デプロイ後にスナップショットデータがゲートされます。
preApprovalsSnapshot	ReleaseDefinitionApprovals	デプロイ前の承認スナップショットの一覧を取得します。
preDeployApprovals	ReleaseApproval[]	デプロイ前の承認の一覧を取得します。
preDeploymentGatesSnapshot	ReleaseDefinitionGatesStep	デプロイ前にスナップショットデータをゲートします。
processParameters	ProcessParameters	プロセスパラメーターを取得します。
rank	integer (int32)	ランクを取得します。
release	ReleaseShallowReference	このリリース環境が関連付けられているリリースの参照を指定するリリース参照を取得します。
releaseCreatedBy	IdentityRef	リリースを作成した ID を取得します。
releaseDefinition	ReleaseDefinitionShallowReference	このリリース環境が関連付けられているリリース定義の参照を指定する releaseDefinitionReference を取得します。
releaseId	integer (int32)	リリース ID を取得します。
scheduledDeploymentTime	string (date-time)	リリース環境のデプロイ時刻のスケジュールを取得します。
schedules	ReleaseSchedule[]	スケジュールの一覧を取得します。
status	EnvironmentStatus	環境の状態を取得します。
timeToDeploy	number (double)	デプロイする時間を取得します。
triggerReason	string	トリガーの理由を取得します。
variableGroups	VariableGroup[]	変数グループの一覧を取得します。
variables	<string, ConfigurationVariableValue>	変数のディクショナリを取得します。

ReleaseEnvironmentShallowReference

Object

名前	型	説明
_links	ReferenceLinks	リリース環境の関連リソース、API、およびビューへのリンクを取得します。
id	integer (int32)	リリース環境の一意識別子を取得します。
name	string	リリース環境の名前を取得または設定します。
url	string	リリース環境にアクセスするための REST API URL を取得します。

ReleaseGates

Object

名前	型	説明
deploymentJobs	DeploymentJob[]	各評価のゲートジョブの詳細を格納します。
id	integer (int32)	リリースゲートの ID。
ignoredGates	IgnoredGate[]	無視されるゲートの一覧。
lastModifiedOn	string (date-time)	ゲートの最終変更時刻。
runPlanId	string (uuid)	ゲートの実行プラン ID。
stabilizationCompletedOn	string (date-time)	ゲートの安定化完了日時。
startedOn	string (date-time)	ゲート評価の開始時刻。
status	GateStatus	リリースゲートの状態。
succeedingSince	string (date-time)	すべてのゲートが正常に実行された日時。

ReleaseReason

列挙

リリースの理由を取得します。

値	説明
continuousIntegration	継続的インテグレーションによってトリガーされるリリースを示します。
manual	リリースが手動でトリガーされたことを示します。
none	リリースによってトリガーされた理由が設定されていないことを示します。
pullRequest	PullRequest によってトリガーされるリリースを示します。
schedule	スケジュールによってトリガーされるリリースを示します。

ReleaseSchedule

Object

名前	型	説明
daysToRelease	ScheduleDays	リリースする曜日。
jobId	string (uuid)	Team Foundation ジョブ定義ジョブ ID。
scheduleOnlyWithChanges	boolean	関連付けられた成果物が変更されたか、リリース定義が変更された場合にのみ、このスケジュールをリリースするかどうかを決定するフラグ。
startHours	integer (int32)	開始するローカルタイムゾーン時間。
startMinutes	integer (int32)	開始するローカルタイムゾーン分。
timeZoneId	string	リリーススケジュールのタイムゾーン ID ('UTC' など)。

ReleaseShallowReference

Object

名前	型	説明
_links	ReferenceLinks	リリースの関連リソース、API、およびビューへのリンクを取得します。
id	integer (int32)	リリースの一意識別子を取得します。
name	string	リリースの名前を取得または設定します。
url	string	リリースにアクセスするための REST API URL を取得します。

ReleaseStatus

列挙

状態を取得します。

値	説明
abandoned	リリースの状態は破棄されています。
active	リリースの状態がアクティブです。
draft	リリースはドラフト状態です。
undefined	リリースの状態が設定されていません。

ReleaseTask

Object

名前	型	説明
agentName	string	タスクが実行されたエージェント名。
finishTime	string (date-time)	リリースタスクの終了時刻。
id	integer (int32)	リリースタスクの ID。
issues	Issue[]	タスクの実行中に発生した問題の一覧。
lineCount	integer (int64)	ログリリースタスクに含まれる行数。
logUrl	string	タスクのログ URL。
name	string	タスクの名前。
percentComplete	integer (int32)	タスクの実行が完了する前に実行されます。
rank	integer (int32)	リリースタスクのランク。
resultCode	string	タスクの結果コード。
startTime	string (date-time)	リリースタスクの ID。
status	TaskStatus	リリースタスクの状態。
task	WorkflowTaskReference	ワークフロータスクリファレンス。
timelineRecordId	string (uuid)	リリースタスクのタイムラインレコード ID。

ReleaseUpdateMetadata

Object

名前	型	説明
comment	string	リリースのコメントを設定します。
keepForever	boolean	アイテム保持ポリシーからリリースを除外するには、'true' を設定します。
manualEnvironments	string[]	手動環境の一覧を設定します。
name	string	リリースの名前を設定します。
status	ReleaseStatus	リリースの状態を設定します。

ScheduleDays

列挙

リリースする曜日。

値	説明
all	週のすべての曜日にスケジュールされます。
friday	金曜日に予定されています。
monday	月曜日に予定されています。
none	スケジュールされた日が設定されていません。
saturday	土曜日に予定されています。
sunday	日曜日に予定されています。
thursday	木曜日に予定されています。
tuesday	火曜日に予定されています。
wednesday	水曜日に予定されています。

TaskInputDefinitionBase

Object

名前	型	説明
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

Object

名前	型	説明
expression	string	条件式
message	string	検証が失敗した場合にユーザーが修正する方法を説明するメッセージ

TaskSourceDefinitionBase

Object

名前	型	説明
authKey	string
endpoint	string
keySelector	string
selector	string
target	string

TaskStatus

列挙

リリースタスクの状態。

値	説明
canceled	タスクの実行が取り消されました。
failed	タスクの実行に失敗しました。
failure	タスクの実行に失敗しました。
inProgress	タスクは現在進行中です。
partiallySucceeded	タスクの実行が部分的に成功しました。
pending	タスクは保留中の状態です。
skipped	タスクの実行がスキップされました。
succeeded	タスクは正常に完了しました。
success	タスクは正常に完了しました。
unknown	タスクに状態が設定されていません。

VariableGroup

Object

名前	型	説明
createdBy	IdentityRef	作成した ID を取得または設定します。
createdOn	string (date-time)	作成日を取得します。
description	string	説明を取得または設定します。
id	integer (int32)	このフィールドの一意識別子を取得します。
isShared	boolean	変数グループが他のプロジェクトと共有されているかどうかを示します。
modifiedBy	IdentityRef	変更した ID を取得または設定します。
modifiedOn	string (date-time)	変更された日付を取得します。
name	string	名前を取得または設定します。
providerData	VariableGroupProviderData	プロバイダーデータを取得または設定します。
type	string	型を取得または設定します。
variableGroupProjectReferences	VariableGroupProjectReference[]	変数グループが他のプロジェクトと共有されているすべてのプロジェクト参照。
variables	<string, VariableValue>	変数のディクショナリを取得および設定します。

VariableGroupProjectReference

Object

変数グループ参照は、変数グループへの浅い参照です。

名前	型	説明
description	string	変数グループの説明を取得または設定します。
name	string	変数グループの名前を取得または設定します。
projectReference	ProjectReference	変数グループのプロジェクト参照を取得または設定します。

VariableGroupProviderData

Object

VariableValue

Object

名前	型	説明
isReadOnly	boolean	変数が読み取り専用かどうかを取得または設定します。
isSecret	boolean	変数がシークレットかどうかを取得または設定します。
value	string	値を取得または設定します。

WorkflowTask

Object

名前	型	説明
alwaysRun	boolean	タスクが常に実行されるかどうかを取得または設定します。
condition	string	タスクの条件を取得または設定します。
continueOnError	boolean	タスクがエラー時に実行を続けるかどうかを取得または設定します。
definitionType	string	タスク定義の種類を取得または設定します。例:- 'Agent'、DeploymentGroup'、'Server'、または 'ServerGate'。
enabled	boolean	タスクが有効かどうかを取得または設定します。
environment	object	タスク環境変数を取得または設定します。
inputs	object	タスク入力を取得または設定します。
name	string	タスクの名前を取得または設定します。
overrideInputs	object	タスクのオーバーライド入力を取得または設定します。
refName	string	タスクの参照名を取得または設定します。
retryCountOnTaskFailure	integer (int32)	タスクの retryCount を取得または設定します。
taskId	string (uuid)	タスクの ID を取得または設定します。
timeoutInMinutes	integer (int32)	タスクのタイムアウトを取得または設定します。
version	string	タスクのバージョンを取得または設定します。

WorkflowTaskReference

Object

名前	型	説明
id	string (uuid)	タスク識別子。
name	string	タスクの名前。
version	string	タスクのバージョン。

次の方法で共有

Releases - Update Release Resource

URI パラメーター

要求本文

応答

セキュリティ

oauth2

スコープ

例

Abandoning an active release

要求のサンプル

応答のサンプル

定義

ApprovalExecutionOrder

ApprovalOptions

ApprovalStatus

ApprovalType

Artifact

ArtifactSourceReference

AuthorizationHeader

ConditionType

ConfigurationVariableValue

DataSourceBindingBase

DeploymentAttempt

DeploymentJob

DeploymentOperationStatus

DeploymentReason

DeploymentStatus

DeployPhase

DeployPhaseStatus

DeployPhaseTypes

EnvironmentOptions

EnvironmentStatus

GateStatus

IdentityRef

IgnoredGate

Issue

ManualIntervention

ManualInterventionStatus

ProcessParameters

ProjectReference

PropertiesCollection

ReferenceLinks

Release

ReleaseApproval

ReleaseApprovalHistory

ReleaseCondition

ReleaseDefinitionApprovals

ReleaseDefinitionApprovalStep

ReleaseDefinitionGate

ReleaseDefinitionGatesOptions

ReleaseDefinitionGatesStep

ReleaseDefinitionShallowReference

ReleaseDeployPhase

ReleaseEnvironment

ReleaseEnvironmentShallowReference

ReleaseGates

ReleaseReason

ReleaseSchedule

ReleaseShallowReference

ReleaseStatus

ReleaseTask

ReleaseUpdateMetadata

ScheduleDays

TaskInputDefinitionBase

TaskInputValidation

TaskSourceDefinitionBase

TaskStatus

VariableGroup

VariableGroupProjectReference

VariableGroupProviderData

VariableValue

WorkflowTask

WorkflowTaskReference