Dela via


Items - Create Eventstream

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 rollen deltagare i arbetsytan.

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 Fabric kapacitet som stöds. Mer information finns i: Microsoft Fabric licenstyper.

Microsoft Entra identiteter som stöds

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

Identitet Stöd
Användare Ja
Tjänsthuvudnamn 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.

folderId

string (uuid)

Mapp-ID:t. Om den inte anges eller är null skapas händelseströmmen med arbetsytan som mapp.

sensitivityLabelSettings

SensitivityLabelSettings

Inställningar för känslighetsetiketter för händelseströmmen.

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
429 Too Many Requests

ErrorResponse

Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas.

Sidhuvuden

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.

  • WorkspaceItemsLimitExceeded – Gränsen för arbetsyteobjekt har överskridits.

Exempel

Create an eventstream example
Create an eventstream with public definition example

Create an eventstream example

Exempelbegäran

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

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

Exempelsvar

{
  "displayName": "Eventstream_1",
  "description": "Eventstream_1 description.",
  "type": "Eventstream",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}
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

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": "eventstreamProperties.json",
        "payload": "ewogICJyZXRlbnRpb25UaW1l..V2ZWwiOiAiTG93Igp9",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Exempelsvar

{
  "displayName": "Eventstream_1",
  "description": "Eventstream_1 description.",
  "type": "Eventstream",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}
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.

EntireTenantPrincipal

Representerar ett klientorganisationsobjekt

ErrorRelatedResource

Det felrelaterade resursinformationsobjektet.

ErrorResponse

Felsvaret.

ErrorResponseDetails

Information om felsvar.

Eventstream

Ett eventstream-objekt.

EventstreamDefinition

Eventstreams offentliga definitionsobjekt. Mer information om strukturen för Eventstream-definitionen finns i den här artikeln .

EventstreamDefinitionPart

Eventstream-definitionsdelsobjekt.

GroupDetails

Gruppera specifik information. Gäller när huvudtypen är Group.

GroupPrincipal

Representerar en säkerhetsgrupp.

GroupType

Gruppens typ. Ytterligare grupptyper kan läggas till över tid.

ItemTag

Representerar en tagg som tillämpas på ett objekt.

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.

PrincipalType

Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

SensitivityLabel

Representerar en känslighetsetikett som tillämpas på ett objekt.

SensitivityLabelApplyStrategy

Strategin för att tillämpa känslighetsetiketten. Standardvärdet är ApplyOrFail. Ytterligare typer kan läggas till över tid.

SensitivityLabelSettings

Inställningar för känslighetsetiketter.

ServicePrincipalDetails

Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är ServicePrincipal.

ServicePrincipalPrincipal

Representerar ett Microsoft Entra tjänstens huvudnamn.

ServicePrincipalProfileDetails

Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är ServicePrincipalProfile.

ServicePrincipalProfilePrincipal

Representerar en profil för tjänstens huvudnamn.

UserDetails

Specifik information om användarens huvudnamn. Gäller när huvudtypen är User.

UserPrincipal

Representerar ett Microsoft Entra användarens huvudnamn.

CreateEventstreamRequest

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.

folderId

string (uuid)

Mapp-ID:t. Om den inte anges eller är null skapas händelseströmmen med arbetsytan som mapp.

sensitivityLabelSettings

SensitivityLabelSettings

Inställningar för känslighetsetiketter för händelseströmmen.

EntireTenantPrincipal

Representerar ett klientorganisationsobjekt

Name Typ Description
displayName

string

Huvudkontots visningsnamn.

id

string (uuid)

Huvudmannens ID.

type string:

EntireTenant

Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

ErrorRelatedResource

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

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 (uuid)

ID för den begäran som är associerad med felet.

ErrorResponseDetails

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

Ett eventstream-objekt.

Name Typ Description
defaultIdentity Principal:

Objektets standardidentitet.

description

string

Objektbeskrivningen.

displayName

string

Objektets visningsnamn.

folderId

string (uuid)

Mapp-ID:t.

id

string (uuid)

Objekt-ID:t.

sensitivityLabel

SensitivityLabel

Objektets känslighetsetikett.

tags

ItemTag[]

Lista över tillämpade taggar.

type

ItemType

Objekttypen.

workspaceId

string (uuid)

Arbetsytans ID.

EventstreamDefinition

Eventstreams offentliga definitionsobjekt. Mer information om strukturen för Eventstream-definitionen finns i den här artikeln .

Name Typ Description
format

string

Formatet för objektdefinitionen.

parts

EventstreamDefinitionPart[]

En lista över definitionsdelar.

EventstreamDefinitionPart

Eventstream-definitionsdelsobjekt.

Name Typ Description
path

string

Händelseströmsdelsökvägen.

payload

string

Nyttolasten för händelseströmsdelen.

payloadType

PayloadType

Nyttolasttypen.

GroupDetails

Gruppera specifik information. Gäller när huvudtypen är Group.

Name Typ Description
groupType

GroupType

Gruppens typ. Ytterligare grupptyper kan läggas till över tid.

GroupPrincipal

Representerar en säkerhetsgrupp.

Name Typ Description
displayName

string

Huvudkontots visningsnamn.

groupDetails

GroupDetails

Gruppera specifik information. Gäller när huvudtypen är Group.

id

string (uuid)

Huvudmannens ID.

type string:

Group

Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

GroupType

Gruppens typ. Ytterligare grupptyper kan läggas till över tid.

Värde Description
Unknown

Huvudgrupptypen är okänd.

SecurityGroup

Huvudnamn är en säkerhetsgrupp.

DistributionList

Huvudnamn är en distributionslista.

ItemTag

Representerar en tagg som tillämpas på ett objekt.

Name Typ Description
displayName

string

Namnet på taggen.

id

string (uuid)

Tagg-ID:t.

ItemType

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

Värde Description
Dashboard

PowerBI-instrumentpanel.

Report

PowerBI-rapport.

SemanticModel

PowerBI-semantisk modell.

PaginatedReport

Sidnumrerad PowerBI-rapport.

Datamart

PowerBI-datamart.

Lakehouse

Ett sjöhus.

Eventhouse

Ett eventhouse.

Environment

En miljö.

KQLDatabase

En KQL-databas.

KQLQueryset

En KQL-frågeuppsättning.

KQLDashboard

En KQL-instrumentpanel.

DataPipeline

En datapipeline.

Notebook

En notebook-fil.

SparkJobDefinition

En definition för Spark-jobb.

MLExperiment

Ett maskininlärningsexperiment.

MLModel

En maskininlärningsmodell.

Warehouse

Ett lager.

Eventstream

En händelseström.

SQLEndpoint

En SQL-slutpunkt.

MirroredWarehouse

Ett speglat lager.

MirroredDatabase

En speglad databas.

Reflex

En reflex.

GraphQLApi

Ett API för GraphQL-objekt.

MountedDataFactory

En MountedDataFactory.

SQLDatabase

En SQLDatabase.

CopyJob

Ett kopieringsjobb.

VariableLibrary

En VariableLibrary.

Dataflow

Ett dataflöde.

ApacheAirflowJob

Ett ApacheAirflowJob.

WarehouseSnapshot

En ögonblicksbild av lagret.

DigitalTwinBuilder

En DigitalTwinBuilder.

DigitalTwinBuilderFlow

Ett Digital Twin Builder Flow.

MirroredAzureDatabricksCatalog

En speglad azure databricks-katalog.

Map

En karta.

AnomalyDetector

En avvikelseidentifiering.

UserDataFunction

En användardatafunktion.

GraphModel

En GraphModel.

GraphQuerySet

En Graph QuerySet.

SnowflakeDatabase

En Snowflake-databas för att lagra isbergstabeller som skapats från Snowflake-kontot.

OperationsAgent

En OperationsAgent.

CosmosDBDatabase

En Cosmos DB-databas.

Ontology

En ontologi.

EventSchemaSet

En EventSchemaSet.

DataAgent

En DataAgent.

PayloadType

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

Värde Description
InlineBase64

Infogad bas 64.

PrincipalType

Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

Värde Description
User

Huvudkontot är ett Microsoft Entra användarens huvudnamn.

ServicePrincipal

Huvudnamn är ett Microsoft Entra tjänstens huvudnamn.

Group

Huvudnamn är en säkerhetsgrupp.

ServicePrincipalProfile

Huvudnamn är en profil för tjänstens huvudnamn.

EntireTenant

Huvudkontot representerar alla klientanvändare.

SensitivityLabel

Representerar en känslighetsetikett som tillämpas på ett objekt.

Name Typ Description
id

string (uuid)

Känslighetsetikettens ID.

SensitivityLabelApplyStrategy

Strategin för att tillämpa känslighetsetiketten. Standardvärdet är ApplyOrFail. Ytterligare typer kan läggas till över tid.

Värde Description
ApplyOrFail

Använd känslighetsetiketten eller misslyckas med åtgärden om den inte kan tillämpas.

Ignore

Ignorera känslighetsetiketten om den inte kan användas och fortsätt med åtgärden utan att använda etiketten.

SensitivityLabelSettings

Inställningar för känslighetsetiketter.

Name Typ Description
labelId

string (uuid)

Känslighetsetikettens ID.

sensitivityLabelApplyStrategy

SensitivityLabelApplyStrategy

Strategin för att tillämpa känslighetsetiketten.

ServicePrincipalDetails

Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är ServicePrincipal.

Name Typ Description
aadAppId

string (uuid)

Tjänstens huvudnamns Microsoft Entra AppId.

ServicePrincipalPrincipal

Representerar ett Microsoft Entra tjänstens huvudnamn.

Name Typ Description
displayName

string

Huvudkontots visningsnamn.

id

string (uuid)

Huvudmannens ID.

servicePrincipalDetails

ServicePrincipalDetails

Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är ServicePrincipal.

type string:

ServicePrincipal

Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

ServicePrincipalProfileDetails

Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är ServicePrincipalProfile.

Name Typ Description
parentPrincipal Principal:

Tjänstens huvudnamnsprofils överordnade huvudnamn.

ServicePrincipalProfilePrincipal

Representerar en profil för tjänstens huvudnamn.

Name Typ Description
displayName

string

Huvudkontots visningsnamn.

id

string (uuid)

Huvudmannens ID.

servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är ServicePrincipalProfile.

type string:

ServicePrincipalProfile

Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

UserDetails

Specifik information om användarens huvudnamn. Gäller när huvudtypen är User.

Name Typ Description
userPrincipalName

string

Användarens huvudnamn.

UserPrincipal

Representerar ett Microsoft Entra användarens huvudnamn.

Name Typ Description
displayName

string

Huvudkontots visningsnamn.

id

string (uuid)

Huvudmannens ID.

type string:

User

Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

userDetails

UserDetails

Specifik information om användarens huvudnamn. Gäller när huvudtypen är User.