Items - Get SQL Database Definition
指定した SQL データベースのパブリック定義を返します。
この API は、実行時間の長い操作 (LRO)をサポートします。
SQL データベースのパブリック定義を取得する場合、秘密度ラベルは定義の一部ではありません。
Permissions
呼び出し元には、SQL データベースの 読み取りと書き込みの アクセス許可が必要です。
必要な委任されたスコープ
SQLDatabase.ReadWrite.All または Item.ReadWrite.All
Limitations
暗号化された秘密度ラベルによって保護された SQL データベース項目の定義を取得するには、呼び出し元は、Microsoft Purviewで構成されているように、ラベルを削除するための十分な使用権限を持っている必要があります。
Microsoft Entra でサポートされている ID
この API では、このセクションに記載されている Microsoft ID がサポートされています。
| アイデンティティ | Support |
|---|---|
| ユーザー | イエス |
| サービス プリンシパルとマネージド ID | イエス |
インターフェイス
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlDatabases/{sqlDatabaseId}/getDefinition
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlDatabases/{sqlDatabaseId}/getDefinition?format={format}
URI パラメーター
| Name | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
sql
|
path | True |
string (uuid) |
SQL データベース ID。 |
|
workspace
|
path | True |
string (uuid) |
ワークスペース ID。 |
|
format
|
query |
string |
SQL データベースのパブリック定義の形式。 サポートされている形式: |
応答
| Name | 型 | 説明 |
|---|---|---|
| 200 OK |
要求は正常に完了しました。 |
|
| 202 Accepted |
要求は受け入れ済み。 定義の取得が進行中です。 ヘッダー
|
|
| 429 Too Many Requests |
サービス レートの制限を超えました。 サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す ヘッダー Retry-After: integer |
|
| Other Status Codes |
一般的なエラー コード:
|
例
Get a Digital Twin Builder Flow public definition example
要求のサンプル
POST https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/sqlDatabases/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/getDefinition
応答のサンプル
{
"definition": {
"parts": [
{
"path": "definition.dacpac",
"payload": "ew0KICAibGFrZWhvdXNlSWQiOiAiYjliNWQzNmYtNDQ0NS00MDNiLWFjODctMDE2YjFjZDIwMjExIg0KfQ==",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
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
定義
| Name | 説明 |
|---|---|
|
Error |
エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。 |
|
Error |
エラー関連のリソース詳細オブジェクト。 |
|
Error |
エラー応答。 |
|
Error |
エラー応答の詳細。 |
|
Payload |
定義パーツペイロードの型。 追加のペイロードの種類は、時間の経過と同時に追加される場合があります。 |
|
SQLDatabase |
SQL データベースのパブリック定義オブジェクト。 SQL データベース定義の構造の詳細については、この 記事 を参照してください。 |
|
SQLDatabase |
SQL データベースのパブリック定義応答。 |
|
SQLDatabase |
SQL データベース定義パーツ オブジェクト。 |
ErrorParameter
エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。
| Name | 型 | 説明 |
|---|---|---|
| message |
string |
パラメーターの意味を人間が判読できる説明。 |
| name |
string |
パラメータ識別子です。 |
| value |
string |
パラメーターの値を指定します。 |
ErrorRelatedResource
エラー関連のリソース詳細オブジェクト。
| Name | 型 | 説明 |
|---|---|---|
| resourceId |
string |
エラーに関係するリソース ID。 |
| resourceType |
string |
エラーに関係するリソースの種類。 |
ErrorResponse
エラー応答。
| Name | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| isRetriable |
boolean |
true の場合、要求を再試行できます。
|
| message |
string |
エラーの人間が判読できる表現。 |
| moreDetails |
その他のエラーの詳細の一覧。 |
|
| parameters |
エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。 |
|
| relatedResource |
エラー関連のリソースの詳細。 |
|
| requestId |
string (uuid) |
エラーに関連付けられている要求の ID。 |
ErrorResponseDetails
エラー応答の詳細。
| Name | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| message |
string |
エラーの人間が判読できる表現。 |
| parameters |
エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。 |
|
| relatedResource |
エラー関連のリソースの詳細。 |
PayloadType
定義パーツペイロードの型。 追加のペイロードの種類は、時間の経過と同時に追加される場合があります。
| 値 | 説明 |
|---|---|
| InlineBase64 |
インライン ベース 64。 |
SQLDatabaseDefinition
SQL データベースのパブリック定義オブジェクト。 SQL データベース定義の構造の詳細については、この 記事 を参照してください。
| Name | 型 | 説明 |
|---|---|---|
| format |
string |
SQL データベース定義の形式。 サポートされている形式: |
| parts |
定義パーツの一覧。 |
SQLDatabaseDefinitionResponse
SQL データベースのパブリック定義応答。
| Name | 型 | 説明 |
|---|---|---|
| definition |
SQL データベースのパブリック定義オブジェクト。 SQL データベース定義の構造の詳細については、この 記事 を参照してください。 |
SQLDatabasePublicDefinitionPart
SQL データベース定義パーツ オブジェクト。
| Name | 型 | 説明 |
|---|---|---|
| path |
string |
SQL データベースのパブリック定義部分のパス。 サポートされている SQL データベース コンテンツ拡張機能: |
| payload |
string |
SQL データベースのパブリック定義部分のペイロード。 |
| payloadType |
ペイロードの種類。 |