Releases - Create

リファレンス

Service:: Release

API Version:: 7.1-preview.8

リリースを作成します。

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

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前です。
project	path	True	string	プロジェクト ID またはプロジェクト名
api-version	query	True	string	使う API のバージョン。このバージョンの API を使用するには、これを '7.1-preview.8' に設定する必要があります。

要求本文

名前	型	説明
artifacts	ArtifactMetadata[]	リリースを作成する成果物の一覧を設定します。
definitionId	integer	リリースを作成する定義 ID を設定します。
description	string	リリースを作成する説明を設定します。
environmentsMetadata	ReleaseStartEnvironmentMetadata[]	環境メタデータの一覧を設定します。
isDraft	boolean	下書きモードでリリースを作成するように 'true' を設定し、それ以外の場合は 'false' を設定します。
manualEnvironments	string[]	環境の一覧を条件として手動に設定します。
properties	PropertiesCollection	クラスは、キーと値のペアのコレクションとしてプロパティバッグを表します。を除くすべてのプリミティブ型 (を持つ任意の `TypeCode != TypeCode.Object`型) の `DBNull` 値が受け入れられます。 Byte[]、Int32、Double、DateType、String 型の値は、その型を保持し、他のプリミティブは String として再調整されます。 Byte[] は base64 でエンコードされた文字列として必要です。
reason	ReleaseReason	リリースを作成する理由を設定します。
variables	<string, ConfigurationVariableValue>	デプロイ時にオーバーライドされるリリース変数の一覧を設定します。

応答

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

セキュリティ

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

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

例

Sample Request

HTTP

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

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

Sample Response

Status code:: 200

{
  "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": {}
}

定義

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

ApprovalExecutionOrder

承認の実行順序。

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

ApprovalOptions

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

ApprovalStatus

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

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

ApprovalType

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

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

Artifact

名前	型	説明
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' を指定できます。

ArtifactMetadata

名前	型	説明
alias	string	成果物のエイリアスを設定します。
instanceReference	BuildVersion	成果物のインスタンス参照を設定します。たとえば、ビルド成果物の場合はビルド番号です。

ArtifactSourceReference

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

AuthorizationHeader

名前	型	説明
name	string
value	string

BuildVersion

名前	型	説明
commitMessage	string	成果物のコミットメッセージを取得または設定します。
definitionId	string	定義 ID を取得または設定します。
definitionName	string	定義名を取得または設定します。
id	string	ビルド ID を取得または設定します。
isMultiDefinitionType	boolean	成果物が複数の定義をサポートしているかどうかを取得または設定します。
name	string	ビルド番号を取得または設定します。
sourceBranch	string	成果物のソースブランチを取得または設定します。
sourcePullRequestVersion	SourcePullRequestVersion	成果物のソース pull request バージョンを取得または設定します。
sourceRepositoryId	string	成果物のリポジトリ ID を取得または設定します。
sourceRepositoryType	string	成果物のリポジトリの種類を取得または設定します。
sourceVersion	string	成果物のソースバージョンを取得または設定します。

ConditionType

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

名前	型	説明
artifact	string	条件の種類は成果物です。
environmentState	string	条件の種類は環境の状態です。
event	string	条件の種類は event です。
undefined	string	条件の種類は未定義です。

ConfigurationVariableValue

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

DataSourceBindingBase

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

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

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

DeploymentJob

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

DeploymentOperationStatus

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

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

DeploymentReason

展開の理由を取得します。

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

DeploymentStatus

展開の状態を取得します。

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

DeployPhase

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

DeployPhaseStatus

フェーズの状態。

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

DeployPhaseTypes

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

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

EnvironmentOptions

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

EnvironmentStatus

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

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

GateStatus

リリースゲートの状態。

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

IdentityRef

名前	型	説明
_links	ReferenceLinks	このフィールドには、グラフの件名に関する 0 個以上の興味深いリンクが含まれています。これらのリンクを呼び出して、このグラフの件名に関する追加のリレーションシップまたは詳細情報を取得できます。
descriptor	string	記述子は、システムの実行中にグラフの件名を参照する主な方法です。このフィールドは、アカウントと組織の両方で同じグラフの件名を一意に識別します。
directoryAlias	string	非推奨 - IdentityRef "_links" ディクショナリの "self" エントリで参照されている 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

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

Issue

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

ManualIntervention

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

ManualInterventionStatus

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

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

ProcessParameters

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

ProjectReference

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

PropertiesCollection

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

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

ReferenceLinks

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

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

Release

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

ReleaseApproval

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

ReleaseApprovalHistory

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

ReleaseCondition

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

ReleaseDefinitionApprovals

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

ReleaseDefinitionApprovalStep

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

ReleaseDefinitionGate

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

ReleaseDefinitionGatesOptions

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

ReleaseDefinitionGatesStep

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

ReleaseDefinitionShallowReference

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

ReleaseDeployPhase

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

ReleaseEnvironment

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

ReleaseEnvironmentShallowReference

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

ReleaseGates

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

ReleaseReason

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

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

ReleaseSchedule

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

ReleaseShallowReference

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

ReleaseStartEnvironmentMetadata

名前	型	説明
definitionEnvironmentId	integer	リリース定義環境 ID を設定します。
variables	<string, ConfigurationVariableValue>	デプロイ時にオーバーライドされる環境変数の一覧を設定します。

ReleaseStartMetadata

名前	型	説明
artifacts	ArtifactMetadata[]	リリースを作成する成果物の一覧を設定します。
definitionId	integer	リリースを作成する定義 ID を設定します。
description	string	リリースを作成する説明を設定します。
environmentsMetadata	ReleaseStartEnvironmentMetadata[]	環境メタデータの一覧を設定します。
isDraft	boolean	下書きモードでリリースを作成するように 'true' を設定し、それ以外の場合は 'false' を設定します。
manualEnvironments	string[]	環境の一覧を条件として手動に設定します。
properties	PropertiesCollection	クラスは、キーと値のペアのコレクションとしてプロパティバッグを表します。を除くすべてのプリミティブ型 (を持つ任意の `TypeCode != TypeCode.Object`型) の `DBNull` 値が受け入れられます。 Byte[]、Int32、Double、DateType、String 型の値は、その型を保持し、他のプリミティブは String として再調整されます。 Byte[] は base64 でエンコードされた文字列として必要です。
reason	ReleaseReason	リリースを作成する理由を設定します。
variables	<string, ConfigurationVariableValue>	デプロイ時にオーバーライドされるリリース変数の一覧を設定します。

ReleaseStatus

状態を取得します。

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

ReleaseTask

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

ScheduleDays

リリースする曜日。

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

SourcePullRequestVersion

名前	型	説明
iterationId	string	リリースが状態を発行する Pull Request イテレーション ID。
pullRequestId	string	リリースが状態を発行する Pull Request ID。
pullRequestMergedAt	string	pull request マージ作成の日付と時刻。 pull request によって作成されたリリースタイムラインレコードを保持する必要があります。
sourceBranch	string	Pull Request のソースブランチ。
sourceBranchCommitId	string	リリースが状態を発行する Pull Request のソースブランチコミット ID。
targetBranch	string	Pull Request のターゲットブランチ。

TaskInputDefinitionBase

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

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

TaskSourceDefinitionBase

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

TaskStatus

リリースタスクの状態。

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

VariableGroup

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

VariableGroupProjectReference

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

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

VariableGroupProviderData

VariableValue

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

WorkflowTask

名前	型	説明
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	タスクの retryCount を取得または設定します。
taskId	string	タスクの ID を取得または設定します。
timeoutInMinutes	integer	タスクのタイムアウトを取得または設定します。
version	string	タスクのバージョンを取得または設定します。

WorkflowTaskReference

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

次の方法で共有