次の方法で共有

Items - Create GraphQLApi

サービス:
GraphQLApi
API バージョン:
v1

指定したワークスペースに GraphQL 項目の API を作成します。

この API は、実行時間の長い操作 (LRO)をサポートします。

パブリック定義を使用して GraphQLApi 項目を作成するには、 GraphQLApi 定義を参照してください。

権限

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

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

GraphQLApi.ReadWrite.All または Item.ReadWrite.All

制限

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

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

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

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

インターフェイス

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

URI パラメーター

名前 / 必須 型 説明
workspaceId
 path True

string (uuid)

ワークスペース ID。

要求本文

名前 必須 型 説明
displayName True

string

GraphQL の API の表示名。 表示名は、項目の種類に応じて名前付け規則に従う必要があります。
definition

GraphQLApiPublicDefinition

GraphQL のパブリック定義の API。
description

string

GraphQL 用 API の説明。 最大長は 256 文字です。
folderId

string (uuid)

フォルダー ID。 指定しない場合、または null の場合、GraphQL の API はワークスペースをそのフォルダーとして使用して作成されます。

応答

名前 型 説明
201 Created

GraphQLApi

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

要求が受け入れ済み、GraphQLApi のプロビジョニングが進行中です。

ヘッダー

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

ErrorResponse

一般的なエラー コード:

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

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

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

  • WorkspaceItemsLimitExceeded - ワークスペース項目の制限を超えました。

例

Create a API for GraphQL example
Create a GraphQLApi with public definition example

Create a API for GraphQL example

要求のサンプル

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

{
  "displayName": "GraphQL 1",
  "description": "An API for GraphQL item description."
}

応答のサンプル

状態コード:
201 
{
  "displayName": "GraphQL 1",
  "description": "An API for GraphQL item description.",
  "type": "GraphQLApi",
  "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 GraphQLApi with public definition example

要求のサンプル

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

{
  "displayName": "GraphQLApi 1",
  "description": "An API for GraphQL item description.",
  "definition": {
    "format": "GraphQLApiV1",
    "parts": [
      {
        "path": "graphql-definition.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

応答のサンプル

状態コード:
201 
{
  "displayName": "GraphQLApi 1",
  "description": "An API for GraphQL item description.",
  "type": "GraphQLApi",
  "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

定義

名前 説明
CreateGraphQLApiRequest

GraphQL 要求ペイロード用の API を作成します。
ErrorRelatedResource

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

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
GraphQLApi

GraphQL 項目の API。
GraphQLApiPublicDefinition

GraphQL パブリック定義オブジェクトの API。 定義を作成するには、 GraphQLApi 定義を参照してください。
GraphQLApiPublicDefinitionPart

GraphQL 定義パーツ オブジェクトの API。
ItemTag

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

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

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

CreateGraphQLApiRequest

Object

GraphQL 要求ペイロード用の API を作成します。

名前 型 説明
definition

GraphQLApiPublicDefinition

GraphQL のパブリック定義の API。
description

string

GraphQL 用 API の説明。 最大長は 256 文字です。
displayName

string

GraphQL の API の表示名。 表示名は、項目の種類に応じて名前付け規則に従う必要があります。
folderId

string (uuid)

フォルダー ID。 指定しない場合、または null の場合、GraphQL の API はワークスペースをそのフォルダーとして使用して作成されます。

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

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

GraphQLApi

Object

GraphQL 項目の API。

名前 型 説明
description

string

アイテムの説明。
displayName

string

アイテムの表示名。
folderId

string (uuid)

フォルダー ID。
id

string (uuid)

アイテム ID。
tags

ItemTag[]

適用されたタグの一覧。
type

ItemType

アイテムの種類。
workspaceId

string (uuid)

ワークスペース ID。

GraphQLApiPublicDefinition

Object

GraphQL パブリック定義オブジェクトの API。 定義を作成するには、 GraphQLApi 定義を参照してください。

名前 型 説明
format

string

項目定義の形式。
parts

GraphQLApiPublicDefinitionPart[]

定義パーツの一覧。

GraphQLApiPublicDefinitionPart

Object

GraphQL 定義パーツ オブジェクトの API。

名前 型 説明
path

string

GraphQL 定義パーツのパスの API。
payload

string

GraphQL 定義パーツペイロードの API。
payloadType

PayloadType

ペイロードの種類。

ItemTag

Object

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

名前 型 説明
displayName

string

タグの名前。
id

string (uuid)

タグ ID。

ItemType

列挙

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

値 説明
Dashboard

PowerBI ダッシュボード。
Report

PowerBI レポート。
SemanticModel

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

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

PowerBI データマート。
Lakehouse

レイクハウス。
Eventhouse

イベントハウス。
Environment

環境。
KQLDatabase

KQL データベース。
KQLQueryset

KQL クエリセット。
KQLDashboard

KQL ダッシュボード。
DataPipeline

データ パイプライン。
Notebook

ノートブック。
SparkJobDefinition

Spark ジョブ定義。
MLExperiment

機械学習の実験。
MLModel

機械学習モデル。
Warehouse

倉庫。
Eventstream

イベントストリーム。
SQLEndpoint

SQL エンドポイント。
MirroredWarehouse

ミラー化された倉庫。
MirroredDatabase

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

反射。
GraphQLApi

GraphQL 項目の API。
MountedDataFactory

MountedDataFactory。
SQLDatabase

SQLDatabase。
CopyJob

コピー ジョブ。
VariableLibrary

VariableLibrary。
Dataflow

データフロー。
ApacheAirflowJob

ApacheAirflowJob。
WarehouseSnapshot

Warehouse スナップショット。
DigitalTwinBuilder

DigitalTwinBuilder。
DigitalTwinBuilderFlow

デジタル ツイン ビルダー フロー。
MirroredAzureDatabricksCatalog

ミラー化された Azure databricks カタログ。
Map

マップ。
AnomalyDetector

Anomaly Detector。
UserDataFunction

ユーザー データ関数。
GraphModel

GraphModel。
GraphQuerySet

Graph QuerySet。
SnowflakeDatabase

Snowflake アカウントから作成された Iceberg テーブルを格納する Snowflake データベース。
OperationsAgent

OperationsAgent。
CosmosDBDatabase

Cosmos DB データベース。

PayloadType

列挙

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

値 説明
InlineBase64

インライン ベース 64。