Partager via

Items - Get Eventstream Definition

Service:
Eventstream
Version d'API:
v1

Retourne la définition publique eventstream spécifiée.
Cette API prend en charge opérations longues (LRO).

Lorsque vous obtenez une définition publique eventstream, l’étiquette de confidentialité ne fait pas partie de la définition.

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

Limites

Cette API est bloquée pour un flux d’événements avec une étiquette de confidentialité chiffrée.

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}/getDefinition
Avec des paramètres facultatifs: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventstreams/{eventstreamId}/getDefinition?format={format}

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.
format
 query

string

Le format de la définition publique du flux d'événements.

Réponses

Nom Type Description
200 OK

EventstreamDefinitionResponse

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

Demande acceptée. La récupération de la définition 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é.

Exemples

Get an eventstream definition example

Exemple de requête

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/eventstreams/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Exemple de réponse

Code d’état:
200 
{
  "definition": {
    "parts": [
      {
        "path": "eventstream.json",
        "payload": "SSdkIGxpa2UgdG8gdGVsbCBh..IGpva2UgZm9yIHlvdS4K",
        "payloadType": "InlineBase64"
      },
      {
        "path": "eventstreamProperties.json",
        "payload": "ewogICJyZXRlbnRpb25UaW1l..V2ZWwiOiAiTG93Igp9",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
Code d’état:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
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.
EventstreamDefinitionResponse

Réponse de définition publique 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.

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.

EventstreamDefinitionResponse

Object

Réponse de définition publique Eventstream.

Nom Type Description
definition

EventstreamDefinition

Objet de définition publique Eventstream.

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.