Partager via

Items - Update Eventstream Definition

Service:
Eventstream
Version d'API:
v1

Met à jour la définition d’un flux d’événements spécifié. La mise à jour remplace la définition actuelle.
Cette API prend en charge opérations longues (LRO).

La mise à jour de la définition eventstream n’affecte pas son étiquette de confidentialité.

Autorisations

L’appelant doit disposer d’autorisations de lecture et d’écriture pour le flux d’événements.

Étendues déléguées requises

Eventstream.ReadWrite.All ou Item.ReadWrite.All

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité Soutien
Utilisateur Oui
Service principal et identités gérées Oui

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventstreams/{eventstreamId}/updateDefinition
Avec des paramètres facultatifs: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventstreams/{eventstreamId}/updateDefinition?updateMetadata={updateMetadata}

Paramètres URI

Nom Dans Obligatoire Type Description
eventstreamId
 path True

string (uuid)

ID du flux d'événements.
workspaceId
 path True

string (uuid)

Identifiant de l’espace de travail.
updateMetadata
 query

boolean

Indique s’il faut mettre à jour les métadonnées de l’élément s’il est fourni dans le .platform fichier. True : Mettez à jour les métadonnées si elles sont fournies dans le fichier dans le .platform cadre de la définition, False : ne mettez pas à jour les métadonnées.

Corps de la demande

Nom Obligatoire Type Description
definition True

EventstreamDefinition

Objet de définition publique Eventstream.

Réponses

Nom Type Description
200 OK

La demande s’est terminée avec succès.
202 Accepted

Demande acceptée. La définition de mise à jour est en cours.

En-têtes

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

ErrorResponse

Codes d’erreur courants :

  • OperationNotSupportedForItem : opération non prise en charge pour l’élément demandé.

  • CorruptedPayload : la charge utile fournie est endommagée.

Exemples

Update an eventstream definition example

Exemple de requête

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

Exemple de réponse

Code d’état:
200
Code d’état:
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

Définitions

Nom Description
ErrorRelatedResource

Objet de détails de ressource associé à l’erreur.
ErrorResponse

Réponse d’erreur.
ErrorResponseDetails

Détails de la réponse d’erreur.
EventstreamDefinition

Objet de définition publique Eventstream.
EventstreamDefinitionPart

Objet de partie de définition Eventstream.
PayloadType

Type de la charge utile du composant de définition. Des types de charge utile supplémentaires peuvent être ajoutés au fil du temps.
UpdateEventstreamDefinitionRequest

Mettre à jour la charge utile de demande de définition publique eventstream.

ErrorRelatedResource

Object

Objet de détails de ressource associé à l’erreur.

Nom Type Description
resourceId

string

ID de ressource impliqué dans l’erreur.
resourceType

string

Type de la ressource impliquée dans l’erreur.

ErrorResponse

Object

Réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
moreDetails

ErrorResponseDetails[]

Liste des détails d’erreur supplémentaires.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.
requestId

string

ID de la demande associée à l’erreur.

ErrorResponseDetails

Object

Détails de la réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.

EventstreamDefinition

Object

Objet de définition publique Eventstream.

Nom Type Description
format

string

Format de la définition d’élément.
parts

EventstreamDefinitionPart[]

Liste des parties de définition.

EventstreamDefinitionPart

Object

Objet de partie de définition Eventstream.

Nom Type Description
path

string

Chemin d’accès de la partie eventstream.
payload

string

Charge utile du composant eventstream.
payloadType

PayloadType

Type de charge utile.

PayloadType

Énumération

Type de la charge utile du composant de définition. Des types de charge utile supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
InlineBase64

Base 64 inline.

UpdateEventstreamDefinitionRequest

Object

Mettre à jour la charge utile de demande de définition publique eventstream.

Nom Type Description
definition

EventstreamDefinition

Objet de définition publique Eventstream.