Items - Create Digital Twin Builder

Usługa:: DigitalTwinBuilder

Wersja interfejsu API:: v1

Uwaga / Notatka

Ten interfejs API jest w wersji zapoznawczej.

Tworzy obiekt DigitalTwinBuilder w określonym obszarze roboczym.
Ten interfejs API obsługuje długotrwałych operacji (LRO).

Aby utworzyć element digitaltwinbuilder z definicją, zapoznaj się z definicją DigitalTwinBuilder.

Uprawnienia

Obiekt wywołujący musi mieć rolę obszaru roboczego współautora .

Wymagane zakresy delegowane

DigitalTwinBuilder.ReadWrite.All lub Item.ReadWrite.All

Ograniczenia

Aby utworzyć element digitaltwinbuilder, obszar roboczy musi znajdować się w obsługiwanej pojemności sieci szkieletowej. Aby uzyskać więcej informacji, zobacz: typy licencji usługi Microsoft Fabric.

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Tożsamość	Wsparcie
Użytkownik	Tak
Główne usługi i Tożsamości zarządzane	Nie.

Interfejs

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.

Treść żądania

Nazwa	Wymagane	Typ	Opis
displayName	True	string	Nazwa wyświetlana elementu digitaltwinbuilder. Nazwa wyświetlana musi być zgodna z regułami nazewnictwa zgodnie z typem elementu, tj. Powinna zaczynać się od litery, zawiera tylko cyfry i litery lub _ i jest mniejsza niż 100.
definition		DigitalTwinBuilderDefinition	Definicja publiczna DigitalTwinBuilder.
description		string	Opis elementu digitaltwinbuilder. Maksymalna długość to 256 znaków.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	DigitalTwinBuilder	Pomyślnie utworzono
202 Accepted		Żądanie zaakceptowane, aprowizowanie aplikacji digitaltwinbuilder w toku Nagłówki Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: InvalidItemType — typ elementu jest nieprawidłowy ItemDisplayNameAlreadyInUse — nazwa wyświetlana elementu jest już używana. CorruptedPayload — podany ładunek jest uszkodzony. WorkspaceItemsLimitExceeded — przekroczono limit elementu obszaru roboczego.

Nazwa

Typ

Opis

201 Created

DigitalTwinBuilder

Pomyślnie utworzono

202 Accepted

Żądanie zaakceptowane, aprowizowanie aplikacji digitaltwinbuilder w toku

Nagłówki

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

Other Status Codes

ErrorResponse

Typowe kody błędów:

InvalidItemType — typ elementu jest nieprawidłowy
ItemDisplayNameAlreadyInUse — nazwa wyświetlana elementu jest już używana.
CorruptedPayload — podany ładunek jest uszkodzony.
WorkspaceItemsLimitExceeded — przekroczono limit elementu obszaru roboczego.

Przykłady

Create a digitaltwinbuilder example

Create a digitaltwinbuilder with public definition example

Create a digitaltwinbuilder example

Przykładowe żądanie

HTTP

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

{
  "displayName": "DigitalTwinBuilder 1",
  "description": "A digitaltwinbuilder description."
}

Przykładowa odpowiedź

Kod stanu:: 201

{
  "displayName": "DigitalTwinBuilder 1",
  "description": "A digitaltwinbuilder description.",
  "type": "DigitalTwinBuilder",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Kod stanu:: 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 digitaltwinbuilder with public definition example

Przykładowe żądanie

HTTP

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

{
  "displayName": "DigitalTwinBuilder_1",
  "description": "An digitaltwinbuilder description.",
  "definition": {
    "parts": [
      {
        "path": "definition.json",
        "payload": "ew0KICAibGFrZWhvdXNlSWQiOiAiYjliNWQzNmYtNDQ0NS00MDNiLWFjODctMDE2YjFjZDIwMjExIg0KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Przykładowa odpowiedź

Kod stanu:: 201

{
  "displayName": "DigitalTwinBuilder_1",
  "description": "An digitaltwinbuilder description.",
  "type": "DigitalTwinBuilder",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047655"
}

Kod stanu:: 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

Definicje

Nazwa	Opis
CreateDigitalTwinBuilderRequest	Utwórz ładunek żądania digitaltwinbuilder.
DigitalTwinBuilder	Obiekt digitaltwinbuilder.
DigitalTwinBuilderDefinition	Obiekt definicji publicznej DigitalTwinBuilder.
DigitalTwinBuilderDefinitionPart	Obiekt części definicji DigitalTwinBuilder.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
ItemTag	Reprezentuje tag zastosowany w elemencie.
ItemType	Typ elementu. Dodatkowe typy elementów można dodawać w czasie.
PayloadType	Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.

CreateDigitalTwinBuilderRequest

Objekt

Utwórz ładunek żądania digitaltwinbuilder.

Nazwa	Typ	Opis
definition	DigitalTwinBuilderDefinition	Definicja publiczna DigitalTwinBuilder.
description	string	Opis elementu digitaltwinbuilder. Maksymalna długość to 256 znaków.
displayName	string	Nazwa wyświetlana elementu digitaltwinbuilder. Nazwa wyświetlana musi być zgodna z regułami nazewnictwa zgodnie z typem elementu, tj. Powinna zaczynać się od litery, zawiera tylko cyfry i litery lub _ i jest mniejsza niż 100.

DigitalTwinBuilder

Objekt

Obiekt digitaltwinbuilder.

Nazwa	Typ	Opis
description	string	Opis elementu.
displayName	string	Nazwa wyświetlana elementu.
folderId	string (uuid)	Identyfikator folderu.
id	string (uuid)	Identyfikator elementu.
tags	ItemTag[]	Lista zastosowanych tagów.
type	ItemType	Typ elementu.
workspaceId	string (uuid)	Identyfikator przestrzeni roboczej.

DigitalTwinBuilderDefinition

Objekt

Obiekt definicji publicznej DigitalTwinBuilder.

Nazwa	Typ	Opis
format	string	Format definicji elementu.
parts	DigitalTwinBuilderDefinitionPart[]	Lista części definicji.

DigitalTwinBuilderDefinitionPart

Objekt

Obiekt części definicji DigitalTwinBuilder.

Nazwa	Typ	Opis
path	string	Ścieżka części DigitalTwinBuilder.
payload	string	Ładunek części DigitalTwinBuilder.
payloadType	PayloadType	Typ ładunku.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType	string	Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

ItemTag

Objekt

Reprezentuje tag zastosowany w elemencie.

Nazwa	Typ	Opis
displayName	string	Nazwa znacznika.
id	string (uuid)	Identyfikator tagu.

ItemType

Wyliczanie

Typ elementu. Dodatkowe typy elementów można dodawać w czasie.

Wartość	Opis
ApacheAirflowJob	Zadanie ApacheAirflowJob.
CopyJob	Zadanie kopiowania.
Dashboard	Pulpit nawigacyjny usługi Power BI.
DataPipeline	Potok danych.
Dataflow	Przepływ danych.
Datamart	Datamart usługi Power BI.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Przepływ usługi Digital Twin Builder.
Environment	Środowisko.
Eventhouse	Magazyn zdarzeń.
Eventstream	Strumień zdarzeń.
GraphQLApi	Interfejs API dla elementu GraphQL.
KQLDashboard	Pulpit nawigacyjny KQL.
KQLDatabase	Baza danych KQL.
KQLQueryset	Zestaw zapytań KQL.
Lakehouse	Jezioro.
MLExperiment	Eksperyment uczenia maszynowego.
MLModel	Model uczenia maszynowego.
MirroredAzureDatabricksCatalog	Dublowany wykaz usługi Azure Databricks.
MirroredDatabase	Dublowana baza danych.
MirroredWarehouse	Dublowany magazyn.
MountedDataFactory	A MountedDataFactory.
Notebook	Zeszyt.
PaginatedReport	Raport podzielony na strony usługi PowerBI.
Reflex	Refleks.
Report	Raport usługi Power BI.
SQLDatabase	Baza danych SQLDatabase.
SQLEndpoint	Punkt końcowy SQL.
SemanticModel	Model semantyczny usługi PowerBI.
SparkJobDefinition	Definicja zadania platformy Spark.
VariableLibrary	ZmiennaLibrary.
Warehouse	Magazyn.
WarehouseSnapshot	Migawka magazynu.

PayloadType

Wyliczanie

Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.

Wartość	Opis
InlineBase64	Śródliniowa baza 64.

Udostępnij za pośrednictwem

Items - Create Digital Twin Builder

Uprawnienia

Wymagane zakresy delegowane

Ograniczenia

Tożsamości obsługiwane przez Microsoft Entra

Interfejs

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Przykłady

Create a digitaltwinbuilder example

Przykładowe żądanie

Przykładowa odpowiedź

Create a digitaltwinbuilder with public definition example

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

CreateDigitalTwinBuilderRequest

DigitalTwinBuilder

DigitalTwinBuilderDefinition

DigitalTwinBuilderDefinitionPart

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PayloadType