Items - Update Mirrored Database

サービス:

MirroredDatabase

API バージョン:

v1

指定したミラー化されたデータベースのプロパティを更新します。

権限

呼び出し元には、ミラー化されたデータベースの 読み取りと書き込みの アクセス許可が必要です。

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

MirroredDatabase.ReadWrite.All または Item.ReadWrite.All

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

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

同一性	支える
利用者	はい
サービス プリンシパルの とマネージド ID の	はい

インターフェイス

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/mirroredDatabases/{mirroredDatabaseId}

URI パラメーター

名前	/	必須	型	説明
mirroredDatabaseId	path	True	string (uuid)	ミラー化されたデータベース ID。
workspaceId	path	True	string (uuid)	ワークスペース ID。

要求本文

名前	型	説明
description	string	ミラー化されたデータベースの説明。 最大長は 256 文字です。
displayName	string	ミラー化されたデータベースの表示名。 表示名は、項目の種類に応じて名前付け規則に従う必要があります。

応答

名前	型	説明
200 OK	MirroredDatabase	要求は正常に完了しました。
Other Status Codes	ErrorResponse	一般的なエラー コード: ItemNotFound - 要求された項目が見つかりませんでした。 InvalidRequest - 無効な更新要求

例

Update a mirrored database example

要求のサンプル

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/mirroredDatabases/b1b1b1b1-cccc-dddd-eeee-f2f2f2f2f2f2

{
  "displayName": "MirroredDatabase's New name",
  "description": "A new description for mirrored database."
}

応答のサンプル

状態コード:

200

{
  "displayName": "MirroredDatabase's New name",
  "description": "A new description for mirrored database.",
  "type": "MirroredDatabase",
  "workspaceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
  "id": "b1b1b1b1-cccc-dddd-eeee-f2f2f2f2f2f2"
}

定義

名前	説明
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
ItemTag	アイテムに適用されるタグを表します。
ItemType	アイテムの種類。 追加の項目の種類は、時間の経過と同時に追加される場合があります。
MirroredDatabase	ミラー化されたデータベース項目。
MirroredDatabaseProperties	ミラー化されたデータベースのプロパティ。
SqlEndpointProperties	SQL エンドポイントのプロパティを含むオブジェクト。
SqlEndpointProvisioningStatus	SQL エンドポイントのプロビジョニング状態の種類。 追加の SqlEndpointProvisioningStatus 型は、時間の経過と同時に追加される場合があります。
UpdateMirroredDatabaseRequest	ミラー化されたデータベース要求を更新します。

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	エラー関連のリソースの詳細。

ItemTag

Object

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

名前	型	説明
displayName	string	タグの名前。
id	string (uuid)	タグ ID。

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 スナップショット。

MirroredDatabase

Object

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

名前	型	説明
description	string	アイテムの説明。
displayName	string	アイテムの表示名。
folderId	string (uuid)	フォルダー ID。
id	string (uuid)	アイテム ID。
properties	MirroredDatabaseProperties	ミラー化されたデータベースのプロパティ。
tags	ItemTag[]	適用されたタグの一覧。
type	ItemType	アイテムの種類。
workspaceId	string (uuid)	ワークスペース ID。

MirroredDatabaseProperties

Object

ミラー化されたデータベースのプロパティ。

名前	型	説明
defaultSchema	string	ミラー化されたデータベースの既定のスキーマ。 このプロパティは、定義で既定のスキーマを有効にするミラー化されたデータベースの場合にのみ返されます。
oneLakeTablesPath	string	ミラー化されたデータベース テーブル ディレクトリへの OneLake パス。
sqlEndpointProperties	SqlEndpointProperties	SQL エンドポイントのプロパティを含むオブジェクト。

SqlEndpointProperties

Object

SQL エンドポイントのプロパティを含むオブジェクト。

名前	型	説明
connectionString	string	SQL エンドポイント接続文字列。
id	string	SQL エンドポイント ID。
provisioningStatus	SqlEndpointProvisioningStatus	SQL エンドポイントのプロビジョニング状態。

SqlEndpointProvisioningStatus

列挙

SQL エンドポイントのプロビジョニング状態の種類。 追加の SqlEndpointProvisioningStatus 型は、時間の経過と同時に追加される場合があります。

値	説明
Failed	SQL エンドポイントのプロビジョニングに失敗しました。
InProgress	SQL エンドポイントのプロビジョニングが進行中です。
Success	SQL エンドポイントのプロビジョニングに成功しました。

UpdateMirroredDatabaseRequest

Object

ミラー化されたデータベース要求を更新します。

名前	型	説明
description	string	ミラー化されたデータベースの説明。 最大長は 256 文字です。
displayName	string	ミラー化されたデータベースの表示名。 表示名は、項目の種類に応じて名前付け規則に従う必要があります。