Deployment Pipelines - List Deployment Pipeline Operations
指定したデプロイ パイプラインで実行された up-to-20 の最新のデプロイ操作の一覧を返します。
権限
呼び出し元には 、管理者 デプロイ パイプライン ロールが必要です。
必要な委任されたスコープ
Pipeline.Read.All または Pipeline.ReadWrite.All
Microsoft Entra でサポートされている ID
この API では、このセクションに記載されている Microsoft ID がサポートされています。
アイデンティティ | 支援 |
---|---|
ユーザー | イエス |
サービス プリンシパルとマネージド ID | イエス |
インターフェイス
GET https://api.fabric.microsoft.com/v1/deploymentPipelines/{deploymentPipelineId}/operations
GET https://api.fabric.microsoft.com/v1/deploymentPipelines/{deploymentPipelineId}/operations?continuationToken={continuationToken}
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
deployment
|
path | True |
string (uuid) |
デプロイ パイプライン ID。 |
continuation
|
query |
string |
結果の次のページを取得するためのトークン。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
要求は正常に完了しました。 |
|
Other Status Codes |
一般的なエラー コード:
|
例
List deployment pipeline operations example |
List deployment pipeline operations with continuation example |
List deployment pipeline operations example
要求のサンプル
GET https://api.fabric.microsoft.com/v1/deploymentPipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/operations
応答のサンプル
{
"value": [
{
"id": "1065e6a3-a020-4c0c-ada7-92b5fe99eec5",
"type": "Deploy",
"status": "Succeeded",
"lastUpdatedTime": "2020-12-13T09:26:43.153",
"executionStartTime": "2020-12-13T09:25:43.153Z",
"executionEndTime": "2020-12-13T09:26:43.153Z",
"sourceStageId": "2e6f0272-e809-410a-be63-50e1d97ba75a",
"targetStageId": "d2056166-041c-4a56-8d37-ea90038bc0d6",
"note": {
"content": "Sample note"
},
"preDeploymentDiffInformation": {
"newItemsCount": 0,
"differentItemsCount": 0,
"noDifferenceItemsCount": 1
},
"performedBy": {
"id": "a35d842b-90d5-59a2-c56a-5f8fcff0bf9d",
"type": "User"
}
},
{
"id": "7e113010-3264-41e4-93c1-1dfb34a93d06",
"type": "Deploy",
"status": "Failed",
"lastUpdatedTime": "2020-12-14T09:26:43.153",
"executionStartTime": "2020-12-14T09:25:43.153Z",
"executionEndTime": "2020-12-13T09:26:43.153Z",
"sourceStageId": "2e6f0272-e809-410a-be63-50e1d97ba75a",
"targetStageId": "d2056166-041c-4a56-8d37-ea90038bc0d6",
"note": {
"content": "Lorem ipsum odor amet, consectetuer adipiscing elit. Himenaeos litora volutpat sem eget ipsum sollicitudin ad porta ligula tristique sapien suscipit magnis pulvinar placerat in vulputate aliquam mauris aptent velit phasellus netus fringilla ad taciti in himenaeos eu vitae feugiat et auctor class maximus urna integer erat amet efficitur ex tellus conubia lorem nam viverra cras magnis potenti pharetra natoque suscipit scelerisque eros adipiscing mollis sagittis habitasse ligula nullam rhoncus at scelerisque justo dolor pretium libero urna massa tristique diam viverra aenean mauris malesuada mus sed ultrices consectetur tristique pretium imperdiet vulputate ligula senectus pretium aenean inceptos id cras magna ut nisl etiam eget magna nibh feugiat duis imperdiet ut ornare arcu primis curae taciti purus quisque turpis lacus auctor ligula tristique placerat consectetur mus vitae penatibus varius proin ligula viverra diam neque at tortor porttitor urna ullamcorper ut nec lobortis porta urna egestas eu cursus ante ",
"isTruncated": true
},
"preDeploymentDiffInformation": {
"newItemsCount": 1,
"differentItemsCount": 0,
"noDifferenceItemsCount": 0
},
"performedBy": {
"id": "a35d842b-90d5-59a2-c56a-5f8fcff0bf9d",
"type": "User"
}
}
]
}
List deployment pipeline operations with continuation example
要求のサンプル
GET https://api.fabric.microsoft.com/v1/deploymentPipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/operations
応答のサンプル
{
"value": [
{
"id": "1065e6a3-a020-4c0c-ada7-92b5fe99eec5",
"type": "Deploy",
"status": "Succeeded",
"lastUpdatedTime": "2020-12-13T09:26:43.153",
"executionStartTime": "2020-12-13T09:25:43.153Z",
"executionEndTime": "2020-12-13T09:26:43.153Z",
"sourceStageId": "2e6f0272-e809-410a-be63-50e1d97ba75a",
"targetStageId": "d2056166-041c-4a56-8d37-ea90038bc0d6",
"note": {
"content": "Sample note"
},
"preDeploymentDiffInformation": {
"newItemsCount": 0,
"differentItemsCount": 0,
"noDifferenceItemsCount": 1
},
"performedBy": {
"id": "a35d842b-90d5-59a2-c56a-5f8fcff0bf9d",
"type": "User"
}
},
{
"id": "7e113010-3264-41e4-93c1-1dfb34a93d06",
"type": "Deploy",
"status": "Failed",
"lastUpdatedTime": "2020-12-14T09:26:43.153",
"executionStartTime": "2020-12-14T09:25:43.153Z",
"executionEndTime": "2020-12-13T09:26:43.153Z",
"sourceStageId": "2e6f0272-e809-410a-be63-50e1d97ba75a",
"targetStageId": "d2056166-041c-4a56-8d37-ea90038bc0d6",
"note": {
"content": "Lorem ipsum odor amet, consectetuer adipiscing elit. Himenaeos litora volutpat sem eget ipsum sollicitudin ad porta ligula tristique sapien suscipit magnis pulvinar placerat in vulputate aliquam mauris aptent velit phasellus netus fringilla ad taciti in himenaeos eu vitae feugiat et auctor class maximus urna integer erat amet efficitur ex tellus conubia lorem nam viverra cras magnis potenti pharetra natoque suscipit scelerisque eros adipiscing mollis sagittis habitasse ligula nullam rhoncus at scelerisque justo dolor pretium libero urna massa tristique diam viverra aenean mauris malesuada mus sed ultrices consectetur tristique pretium imperdiet vulputate ligula senectus pretium aenean inceptos id cras magna ut nisl etiam eget magna nibh feugiat duis imperdiet ut ornare arcu primis curae taciti purus quisque turpis lacus auctor ligula tristique placerat consectetur mus vitae penatibus varius proin ligula viverra diam neque at tortor porttitor urna ullamcorper ut nec lobortis porta urna egestas eu cursus ante ",
"isTruncated": true
},
"preDeploymentDiffInformation": {
"newItemsCount": 1,
"differentItemsCount": 0,
"noDifferenceItemsCount": 0
},
"performedBy": {
"id": "a35d842b-90d5-59a2-c56a-5f8fcff0bf9d",
"type": "User"
}
}
],
"continuationToken": "LDEsMTAwMDAwLDA%3D",
"continuationUri": "https://api.fabric.microsoft.com/v1/deploymentPipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/operations?continuationToken=LDEsMTAwMDAwLDA%3D"
}
定義
名前 | 説明 |
---|---|
Deployment |
ファブリック デプロイ パイプライン操作。 |
Deployment |
デプロイを説明するメモ。 |
Deployment |
Fabric デプロイ パイプライン操作のコレクション。 |
Deployment |
デプロイ パイプライン操作の状態。 追加の状態は、時間の経過と同時に追加される場合があります。 |
Deployment |
操作の種類。 追加の型は、時間の経過と同時に追加される場合があります。 |
Error |
エラー関連のリソース詳細オブジェクト。 |
Error |
エラー応答。 |
Error |
エラー応答の詳細。 |
Group |
グループ固有の詳細。 プリンシパルの種類が |
Group |
グループの種類。 グループの種類は、時間の経過と同時に追加される場合があります。 |
Pre |
デプロイ前の新しい、異なる、同一のデプロイ済みアイテムの数。 |
Principal |
ID または Microsoft Entra グループを表します。 |
Principal |
プリンシパルの型。 プリンシパルの種類は、時間の経過と同時に追加される場合があります。 |
Service |
サービス プリンシパル固有の詳細。 プリンシパルの種類が |
Service |
サービス プリンシパル プロファイルの詳細。 プリンシパルの種類が |
User |
ユーザー プリンシパル固有の詳細。 プリンシパルの種類が |
DeploymentPipelineOperation
ファブリック デプロイ パイプライン操作。
名前 | 型 | 説明 |
---|---|---|
executionEndTime |
string (date-time) |
操作が終了した日付と時刻。 |
executionStartTime |
string (date-time) |
操作が開始された日付と時刻。 |
id |
string (uuid) |
操作 ID。 |
lastUpdatedTime |
string (date-time) |
操作が最後に更新された日時。 |
note |
操作の説明を表すメモ。 |
|
performedBy |
デプロイ パイプライン操作を実行したプリンシパル。 |
|
preDeploymentDiffInformation |
デプロイ前のソース ステージ内のデプロイ済み項目の数。ターゲット ステージの項目と同じか、または異なります。 |
|
sourceStageId |
string (uuid) |
ソース デプロイ パイプライン ステージの ID。 |
status |
デプロイ パイプライン操作の状態。 追加の状態は、時間の経過と同時に追加される場合があります。 |
|
targetStageId |
string (uuid) |
ターゲット デプロイ パイプライン ステージの ID。 |
type |
操作の種類。 追加の型は、時間の経過と同時に追加される場合があります。 |
DeploymentPipelineOperationNote
デプロイを説明するメモ。
名前 | 型 | 説明 |
---|---|---|
content |
string |
デプロイを説明するテキスト。 |
isTruncated |
boolean |
メモの内容が切り捨てられているかどうかを示します。 True - ノートコンテンツが切り捨てられ、False - ノートコンテンツが切り捨てられません。 既定値は false です。 |
DeploymentPipelineOperations
Fabric デプロイ パイプライン操作のコレクション。
名前 | 型 | 説明 |
---|---|---|
continuationToken |
string |
次の結果セット バッチのトークン。 これ以上レコードがない場合は、応答から削除されます。 |
continuationUri |
string |
次の結果セット バッチの URI。 これ以上レコードがない場合は、応答から削除されます。 |
value |
デプロイ パイプライン操作のコレクション。 |
DeploymentPipelineOperationStatus
デプロイ パイプライン操作の状態。 追加の状態は、時間の経過と同時に追加される場合があります。
値 | 説明 |
---|---|
Failed |
操作に失敗しました |
NotStarted |
操作が開始されていません |
Running |
実行中の操作 |
Succeeded |
操作に成功しました |
DeploymentPipelineOperationType
操作の種類。 追加の型は、時間の経過と同時に追加される場合があります。
値 | 説明 |
---|---|
Deploy |
ステージ間でコンテンツを展開する。 |
ErrorRelatedResource
エラー関連のリソース詳細オブジェクト。
名前 | 型 | 説明 |
---|---|---|
resourceId |
string |
エラーに関係するリソース ID。 |
resourceType |
string |
エラーに関係するリソースの種類。 |
ErrorResponse
エラー応答。
名前 | 型 | 説明 |
---|---|---|
errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
message |
string |
エラーの人間が判読できる表現。 |
moreDetails |
その他のエラーの詳細の一覧。 |
|
relatedResource |
エラー関連のリソースの詳細。 |
|
requestId |
string |
エラーに関連付けられている要求の ID。 |
ErrorResponseDetails
エラー応答の詳細。
名前 | 型 | 説明 |
---|---|---|
errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
message |
string |
エラーの人間が判読できる表現。 |
relatedResource |
エラー関連のリソースの詳細。 |
GroupDetails
グループ固有の詳細。 プリンシパルの種類が Group
場合に適用されます。
名前 | 型 | 説明 |
---|---|---|
groupType |
グループの種類。 グループの種類は、時間の経過と同時に追加される場合があります。 |
GroupType
グループの種類。 グループの種類は、時間の経過と同時に追加される場合があります。
値 | 説明 |
---|---|
DistributionList |
プリンシパルは配布リストです。 |
SecurityGroup |
プリンシパルはセキュリティ グループです。 |
Unknown |
プリンシパル グループの種類が不明です。 |
PreDeploymentDiffInformation
デプロイ前の新しい、異なる、同一のデプロイ済みアイテムの数。
名前 | 型 | 説明 |
---|---|---|
differentItemsCount |
integer |
デプロイ前の、ソースステージとターゲットステージの違いを持つデプロイ済みアイテムの数。 |
newItemsCount |
integer |
ターゲット ステージにデプロイされた新しい項目の数。 |
noDifferenceItemsCount |
integer |
デプロイ前のソース ステージとターゲット ステージでデプロイされた同じ項目の数。 |
Principal
ID または Microsoft Entra グループを表します。
名前 | 型 | 説明 |
---|---|---|
displayName |
string |
プリンシパルの表示名。 |
groupDetails |
グループ固有の詳細。 プリンシパルの種類が |
|
id |
string (uuid) |
プリンシパルの ID。 |
servicePrincipalDetails |
サービス プリンシパル固有の詳細。 プリンシパルの種類が |
|
servicePrincipalProfileDetails |
サービス プリンシパル プロファイルの詳細。 プリンシパルの種類が |
|
type |
プリンシパルの型。 プリンシパルの種類は、時間の経過と同時に追加される場合があります。 |
|
userDetails |
ユーザー プリンシパル固有の詳細。 プリンシパルの種類が |
PrincipalType
プリンシパルの型。 プリンシパルの種類は、時間の経過と同時に追加される場合があります。
値 | 説明 |
---|---|
Group |
プリンシパルはセキュリティ グループです。 |
ServicePrincipal |
プリンシパルは Microsoft Entra サービス プリンシパルです。 |
ServicePrincipalProfile |
プリンシパルはサービス プリンシパル プロファイルです。 |
User |
プリンシパルは Microsoft Entra ユーザー プリンシパルです。 |
ServicePrincipalDetails
サービス プリンシパル固有の詳細。 プリンシパルの種類が ServicePrincipal
場合に適用されます。
名前 | 型 | 説明 |
---|---|---|
aadAppId |
string (uuid) |
サービス プリンシパルの Microsoft Entra AppId。 |
ServicePrincipalProfileDetails
サービス プリンシパル プロファイルの詳細。 プリンシパルの種類が ServicePrincipalProfile
場合に適用されます。
名前 | 型 | 説明 |
---|---|---|
parentPrincipal |
サービス プリンシパル プロファイルの親プリンシパル。 |
UserDetails
ユーザー プリンシパル固有の詳細。 プリンシパルの種類が User
場合に適用されます。
名前 | 型 | 説明 |
---|---|---|
userPrincipalName |
string |
ユーザー プリンシパル名。 |