Items - Get User Data Function Definition

Servizio:: UserDataFunction

Versione API:: v1

Restituisce la definizione pubblica UserDataFunction specificata.
Questa API supporta operazioni con esecuzione prolungata (LRO).

Quando si ottiene la definizione pubblica di UserDataFunction, l'etichetta di riservatezza non fa parte della definizione.

Permissions

Il chiamante deve disporre delle autorizzazioni di lettura e scrittura per UserDataFunction.

Ambiti delegati obbligatori

Elemento.LeggiScrivi.Tutto

Microsoft Entra identità supportate

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità	Support
User	Yes
Principale del servizio e Identità gestite	NO

Interfaccia

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
userDataFunctionId	path	True	string (uuid)	ID UserDataFunction.
workspaceId	path	True	string (uuid)	L’ID dell’area di lavoro.
format	query		string	Formato della definizione pubblica UserDataFunction.

Risposte

Nome	Tipo	Descrizione
200 OK	UserDataFunctionDefinitionResponse	Richiesta completata correttamente.
202 Accepted		Richiesta accettata. Il recupero della definizione è in corso. Intestazioni Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione `Retry-After` che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive. Intestazioni Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: OperationNotSupportedForItem: operazione non supportata per l'elemento richiesto.

Esempio

Get a UserDataFunction public definition example

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 200

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

Codice di stato:: 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

Definizioni

Nome	Descrizione
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
PayloadType	Tipo del payload della parte di definizione. È possibile aggiungere altri tipi di payload nel tempo.
UserDataFunctionDefinitionResponse	Risposta di definizione pubblica UserDataFunction.
UserDataFunctionPublicDefinition	Oggetto definizione pubblica UserDataFunction. Per altre informazioni sulla struttura della definizione UserDataFunction, vedere questo articolo .
UserDataFunctionPublicDefinitionPart	Oggetto parte definizione UserDataFunction.

ErrorRelatedResource

Oggetto

Oggetto dettagli risorsa correlato all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Oggetto

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
isRetriable	boolean	Se true, la richiesta può essere ritentata. Usare l'intestazione della `Retry-After` risposta per determinare il ritardo, se disponibile.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string (uuid)	ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

PayloadType

Enumerazione

Tipo del payload della parte di definizione. È possibile aggiungere altri tipi di payload nel tempo.

Valore	Descrizione
InlineBase64	Inline Base 64.

UserDataFunctionDefinitionResponse

Oggetto

Risposta di definizione pubblica UserDataFunction.

Nome	Tipo	Descrizione
definition	UserDataFunctionPublicDefinition	Oggetto definizione pubblica UserDataFunction. Per altre informazioni sulla struttura della definizione UserDataFunction, vedere questo articolo .

UserDataFunctionPublicDefinition

Oggetto

Oggetto definizione pubblica UserDataFunction. Per altre informazioni sulla struttura della definizione UserDataFunction, vedere questo articolo .

Nome	Tipo	Descrizione
format	string	Formato della definizione della funzione dati utente.
parts	UserDataFunctionPublicDefinitionPart[]	Elenco di parti di definizione.

UserDataFunctionPublicDefinitionPart

Oggetto

Oggetto parte definizione UserDataFunction.

Nome	Tipo	Descrizione
path	string	Percorso della parte della definizione pubblica UserDataFunction.
payload	string	Payload della parte di definizione pubblica UserDataFunction.
payloadType	PayloadType	Tipo di payload.