Items - Get Notebook Definition

サービス:: Notebook

API バージョン:: v1

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

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

権限

呼び出し元には、ノートブックの 読み取りと書き込みの アクセス許可が必要です。

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

Notebook.ReadWrite.All または Item.ReadWrite.All

制限事項

暗号化された秘密度ラベルを持つノートブックでは、この API はブロックされます。

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

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

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

インターフェイス

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/getDefinition

省略可能なパラメーターを含む:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/getDefinition?format={format}

URI パラメーター

名前	/	必須	型	説明
notebookId	path	True	string (uuid)	ノートブック ID。
workspaceId	path	True	string (uuid)	ワークスペース ID。
format	query		string	ノートブックのパブリック定義の形式。サポートされている形式: `ipynb` と `fabricGitSource`。形式が指定されていない場合は、 `fabricGitSource` が使用されます。

応答

名前	型	説明
200 OK	NotebookDefinitionResponse	要求は正常に完了しました。
202 Accepted		要求は受け入れ済み。定義の取得が進行中です。ヘッダー Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	一般的なエラーコード: OperationNotSupportedForItem - 要求された項目に対する操作はサポートされていません。

名前

型

説明

200 OK

NotebookDefinitionResponse

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

202 Accepted

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

ヘッダー

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

一般的なエラーコード:

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

例

Get a notebook definition in fabricGitSource format example

Get a notebook definition in ipynb format example

Get a notebook definition in fabricGitSource format example

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "definition": {
    "parts": [
      {
        "path": "notebook-content.py",
        "payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
        "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

Get a notebook definition in ipynb format example

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "definition": {
    "parts": [
      {
        "path": "notebook-content.ipynb",
        "payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
        "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

定義

名前	説明
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
NotebookDefinition	ノートブックのパブリック定義オブジェクト。ノートブックのパブリック定義を作成する方法の詳細については、この記事を参照してください。
NotebookDefinitionPart	ノートブック定義パーツオブジェクト。
NotebookDefinitionResponse	ノートブックのパブリック定義の応答。
PayloadType	定義パーツペイロードの型。追加のペイロードの種類は、時間の経過と同時に追加される場合があります。

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

NotebookDefinition

Object

ノートブックのパブリック定義オブジェクト。ノートブックのパブリック定義を作成する方法の詳細については、この記事を参照してください。

名前	型	説明
format	string	ノートブック定義の形式。サポートされている形式: `ipynb` と `fabricGitSource`。形式が指定されていない場合は、 `fabricGitSource` が使用されます。
parts	NotebookDefinitionPart[]	定義パーツの一覧。

NotebookDefinitionPart

Object

ノートブック定義パーツオブジェクト。

名前	型	説明
path	string	ノートブックパーツのパス。サポートされているノートブックコンテンツ拡張機能: `.ipynb`形式の`ipynb`、`.py`、`.scala`、`.r`、`.sql`形式の`fabricGitSource`。
payload	string	ノートブックパーツのペイロード。
payloadType	PayloadType	ペイロードの型。

NotebookDefinitionResponse

Object

ノートブックのパブリック定義の応答。

名前	型	説明
definition	NotebookDefinition	ノートブックのパブリック定義オブジェクト。ノートブックのパブリック定義を作成する方法の詳細については、この記事を参照してください。

PayloadType

列挙

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

値	説明
InlineBase64	インラインベース 64。

次の方法で共有

Items - Get Notebook Definition

権限

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

制限事項

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

インターフェイス

URI パラメーター

応答

例

Get a notebook definition in fabricGitSource format example

要求のサンプル

応答のサンプル

Get a notebook definition in ipynb format example

要求のサンプル

応答のサンプル

定義

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

NotebookDefinition

NotebookDefinitionPart

NotebookDefinitionResponse

PayloadType