Aracılığıyla paylaş

Items - Create GraphQLApi

Hizmet:
GraphQLApi
API Sürümü:
v1

Belirtilen çalışma alanında GraphQL öğesi için bir API oluşturur.

Bu API, uzun süre çalışan işlemleri (LRO)destekler.

Genel bir tanım ile GraphQLApi öğesi oluşturmak için GraphQLApi tanımına bakın.

İzinler

Çağıranın katkıda bulunan çalışma alanı rolü olmalıdır.

Gerekli Temsilci Kapsamları

GraphQLApi.ReadWrite.All veya Item.ReadWrite.All

Sınırlama

  • GraphQLApi oluşturmak için çalışma alanının desteklenen bir Doku kapasitesinde olması gerekir. Daha fazla bilgi için bkz. Microsoft Fabric lisans türleri.

Microsoft Entra tarafından desteklenen kimlikler

Bu API, bu bölümde listelenen Microsoft kimliklerini destekler.

Kimlik Destek
Kullanıcı Evet
Hizmet sorumlusu ve yönetilen kimlikler Evet

Arayüz

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

URI Parametreleri

Name İçinde Gerekli Tür Description
workspaceId
 path True

string (uuid)

Çalışma alanı kimliği.

İstek Gövdesi

Name Gerekli Tür Description
displayName True

string

GraphQL için API görünen adı. Görünen ad, öğe türüne göre adlandırma kurallarına uymalıdır.
definition

GraphQLApiPublicDefinition

GraphQL genel tanımı için API.
description

string

GraphQL için API açıklaması. Uzunluk üst sınırı 256 karakterdir.
folderId

string (uuid)

Klasör kimliği. Belirtilmezse veya null değilse, GraphQL API'si çalışma alanı klasörü olarak oluşturulur.

Yanıtlar

Name Tür Description
201 Created

GraphQLApi

Başarıyla oluşturuldu
202 Accepted

İstek kabul edildi, GraphQLApi sağlama devam ediyor.

Üst Bilgiler

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

ErrorResponse

Yaygın hata kodları:

  • InvalidItemType - Öğe türü geçersiz

  • ItemDisplayNameAlreadyInUse - Öğe görünen adı zaten kullanılıyor.

  • BozukPayload - Sağlanan yük bozuk.

  • WorkspaceItemsLimitExceeded - Çalışma alanı öğe sınırı aşıldı.

Örnekler

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

Create a API for GraphQL example

Örnek isteği

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

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

Örnek yanıt

Durum kodu:
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"
}
Durum kodu:
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

Örnek isteği

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"
      }
    ]
  }
}

Örnek yanıt

Durum kodu:
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"
}
Durum kodu:
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

Tanımlar

Name Description
CreateGraphQLApiRequest

GraphQL istek yükü için API oluşturun.
ErrorRelatedResource

Hatayla ilgili kaynak ayrıntıları nesnesi.
ErrorResponse

Hata yanıtı.
ErrorResponseDetails

Hata yanıtı ayrıntıları.
GraphQLApi

GraphQL öğesi için bir API.
GraphQLApiPublicDefinition

GraphQL genel tanım nesnesi için API. Tanımı oluşturmak için bkz. GraphQLApi tanımı.
GraphQLApiPublicDefinitionPart

GraphQL tanımı parça nesnesi için API.
ItemTag

Bir öğeye uygulanan etiketi temsil eder.
ItemType

Öğenin türü. Zaman içinde ek öğe türleri eklenebilir.
PayloadType

Tanım parçası yükünün türü. Zaman içinde ek yük türleri eklenebilir.

CreateGraphQLApiRequest

Nesne

GraphQL istek yükü için API oluşturun.

Name Tür Description
definition

GraphQLApiPublicDefinition

GraphQL genel tanımı için API.
description

string

GraphQL için API açıklaması. Uzunluk üst sınırı 256 karakterdir.
displayName

string

GraphQL için API görünen adı. Görünen ad, öğe türüne göre adlandırma kurallarına uymalıdır.
folderId

string (uuid)

Klasör kimliği. Belirtilmezse veya null değilse, GraphQL API'si çalışma alanı klasörü olarak oluşturulur.

ErrorRelatedResource

Nesne

Hatayla ilgili kaynak ayrıntıları nesnesi.

Name Tür Description
resourceId

string

Hataya dahil olan kaynak kimliği.
resourceType

string

Hataya dahil olan kaynağın türü.

ErrorResponse

Nesne

Hata yanıtı.

Name Tür Description
errorCode

string

Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
message

string

Hatanın okunabilir bir gösterimi.
moreDetails

ErrorResponseDetails[]

Ek hata ayrıntılarının listesi.
relatedResource

ErrorRelatedResource

Hatayla ilgili kaynak ayrıntıları.
requestId

string

Hatayla ilişkili isteğin kimliği.

ErrorResponseDetails

Nesne

Hata yanıtı ayrıntıları.

Name Tür Description
errorCode

string

Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
message

string

Hatanın okunabilir bir gösterimi.
relatedResource

ErrorRelatedResource

Hatayla ilgili kaynak ayrıntıları.

GraphQLApi

Nesne

GraphQL öğesi için bir API.

Name Tür Description
description

string

Öğe açıklaması.
displayName

string

Öğenin görünen adı.
folderId

string (uuid)

Klasör kimliği.
id

string (uuid)

Öğe kimliği.
tags

ItemTag[]

Uygulanan etiketlerin listesi.
type

ItemType

Öğe türü.
workspaceId

string (uuid)

Çalışma alanı kimliği.

GraphQLApiPublicDefinition

Nesne

GraphQL genel tanım nesnesi için API. Tanımı oluşturmak için bkz. GraphQLApi tanımı.

Name Tür Description
format

string

Öğe tanımının biçimi.
parts

GraphQLApiPublicDefinitionPart[]

Tanım bölümlerinin listesi.

GraphQLApiPublicDefinitionPart

Nesne

GraphQL tanımı parça nesnesi için API.

Name Tür Description
path

string

GraphQL tanımı parça yolu için API.
payload

string

GraphQL tanımı parça yükü için API.
payloadType

PayloadType

Yük türü.

ItemTag

Nesne

Bir öğeye uygulanan etiketi temsil eder.

Name Tür Description
displayName

string

Etiketin adı.
id

string (uuid)

Etiket kimliği.

ItemType

Numaralandırma

Öğenin türü. Zaman içinde ek öğe türleri eklenebilir.

Değer Description
Dashboard

PowerBI panosu.
Report

PowerBI raporu.
SemanticModel

PowerBI anlam modeli.
PaginatedReport

PowerBI sayfalandırılmış raporu.
Datamart

PowerBI datamart.
Lakehouse

Göl evi.
Eventhouse

Bir olay evi.
Environment

Bir ortam.
KQLDatabase

KQL veritabanı.
KQLQueryset

KQL sorgu kümesi.
KQLDashboard

KQL panosu.
DataPipeline

Veri işlem hattı.
Notebook

Bir not defteri.
SparkJobDefinition

Spark iş tanımı.
MLExperiment

Makine öğrenmesi denemesi.
MLModel

Makine öğrenmesi modeli.
Warehouse

Bir depo.
Eventstream

Bir olay akışı.
SQLEndpoint

Bir SQL uç noktası.
MirroredWarehouse

Aynalı bir depo.
MirroredDatabase

Yansıtılmış veritabanı.
Reflex

Bir refleks.
GraphQLApi

GraphQL öğesi için bir API.
MountedDataFactory

Bir MountedDataFactory.
SQLDatabase

A SQLDatabase.
CopyJob

Kopyalama işi.
VariableLibrary

Bir VariableLibrary.
Dataflow

Veri akışı.
ApacheAirflowJob

An ApacheAirflowJob.
WarehouseSnapshot

Ambar anlık görüntüsü.
DigitalTwinBuilder

A DigitalTwinBuilder.
DigitalTwinBuilderFlow

Dijital İkiz Oluşturucu Akışı.
MirroredAzureDatabricksCatalog

Yansıtılmış azure databricks kataloğu.
Map

Bir harita.
AnomalyDetector

Anomali Algılayıcısı.
UserDataFunction

Kullanıcı Verileri İşlevi.
GraphModel

A GraphModel.
GraphQuerySet

A Graph QuerySet.
SnowflakeDatabase

Snowflake hesabından oluşturulan Iceberg tablolarını depolamak için bir Snowflake Veritabanı.
OperationsAgent

A OperationsAgent.
CosmosDBDatabase

Cosmos DB Veritabanı.

PayloadType

Numaralandırma

Tanım parçası yükünün türü. Zaman içinde ek yük türleri eklenebilir.

Değer Description
InlineBase64

Satır içi Temel 64.