Items - Update User Data Function Definition

Service:: UserDataFunction

API-versie:: v1

Hiermee wordt de definitie voor de opgegeven UserDataFunction overschreven.
Deze API ondersteunt langlopende bewerkingen (LRO).

Het bijwerken van de definitie van UserDataFunction heeft geen invloed op het vertrouwelijkheidslabel.

Permissions

De beller moet lees- en schrijfmachtigingen hebben voor de UserDataFunction.

Vereiste gedelegeerde bereiken

Item.ReadWrite.All

Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identiteit	Support
User	Yes
serviceprincipal en beheerde identiteiten	Nee.

gebruikersinterface

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
userDataFunctionId	path	True	string (uuid)	De UserDataFunction-id.
workspaceId	path	True	string (uuid)	De werkruimte-ID.
updateMetadata	query		boolean	Als deze is ingesteld op true en het .platform-bestand wordt opgegeven als onderdeel van de definitie, worden de metagegevens van het item bijgewerkt met behulp van de metagegevens in het PLATFORM-bestand

Aanvraagbody

Name	Vereist	Type	Description
definition	True	UserDataFunctionPublicDefinition	UserDataFunction public definition object. Raadpleeg dit artikel voor meer informatie over de structuur van de definitie UserDataFunction.

Antwoorden

Name	Type	Description
200 OK		De aanvraag is voltooid.
202 Accepted		Aanvraag geaccepteerd. De definitie van de update wordt uitgevoerd. Kopteksten Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	De servicesnelheidslimiet is overschreden. De server retourneert een `Retry-After` header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden. Kopteksten Retry-After: integer
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: OperationNotSupportedForItem - Bewerking wordt niet ondersteund voor aangevraagd item. CorruptedPayload: de opgegeven nettolading is beschadigd.

Voorbeelden

Update a UserDataFunction public definition example

Voorbeeldaanvraag

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"
      }
    ]
  }
}

Voorbeeldrespons

Statuscode:: 200

Statuscode:: 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

Definities

Name	Description
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
PayloadType	Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.
UpdateUserDataFunctionDefinitionRequest	De nettolading van de openbare definitie userDataFunction bijwerken.
UserDataFunctionPublicDefinition	UserDataFunction public definition object. Raadpleeg dit artikel voor meer informatie over de structuur van de definitie UserDataFunction.
UserDataFunctionPublicDefinitionPart	Object van het definitieonderdeel UserDataFunction.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name	Type	Description
resourceId	string	De resource-id die betrokken is bij de fout.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
isRetriable	boolean	Wanneer waar, kan de aanvraag opnieuw worden geprobeerd. Gebruik de `Retry-After` antwoordheader om de vertraging te bepalen, indien beschikbaar.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string (uuid)	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

PayloadType

Opsomming

Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.

Waarde	Description
InlineBase64	Inline base 64.

UpdateUserDataFunctionDefinitionRequest

Object

De nettolading van de openbare definitie userDataFunction bijwerken.

Name	Type	Description
definition	UserDataFunctionPublicDefinition	UserDataFunction public definition object. Raadpleeg dit artikel voor meer informatie over de structuur van de definitie UserDataFunction.

UserDataFunctionPublicDefinition

Object

UserDataFunction public definition object. Raadpleeg dit artikel voor meer informatie over de structuur van de definitie UserDataFunction.

Name	Type	Description
format	string	De indeling van de definitie van de functie gebruikersgegevens.
parts	UserDataFunctionPublicDefinitionPart[]	Een lijst met definitieonderdelen.

UserDataFunctionPublicDefinitionPart

Object

Object van het definitieonderdeel UserDataFunction.

Name	Type	Description
path	string	Het pad van het onderdeel UserDataFunction van de openbare definitie.
payload	string	De nettolading van het openbare definitieonderdeel UserDataFunction.
payloadType	PayloadType	Het nettoladingstype.