Items - Get User Data Function Definition

Služba:: UserDataFunction

Verzia rozhrania API:: v1

Vráti zadanú verejnú definíciu UserDataFunction.
Toto rozhranie API podporuje dlhotrvajúce operácie (LRO).

Keď sa zobrazí verejná definícia funkcie UserDataFunction, označenie citlivosti nie je súčasťou definície.

Povolenia

Volajúci musí mať povolenia na čítanie a zapisovanie pre funkciu UserDataFunction.

Povinné delegované rozsahy

Item.ReadWrite.All

podporované identity Microsoft Entra

Toto rozhranie API podporuje identity Microsoft uvedené v tejto časti.

Identita	Podporovať
Používateľ	Áno
Objekt služby a spravované identity	Nie

Rozhranie

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/userDataFunctions/{userDataFunctionId}/getDefinition

S voliteľnými parametrami:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/userDataFunctions/{userDataFunctionId}/getDefinition?format={format}

Parametre URI

Name	V	Povinné	Typ	Description
userDataFunctionId	path	True	string (uuid)	ID userDataFunction.
workspaceId	path	True	string (uuid)	ID pracovného priestoru.
format	query		string	Formát verejnej definície UserDataFunction.

Odpovede

Name	Typ	Description
200 OK	UserDataFunctionDefinitionResponse	Požiadavka sa úspešne dokončila.
202 Accepted		Žiadosť prijatá. Načítanie definície prebieha. Hlavičky Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Prekročil sa limit rýchlosti služby. Server vráti hlavičku `Retry-After` v sekundách, ako dlho musí klient počkať, kým odošle ďalšie požiadavky. Hlavičky Retry-After: integer
Other Status Codes	ErrorResponse	Bežné kódy chýb: OperationNotSupportedForItem – Operácia nie je podporovaná pre požadovanú položku.

Príklady

Get a UserDataFunction public definition example

Vzorová požiadavka

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/userDataFunctions/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Vzorová odpoveď

Kód stavu:: 200

{
  "definition": {
    "parts": [
      {
        "path": "UserDataFunctionV1.json",
        "payload": "ew0KICAiZXhlY3V0YW..OWRmNDhhY2ZmZTgifQ",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Kód stavu:: 202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Definície

Name	Description
ErrorRelatedResource	Objekt s podrobnosťami o zdroji súvisiacej s chybou.
ErrorResponse	Odpoveď na chybu.
ErrorResponseDetails	Podrobnosti o chybovej odpovedi.
PayloadType	Typ údajovej časti definície. V priebehu času je možné pridať ďalšie typy údajovej časti.
UserDataFunctionDefinitionResponse	Odpoveď verejnej definície UserDataFunction.
UserDataFunctionPublicDefinition	Objekt verejnej definície UserDataFunction. Ďalšie podrobnosti o štruktúre definície userDataFunction nájdete v tomto článku .
UserDataFunctionPublicDefinitionPart	Časť objektu definície UserDataFunction.

ErrorRelatedResource

Object

Objekt s podrobnosťami o zdroji súvisiacej s chybou.

Name	Typ	Description
resourceId	string	ID prostriedku, ktoré je súčasťou chyby.
resourceType	string	Typ prostriedku, ktorý je zapojený do chyby.

ErrorResponse

Object

Odpoveď na chybu.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
isRetriable	boolean	Ak je hodnota true, žiadosť sa môže zopakovať. `Retry-After` Ak je k dispozícii, oneskorenie môžete určiť pomocou hlavičky odpovede.
message	string	Zobrazenie chyby čitateľné ľuďmi.
moreDetails	ErrorResponseDetails[]	Zoznam ďalších podrobností o chybe.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.
requestId	string (uuid)	ID požiadavky súvisiacej s chybou.

ErrorResponseDetails

Object

Podrobnosti o chybovej odpovedi.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message	string	Zobrazenie chyby čitateľné ľuďmi.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.

PayloadType

Enumerácia

Typ údajovej časti definície. V priebehu času je možné pridať ďalšie typy údajovej časti.

Hodnota	Description
InlineBase64	Inline Base 64.

UserDataFunctionDefinitionResponse

Object

Odpoveď verejnej definície UserDataFunction.

Name	Typ	Description
definition	UserDataFunctionPublicDefinition	Objekt verejnej definície UserDataFunction. Ďalšie podrobnosti o štruktúre definície userDataFunction nájdete v tomto článku .

UserDataFunctionPublicDefinition

Object

Objekt verejnej definície UserDataFunction. Ďalšie podrobnosti o štruktúre definície userDataFunction nájdete v tomto článku .

Name	Typ	Description
format	string	Formát definície údajovej funkcie používateľa.
parts	UserDataFunctionPublicDefinitionPart[]	Zoznam častí definície.

UserDataFunctionPublicDefinitionPart

Object

Časť objektu definície UserDataFunction.

Name	Typ	Description
path	string	Cesta k verejnej definícii UserDataFunction.
payload	string	Údajová časť údajovej časti funkcie UserDataFunction.
payloadType	PayloadType	Typ údajovej časti.