Poznámka
Na prístup k tejto stránke sa vyžaduje oprávnenie. Môžete sa skúsiť prihlásiť alebo zmeniť adresáre.
Na prístup k tejto stránke sa vyžaduje oprávnenie. Môžete skúsiť zmeniť adresáre.
Rozhrania Microsoft Fabric REST API sú navrhnuté tak, aby vývojárom pomohli s automatizáciou služby Fabric. Referenčné stránky k rozhraniu REST API služby Fabric (dokumentácia) sú štruktúrované tak, aby vývojárom pomohli nájsť potrebné informácie.
Referenčné stránky sú rozdelené do dvoch hlavných sekcií:
Základné rozhrania API – základné rozhrania API poskytujú informácie a funkcie pre všetky položky v rámci služby Microsoft Fabric. Základné rozhrania API nie sú špecifické pre jedno vyťaženie a môžu sa používať vo všetkých vyťaženiach. Základné rozhrania API sú rozhrania API na vytváranie, čítanie, aktualizáciu a odstraňovanie. Môžete ich použiť na vytváranie alebo aktualizáciu položiek služby Fabric spolu s ich bežnými vlastnosťami. Základné rozhrania API možno použiť pri vykonávaní hromadných operácií, ktoré nenúti manipuláciu so žiadnou vlastnosťou špecifickou pre konkrétny typ položky.
Rozhrania API vyťaženia – rozhrania API vyťaženia sa zameriavajú na konkrétny typ položky v službe Fabric.
Sekcie core a workload reference page obsahujú zoznam všetkých rozhraní API abecedne. Každá sekcia obsahuje prehľad, ktorý obsahuje zoznam všetkých rozhraní API v sekcii a abecedný zoznam rozhraní API v tejto sekcii.
Položka špecifická pre položku
V sekcii konkrétnej položky sa podrobne uvádzajú podrobnosti jednotlivých typov položiek v službe Fabric. Každá položka typu položky obsahuje:
Prehľad: Stručný popis typu položky.
Koncové body: Zoznamy dostupných koncových bodov pre typ položky spolu s podrobnosťami o parametroch, formátoch požiadavky a odpovede a príkladoch.
Modely: Definuje dátový model pre typ položky, pričom špecifikuje vlastnosti a typy.
Akcie: Uvádza dostupné akcie pre typ položky vrátane podrobností o parametroch, formátoch požiadavky a odpovede a príkladoch.
Položka špecifická pre položku sa používa na pochopenie jedinečných aspektov rozhrania API súvisiacich s konkrétnym typom položky a pokyny na vykonávanie operácií súvisiacich s týmto typom položky.
Štruktúra referenčnej strany
Každá referenčná stránka má nasledujúce časti:
Prehľad – krátky odsek v hornej časti článku, ktorý popisuje rozhranie API.
Povolenia – zoznam povolení používateľa potrebných na volanie rozhrania API.
Požadovaný rozsah – zoznam povolení (známych aj ako rozsahy), ktoré vyžaduje rozhranie API.
Obmedzenia – (voliteľné) Zoznam obmedzení pre rozhranie API.
Interface – zobrazí formulár HTTP rozhrania API.
Parametre URI – zoznam parametrov používaných na identifikáciu konkrétneho zdroja alebo zdrojov.
Text požiadavky – zoznam vlastností, ktoré možno odovzdať do rozhrania API.
Odpovede – zoznam možných odpovedí z rozhrania API.
Príklady – zoznam príkladov, ktoré zobrazujú, ako používať rozhranie API.
Definície – parametre, ktoré definujú štruktúru a vlastnosti objektu, ktorý možno odovzdať do rozhrania API.
Nová referenčná štruktúra dokumentácie rozhrania API je určená na poskytovanie jasného a konzistentného spôsobu prístupu k informáciám a používania informácií o rozhraní API. Rozdelením časti CORE a položky konkrétnej položky chceme vývojárom uľahčiť vyhľadávanie a používanie informácií potrebných na integráciu so službou Microsoft Fabric.
Uvítame vaše pripomienky a návrhy, ako zlepšiť dokumentáciu a rozhranie API.