Topology - Get Eventstream Destination

Service:

Eventstream

API-versie:

v1

Retourneert de opgegeven bestemming van de eventstream.

Machtigingen

De beller moet viewer hebben of een hogere werkruimterol.

Vereiste gedelegeerde bereiken

Eventstream.Read.All of Eventstream.ReadWrite.All of Item.Read.All of Item.ReadWrite.All

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft -identiteiten vermeld in deze sectie.

Identiteit	Ondersteuning
Gebruiker	Ja
serviceprincipal en beheerde identiteiten	Ja

gebruikersinterface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventstreams/{eventstreamId}/destinations/{destinationId}

URI-parameters

Name	In	Vereist	Type	Description
destinationId	path	True	string (uuid)	De doel-id.
eventstreamId	path	True	string (uuid)	De evenementenstroom-id.
workspaceId	path	True	string (uuid)	De werkruimte-id.

Antwoorden

Name	Type	Description
200 OK	DestinationResponse: ActivatorDestinationResponse CustomEndpointDestinationResponse EventhouseDestinationResponse LakehouseDestinationResponse	De aanvraag is voltooid.
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: ItemNotFound : het aangevraagde item is niet gevonden.

Voorbeelden

Get an eventstream destination example

Voorbeeldaanvraag

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/eventstreams/8c500070-073f-4a88-b478-8fabe1941c52/destinations/2e4c91e7-0c4a-4cc4-abe3-cc7ba4310a37

Voorbeeldrespons

Statuscode:

200

Definities

Name	Description
ActivatorDestinationProperties	Activator doeleigenschappen.
ActivatorDestinationResponse	Activator-doelantwoord.
AvroSerializationInfo	Avro-serialisatie-informatie.
AvroSerializationProperties	Avro-serialisatie-eigenschappen.
ColumnSchema	Vertegenwoordigt het schema van een kolom.
CsvSerializationInfo	Informatie over CSV-serialisatie.
CsvSerializationProperties	CSV-serialisatie-eigenschappen.
CustomEndpointDestinationProperties	Doeleigenschappen voor aangepaste eindpunten.
CustomEndpointDestinationResponse	Antwoord op doel van aangepaste eindpunten.
DataType	Vertegenwoordigt het gegevenstype. Er kunnen in de loop van de tijd extra gegevenstypen worden toegevoegd.
DestinationType	Geeft het type van de bestemming aan. Er kunnen in de loop van de tijd extra doeltypen worden toegevoegd.
ErrorInfo	Vertegenwoordigt de foutgegevens.
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
EventhouseDestinationResponse	Antwoord van eventhouse-bestemming.
EventhouseDirectIngestionModeDestinationProperties	Doeleigenschappen van de Eventhouse DirectIngestion-modus.
EventhouseProcessedIngestionModeDestinationProperties	Doeleigenschappen van de Eventhouse ProcessedIngestion-modus.
InputSchema	Vertegenwoordigt het invoerschema van de bron, bestemming of operator.
JsonSerializationInfo	JSON-serialisatiegegevens.
JsonSerializationProperties	JSON-serialisatie-eigenschappen.
LakehouseDestinationProperties	Lakehouse-doeleigenschappen.
LakehouseDestinationResponse	Het doelantwoord van Lakehouse.
NodeReference	Vertegenwoordigt een verwijzing naar een knooppunt met behulp van de unieke naam.
NodeStatus	De status van het knooppunt. Er kan na verloop van tijd extra knooppuntstatus worden toegevoegd.
Schema	Vertegenwoordigt het schema van de gegevens.
SerializationType	Het serialisatietype.

ActivatorDestinationProperties

Object

Activator doeleigenschappen.

Name	Type	Description
inputSerialization	SerializationInfo: AvroSerializationInfo CsvSerializationInfo JsonSerializationInfo	Serialisatie-informatie.
itemId	string (uuid)	De activator-item-id.
workspaceId	string (uuid)	De Activator-werkruimte-id.

ActivatorDestinationResponse

Object

Activator-doelantwoord.

Name	Type	Description
error	ErrorInfo	De foutinformatie.
id	string (uuid)	De unieke id van de bestemming.
inputNodes	NodeReference[]	Een lijst met de verwijzingen naar de invoerknooppunten van de bestemming.
inputSchemas	InputSchema[]	De invoerschema's van de bestemming.
name	string	De unieke naam van de bestemming.
properties	ActivatorDestinationProperties	De eigenschappen van de Activator-bestemming.
status	NodeStatus	De status van het knooppunt. Er kan na verloop van tijd extra knooppuntstatus worden toegevoegd.
type	string: Activator	Het type bestemming.

AvroSerializationInfo

Object

Avro-serialisatie-informatie.

Name	Type	Description
properties	AvroSerializationProperties	Avro-serialisatie-eigenschappen.
type	string: Avro	Het serialisatietype.

AvroSerializationProperties

Object

Avro-serialisatie-eigenschappen.

ColumnSchema

Object

Vertegenwoordigt het schema van een kolom.

Name	Type	Description
fields	ColumnSchema[]	Een lijst met de velden voor het record- of matrixgegevenstype.
items	ColumnSchema	Het schema van de matrixitems.
name	string	De naam van de kolom.
type	DataType	Het gegevenstype van de kolom.

CsvSerializationInfo

Object

Informatie over CSV-serialisatie.

Name	Type	Description
properties	CsvSerializationProperties	CSV-serialisatie-eigenschappen.
type	string: Csv	Het serialisatietype.

CsvSerializationProperties

Object

CSV-serialisatie-eigenschappen.

Name	Type	Description
encoding	enum: UTF8	Het coderingstype.
fieldDelimiter	string	Het veldscheidingsteken.
format	enum: WithHeaders WithoutHeaders	Het notatietype.

CustomEndpointDestinationProperties

Object

Doeleigenschappen voor aangepaste eindpunten.

CustomEndpointDestinationResponse

Object

Antwoord op doel van aangepaste eindpunten.

Name	Type	Description
error	ErrorInfo	De foutinformatie.
id	string (uuid)	De unieke id van de bestemming.
inputNodes	NodeReference[]	Een lijst met de verwijzingen naar de invoerknooppunten van de bestemming.
inputSchemas	InputSchema[]	De invoerschema's van de bestemming.
name	string	De unieke naam van de bestemming.
properties	CustomEndpointDestinationProperties	De eigenschappen van de bestemming van het aangepaste eindpunt.
status	NodeStatus	De status van het knooppunt. Er kan na verloop van tijd extra knooppuntstatus worden toegevoegd.
type	string: CustomEndpoint	Het type bestemming.

DataType

Inventarisatie

Vertegenwoordigt het gegevenstype. Er kunnen in de loop van de tijd extra gegevenstypen worden toegevoegd.

Waarde	Description
Any	Onbekend gegevenstype.
Array	Matrixgegevenstype.
BigInt	BigInt-gegevenstype.
Bit	Bitgegevenstype.
DateTime	Datum/tijd-gegevenstype.
Float	Gegevenstype floaten.
Nvarchar(max)	Nvarchar(max) gegevenstype.
Record	Recordgegevenstype.

DestinationType

Inventarisatie

Geeft het type van de bestemming aan. Er kunnen in de loop van de tijd extra doeltypen worden toegevoegd.

Waarde	Description
Activator	Het type Activator-doel.
CustomEndpoint	Het doeltype CustomEndpoint.
Eventhouse	Het doeltype Eventhouse.
Lakehouse	Het doeltype Lakehouse.

ErrorInfo

Object

Vertegenwoordigt de foutgegevens.

Name	Type	Description
errorCode	string	De foutcode.
errorDetails	string[]	De foutdetails.
errorMessage	string	Het foutbericht.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name	Type	Description
resourceId	string	De resource-id die betrokken is bij de fout.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

EventhouseDestinationResponse

Object

Antwoord van eventhouse-bestemming.

Name	Type	Description
error	ErrorInfo	De foutinformatie.
id	string (uuid)	De unieke id van de bestemming.
inputNodes	NodeReference[]	Een lijst met de verwijzingen naar de invoerknooppunten van de bestemming.
inputSchemas	InputSchema[]	De invoerschema's van de bestemming.
name	string	De unieke naam van de bestemming.
properties	EventhouseDestinationProperties: EventhouseDirectIngestionModeDestinationProperties EventhouseProcessedIngestionModeDestinationProperties	Eventhouse-doeleigenschappen.
status	NodeStatus	De status van het knooppunt. Er kan na verloop van tijd extra knooppuntstatus worden toegevoegd.
type	string: Eventhouse	Het type bestemming.

EventhouseDirectIngestionModeDestinationProperties

Object

Doeleigenschappen van de Eventhouse DirectIngestion-modus.

Name	Type	Description
connectionName	string	De verbindingsnaam.
dataIngestionMode	string: DirectIngestion	De gegevensopnamemodus.
itemId	string (uuid)	De item-id eventhouse.
mappingRuleName	string	De naam van de toewijzingsregel.
tableName	string	De naam van de KQL-tabel.
workspaceId	string (uuid)	De Eventhouse-werkruimte-id.

EventhouseProcessedIngestionModeDestinationProperties

Object

Doeleigenschappen van de Eventhouse ProcessedIngestion-modus.

Name	Type	Description
dataIngestionMode	string: ProcessedIngestion	De gegevensopnamemodus.
databaseName	string	De naam van de KQL-database.
inputSerialization	SerializationInfo: AvroSerializationInfo CsvSerializationInfo JsonSerializationInfo	Serialisatie-informatie.
itemId	string (uuid)	De item-id eventhouse.
tableName	string	De naam van de KQL-tabel.
workspaceId	string (uuid)	De Eventhouse-werkruimte-id.

InputSchema

Object

Vertegenwoordigt het invoerschema van de bron, bestemming of operator.

Name	Type	Description
name	string	De naam van het invoerschema.
schema	Schema	Vertegenwoordigt het schema van de gegevens.

JsonSerializationInfo

Object

JSON-serialisatiegegevens.

Name	Type	Description
properties	JsonSerializationProperties	JSON-serialisatie-eigenschappen.
type	string: Json	Het serialisatietype.

JsonSerializationProperties

Object

JSON-serialisatie-eigenschappen.

Name	Type	Description
encoding	enum: UTF8	Het coderingstype.

LakehouseDestinationProperties

Object

Lakehouse-doeleigenschappen.

Name	Type	Default value	Description
deltaTable	string		De naam van de deltatabel.
inputSerialization	SerializationInfo: AvroSerializationInfo CsvSerializationInfo JsonSerializationInfo		Serialisatie-informatie.
itemId	string (uuid)		De Lakehouse-item-id.
maximumDurationInSeconds	integer	120	De maximale duur in seconden voor een uitvoerbatch. De standaardwaarde is 120.
minimumRows	integer	100000	Het minimale aantal rijen voor een uitvoerbatch. De standaardwaarde is 100000.
schema	string		De schemanaam.
workspaceId	string (uuid)		De id van de Lakehouse-werkruimte.

LakehouseDestinationResponse

Object

Het doelantwoord van Lakehouse.

Name	Type	Description
error	ErrorInfo	De foutinformatie.
id	string (uuid)	De unieke id van de bestemming.
inputNodes	NodeReference[]	Een lijst met de verwijzingen naar de invoerknooppunten van de bestemming.
inputSchemas	InputSchema[]	De invoerschema's van de bestemming.
name	string	De unieke naam van de bestemming.
properties	LakehouseDestinationProperties	De eigenschappen van de Lakehouse-bestemming.
status	NodeStatus	De status van het knooppunt. Er kan na verloop van tijd extra knooppuntstatus worden toegevoegd.
type	string: Lakehouse	Het type bestemming.

NodeReference

Object

Vertegenwoordigt een verwijzing naar een knooppunt met behulp van de unieke naam.

Name	Type	Description
name	string	De unieke naam van het knooppunt.

NodeStatus

Inventarisatie

De status van het knooppunt. Er kan na verloop van tijd extra knooppuntstatus worden toegevoegd.

Waarde	Description
Created	Het knooppunt is gemaakt.
Creating	Het knooppunt wordt gemaakt.
Deleting	Het knooppunt wordt verwijderd.
External	De knooppuntstatus is afhankelijk van een externe service.
Failed	Het knooppunt is mislukt.
Paused	Het knooppunt is onderbroken.
Pausing	Het knooppunt wordt onderbroken.
Resuming	Het knooppunt wordt hervat.
Running	Het knooppunt wordt uitgevoerd.
Unknown	De status van het knooppunt is onbekend.
Updating	Het knooppunt wordt bijgewerkt.
Warning	Het knooppunt heeft een waarschuwing.

Schema

Object

Vertegenwoordigt het schema van de gegevens.

Name	Type	Description
columns	ColumnSchema[]	Een lijst met de kolommen in het schema.

SerializationType

Inventarisatie

Het serialisatietype.

Waarde	Description
Avro	Het serialisatietype is Avro.
Csv	Het serialisatietype is CSV.
Json	Het serialisatietype is JSON.