次の方法で共有

Items - Create Notebook

  • リファレンス
サービス:
Notebook
API バージョン:
v1

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

定義を使用してノートブックを作成するには、ノートブック定義 記事 参照してください。

権限

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

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

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

制限

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

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

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

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

インターフェイス

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

URI パラメーター

名前 / 必須 型 説明
workspaceId
 path True

string

uuid

ワークスペース ID。

要求本文

名前 必須 型 説明
displayName True

string

ノートブックの表示名。 表示名は、項目の種類に応じて名前付け規則に従う必要があります。
definition

NotebookDefinition

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

string

ノートブックの説明。 最大長は 256 文字です。

応答

名前 型 説明
201 Created

Notebook

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

受け入れ済み、ノートブックのプロビジョニングが進行中の要求。

ヘッダー

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

一般的なエラー コード:

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

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

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

例

Create a notebook example
Create a notebook with public definition example

Create a notebook example

要求のサンプル

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

{
  "displayName": "Notebook 1",
  "description": "A notebook description."
}

応答のサンプル

状態コード:
201 
{
  "displayName": "Notebook 1",
  "description": "A notebook description.",
  "type": "Notebook",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
状態コード:
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 notebook with public definition example

要求のサンプル

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

{
  "displayName": "Notebook 1",
  "description": "A notebook description",
  "definition": {
    "format": "ipynb",
    "parts": [
      {
        "path": "notebook-content.py",
        "payload": "eyJuYmZvcm1hdCI6N..5ndWUiOiJweXRob24ifX19",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

応答のサンプル

状態コード:
201 
{
  "displayName": "Notebook 1",
  "description": "A notebook description",
  "type": "Notebook",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
状態コード:
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

定義

名前 説明
CreateNotebookRequest

ノートブック要求ペイロードを作成します。
ErrorRelatedResource

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

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
ItemType

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

ノートブック オブジェクト。
NotebookDefinition

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

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

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

CreateNotebookRequest

Object

ノートブック要求ペイロードを作成します。

名前 型 説明
definition

NotebookDefinition

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

string

ノートブックの説明。 最大長は 256 文字です。
displayName

string

ノートブックの表示名。 表示名は、項目の種類に応じて名前付け規則に従う必要があります。

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

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

ItemType

列挙

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

値 説明
Dashboard

PowerBI ダッシュボード。
DataPipeline

データ パイプライン。
Datamart

PowerBI データマート。
Environment

環境。
Eventhouse

イベントハウス。
Eventstream

イベントストリーム。
GraphQLApi

GraphQL 項目の API。
KQLDashboard

KQL ダッシュボード。
KQLDatabase

KQL データベース。
KQLQueryset

KQL クエリセット。
Lakehouse

レイクハウス。
MLExperiment

機械学習の実験。
MLModel

機械学習モデル。
MirroredDatabase

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

ミラー化された倉庫。
MountedDataFactory

MountedDataFactory。
Notebook

ノートブック。
PaginatedReport

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

反射。
Report

PowerBI レポート。
SQLDatabase

SQLDatabase。
SQLEndpoint

SQL エンドポイント。
SemanticModel

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

Spark ジョブ定義。
Warehouse

倉庫。

Notebook

Object

ノートブック オブジェクト。

名前 型 説明
description

string

アイテムの説明。
displayName

string

アイテムの表示名。
id

string

uuid

アイテム ID。
type

ItemType

アイテムの種類。
workspaceId

string

uuid

ワークスペース ID。

NotebookDefinition

Object

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

名前 型 説明
format

string

ノートブック定義の形式。 サポートされている形式: ipynb.
parts

NotebookDefinitionPart[]

定義パーツの一覧。

NotebookDefinitionPart

Object

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

名前 型 説明
path

string

ノートブック パーツのパス。
payload

string

ノートブック パーツのペイロード。
payloadType

PayloadType

ペイロードの種類。

PayloadType

列挙

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

値 説明
InlineBase64

インライン ベース 64。