Items - Update User Data Function Definition

Tjeneste:: UserDataFunction

API-versjon:: v1

Overstyrer definisjonen for den angitte UserDataFunction.
Denne API-en støtter langvarige operasjoner (LRO).

Oppdatering av userdatafunksjonsdefinisjonen påvirker ikke følsomhetsetiketten.

Tillatelser

Innringeren må ha lese- og skrivetillatelser for UserDataFunction.

Nødvendige delegerte omfang

Item.ReadWrite.All

Microsoft Entra støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identity	Støtte
Bruker	Ja
tjenestekontohaver og administrerte identiteter	Nei

Grensesnitt

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

Med valgfrie parametere:

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

URI-parametere

Navn	I	Obligatorisk	Type	Beskrivelse
userDataFunctionId	path	True	string (uuid)	UserDataFunction-ID-en.
workspaceId	path	True	string (uuid)	Arbeidsområde-ID-en.
updateMetadata	query		boolean	Når satt til sann og .platform-filen er angitt som en del av definisjonen, oppdateres elementets metadata ved hjelp av metadataene i .platform-filen

Brødtekst for forespørsel

Navn	Obligatorisk	Type	Beskrivelse
definition	True	UserDataFunctionPublicDefinition	Offentlig definisjonsobjekt for UserDataFunction. Se denne artikkelen for mer informasjon om strukturen i UserDataFunction-definisjonen.

Svar

Navn	Type	Beskrivelse
200 OK		Forespørselen er fullført.
202 Accepted		Forespørselen er godtatt. Oppdateringsdefinisjonen pågår. Overskrifter Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Grensen for tjenestesats ble overskredet. Serveren returnerer en `Retry-After` topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler. Overskrifter Retry-After: integer
Other Status Codes	ErrorResponse	Vanlige feilkoder: OperationNotSupportedForItem – operasjonen støttes ikke for forespurt element. CorruptedPayload – den angitte nyttelasten er skadet.

Eksempler

Update a UserDataFunction public definition example

Eksempelforespørsel

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/userDataFunctions/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

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

Eksempelsvar

Statuskode:: 200

Statuskode:: 202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Definisjoner

Navn	Beskrivelse
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
PayloadType	Typen nyttelast for definisjonsdelen. Flere nyttelasttyper kan legges til over tid.
UpdateUserDataFunctionDefinitionRequest	Oppdater payload for den offentlige definisjonsforespørselen userDataFunction.
UserDataFunctionPublicDefinition	Offentlig definisjonsobjekt for UserDataFunction. Se denne artikkelen for mer informasjon om strukturen i UserDataFunction-definisjonen.
UserDataFunctionPublicDefinitionPart	UserDataFunction-definisjonsdelobjekt.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Navn	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
isRetriable	boolean	Når sann, kan forespørselen prøves på nytt. `Retry-After` Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string (uuid)	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

PayloadType

Opplisting

Typen nyttelast for definisjonsdelen. Flere nyttelasttyper kan legges til over tid.

Verdi	Beskrivelse
InlineBase64	Innebygd grunntall 64.

UpdateUserDataFunctionDefinitionRequest

Objekt

Oppdater payload for den offentlige definisjonsforespørselen userDataFunction.

Navn	Type	Beskrivelse
definition	UserDataFunctionPublicDefinition	Offentlig definisjonsobjekt for UserDataFunction. Se denne artikkelen for mer informasjon om strukturen i UserDataFunction-definisjonen.

UserDataFunctionPublicDefinition

Objekt

Offentlig definisjonsobjekt for UserDataFunction. Se denne artikkelen for mer informasjon om strukturen i UserDataFunction-definisjonen.

Navn	Type	Beskrivelse
format	string	Formatet for definisjonen av brukerdatafunksjonen.
parts	UserDataFunctionPublicDefinitionPart[]	En liste over definisjonsdeler.

UserDataFunctionPublicDefinitionPart

Objekt

UserDataFunction-definisjonsdelobjekt.

Navn	Type	Beskrivelse
path	string	Den offentlige definisjonsdelbanen UserDataFunction.
payload	string	Den offentlige definisjonsdelen For UserDataFunction- delnyttelast.
payloadType	PayloadType	Nyttelasttypen.