Definitions - Create

リファレンス

サービス:: Release

API バージョン:: 7.1

リリース定義を作成する

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

URI パラメーター

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

要求本文

名前	型	説明
_links	ReferenceLinks	リリース定義の関連リソース、API、およびビューへのリンクを取得します。
artifacts	Artifact[]	成果物の一覧を取得または設定します。
comment	string	コメントを取得または設定します。
createdBy	IdentityRef	作成した ID を取得または設定します。
createdOn	string (date-time)	作成日を取得します。
description	string	説明を取得または設定します。
environments	ReleaseDefinitionEnvironment[]	環境の一覧を取得または設定します。
id	integer (int32)	リリース定義の一意識別子を取得します。
isDeleted	boolean	リリース定義が削除されるかどうか。
lastRelease	ReleaseReference	最後のリリースの参照を取得します。
modifiedBy	IdentityRef	変更した ID を取得または設定します。
modifiedOn	string (date-time)	変更された日付を取得します。
name	string	リリース定義の名前を取得または設定します。
path	string	リリース定義のパスを取得または設定します。
projectReference	ProjectReference	プロジェクト参照を取得または設定します。
properties	PropertiesCollection	プロパティを取得または設定します。
releaseNameFormat	string	リリース名の形式を取得または設定します。
revision	integer (int32)	リビジョン番号を取得します。
source	ReleaseDefinitionSource	リリース定義のソースを取得または設定します。
tags	string[]	タグの一覧を取得または設定します。
triggers	ReleaseTriggerBase[]	トリガーの一覧を取得または設定します。
url	string	リリース定義にアクセスするための REST API URL を取得します。
variableGroups	integer[] (int32)	変数グループの一覧を取得または設定します。
variables	<string, ConfigurationVariableValue>	変数のディクショナリを取得または設定します。

応答

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

セキュリティ

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	フォルダー、リリース、リリース定義、リリース環境、新しいリリースをキューに登録する機能など、リリース成果物の読み取りと更新を行う機能を付与します。

例

Create release definition

要求のサンプル

HTTP

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

{
  "source": "undefined",
  "revision": 1,
  "description": null,
  "createdBy": null,
  "createdOn": "0001-01-01T00:00:00",
  "modifiedBy": null,
  "modifiedOn": "0001-01-01T00:00:00",
  "isDeleted": false,
  "variables": {},
  "variableGroups": [],
  "environments": [
    {
      "id": 0,
      "name": "PROD",
      "variables": {},
      "variableGroups": [],
      "preDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": false,
            "isNotificationOn": false,
            "approver": {
              "displayName": null,
              "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97"
            },
            "id": 0
          }
        ]
      },
      "postDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 0
          }
        ]
      },
      "deployPhases": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "artifactsDownloadInput": {},
            "queueId": 15,
            "demands": [],
            "enableAccessToken": false,
            "timeoutInMinutes": 0,
            "jobCancelTimeoutInMinutes": 1,
            "condition": "succeeded()",
            "overrideInputs": {}
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "workflowTasks": []
        }
      ],
      "environmentOptions": {
        "emailNotificationType": "OnlyOnFailure",
        "emailRecipients": "release.environment.owner;release.creator",
        "skipArtifactsDownload": false,
        "timeoutInMinutes": 0,
        "enableAccessToken": false,
        "publishDeploymentStatus": false,
        "badgeEnabled": false,
        "autoLinkWorkItems": false,
        "pullRequestDeploymentEnabled": false
      },
      "demands": [],
      "conditions": [],
      "executionPolicy": {
        "concurrencyCount": 0,
        "queueDepthCount": 0
      },
      "schedules": [],
      "retentionPolicy": {
        "daysToKeep": 30,
        "releasesToKeep": 3,
        "retainBuild": true
      },
      "properties": {},
      "preDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "postDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "environmentTriggers": []
    }
  ],
  "artifacts": [],
  "triggers": [],
  "releaseNameFormat": null,
  "tags": [],
  "properties": {},
  "id": 0,
  "name": "Fabrikam-web",
  "projectReference": null,
  "_links": {}
}

応答のサンプル

状態コード:: 200

{
  "source": "restApi",
  "revision": 1,
  "description": null,
  "createdBy": {
    "displayName": "Chuck Reinhart",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      }
    },
    "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "uniqueName": "fabfiber@outlook.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
  },
  "createdOn": "2018-12-11T04:56:42.237Z",
  "modifiedBy": {
    "displayName": "Chuck Reinhart",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      }
    },
    "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "uniqueName": "fabfiber@outlook.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
  },
  "modifiedOn": "2018-12-11T04:56:42.237Z",
  "isDeleted": false,
  "variables": {},
  "variableGroups": [],
  "environments": [
    {
      "id": 42,
      "name": "PROD",
      "rank": 1,
      "owner": {
        "displayName": "Chuck Reinhart",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
          }
        },
        "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "uniqueName": "fabfiber@outlook.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      },
      "variables": {},
      "variableGroups": [],
      "preDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": false,
            "isNotificationOn": false,
            "approver": {
              "displayName": "Chuck Reinhart",
              "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "_links": {
                "avatar": {
                  "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
                }
              },
              "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "uniqueName": "fabfiber@outlook.com",
              "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
            },
            "id": 124
          }
        ],
        "approvalOptions": {
          "requiredApproverCount": 0,
          "releaseCreatorCanBeApprover": true,
          "autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
          "enforceIdentityRevalidation": false,
          "timeoutInMinutes": 0,
          "executionOrder": "beforeGates"
        }
      },
      "deployStep": {
        "id": 125
      },
      "postDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 126
          }
        ]
      },
      "deployPhases": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "artifactsDownloadInput": {
              "downloadInputs": []
            },
            "queueId": 15,
            "demands": [],
            "enableAccessToken": false,
            "timeoutInMinutes": 0,
            "jobCancelTimeoutInMinutes": 1,
            "condition": "succeeded()",
            "overrideInputs": {}
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "refName": null,
          "workflowTasks": []
        }
      ],
      "environmentOptions": {
        "emailNotificationType": "OnlyOnFailure",
        "emailRecipients": "release.environment.owner;release.creator",
        "skipArtifactsDownload": false,
        "timeoutInMinutes": 0,
        "enableAccessToken": false,
        "publishDeploymentStatus": false,
        "badgeEnabled": false,
        "autoLinkWorkItems": false,
        "pullRequestDeploymentEnabled": false
      },
      "demands": [],
      "conditions": [],
      "executionPolicy": {
        "concurrencyCount": 0,
        "queueDepthCount": 0
      },
      "schedules": [],
      "currentRelease": {
        "id": 0,
        "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/0",
        "_links": {}
      },
      "retentionPolicy": {
        "daysToKeep": 30,
        "releasesToKeep": 3,
        "retainBuild": true
      },
      "properties": {},
      "preDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "postDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "environmentTriggers": [],
      "badgeUrl": "https://vsrm.dev.azure.com/fabrikam/_apis/public/Release/badge/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/42/42"
    }
  ],
  "artifacts": [],
  "triggers": [],
  "releaseNameFormat": "",
  "tags": [],
  "properties": {},
  "id": 42,
  "name": "Fabrikam-web",
  "path": "\\",
  "projectReference": null,
  "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/42",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/42"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=42"
    }
  }
}

定義

名前	説明
ApprovalExecutionOrder	承認の実行順序。
ApprovalOptions
Artifact
ArtifactSourceReference
AuthorizationHeader
Condition
ConditionType	条件の種類を取得または設定します。
ConfigurationVariableValue
DataSourceBindingBase	サービスエンドポイント要求のデータソースのバインドを表します。
Demand
DeployPhase
DeployPhaseTypes	展開フェーズの種類を示します。
EnvironmentExecutionPolicy	リリース管理側キューでの環境キューに関するポリシーを定義します。説明されているポリシーが満たされている場合にのみ、環境ランナー (事前デプロイやその他の手順の作成) に送信されます。
EnvironmentOptions
EnvironmentRetentionPolicy
EnvironmentTrigger
EnvironmentTriggerType	トリガーの種類を取得または設定します。
IdentityRef
ProcessParameters
ProjectReference
PropertiesCollection	このクラスは、キーと値のペアのコレクションとしてプロパティバッグを表します。 `DBNull` を除くすべてのプリミティブ型 (`TypeCode != TypeCode.Object`を持つ任意の型) の値が受け入れられます。 Byte[]、Int32、Double、DateType、String 型の値は型を保持し、他のプリミティブは文字列として再調整されます。 Byte[] は base64 でエンコードされた文字列として必要です。
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
ReleaseDefinition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionDeployStep
ReleaseDefinitionEnvironment
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDefinitionSource	リリース定義のソースを取得または設定します。
ReleaseReason	リリースの理由を取得します。
ReleaseReference
ReleaseSchedule
ReleaseShallowReference
ReleaseTriggerBase
ReleaseTriggerType	リリーストリガーの種類。
ScheduleDays	リリースする曜日。
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
WorkflowTask

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 日) を意味します。

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

Condition

Object

名前	型	説明
conditionType	ConditionType	条件の種類を取得または設定します。
name	string	条件の名前を取得または設定します。例: 'ReleaseStarted'。
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	データソースのターゲットを取得または設定します。

Demand

Object

名前	型	説明
name	string	需要の名前を取得および設定します。
value	string	需要の値を取得および設定します。

DeployPhase

Object

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

DeployPhaseTypes

列挙

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

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

EnvironmentExecutionPolicy

Object

リリース管理側キューでの環境キューに関するポリシーを定義します。説明されているポリシーが満たされている場合にのみ、環境ランナー (事前デプロイやその他の手順の作成) に送信されます。

名前	型	説明
concurrencyCount	integer (int32)	このポリシーは、環境ランナーを使用する環境の数を決定します。
queueDepthCount	integer (int32)	EnvironmentQueue テーブル内のキューの深さ。このテーブルは、環境ランナーが (ポリシーに従って) 実行するために別の環境を取得するまで、環境エントリを保持します。

EnvironmentOptions

Object

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

EnvironmentRetentionPolicy

Object

名前	型	説明
daysToKeep	integer (int32)	環境を保持する日数を取得および設定します。
releasesToKeep	integer (int32)	保持するリリースの数を取得および設定します。
retainBuild	boolean	保持するビルドとして取得および設定します。

EnvironmentTrigger

Object

名前	型	説明
definitionEnvironmentId	integer (int32)	このトリガーが適用される定義環境 ID。
releaseDefinitionId	integer (int32)	このトリガーが適用される ReleaseDefinition ID。
triggerContent	string	トリガーの内容を取得または設定します。
triggerType	EnvironmentTriggerType	トリガーの種類を取得または設定します。

EnvironmentTriggerType

列挙

トリガーの種類を取得または設定します。

値	説明
deploymentGroupRedeploy	環境トリガーの種類は、デプロイグループの再デプロイです。
rollbackRedeploy	環境トリガーの種類は Rollback です。
undefined	環境トリガーの種類は未定義です。

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 は、このグラフの件名のソースリソースへの完全なルートです。

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	リンクの読み取りビュー。参照リンクは読み取り専用であるため、読み取り専用として公開する必要があります。

ReleaseDefinition

Object

名前	型	説明
_links	ReferenceLinks	リリース定義の関連リソース、API、およびビューへのリンクを取得します。
artifacts	Artifact[]	成果物の一覧を取得または設定します。
comment	string	コメントを取得または設定します。
createdBy	IdentityRef	作成した ID を取得または設定します。
createdOn	string (date-time)	作成日を取得します。
description	string	説明を取得または設定します。
environments	ReleaseDefinitionEnvironment[]	環境の一覧を取得または設定します。
id	integer (int32)	リリース定義の一意識別子を取得します。
isDeleted	boolean	リリース定義が削除されるかどうか。
lastRelease	ReleaseReference	最後のリリースの参照を取得します。
modifiedBy	IdentityRef	変更した ID を取得または設定します。
modifiedOn	string (date-time)	変更された日付を取得します。
name	string	リリース定義の名前を取得または設定します。
path	string	リリース定義のパスを取得または設定します。
projectReference	ProjectReference	プロジェクト参照を取得または設定します。
properties	PropertiesCollection	プロパティを取得または設定します。
releaseNameFormat	string	リリース名の形式を取得または設定します。
revision	integer (int32)	リビジョン番号を取得します。
source	ReleaseDefinitionSource	リリース定義のソースを取得または設定します。
tags	string[]	タグの一覧を取得または設定します。
triggers	ReleaseTriggerBase[]	トリガーの一覧を取得または設定します。
url	string	リリース定義にアクセスするための REST API URL を取得します。
variableGroups	integer[] (int32)	変数グループの一覧を取得または設定します。
variables	<string, ConfigurationVariableValue>	変数のディクショナリを取得または設定します。

ReleaseDefinitionApprovals

Object

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

ReleaseDefinitionApprovalStep

Object

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

ReleaseDefinitionDeployStep

Object

名前	型	説明
id	integer (int32)	承認またはデプロイ手順の ID。
tasks	WorkflowTask[]	この定義の手順の一覧。

ReleaseDefinitionEnvironment

Object

名前	型	説明
badgeUrl	string	BadgeUrl を取得または設定します。 BadgeUrl は、リリース定義環境でバッジが有効になる場合に使用されます。
conditions	Condition[]	環境条件を取得または設定します。
currentRelease	ReleaseShallowReference	現在のリリース参照を取得または設定します。
demands	Demand[]	要求を取得または設定します。
deployPhases	DeployPhase[]	環境の展開フェーズを取得または設定します。
deployStep	ReleaseDefinitionDeployStep	配置ステップを取得または設定します。
environmentOptions	EnvironmentOptions	環境オプションを取得または設定します。
environmentTriggers	EnvironmentTrigger[]	環境のトリガーを取得または設定します。
executionPolicy	EnvironmentExecutionPolicy	環境実行ポリシーを取得または設定します。
id	integer (int32)	ReleaseDefinitionEnvironment の ID を取得および設定します。
name	string	ReleaseDefinitionEnvironment の名前を取得および設定します。
owner	IdentityRef	ReleaseDefinitionEnvironment の所有者を取得および設定します。
postDeployApprovals	ReleaseDefinitionApprovals	デプロイ後の承認を取得または設定します。
postDeploymentGates	ReleaseDefinitionGatesStep	配置後ゲートを取得または設定します。
preDeployApprovals	ReleaseDefinitionApprovals	デプロイ前の承認を取得または設定します。
preDeploymentGates	ReleaseDefinitionGatesStep	デプロイ前ゲートを取得または設定します。
processParameters	ProcessParameters	環境プロセスパラメーターを取得または設定します。
properties	PropertiesCollection	環境のプロパティを取得または設定します。
queueId	integer (int32)	キュー ID を取得または設定します。
rank	integer (int32)	ReleaseDefinitionEnvironment のランクを取得および設定します。
retentionPolicy	EnvironmentRetentionPolicy	環境の保持ポリシーを取得または設定します。
schedules	ReleaseSchedule[]	スケジュールを取得または設定します。
variableGroups	integer[] (int32)	変数グループを取得または設定します。
variables	<string, ConfigurationVariableValue>	変数を取得および設定します。

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 を取得します。

ReleaseDefinitionSource

列挙

リリース定義のソースを取得または設定します。

値	説明
ibiza	イビサから作成された ReleaseDefinition を示します。
portalExtensionApi	PortalExtension API から作成された ReleaseDefinition を示します。
restApi	REST API を使用して作成された ReleaseDefinition を示します。
undefined	ReleaseDefinition ソースが定義されていないことを示します。
userInterface	UI を使用して作成された ReleaseDefinition を示します。

ReleaseReason

列挙

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

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

ReleaseReference

Object

名前	型	説明
_links	ReferenceLinks	リリースにアクセスするためのリンクを取得します。
artifacts	Artifact[]	成果物の一覧を取得します。
createdBy	IdentityRef	リリースを作成した ID を取得します。
createdOn	string (date-time)	このリリースが作成された日付を取得します。
description	string	説明を取得します。
id	integer (int32)	リリースの ID。
modifiedBy	IdentityRef	リリースを変更した ID を取得します。
name	string	リリースの名前を取得します。
reason	ReleaseReason	リリースの理由を取得します。
releaseDefinition	ReleaseDefinitionShallowReference	リリース定義の浅い参照を取得します。

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 を取得します。

ReleaseTriggerBase

Object

名前	型	説明
triggerType	ReleaseTriggerType	リリーストリガーの種類。

ReleaseTriggerType

列挙

リリーストリガーの種類。

値	説明
artifactSource	成果物ベースのリリーストリガー。
containerImage	コンテナーイメージベースのリリーストリガー。
package	パッケージベースのリリーストリガー。
pullRequest	プル要求ベースのリリーストリガー。
schedule	スケジュールベースのリリーストリガー。
sourceRepo	ソースリポジトリベースのリリーストリガー。
undefined	リリーストリガーの種類が設定されていません。

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

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	タスクのバージョンを取得または設定します。

次の方法で共有

Definitions - Create

URI パラメーター

要求本文

応答

セキュリティ

oauth2

スコープ

例

Create release definition

要求のサンプル

応答のサンプル

定義

ApprovalExecutionOrder

ApprovalOptions

Artifact

ArtifactSourceReference

AuthorizationHeader

Condition

ConditionType

ConfigurationVariableValue

DataSourceBindingBase

Demand

DeployPhase

DeployPhaseTypes

EnvironmentExecutionPolicy

EnvironmentOptions

EnvironmentRetentionPolicy

EnvironmentTrigger

EnvironmentTriggerType

IdentityRef

ProcessParameters

ProjectReference

PropertiesCollection

ReferenceLinks

ReleaseDefinition

ReleaseDefinitionApprovals

ReleaseDefinitionApprovalStep

ReleaseDefinitionDeployStep

ReleaseDefinitionEnvironment

ReleaseDefinitionGate

ReleaseDefinitionGatesOptions

ReleaseDefinitionGatesStep

ReleaseDefinitionShallowReference

ReleaseDefinitionSource

ReleaseReason

ReleaseReference

ReleaseSchedule

ReleaseShallowReference

ReleaseTriggerBase

ReleaseTriggerType

ScheduleDays

TaskInputDefinitionBase

TaskInputValidation

TaskSourceDefinitionBase

WorkflowTask