次の方法で共有

Items - Get Data Pipeline Definition

サービス:
DataPipeline
API バージョン:
v1

指定したデータ パイプラインのパブリック定義を返します。
この API は、実行時間の長い操作 (LRO)をサポートします。

DataPipeline のパブリック定義を取得する場合、秘密度ラベルは定義の一部ではありません。

権限

呼び出し元には、データ パイプラインの 読み取りと書き込みの アクセス許可が必要です。

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

DataPipeline.ReadWrite.All または Item.ReadWrite.All

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

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

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

インターフェイス

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataPipelines/{dataPipelineId}/getDefinition
省略可能なパラメーターを含む: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataPipelines/{dataPipelineId}/getDefinition?format={format}

URI パラメーター

名前 / 必須 型 説明
dataPipelineId
 path True

string (uuid)

データ パイプライン ID。
workspaceId
 path True

string (uuid)

ワークスペース ID。
format
 query

string

データ パイプラインのパブリック定義の形式。

応答

名前 型 説明
200 OK

DataPipelineDefinitionResponse

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

要求は受け入れ済み。 定義の取得が進行中です。

ヘッダー

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

一般的なエラー コード:

  • OperationNotSupportedForItem - 要求された項目に対する操作はサポートされていません。

例

Get a data pipeline public definition example

要求のサンプル

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/dataPipelines/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

応答のサンプル

状態コード:
200 
{
  "definition": {
    "parts": [
      {
        "path": "pipeline-content.json",
        "payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgImFjdGl2aXRpZXMiOiBbXQogIH0KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
状態コード:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

定義

名前 説明
DataPipelineDefinition

データ パイプラインのパブリック定義オブジェクト。
DataPipelineDefinitionPart

データ パイプライン定義パーツ オブジェクト。
DataPipelineDefinitionResponse

データ パイプラインのパブリック定義応答。
ErrorRelatedResource

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

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
PayloadType

定義パーツペイロードの型。 追加のペイロードの種類は、時間の経過と同時に追加される場合があります。

DataPipelineDefinition

Object

データ パイプラインのパブリック定義オブジェクト。

名前 型 説明
format

string

項目定義の形式。
parts

DataPipelineDefinitionPart[]

定義パーツの一覧。

DataPipelineDefinitionPart

Object

データ パイプライン定義パーツ オブジェクト。

名前 型 説明
path

string

データ パイプライン パーツのパス。
payload

string

データ パイプライン パーツのペイロード。
payloadType

PayloadType

ペイロードの種類。

DataPipelineDefinitionResponse

Object

データ パイプラインのパブリック定義応答。

名前 型 説明
definition

DataPipelineDefinition

データ パイプラインのパブリック定義オブジェクト。

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

エラー関連のリソースの詳細。

PayloadType

列挙

定義パーツペイロードの型。 追加のペイロードの種類は、時間の経過と同時に追加される場合があります。

値 説明
InlineBase64

インライン ベース 64。