Items - Create GraphQLApi

서비스:: GraphQLApi

API 버전:: v1

지정된 작업 영역에서 GraphQL 항목에 대한 API를 만듭니다.

이 API는 LRO(장기 실행 작업)지원합니다.

공용 정의를 사용하여 GraphQLApi 항목을 만들려면 GraphQLApi 정의를 참조하세요.

권한을

호출자에게 는 기여자 작업 영역 역할이 있어야 합니다.

필요한 위임된 범위

GraphQLApi.ReadWrite.All 또는 Item.ReadWrite.All

제한

GraphQLApi를 만들려면 작업 영역이 지원되는 패브릭 용량에 있어야 합니다. 자세한 내용은 다음을 참조하세요. Microsoft Fabric 라이선스 유형.

Microsoft Entra 지원 ID

이 API는 이 섹션에 나열된 Microsoft ID 지원합니다.

신원	지원
사용자	예
서비스 주체 및 관리 ID	예

인터페이스

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
workspaceId	path	True	string (uuid)	작업 영역 ID입니다.

요청 본문

Name	필수	형식	Description
displayName	True	string	GraphQL용 API 표시 이름입니다. 표시 이름은 항목 유형에 따라 명명 규칙을 따라야 합니다.
definition		GraphQLApiPublicDefinition	GraphQL용 API 공용 정의입니다.
description		string	GraphQL용 API 설명입니다. 최대 길이는 256자입니다.
folderId		string (uuid)	폴더 ID입니다. 지정하지 않거나 null이면 작업 영역을 폴더로 사용하여 GraphQL용 API가 만들어집니다.

응답

Name	형식	Description
201 Created	GraphQLApi	성공적으로 생성됨
202 Accepted		요청이 수락되었습니다. GraphQLApi 프로비저닝이 진행 중입니다. 헤더 Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	일반적인 오류 코드: InvalidItemType - 항목 유형이 잘못되었습니다. ItemDisplayNameAlreadyInUse - 항목 표시 이름이 이미 사용되었습니다. CorruptedPayload - 제공된 페이로드가 손상되었습니다. WorkspaceItemsLimitExceeded - 작업 영역 항목 제한을 초과했습니다.

Name

형식

Description

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

샘플 요청

HTTP

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

샘플 요청

HTTP

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

정의

Name	Description
CreateGraphQLApiRequest	GraphQL 요청 페이로드용 API를 만듭니다.
ErrorRelatedResource	오류 관련 리소스 세부 정보 개체입니다.
ErrorResponse	오류 응답입니다.
ErrorResponseDetails	오류 응답 세부 정보입니다.
GraphQLApi	GraphQL 항목에 대한 API입니다.
GraphQLApiPublicDefinition	GraphQL 공용 정의 개체에 대한 API입니다. 정의를 만들려면 GraphQLApi 정의를 참조하세요.
GraphQLApiPublicDefinitionPart	GraphQL 정의 파트 개체에 대한 API입니다.
ItemTag	항목에 적용된 태그를 나타냅니다.
ItemType	항목의 형식입니다. 추가 항목 유형은 시간이 지남에 따라 추가될 수 있습니다.
PayloadType	정의 파트 페이로드의 형식입니다. 추가 페이로드 유형은 시간이 지남에 따라 추가될 수 있습니다.

CreateGraphQLApiRequest

Object

GraphQL 요청 페이로드용 API를 만듭니다.

Name	형식	Description
definition	GraphQLApiPublicDefinition	GraphQL용 API 공용 정의입니다.
description	string	GraphQL용 API 설명입니다. 최대 길이는 256자입니다.
displayName	string	GraphQL용 API 표시 이름입니다. 표시 이름은 항목 유형에 따라 명명 규칙을 따라야 합니다.
folderId	string (uuid)	폴더 ID입니다. 지정하지 않거나 null이면 작업 영역을 폴더로 사용하여 GraphQL용 API가 만들어집니다.

ErrorRelatedResource

Object

오류 관련 리소스 세부 정보 개체입니다.

Name	형식	Description
resourceId	string	오류와 관련된 리소스 ID입니다.
resourceType	string	오류와 관련된 리소스의 형식입니다.

ErrorResponse

Object

오류 응답입니다.

Name	형식	Description
errorCode	string	오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
message	string	사용자가 읽을 수 있는 오류 표현입니다.
moreDetails	ErrorResponseDetails[]	추가 오류 세부 정보 목록입니다.
relatedResource	ErrorRelatedResource	오류 관련 리소스 세부 정보입니다.
requestId	string	오류와 연결된 요청의 ID입니다.

ErrorResponseDetails

Object

오류 응답 세부 정보입니다.

Name	형식	Description
errorCode	string	오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
message	string	사용자가 읽을 수 있는 오류 표현입니다.
relatedResource	ErrorRelatedResource	오류 관련 리소스 세부 정보입니다.

GraphQLApi

Object

GraphQL 항목에 대한 API입니다.

Name	형식	Description
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 정의를 참조하세요.

Name	형식	Description
format	string	항목 정의의 형식입니다.
parts	GraphQLApiPublicDefinitionPart[]	정의 부분 목록입니다.

GraphQLApiPublicDefinitionPart

Object

GraphQL 정의 파트 개체에 대한 API입니다.

Name	형식	Description
path	string	GraphQL용 API 정의 부분 경로입니다.
payload	string	GraphQL 정의 파트 페이로드용 API입니다.
payloadType	PayloadType	페이로드 형식입니다.

ItemTag

Object

항목에 적용된 태그를 나타냅니다.

Name	형식	Description
displayName	string	태그의 이름입니다.
id	string (uuid)	태그 ID입니다.

ItemType

열거형

항목의 형식입니다. 추가 항목 유형은 시간이 지남에 따라 추가될 수 있습니다.

값	Description
Dashboard	PowerBI 대시보드.
Report	PowerBI 보고서입니다.
SemanticModel	PowerBI 의미 체계 모델입니다.
PaginatedReport	PowerBI 페이지를 매긴 보고서입니다.
Datamart	PowerBI datamart.
Lakehouse	레이크 하우스.
Eventhouse	이벤트 하우스.
Environment	환경입니다.
KQLDatabase	KQL 데이터베이스입니다.
KQLQueryset	KQL 쿼리 세트입니다.
KQLDashboard	KQL 대시보드.
DataPipeline	데이터 파이프라인입니다.
Notebook	전자 필기장입니다.
SparkJobDefinition	Spark 작업 정의입니다.
MLExperiment	기계 학습 실험입니다.
MLModel	기계 학습 모델입니다.
Warehouse	창고.
Eventstream	eventstream입니다.
SQLEndpoint	SQL 엔드포인트입니다.
MirroredWarehouse	미러된 창고입니다.
MirroredDatabase	미러된 데이터베이스입니다.
Reflex	반사.
GraphQLApi	GraphQL 항목에 대한 API입니다.
MountedDataFactory	MountedDataFactory입니다.
SQLDatabase	SQLDatabase입니다.
CopyJob	복사 작업입니다.
VariableLibrary	VariableLibrary입니다.
Dataflow	데이터 흐름입니다.
ApacheAirflowJob	ApacheAirflowJob입니다.
WarehouseSnapshot	웨어하우스 스냅샷.
DigitalTwinBuilder	DigitalTwinBuilder입니다.
DigitalTwinBuilderFlow	디지털 트윈 빌더 흐름입니다.
MirroredAzureDatabricksCatalog	미러된 Azure Databricks 카탈로그입니다.
Map	지도입니다.
AnomalyDetector	Anomaly Detector입니다.
UserDataFunction	사용자 데이터 함수입니다.
GraphModel	GraphModel입니다.
GraphQuerySet	Graph QuerySet입니다.
SnowflakeDatabase	Snowflake 계정에서 만든 빙산 테이블을 저장하는 Snowflake 데이터베이스입니다.
OperationsAgent	OperationsAgent입니다.
CosmosDBDatabase	Cosmos DB 데이터베이스입니다.

PayloadType

열거형

정의 파트 페이로드의 형식입니다. 추가 페이로드 유형은 시간이 지남에 따라 추가될 수 있습니다.

값	Description
InlineBase64	인라인 베이스 64.

다음을 통해 공유

Items - Create GraphQLApi

권한을

필요한 위임된 범위

제한

Microsoft Entra 지원 ID

인터페이스

URI 매개 변수

요청 본문

응답

예제

Create a API for GraphQL example

샘플 요청

샘플 응답

Create a GraphQLApi with public definition example

샘플 요청

샘플 응답

정의

CreateGraphQLApiRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphQLApi

GraphQLApiPublicDefinition

GraphQLApiPublicDefinitionPart

ItemTag

ItemType

PayloadType