Dataflows - Save Dataflow Gen One As Dataflow Gen Two

サービス:: Power BI REST APIs

API バージョン:: v1.0

データフロー Gen1 をデータフロー Gen2 (CI/CD) として保存する (プレビュー)
Gen1 データフローを Fabric ネイティブ成果物 (Gen2 CI/CD) に変換します。

主な特徴:

元の Gen1 データフローを保持しながら、新しい Gen2 (CI/CD) アーティファクトを作成します
必要に応じて更新スケジュールを移行します
ファブリックと互換性のある形式に接続形式を更新します
秘密度ラベルとセキュリティ設定を保持します
致命的でない問題の詳細なエラー報告を提供します
新しい成果物のターゲットワークスペースの指定をサポートします

前提条件:

ソースデータフローは第 1 世代である必要があります
ユーザーはワークスペースに対する適切なアクセス許可を持っている必要があります

移行プロセス:

ソースデータフローとアクセス許可を検証します
データフロー定義を Fabric 形式に変換します
Fabric の互換性のために接続文字列を更新します
指定したワークスペースに新しい Gen2 成果物を作成します
必要に応じて更新スケジュールを移行する

エラー処理: API は、一部の重要でない操作が失敗した場合 (移行のスケジュールなど) でも成功を返します。このようなエラーは、応答の errors 配列で報告されます。

Preview

これはプレビュー API 呼び出しです。

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dataflows/{gen1DataflowId}/saveAsNativeArtifact

URI パラメーター

名前	/	必須	型	説明
gen1DataflowId	path	True	string (uuid)	ネイティブ成果物として保存する Gen1 データフローのオブジェクト ID
groupId	path	True	string (uuid)	gen1 データフローのワークスペース (グループ) ID

要求本文

名前	型	説明
description	string maxLength: 4000	新しい成果物の説明 (省略可能)。指定されていない場合、または空の場合は、ソースデータフローの説明がコピーされます。最大長: 4,000 文字
displayName	string maxLength: 200	新しい成果物のオプションの表示名。指定されていない場合、または空の場合、名前の競合を回避するために、"_copy1"、"_copy2" などのサフィックスを持つソースデータフロー名に基づいて名前が生成されます。最大長: 200 文字
includeSchedule	boolean	移行にソースデータフローからの更新スケジュールを含めるかどうか。 true の場合、既存のスケジュールを無効状態の新しい成果物にコピーしようとします。 false の場合、新しい成果物はスケジュールなしで作成されます。
targetWorkspaceId	string (uuid)	新しい成果物が作成されるオプションのターゲットワークスペース ID。指定されていない場合、または空の場合、新しい成果物はソースデータフローと同じワークスペースに作成されます。

応答

名前	型	説明
200 OK	SaveAsNativeDataflowResponse	[OK]

例

Example

要求のサンプル

POST https://api.powerbi.com/v1.0/myorg/groups/51e47fc5-48fd-4826-89f0-021bd3a80abd/dataflows/928228ba-008d-4fd9-864a-92d2752ee5ce/saveAsNativeArtifact

要求本文

{
  "displayName": "newDataflowName",
  "description": "New dataflow description",
  "includeSchedule": "true",
  "targetWorkspaceId": "d4c3b4a1-2f5e-4c3a-9f7e-123456789abc"
}

応答のサンプル

状態コード:: 200

状態コード:: 400

定義

名前	説明
ArtifactMetadata	Fabric 成果物のメタデータ情報
ArtifactMetadataUser	アーティファクトメタデータ内のユーザー情報
ArtifactProvisionState	成果物の現在のプロビジョニング状態
SaveAsNativeDataflowErrorCode	移行中に発生する可能性がある致命的でない警告コード。これらは、全体的な操作の成功を妨げるような部分的なエラーを示します。
SaveAsNativeDataflowRequest	Gen1 データフローを Gen2 (CI/CD) ネイティブ成果物に移行するための要求本文
SaveAsNativeDataflowResponse	データフロー移行操作からの応答

ArtifactMetadata

Object

Fabric 成果物のメタデータ情報

名前	型	説明
artifactType	string	成果物の種類
capacityObjectId	string (uuid)	この成果物をホストしている容量の ID
createdByUser	ArtifactMetadataUser	アーティファクトメタデータ内のユーザー情報
createdDate	string (date-time)	成果物が作成されたとき
description	string	成果物の説明
displayName	string	成果物の表示名
folderObjectId	string (uuid)	この成果物を含むワークスペース/フォルダーの ID
lastUpdatedDate	string (date-time)	成果物が最後に更新されたとき
modifiedByUser	ArtifactMetadataUser	アーティファクトメタデータ内のユーザー情報
objectId	string (uuid)	成果物の一意識別子
ownerUser	ArtifactMetadataUser	アーティファクトメタデータ内のユーザー情報
provisionState	ArtifactProvisionState	成果物の現在のプロビジョニング状態
workloadPayload	string	ワークロード固有のペイロードデータ

ArtifactMetadataUser

Object

アーティファクトメタデータ内のユーザー情報

名前	型	説明
displayName	string	ユーザーの表示名
emailAddress	string (email)	ユーザーのメールアドレス
objectId	string (uuid)	ユーザーのオブジェクト ID

ArtifactProvisionState

列挙

成果物の現在のプロビジョニング状態

値	説明
InProgress	成果物がプロビジョニングされています
Active	成果物がアクティブです
Migrating	成果物が移行中です
Recovering	成果物が回復中です
SoftDeletedByUser	成果物がユーザーによって論理的に削除される
SoftDeleted	成果物が論理的に削除される
Failed	成果物のプロビジョニングに失敗しました
Deleting	成果物が削除されています
DisabledByDeprovisioning	プロビジョニング解除によって成果物が無効になる
DeprovisioningFailed	アーティファクトのプロビジョニング解除に失敗しました
DeletedByDeprovision	プロビジョニング解除によって成果物が削除される
DeletedByWorkload	成果物はワークロードによって削除されます

SaveAsNativeDataflowErrorCode

列挙

移行中に発生する可能性がある致命的でない警告コード。これらは、全体的な操作の成功を妨げるような部分的なエラーを示します。

値	説明
FailedToCopySchedule	更新スケジュールを新しい成果物にコピーできませんでした
SetDataflowOriginFailed	新しい成果物の配信元追跡情報を設定できませんでした
ConnectionsUpdateFailed	接続文字列を Fabric 形式に更新できませんでした

SaveAsNativeDataflowRequest

Object

Gen1 データフローを Gen2 (CI/CD) ネイティブ成果物に移行するための要求本文

名前	型	説明
description	string maxLength: 4000	新しい成果物の説明 (省略可能)。指定されていない場合、または空の場合は、ソースデータフローの説明がコピーされます。最大長: 4,000 文字
displayName	string maxLength: 200	新しい成果物のオプションの表示名。指定されていない場合、または空の場合、名前の競合を回避するために、"_copy1"、"_copy2" などのサフィックスを持つソースデータフロー名に基づいて名前が生成されます。最大長: 200 文字
includeSchedule	boolean	移行にソースデータフローからの更新スケジュールを含めるかどうか。 true の場合、既存のスケジュールを無効状態の新しい成果物にコピーしようとします。 false の場合、新しい成果物はスケジュールなしで作成されます。
targetWorkspaceId	string (uuid)	新しい成果物が作成されるオプションのターゲットワークスペース ID。指定されていない場合、または空の場合、新しい成果物はソースデータフローと同じワークスペースに作成されます。

SaveAsNativeDataflowResponse

Object

データフロー移行操作からの応答

名前	型	説明
artifactMetadata	ArtifactMetadata	新しく作成された Gen2(CI/CD) 成果物の完全なメタデータ
errors	SaveAsNativeDataflowErrorCode[]	移行プロセス中に発生した致命的でないエラーの一覧。これらのエラーが発生した場合でも、移行は成功したと見なされますが、一部の機能が正しく移行されていない可能性があります。

次の方法で共有

Dataflows - Save Dataflow Gen One As Dataflow Gen Two

Preview

URI パラメーター

要求本文

応答

例

Example

要求のサンプル

応答のサンプル

定義

ArtifactMetadata

ArtifactMetadataUser

ArtifactProvisionState

SaveAsNativeDataflowErrorCode

SaveAsNativeDataflowRequest

SaveAsNativeDataflowResponse