Items - Create Eventstream

Referens

Tjänst:: Eventstream

API-version:: v1

Skapar en händelseström på den angivna arbetsytan.
Det här API:et stöder tidskrävande åtgärder (LRO).

Om du vill skapa en händelseström med definition läser du Eventstream-definition.

Behörigheter

Anroparen måste ha deltagare eller högre arbetsyteroll.

Obligatoriska delegerade omfång

Eventstream.ReadWrite.All eller Item.ReadWrite.All

Begränsningar

Om du vill skapa en händelseström måste arbetsytan finnas på en infrastrukturresurskapacitet som stöds. Mer information finns i: Microsoft Fabric-licenstyper.

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Stöd
Användare	Ja
Tjänstens huvudnamn och hanterade identiteter	Ja

Gränssnitt

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventstreams

URI-parametrar

Name	I	Obligatorisk	Typ	Description
workspaceId	path	True	string uuid	Arbetsytans ID.

Begärandetext

Name	Obligatorisk	Typ	Description
displayName	True	string	Visningsnamnet för händelseströmmen. Visningsnamnet måste följa namngivningsreglerna efter objekttyp.
definition		EventstreamDefinition	Den offentliga definitionen eventstream.
description		string	Beskrivningen av händelseströmmen. Maximal längd är 256 tecken.

Svar

Name	Typ	Description
201 Created	Eventstream	Har skapats
202 Accepted		Begäran accepterad, eventstream-etablering pågår Sidhuvuden Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: InvalidItemType – Objekttypen är ogiltig ItemDisplayNameAlreadyInUse – Objektets visningsnamn används redan. CorruptedPayload – den angivna nyttolasten är skadad.

Name

Typ

Description

201 Created

Eventstream

Har skapats

202 Accepted

Begäran accepterad, eventstream-etablering pågår

Sidhuvuden

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Vanliga felkoder:

InvalidItemType – Objekttypen är ogiltig
ItemDisplayNameAlreadyInUse – Objektets visningsnamn används redan.
CorruptedPayload – den angivna nyttolasten är skadad.

Exempel

Create an eventstream example

Create an eventstream with public definition example

Create an eventstream example

Exempelbegäran

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/eventstreams

{
  "displayName": "Eventstream_1",
  "description": "Eventstream_1 description."
}

Exempelsvar

Statuskod:: 201

{
  "displayName": "Eventstream_1",
  "description": "Eventstream_1 description.",
  "type": "Eventstream",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

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

Create an eventstream with public definition example

Exempelbegäran

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/eventstreams

{
  "displayName": "Eventstream_1",
  "description": "Eventstream_1 description.",
  "definition": {
    "format": "eventstream",
    "parts": [
      {
        "path": "eventstream.json",
        "payload": "SSdkIGxpa2UgdG8gdGVsbCBh..IGpva2UgZm9yIHlvdS4K",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Exempelsvar

Statuskod:: 201

{
  "displayName": "Eventstream_1",
  "description": "Eventstream_1 description.",
  "type": "Eventstream",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

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

Definitioner

Name	Description
CreateEventstreamRequest	Skapa nyttolast för eventstream-begäran.
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
Eventstream	Ett eventstream-objekt.
EventstreamDefinition	Eventstreams offentliga definitionsobjekt.
EventstreamDefinitionPart	Eventstream-definitionsdelsobjekt.
ItemType	Typ av objekt. Ytterligare objekttyper kan läggas till över tid.
PayloadType	Typ av definitionsdelens nyttolast. Ytterligare nyttolasttyper kan läggas till över tid.

CreateEventstreamRequest

Objekt

Skapa nyttolast för eventstream-begäran.

Name	Typ	Description
definition	EventstreamDefinition	Den offentliga definitionen eventstream.
description	string	Beskrivningen av händelseströmmen. Maximal längd är 256 tecken.
displayName	string	Visningsnamnet för händelseströmmen. Visningsnamnet måste följa namngivningsreglerna efter objekttyp.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

Eventstream

Objekt

Ett eventstream-objekt.

Name	Typ	Description
description	string	Objektbeskrivningen.
displayName	string	Objektets visningsnamn.
id	string uuid	Objekt-ID:t.
type	ItemType	Objekttypen.
workspaceId	string uuid	Arbetsytans ID.

EventstreamDefinition

Objekt

Eventstreams offentliga definitionsobjekt.

Name	Typ	Description
format	string	Formatet för objektdefinitionen.
parts	EventstreamDefinitionPart[]	En lista över definitionsdelar.

EventstreamDefinitionPart

Objekt

Eventstream-definitionsdelsobjekt.

Name	Typ	Description
path	string	Händelseströmsdelsökvägen.
payload	string	Nyttolasten för händelseströmsdelen.
payloadType	PayloadType	Nyttolasttypen.

ItemType

Uppräkning

Typ av objekt. Ytterligare objekttyper kan läggas till över tid.

Värde	Description
Dashboard	PowerBI-instrumentpanel.
DataPipeline	En datapipeline.
Datamart	PowerBI-datamart.
Environment	En miljö.
Eventhouse	Ett eventhouse.
Eventstream	En händelseström.
GraphQLApi	Ett API för GraphQL-objekt.
KQLDashboard	En KQL-instrumentpanel.
KQLDatabase	En KQL-databas.
KQLQueryset	En KQL-frågeuppsättning.
Lakehouse	Ett sjöhus.
MLExperiment	Ett maskininlärningsexperiment.
MLModel	En maskininlärningsmodell.
MirroredDatabase	En speglad databas.
MirroredWarehouse	Ett speglat lager.
MountedDataFactory	En MountedDataFactory.
Notebook	En notebook-fil.
PaginatedReport	Sidnumrerad PowerBI-rapport.
Reflex	En reflex.
Report	PowerBI-rapport.
SQLDatabase	En SQLDatabase.
SQLEndpoint	En SQL-slutpunkt.
SemanticModel	PowerBI-semantisk modell.
SparkJobDefinition	En definition för Spark-jobb.
Warehouse	Ett lager.

PayloadType

Uppräkning

Typ av definitionsdelens nyttolast. Ytterligare nyttolasttyper kan läggas till över tid.

Värde	Description
InlineBase64	Infogad bas 64.

Dela via

Items - Create Eventstream

Behörigheter

Obligatoriska delegerade omfång

Begränsningar

Identiteter som stöds av Microsoft Entra

Gränssnitt

URI-parametrar

Begärandetext

Svar

Exempel

Create an eventstream example

Exempelbegäran

Exempelsvar

Create an eventstream with public definition example

Exempelbegäran

Exempelsvar

Definitioner

CreateEventstreamRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

Eventstream

EventstreamDefinition

EventstreamDefinitionPart

ItemType

PayloadType

Ytterligare resurser