Items - Update User Data Function Definition

Tjeneste:: UserDataFunction

API-version:: v1

Tilsidesætter definitionen for den angivne UserDataFunction.
Denne API understøtter LRO-handlinger (Long Running Operations).

Opdatering af UserDataFunctions definition påvirker ikke følsomhedsmærkaten.

Tilladelser

Kalderen skal have læse- og skrivetilladelser til UserDataFunction.

Påkrævede delegerede områder

Item.ReadWrite.All

Microsoft Entra understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identity	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Nej

Grænseflade

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

Med valgfrie parametre:

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

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
userDataFunctionId	path	True	string (uuid)	UserDataFunction-id'et.
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.
updateMetadata	query		boolean	Når den er angivet til true, og .platform-filen er angivet som en del af definitionen, opdateres elementets metadata ved hjælp af metadataene i .platform-filen

Brødtekst for anmodning

Name	Påkrævet	Type	Beskrivelse
definition	True	UserDataFunctionPublicDefinition	Det offentlige definitionsobjekt UserDataFunction. Se denne artikel for at få flere oplysninger om strukturen i UserDataFunction-definitionen.

Svar

Name	Type	Beskrivelse
200 OK		Anmodningen blev fuldført.
202 Accepted		Anmodningen blev accepteret. Opdateringsdefinitionen er i gang. Headere Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en `Retry-After` header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: OperationNotSupportedForItem – Handlingen understøttes ikke for det ønskede element. CorruptedPayload – Den angivne nyttedata er beskadiget.

Eksempler

Update a UserDataFunction public definition example

Eksempelanmodning

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

Definitioner

Name	Beskrivelse
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
PayloadType	Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.
UpdateUserDataFunctionDefinitionRequest	Opdater nyttedata for userDataFunction for anmodning om offentlig definition.
UserDataFunctionPublicDefinition	Det offentlige definitionsobjekt UserDataFunction. Se denne artikel for at få flere oplysninger om strukturen i UserDataFunction-definitionen.
UserDataFunctionPublicDefinitionPart	UserDataFunction-definitionsdelsobjekt.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
isRetriable	boolean	Når sand, kan anmodningen prøves igen. Brug svarheaderen `Retry-After` til at bestemme forsinkelsen, hvis den er tilgængelig.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

PayloadType

Optælling

Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.

Værdi	Beskrivelse
InlineBase64	Indbygget grundlinje 64.

UpdateUserDataFunctionDefinitionRequest

Objekt

Opdater nyttedata for userDataFunction for anmodning om offentlig definition.

Name	Type	Beskrivelse
definition	UserDataFunctionPublicDefinition	Det offentlige definitionsobjekt UserDataFunction. Se denne artikel for at få flere oplysninger om strukturen i UserDataFunction-definitionen.

UserDataFunctionPublicDefinition

Objekt

Det offentlige definitionsobjekt UserDataFunction. Se denne artikel for at få flere oplysninger om strukturen i UserDataFunction-definitionen.

Name	Type	Beskrivelse
format	string	Formatet af definitionen af brugerdatafunktionen.
parts	UserDataFunctionPublicDefinitionPart[]	En liste over definitionsdele.

UserDataFunctionPublicDefinitionPart

Objekt

UserDataFunction-definitionsdelsobjekt.

Name	Type	Beskrivelse
path	string	Stien til den offentlige definition af UserDataFunction.
payload	string	Payload for den offentlige definition af UserDataFunction.
payloadType	PayloadType	Nyttedatatypen.