次の方法で共有

Items - Create Dataflow

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

指定したワークスペースにデータフローを作成します。
この API は、実行時間の長い操作 (LRO)をサポートします。

パブリック定義を使用してデータフローを作成するには、 データフロー に関する記事を参照してください。

権限

呼び出し元には 共同作成者 ワークスペース ロールが必要です。

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

Dataflow.ReadWrite.All または Item.ReadWrite.All

制限事項

  • データフローを作成するには、ワークスペースがサポートされている Fabric 容量上にある必要があります。 詳細については、「Microsoft Fabric ライセンスの種類を参照してください。

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

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

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

インターフェイス

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataflows

URI パラメーター

名前 / 必須 型 説明
workspaceId
 path True

string (uuid)

ワークスペース ID。

要求本文

名前 必須 型 説明
displayName True

string

データフローの表示名。 表示名は、項目の種類に応じて名前付け規則に従う必要があります。
definition

DataflowDefinition

データフローのパブリック定義。
description

string

データフローの説明。 最大長は 256 文字です。
folderId

string (uuid)

フォルダー ID。 指定しない場合、または null の場合、ワークスペースをフォルダーとして使用してデータフローが作成されます。
sensitivityLabelSettings

SensitivityLabelSettings

データフローの秘密度ラベルの設定。

応答

名前 型 説明
201 Created

Dataflow

正常に作成されました
202 Accepted

要求が受け入れ済み、データフローのプロビジョニングが進行中です。

ヘッダー

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

サービス レートの制限を超えました。 サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す Retry-After ヘッダーを返します。

ヘッダー

Retry-After: integer
Other Status Codes

ErrorResponse

一般的なエラー コード:

  • InvalidItemType - 項目の種類が無効です

  • ItemDisplayNameAlreadyInUse - 項目の表示名は既に使用されています。

  • CorruptedPayload - 指定されたペイロードが破損しています。

例

Create a Dataflow example
Create a Dataflow with public definition example

Create a Dataflow example

要求のサンプル

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/dataflows

{
  "displayName": "TestDataflow",
  "description": "A Dataflow description."
}

応答のサンプル

状態コード:
201 
{
  "displayName": "TestDataflow",
  "description": "A Dataflow description.",
  "type": "Dataflow",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}
状態コード:
202 
Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create a Dataflow with public definition example

要求のサンプル

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/dataflows

{
  "displayName": "TestDataflow",
  "description": "A Dataflow description.",
  "definition": {
    "parts": [
      {
        "path": "queryMetadata.json",
        "payload": "ewogICJmb3JtYXRWZXJzaW9uIjogIjIwMjUwMiIsCiAgImNvbXB1dGVFbmdpbmVTZXR0aW5ncyI6IHt9LAogICJuYW1lIjogIlRlc3REYXRhZmxvdyIsCiAgInF1ZXJ5R3JvdXBzIjogW10sCiAgImRvY3VtZW50TG9jYWxlIjogImVuLVVTIiwKICAicXVlcmllc01ldGFkYXRhIjogewogICAgInF1ZXJ5IjogewogICAgICAicXVlcnlJZCI6ICJiZTE3MjEwZi01YWNhLTQyMWEtOGMwYS1iZjYzMTQ4N2JiOGUiLAogICAgICAicXVlcnlOYW1lIjogIlF1ZXJ5IgogICAgfQogIH0sCiAgImNvbm5lY3Rpb25zIjogW10KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "mashup.pq",
        "payload": "W1N0YWdpbmdEZWZpbml0aW9uID0gW0tpbmQgPSAiRmFzdENvcHkiXV0Kc2VjdGlvbiBTZWN0aW9uMTsKc2hhcmVkIFF1ZXJ5ID0gbGV0CiAgU291cmNlID0gVGFibGUuRnJvbVJvd3MoSnNvbi5Eb2N1bWVudChCaW5hcnkuRGVjb21wcmVzcyhCaW5hcnkuRnJvbVRleHQoImk0NVdNbFRTVVhMT3p5bk56VE9LUjdDTmdleFluV2dsSXlSWkl5UlpJNlhZV0FBPSIsIEJpbmFyeUVuY29kaW5nLkJhc2U2NCksIENvbXByZXNzaW9uLkRlZmxhdGUpKSwgbGV0IF90ID0gKCh0eXBlIG51bGxhYmxlIHRleHQpIG1ldGEgW1NlcmlhbGl6ZWQuVGV4dCA9IHRydWVdKSBpbiB0eXBlIHRhYmxlIFtDb2x1bW4xID0gX3QsIENvbHVtbjIgPSBfdCwgQ29sdW1uMyA9IF90XSksCiAgIyJDaGFuZ2VkIGNvbHVtbiB0eXBlIiA9IFRhYmxlLlRyYW5zZm9ybUNvbHVtblR5cGVzKFNvdXJjZSwge3siQ29sdW1uMSIsIEludDY0LlR5cGV9LCB7IkNvbHVtbjIiLCB0eXBlIHRleHR9LCB7IkNvbHVtbjMiLCB0eXBlIHRleHR9fSkKaW4KICAjIkNoYW5nZWQgY29sdW1uIHR5cGUiOwo=",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIkRhdGFmbG93IiwKICAgICJkaXNwbGF5TmFtZSI6ICJUZXN0RGF0YWZsb3ciCiAgfSwKICAiY29uZmlnIjogewogICAgInZlcnNpb24iOiAiMi4wIiwKICAgICJsb2dpY2FsSWQiOiAiZjU4ZDJmODMtYTMwMC1iMTM1LTQ3ODgtMDU5NjgzY2Q1NzFjIgogIH0KfQ==",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

応答のサンプル

状態コード:
201 
{
  "displayName": "TestDataflow",
  "description": "A Dataflow description.",
  "type": "Dataflow",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}
状態コード:
202 
Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

定義

名前 説明
CreateDataflowRequest

データフロー要求ペイロードを作成します。
Dataflow

データフロー オブジェクト。
DataflowDefinition

データフロー パブリック定義オブジェクト。 データフロー定義の構造の詳細については、この 記事 を参照してください。
DataflowDefinitionPart

データフロー定義パーツ オブジェクト。
ErrorRelatedResource

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

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
ItemTag

アイテムに適用されるタグを表します。
ItemType

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

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

アイテムに適用される秘密度ラベルを表します。
SensitivityLabelApplyStrategy

秘密度ラベルを適用するための戦略。 既定値は ApplyOrFail です。 追加の型は、時間の経過と同時に追加される場合があります。
SensitivityLabelSettings

秘密度ラベルの設定。

CreateDataflowRequest

Object

データフロー要求ペイロードを作成します。

名前 型 説明
definition

DataflowDefinition

データフローのパブリック定義。
description

string

データフローの説明。 最大長は 256 文字です。
displayName

string

データフローの表示名。 表示名は、項目の種類に応じて名前付け規則に従う必要があります。
folderId

string (uuid)

フォルダー ID。 指定しない場合、または null の場合、ワークスペースをフォルダーとして使用してデータフローが作成されます。
sensitivityLabelSettings

SensitivityLabelSettings

データフローの秘密度ラベルの設定。

Dataflow

Object

データフロー オブジェクト。

名前 型 説明
description

string

アイテムの説明。
displayName

string

アイテムの表示名。
folderId

string (uuid)

フォルダー ID。
id

string (uuid)

アイテム ID。
sensitivityLabel

SensitivityLabel

項目の秘密度ラベル。
tags

ItemTag[]

適用されたタグの一覧。
type

ItemType

アイテムの種類。
workspaceId

string (uuid)

ワークスペース ID。

DataflowDefinition

Object

データフロー パブリック定義オブジェクト。 データフロー定義の構造の詳細については、この 記事 を参照してください。

名前 型 説明
parts

DataflowDefinitionPart[]

定義パーツの一覧。

DataflowDefinitionPart

Object

データフロー定義パーツ オブジェクト。

名前 型 説明
path

string

データフロー パブリック定義パーツのパス。
payload

string

Dataflow パブリック定義パーツのペイロード。
payloadType

PayloadType

ペイロードの種類。

ErrorRelatedResource

Object

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

名前 型 説明
resourceId

string

エラーに関係するリソース ID。
resourceType

string

エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

名前 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message

string

エラーの人間が判読できる表現。
moreDetails

ErrorResponseDetails[]

その他のエラーの詳細の一覧。
relatedResource

ErrorRelatedResource

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

string (uuid)

エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message

string

エラーの人間が判読できる表現。
relatedResource

ErrorRelatedResource

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

ItemTag

Object

アイテムに適用されるタグを表します。

名前 型 説明
displayName

string

タグの名前。
id

string (uuid)

タグ ID。

ItemType

列挙

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

値 説明
Dashboard

PowerBI ダッシュボード。
Report

PowerBI レポート。
SemanticModel

PowerBI セマンティック モデル。
PaginatedReport

PowerBI のページ分割されたレポート。
Datamart

PowerBI データマート。
Lakehouse

レイクハウス。
Eventhouse

イベントハウス。
Environment

環境。
KQLDatabase

KQL データベース。
KQLQueryset

KQL クエリセット。
KQLDashboard

KQL ダッシュボード。
DataPipeline

データ パイプライン。
Notebook

ノートブック。
SparkJobDefinition

Spark ジョブ定義。
MLExperiment

機械学習の実験。
MLModel

機械学習モデル。
Warehouse

倉庫。
Eventstream

イベントストリーム。
SQLEndpoint

SQL エンドポイント。
MirroredWarehouse

ミラー化された倉庫。
MirroredDatabase

ミラー化されたデータベース。
Reflex

反射。
GraphQLApi

GraphQL 項目の API。
MountedDataFactory

MountedDataFactory。
SQLDatabase

SQLDatabase。
CopyJob

コピー ジョブ。
VariableLibrary

VariableLibrary。
Dataflow

データフロー。
ApacheAirflowJob

ApacheAirflowJob。
WarehouseSnapshot

Warehouse スナップショット。
DigitalTwinBuilder

DigitalTwinBuilder。
DigitalTwinBuilderFlow

デジタル ツイン ビルダー フロー。
MirroredAzureDatabricksCatalog

ミラー化された Azure databricks カタログ。
Map

マップ。
AnomalyDetector

Anomaly Detector。
UserDataFunction

ユーザー データ関数。
GraphModel

GraphModel。
GraphQuerySet

Graph QuerySet。
SnowflakeDatabase

Snowflake アカウントから作成された Iceberg テーブルを格納する Snowflake データベース。
OperationsAgent

OperationsAgent。
CosmosDBDatabase

Cosmos DB データベース。
Ontology

オントロジ。
EventSchemaSet

EventSchemaSet。
DataAgent

DataAgent。

PayloadType

列挙

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

値 説明
InlineBase64

インライン ベース 64。

SensitivityLabel

Object

アイテムに適用される秘密度ラベルを表します。

名前 型 説明
id

string (uuid)

秘密度ラベル ID。

SensitivityLabelApplyStrategy

列挙

秘密度ラベルを適用するための戦略。 既定値は ApplyOrFail です。 追加の型は、時間の経過と同時に追加される場合があります。

値 説明
ApplyOrFail

秘密度ラベルを適用するか、適用できない場合は操作を失敗します。
Ignore

秘密度ラベルを適用できない場合は無視し、ラベルを適用せずに操作を続行します。

SensitivityLabelSettings

Object

秘密度ラベルの設定。

名前 型 説明
labelId

string (uuid)

秘密度ラベル ID。
sensitivityLabelApplyStrategy

SensitivityLabelApplyStrategy

秘密度ラベルを適用するための戦略。