Freigeben über

Items - Update Digital Twin Builder Definition

Dienst:
DigitalTwinBuilder
API-Version:
v1

Aktualisiert die Definition eines angegebenen DigitalTwinBuilder. Das Update setzt die aktuelle Definition außer Kraft.

Note

Digital Twin Builder-Element befindet sich derzeit in der Vorschau (weitere Informationen).

Diese API unterstützt LRO-.

Das Aktualisieren der Digitaltwinbuilder-Definition wirkt sich nicht auf die Vertraulichkeitsbezeichnung aus.

Permissions

Der Aufrufer muss Lese- und Schreibberechtigungen für den digitalen Zwillings-Generator besitzen.

Erforderliche delegierte Bereiche

DigitalTwinBuilder.ReadWrite.All oder Item.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identity Support
User Yes
Service Principal und Verwaltete Identitäten No

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/digitaltwinbuilders/{digitaltwinbuilderId}/updateDefinition
Mit optionalen Parametern: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/digitaltwinbuilders/{digitaltwinbuilderId}/updateDefinition?updateMetadata={updateMetadata}

URI-Parameter

Name In Erforderlich Typ Beschreibung
digitaltwinbuilderId
 path True

string (uuid)

Die Digitaltwinbuilder-ID.
workspaceId
 path True

string (uuid)

Die Arbeitsbereichs-ID.
updateMetadata
 query

boolean

Gibt an, ob die Metadaten des Elements aktualisiert werden sollen, wenn es in der .platform Datei bereitgestellt wird. True – Aktualisieren Sie die Metadaten, wenn sie in der .platform Datei als Teil der Definition bereitgestellt wird, "False". Aktualisieren Sie die Metadaten nicht.

Anforderungstext

Name Erforderlich Typ Beschreibung
definition True

DigitalTwinBuilderDefinition

Öffentliches Definitionsobjekt "DigitalTwinBuilder".

Antworten

Name Typ Beschreibung
200 OK

Die Anforderung wurde erfolgreich abgeschlossen.
202 Accepted

Anforderung angenommen. Die Updatedefinition wird ausgeführt.

Header

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • OperationNotSupportedForItem – Vorgang für angefordertes Element nicht unterstützt.

  • CorruptedPayload – Die bereitgestellte Nutzlast ist beschädigt.

Beispiele

Update a digitaltwinbuilder definition example

Beispielanforderung

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

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

Beispiel für eine Antwort

Statuscode:
200
Statuscode:
202 
Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Definitionen

Name Beschreibung
DigitalTwinBuilderDefinition

Öffentliches Definitionsobjekt "DigitalTwinBuilder".
DigitalTwinBuilderDefinitionPart

DigitalTwinBuilder-Definitionsteilobjekt.
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
PayloadType

Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.
UpdateDigitalTwinBuilderDefinitionRequest

Aktualisieren Sie die Nutzlast der öffentlichen Definitionsanforderung digitaltwinbuilder.

DigitalTwinBuilderDefinition

Objekt

Öffentliches Definitionsobjekt "DigitalTwinBuilder".

Name Typ Beschreibung
format

string

Das Format der Elementdefinition.
parts

DigitalTwinBuilderDefinitionPart[]

Eine Liste der Definitionsteile.

DigitalTwinBuilderDefinitionPart

Objekt

DigitalTwinBuilder-Definitionsteilobjekt.

Name Typ Beschreibung
path

string

Der Teilpfad "DigitalTwinBuilder".
payload

string

Die Nutzlast des DigitalTwinBuilder-Teils.
payloadType

PayloadType

Der Nutzlasttyp.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

PayloadType

Enumeration

Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
InlineBase64

Inlinebasis 64.

UpdateDigitalTwinBuilderDefinitionRequest

Objekt

Aktualisieren Sie die Nutzlast der öffentlichen Definitionsanforderung digitaltwinbuilder.

Name Typ Beschreibung
definition

DigitalTwinBuilderDefinition

Öffentliches Definitionsobjekt "DigitalTwinBuilder".