Items - Create Reflex

Služba:: Reflex

Verze rozhraní API:: v1

Vytvoří Reflex v zadaném pracovním prostoru.
Toto rozhraní API podporuje dlouhotrvajících operací (LRO).

Pokud chcete vytvořit poznámkový blok s definicí, přečtěte si článku o definici Reflexu.

Dovolení

Volající musí mít roli pracovního prostoru přispěvatele .

Požadované delegovaná rozsahy

Reflex.ReadWrite.All nebo Item.ReadWrite.All

Omezení

Pokud chcete vytvořit Reflex, musí být pracovní prostor v podporované kapacitě prostředků infrastruktury. Další informace naleznete v tématu: typy licencí Microsoft Fabric.

Podporované identity Microsoft Entra

Toto rozhraní API podporuje identity Microsoft uvedené v této části.

Identita	Podpora
Uživatel	Ano
instančního objektu a spravované identity	Ano

Rozhraní

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
workspaceId	path	True	string (uuid)	ID pracovního prostoru.

Text požadavku

Name	Vyžadováno	Typ	Description
displayName	True	string	Zobrazovaný název Reflexu. Zobrazovaný název musí odpovídat pravidlům pojmenování podle typu položky.
definition		ReflexDefinition	Definice reflexní veřejnosti.
description		string	Popis Reflexu. Maximální délka je 256 znaků.
folderId		string (uuid)	ID složky. Pokud není zadána nebo null, reflex se vytvoří s pracovním prostorem jako jeho složkou.

Odpovědi

Name	Typ	Description
201 Created	Reflex	Úspěšně vytvořeno
202 Accepted		Žádost byla přijata, probíhá zřizování poznámkového bloku. Hlavičky Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Běžné kódy chyb: InvalidItemType – Typ položky je neplatný. ItemDisplayNameAlreadyInUse – Zobrazovaný název položky je již použit. Poškozená částPayload – zadanou datovou část je poškozena. WorkspaceItemsLimitExceededed – Došlo k překročení limitu položek pracovního prostoru.

Name

Typ

Description

201 Created

Reflex

Úspěšně vytvořeno

202 Accepted

Žádost byla přijata, probíhá zřizování poznámkového bloku.

Hlavičky

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

Other Status Codes

ErrorResponse

Běžné kódy chyb:

InvalidItemType – Typ položky je neplatný.
ItemDisplayNameAlreadyInUse – Zobrazovaný název položky je již použit.
Poškozená částPayload – zadanou datovou část je poškozena.
WorkspaceItemsLimitExceededed – Došlo k překročení limitu položek pracovního prostoru.

Příklady

Create a Reflex example

Create a Reflex with public definition example

Create a Reflex example

Ukázkový požadavek

HTTP

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

{
  "displayName": "Reflex 1",
  "description": "A Reflex description."
}

Ukázková odpověď

Stavový kód:: 201

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

Stavový kód:: 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 Reflex with public definition example

Ukázkový požadavek

HTTP

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

{
  "displayName": "Reflex 1",
  "description": "A Reflex description",
  "definition": {
    "format": "json",
    "parts": [
      {
        "path": "ReflexEntities.json",
        "payload": "eyJuYmZvcm1hdCI6N..5ndWUiOiJweXRob24ifX19",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Ukázková odpověď

Stavový kód:: 201

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

Stavový kód:: 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

Definice

Name	Description
CreateReflexRequest	Vytvoření datové části žádosti Reflex
ErrorRelatedResource	Chyba související s objektem podrobností o prostředku.
ErrorResponse	Odpověď na chybu.
ErrorResponseDetails	Podrobnosti o odpovědi na chybu.
ItemTag	Představuje značku použitou u položky.
ItemType	Typ položky. V průběhu času je možné přidat další typy položek.
PayloadType	Typ datové části definice. V průběhu času je možné přidat další typy datových částí.
Reflex	Reflexní objekt.
ReflexDefinition	Objekt reflexní veřejné definice. Další podrobnosti o vytvoření veřejné definice Reflexu najdete v tomto článku.
ReflexDefinitionPart	Objekt části definice reflexu.

CreateReflexRequest

Objekt

Vytvoření datové části žádosti Reflex

Name	Typ	Description
definition	ReflexDefinition	Definice reflexní veřejnosti.
description	string	Popis Reflexu. Maximální délka je 256 znaků.
displayName	string	Zobrazovaný název Reflexu. Zobrazovaný název musí odpovídat pravidlům pojmenování podle typu položky.
folderId	string (uuid)	ID složky. Pokud není zadána nebo null, reflex se vytvoří s pracovním prostorem jako jeho složkou.

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Name	Typ	Description
resourceId	string	ID prostředku, které je součástí chyby.
resourceType	string	Typ prostředku, který je součástí chyby.

ErrorResponse

Objekt

Odpověď na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
moreDetails	ErrorResponseDetails[]	Seznam dalších podrobností o chybě
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou
requestId	string	ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou

ItemTag

Objekt

Představuje značku použitou u položky.

Name	Typ	Description
displayName	string	Název značky.
id	string (uuid)	ID značky.

ItemType

Výčet

Typ položky. V průběhu času je možné přidat další typy položek.

Hodnota	Description
ApacheAirflowJob	An ApacheAirflowJob.
CopyJob	Úloha kopírování.
Dashboard	Řídicí panel PowerBI
DataPipeline	Datový kanál.
Dataflow	Tok dat.
Datamart	Datový diagram PowerBI
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Tok digitálního dvojčete.
Environment	Prostředí.
Eventhouse	Eventhouse.
Eventstream	Eventstream.
GraphQLApi	Rozhraní API pro položku GraphQL
KQLDashboard	Řídicí panel KQL.
KQLDatabase	Databáze KQL.
KQLQueryset	Sada dotazů KQL.
Lakehouse	Jezero.
MLExperiment	Experiment strojového učení.
MLModel	Model strojového učení.
MirroredAzureDatabricksCatalog	Zrcadlený katalog Azure Databricks.
MirroredDatabase	Zrcadlené databáze.
MirroredWarehouse	Zrcadlený sklad.
MountedDataFactory	A MountedDataFactory.
Notebook	Poznámkový blok.
PaginatedReport	Stránkovaná sestava PowerBI
Reflex	A Reflex.
Report	Sestava PowerBI
SQLDatabase	Databáze SQLDatabase.
SQLEndpoint	Koncový bod SQL.
SemanticModel	Sémantický model PowerBI
SparkJobDefinition	Definice úlohy Sparku.
VariableLibrary	ProměnnáLibrary.
Warehouse	Sklad.
WarehouseSnapshot	Snímek skladu.

PayloadType

Výčet

Typ datové části definice. V průběhu času je možné přidat další typy datových částí.

Hodnota	Description
InlineBase64	Vložená základna 64.

Reflex

Objekt

Reflexní objekt.

Name	Typ	Description
description	string	Popis položky.
displayName	string	Zobrazovaný název položky.
folderId	string (uuid)	ID složky.
id	string (uuid)	ID položky.
tags	ItemTag[]	Seznam použitých značek
type	ItemType	Typ položky.
workspaceId	string (uuid)	ID pracovního prostoru.

ReflexDefinition

Objekt

Objekt reflexní veřejné definice. Další podrobnosti o vytvoření veřejné definice Reflexu najdete v tomto článku.

Name	Typ	Description
format	string	Formát definice položky. Podporovaný formát: `json`.
parts	ReflexDefinitionPart[]	Seznam částí definice.

ReflexDefinitionPart

Objekt

Objekt části definice reflexu.

Name	Typ	Description
path	string	Cesta části veřejné definice Reflexu.
payload	string	Datová část veřejné definice Reflexu.
payloadType	PayloadType	Typ datové části.

Sdílet prostřednictvím

Items - Create Reflex

Dovolení

Požadované delegovaná rozsahy

Omezení

Podporované identity Microsoft Entra

Rozhraní

Parametry identifikátoru URI

Text požadavku

Odpovědi

Příklady

Create a Reflex example

Ukázkový požadavek

Ukázková odpověď

Create a Reflex with public definition example

Ukázkový požadavek

Ukázková odpověď

Definice

CreateReflexRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PayloadType

Reflex

ReflexDefinition

ReflexDefinitionPart