Deployment Pipelines - Get Deployment Pipeline Operation

リファレンス

サービス:: Core

API バージョン:: v1

デプロイ実行プランを含め、指定したデプロイパイプラインで実行された指定されたデプロイ操作の詳細を返します。

権限

呼び出し元には 、管理者 デプロイパイプラインロールが必要です。

必要な委任されたスコープ

Pipeline.Read.All または Pipeline.ReadWrite.All

Microsoft Entra でサポートされている ID

この API では、このセクションに記載されている Microsoft ID がサポートされています。

アイデンティティ	支援
ユーザー	イエス
サービスプリンシパルとマネージド ID	イエス

インターフェイス

GET https://api.fabric.microsoft.com/v1/deploymentPipelines/{deploymentPipelineId}/operations/{operationId}

URI パラメーター

名前	/	必須	型	説明
deploymentPipelineId	path	True	string (uuid)	デプロイパイプライン ID。
operationId	path	True	string (uuid)	操作 ID。

応答

名前	型	説明
200 OK	DeploymentPipelineOperationExtendedInfo	要求は正常に完了しました。
Other Status Codes	ErrorResponse	一般的なエラーコード: UnknownError - エラーが発生しました

名前

型

説明

200 OK

DeploymentPipelineOperationExtendedInfo

要求は正常に完了しました。

Other Status Codes

ErrorResponse

一般的なエラーコード:

UnknownError - エラーが発生しました

例

Get a deployment pipeline operation example

要求のサンプル

HTTP

GET https://api.fabric.microsoft.com/v1/deploymentPipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/operations/1065e6a3-a020-4c0c-ada7-92b5fe99eec5

応答のサンプル

状態コード:: 200

{
  "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",
  "executionPlan": {
    "steps": [
      {
        "index": 0,
        "description": "DataflowDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "New",
        "sourceAndTarget": {
          "sourceItemId": "29efcfb0-0063-44af-a4ed-6c0bee3417d3",
          "sourceItemDisplayName": "Source dataflow",
          "itemType": "Dataflow"
        }
      },
      {
        "index": 1,
        "description": "DatamartDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "New",
        "sourceAndTarget": {
          "sourceItemId": "645cd81f-1b21-4006-82b6-54cc7ec0352e",
          "sourceItemDisplayName": "Source datamart",
          "itemType": "Datamart"
        }
      },
      {
        "index": 2,
        "description": "DatasetDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "NoDifference",
        "sourceAndTarget": {
          "sourceItemId": "1a201f2a-d1d8-45c0-8c61-1676338517de",
          "sourceItemDisplayName": "Source dataset",
          "targetItemId": "dd3b6aa1-4d40-405c-a19b-48314a27e8ee",
          "targetItemDisplayName": "Target dataset",
          "itemType": "SemanticModel"
        }
      },
      {
        "index": 3,
        "description": "ReportDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "Different",
        "sourceAndTarget": {
          "sourceItemId": "2d225191-65f8-4ec3-b77d-06100602b1f7",
          "sourceItemDisplayName": "Source report",
          "targetItemId": "9d5c1f0f-f85c-48f4-8a8e-4c77547116b3",
          "targetItemDisplayName": "Target report",
          "itemType": "Report"
        }
      },
      {
        "index": 4,
        "description": "DashboardDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "New",
        "sourceAndTarget": {
          "sourceItemId": "9046e4cc-8aea-4a7a-a3b5-1a78b1447d82",
          "sourceItemDisplayName": "Source dashboard",
          "itemType": "Dashboard"
        }
      }
    ]
  },
  "note": {
    "content": "Sample note"
  },
  "preDeploymentDiffInformation": {
    "newItemsCount": 3,
    "differentItemsCount": 1,
    "noDifferenceItemsCount": 1
  },
  "performedBy": {
    "id": "a35d842b-90d5-59a2-c56a-5f8fcff0bf9d",
    "type": "User"
  }
}

定義

名前	説明
DeploymentExecutionPlan	デプロイ実行プラン。
DeploymentExecutionStep	デプロイ実行ステップ。
DeploymentPipelineOperationExtendedInfo	ファブリックデプロイパイプライン操作。
DeploymentPipelineOperationNote	デプロイを説明するメモ。
DeploymentPipelineOperationStatus	デプロイパイプライン操作の状態。追加の状態は、時間の経過と同時に追加される場合があります。
DeploymentPipelineOperationType	操作の種類。追加の型は、時間の経過と同時に追加される場合があります。
DeploymentSourceAndTarget	ソースアイテムとターゲットアイテム。
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
GroupDetails	グループ固有の詳細。プリンシパルの種類が `Group`場合に適用されます。
GroupType	グループの種類。グループの種類は、時間の経過と同時に追加される場合があります。
ItemPreDeploymentDiffState	デプロイ前に、項目が新しいか、ターゲットステージの項目と異なるか、同じかどうかを指定します。追加の状態は、時間の経過と同時に追加される場合があります。
ItemType	アイテムの種類。追加の項目の種類は、時間の経過と同時に追加される場合があります。
PreDeploymentDiffInformation	デプロイ前の新しい、異なる、同一のデプロイ済みアイテムの数。
Principal	ID または Microsoft Entra グループを表します。
PrincipalType	プリンシパルの型。プリンシパルの種類は、時間の経過と同時に追加される場合があります。
ServicePrincipalDetails	サービスプリンシパル固有の詳細。プリンシパルの種類が `ServicePrincipal`場合に適用されます。
ServicePrincipalProfileDetails	サービスプリンシパルプロファイルの詳細。プリンシパルの種類が `ServicePrincipalProfile`場合に適用されます。
UserDetails	ユーザープリンシパル固有の詳細。プリンシパルの種類が `User`場合に適用されます。

DeploymentExecutionPlan

Object

デプロイ実行プラン。

名前	型	説明
steps	DeploymentExecutionStep[]	実行プランステップのコレクション。

DeploymentExecutionStep

Object

デプロイ実行ステップ。

名前	型	説明
description	string	デプロイ手順の説明。
error	ErrorResponse	エラーの詳細。デプロイパイプライン操作が失敗した場合にのみ適用されます。
index	integer	ステップインデックス。
preDeploymentDiffState	ItemPreDeploymentDiffState	デプロイ前のターゲットステージの項目とは異なる、または同一の新しい項目です。
sourceAndTarget	DeploymentSourceAndTarget	ステップのソース項目とターゲット項目。
status	DeploymentPipelineOperationStatus	デプロイパイプライン操作の状態。追加の状態は、時間の経過と同時に追加される場合があります。

DeploymentPipelineOperationExtendedInfo

Object

ファブリックデプロイパイプライン操作。

名前	型	説明
executionEndTime	string (date-time)	操作が終了した日付と時刻。
executionPlan	DeploymentExecutionPlan	デプロイ実行プラン。
executionStartTime	string (date-time)	操作が開始された日付と時刻。
id	string (uuid)	操作 ID。
lastUpdatedTime	string (date-time)	操作が最後に更新された日時。
note	DeploymentPipelineOperationNote	操作の説明を表すメモ。
performedBy	Principal	デプロイパイプライン操作を実行したプリンシパル。
preDeploymentDiffInformation	PreDeploymentDiffInformation	デプロイ前のソースステージ内のデプロイ済み項目の数。ターゲットステージの項目と同じか、または異なります。
sourceStageId	string (uuid)	ソースデプロイパイプラインステージの ID。
status	DeploymentPipelineOperationStatus	デプロイパイプライン操作の状態。追加の状態は、時間の経過と同時に追加される場合があります。
targetStageId	string (uuid)	ターゲットデプロイパイプラインステージの ID。
type	DeploymentPipelineOperationType	操作の種類。追加の型は、時間の経過と同時に追加される場合があります。

DeploymentPipelineOperationNote

Object

デプロイを説明するメモ。

名前	型	説明
content	string	デプロイを説明するテキスト。
isTruncated	boolean	メモの内容が切り捨てられているかどうかを示します。 True - ノートコンテンツが切り捨てられ、False - ノートコンテンツが切り捨てられません。既定値は false です。

DeploymentPipelineOperationStatus

列挙

デプロイパイプライン操作の状態。追加の状態は、時間の経過と同時に追加される場合があります。

値	説明
Failed	操作に失敗しました
NotStarted	操作が開始されていません
Running	実行中の操作
Succeeded	操作に成功しました

DeploymentPipelineOperationType

列挙

操作の種類。追加の型は、時間の経過と同時に追加される場合があります。

値	説明
Deploy	ステージ間でコンテンツを展開する。

DeploymentSourceAndTarget

Object

ソースアイテムとターゲットアイテム。

名前	型	説明
itemType	ItemType	ターゲットステージで上書きされる Fabric 項目の種類。 Fabric アイテムを上書きする場合にのみ適用されます。
sourceItemDisplayName	string	ソースステージからデプロイされた Fabric 項目の表示名。
sourceItemId	string (uuid)	ソースステージからデプロイされる Fabric 項目の ID。
targetItemDisplayName	string	ターゲットステージで上書きされるファブリック項目の名前。 Fabric アイテムを上書きする場合にのみ適用されます。
targetItemId	string (uuid)	ターゲットステージで上書きされる Fabric 項目の ID。 Fabric アイテムを上書きする場合にのみ適用されます。

ErrorRelatedResource

Object

エラー関連のリソース詳細オブジェクト。

名前	型	説明
resourceId	string	エラーに関係するリソース ID。
resourceType	string	エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が判読できる表現。
moreDetails	ErrorResponseDetails[]	その他のエラーの詳細の一覧。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。
requestId	string	エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が判読できる表現。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。

GroupDetails

Object

グループ固有の詳細。プリンシパルの種類が Group場合に適用されます。

名前	型	説明
groupType	GroupType	グループの種類。グループの種類は、時間の経過と同時に追加される場合があります。

GroupType

列挙

グループの種類。グループの種類は、時間の経過と同時に追加される場合があります。

値	説明
DistributionList	プリンシパルは配布リストです。
SecurityGroup	プリンシパルはセキュリティグループです。
Unknown	プリンシパルグループの種類が不明です。

ItemPreDeploymentDiffState

列挙

デプロイ前に、項目が新しいか、ターゲットステージの項目と異なるか、同じかどうかを指定します。追加の状態は、時間の経過と同時に追加される場合があります。

値	説明
Different	デプロイ前は、ソースステージの項目がターゲットステージの項目と同じではありませんでした。
New	ターゲットステージに存在しない新しいデプロイ済みアイテム。
NoDifference	デプロイ前のソースステージの項目は、ターゲットステージの項目と同じでした。

ItemType

列挙

アイテムの種類。追加の項目の種類は、時間の経過と同時に追加される場合があります。

値	説明
ApacheAirflowJob	ApacheAirflowJob。
CopyJob	コピージョブ。
Dashboard	PowerBI ダッシュボード。
DataPipeline	データパイプライン。
Dataflow	データフロー。
Datamart	PowerBI データマート。
DigitalTwinBuilder	DigitalTwinBuilder。
DigitalTwinBuilderFlow	デジタルツインビルダーフロー。
Environment	環境。
Eventhouse	イベントハウス。
Eventstream	イベントストリーム。
GraphQLApi	GraphQL 項目の API。
KQLDashboard	KQL ダッシュボード。
KQLDatabase	KQL データベース。
KQLQueryset	KQL クエリセット。
Lakehouse	レイクハウス。
MLExperiment	機械学習の実験。
MLModel	機械学習モデル。
MirroredAzureDatabricksCatalog	ミラー化された Azure databricks カタログ。
MirroredDatabase	ミラー化されたデータベース。
MirroredWarehouse	ミラー化された倉庫。
MountedDataFactory	MountedDataFactory。
Notebook	ノートブック。
PaginatedReport	PowerBI のページ分割されたレポート。
Reflex	反射。
Report	PowerBI レポート。
SQLDatabase	SQLDatabase。
SQLEndpoint	SQL エンドポイント。
SemanticModel	PowerBI セマンティックモデル。
SparkJobDefinition	Spark ジョブ定義。
VariableLibrary	VariableLibrary。
Warehouse	倉庫。
WarehouseSnapshot	Warehouse スナップショット。

PreDeploymentDiffInformation

Object

デプロイ前の新しい、異なる、同一のデプロイ済みアイテムの数。

名前	型	説明
differentItemsCount	integer	デプロイ前の、ソースステージとターゲットステージの違いを持つデプロイ済みアイテムの数。
newItemsCount	integer	ターゲットステージにデプロイされた新しい項目の数。
noDifferenceItemsCount	integer	デプロイ前のソースステージとターゲットステージでデプロイされた同じ項目の数。

Principal

Object

ID または Microsoft Entra グループを表します。

名前	型	説明
displayName	string	プリンシパルの表示名。
groupDetails	GroupDetails	グループ固有の詳細。プリンシパルの種類が `Group`場合に適用されます。
id	string (uuid)	プリンシパルの ID。
servicePrincipalDetails	ServicePrincipalDetails	サービスプリンシパル固有の詳細。プリンシパルの種類が `ServicePrincipal`場合に適用されます。
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	サービスプリンシパルプロファイルの詳細。プリンシパルの種類が `ServicePrincipalProfile`場合に適用されます。
type	PrincipalType	プリンシパルの型。プリンシパルの種類は、時間の経過と同時に追加される場合があります。
userDetails	UserDetails	ユーザープリンシパル固有の詳細。プリンシパルの種類が `User`場合に適用されます。

PrincipalType

列挙

プリンシパルの型。プリンシパルの種類は、時間の経過と同時に追加される場合があります。

値	説明
Group	プリンシパルはセキュリティグループです。
ServicePrincipal	プリンシパルは Microsoft Entra サービスプリンシパルです。
ServicePrincipalProfile	プリンシパルはサービスプリンシパルプロファイルです。
User	プリンシパルは Microsoft Entra ユーザープリンシパルです。

ServicePrincipalDetails

Object

サービスプリンシパル固有の詳細。プリンシパルの種類が ServicePrincipal場合に適用されます。

名前	型	説明
aadAppId	string (uuid)	サービスプリンシパルの Microsoft Entra AppId。

ServicePrincipalProfileDetails

Object

サービスプリンシパルプロファイルの詳細。プリンシパルの種類が ServicePrincipalProfile場合に適用されます。

名前	型	説明
parentPrincipal	Principal	サービスプリンシパルプロファイルの親プリンシパル。

UserDetails

Object

ユーザープリンシパル固有の詳細。プリンシパルの種類が User場合に適用されます。

名前	型	説明
userPrincipalName	string	ユーザープリンシパル名。

次の方法で共有

Deployment Pipelines - Get Deployment Pipeline Operation

権限

必要な委任されたスコープ

Microsoft Entra でサポートされている ID

インターフェイス

URI パラメーター

応答

例

Get a deployment pipeline operation example

要求のサンプル

応答のサンプル

定義

DeploymentExecutionPlan

DeploymentExecutionStep

DeploymentPipelineOperationExtendedInfo

DeploymentPipelineOperationNote

DeploymentPipelineOperationStatus

DeploymentPipelineOperationType

DeploymentSourceAndTarget

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

ItemPreDeploymentDiffState

ItemType

PreDeploymentDiffInformation

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails