Freigeben über

Items - Update Eventstream Definition

Dienst:
Eventstream
API-Version:
v1

Aktualisiert die Definition eines angegebenen Ereignisstreams. Das Update setzt die aktuelle Definition außer Kraft.
Diese API unterstützt LRO-.

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

Erlaubnisse

Der Aufrufer muss Lese- und Schreibberechtigungen für den Eventstream besitzen.

Erforderliche delegierte Bereiche

Eventstream.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.

Identität Unterstützung
Benutzer Ja
Service Principal und Verwaltete Identitäten Ja

Schnittstelle

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
eventstreamId
 path True

string (uuid)

Die Ereignisstream-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

EventstreamDefinition

Öffentliches Eventstream-Definitionsobjekt.

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 an eventstream definition example

Beispielanforderung

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

{
  "definition": {
    "parts": [
      {
        "path": "eventstream.json",
        "payload": "SSdkIGxpa2UgdG8gdGVsbCBh..IGpva2UgZm9yIHlvdS4K",
        "payloadType": "InlineBase64"
      },
      {
        "path": "eventstreamProperties.json",
        "payload": "ewogICJyZXRlbnRpb25UaW1l..V2ZWwiOiAiTG93Igp9",
        "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/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Definitionen

Name Beschreibung
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
EventstreamDefinition

Öffentliches Eventstream-Definitionsobjekt.
EventstreamDefinitionPart

Eventstream-Definitionsteilobjekt.
PayloadType

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

Aktualisieren sie die Nutzlast der öffentlichen Definitionsanforderung für eventstream.

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.

EventstreamDefinition

Objekt

Öffentliches Eventstream-Definitionsobjekt.

Name Typ Beschreibung
format

string

Das Format der Elementdefinition.
parts

EventstreamDefinitionPart[]

Eine Liste der Definitionsteile.

EventstreamDefinitionPart

Objekt

Eventstream-Definitionsteilobjekt.

Name Typ Beschreibung
path

string

Der Eventstream-Teilpfad.
payload

string

Die Eventstream-Webpartnutzlast.
payloadType

PayloadType

Der Nutzlasttyp.

PayloadType

Enumeration

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

Wert Beschreibung
InlineBase64

Inlinebasis 64.

UpdateEventstreamDefinitionRequest

Objekt

Aktualisieren sie die Nutzlast der öffentlichen Definitionsanforderung für eventstream.

Name Typ Beschreibung
definition

EventstreamDefinition

Öffentliches Eventstream-Definitionsobjekt.