Items - Create Eventhouse
Creates an eventhouse in the specified workspace.
This API supports long running operations (LRO).
Permissions
The caller must have contributor or higher workspace role.
Required Delegated Scopes
Eventhouse.ReadWrite.All or Item.ReadWrite.All
Limitations
- To create an eventhouse the workspace must be on a supported Fabric capacity. For more information see: Microsoft Fabric license types.
Microsoft Entra supported identities
This API supports the Microsoft identities listed in this section.
Identity | Support |
---|---|
User | Yes |
Service principal and Managed identities | Yes |
Interface
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventhouses
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
workspace
|
path | True |
string uuid |
The workspace ID. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
displayName | True |
string |
The eventhouse display name. The eventhouse name can contain alphanumeric characters, underscores, periods, and hyphens. Special characters aren't supported. |
definition |
The eventhouse public definition. |
||
description |
string |
The eventhouse description. Maximum length is 256 characters. |
Responses
Name | Type | Description |
---|---|---|
201 Created |
Successfully created |
|
202 Accepted |
Request accepted, eventhouse provisioning in progress Headers
|
|
Other Status Codes |
Common error codes:
|
Examples
Create an eventhouse example |
Create an eventhouse with definition example |
Create an eventhouse example
Sample request
POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/eventhouses
{
"displayName": "Eventhouse_1",
"description": "An eventhouse description."
}
Sample response
{
"displayName": "Eventhouse_1",
"description": "An eventhouse description.",
"type": "Eventhouse",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047655"
}
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 eventhouse with definition example
Sample request
POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/eventhouses
{
"displayName": "Eventhouse_1",
"description": "An eventhouse description.",
"definition": {
"parts": [
{
"path": "EventhouseProperties.json",
"payload": "e30=",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
Sample response
{
"displayName": "Eventhouse_1",
"description": "An eventhouse description.",
"type": "Eventhouse",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047655"
}
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
Definitions
Name | Description |
---|---|
Create |
Create eventhouse request. |
Error |
The error related resource details object. |
Error |
The error response. |
Error |
The error response details. |
Eventhouse |
An eventhouse object. |
Eventhouse |
Eventhouse public definition object. |
Eventhouse |
Eventhouse definition part object. |
Eventhouse |
The eventhouse properties. |
Item |
The type of the item. Additional item types may be added over time. |
Payload |
The type of the definition part payload. Additional payload types may be added over time. |
CreateEventhouseRequest
Create eventhouse request.
Name | Type | Description |
---|---|---|
definition |
The eventhouse public definition. |
|
description |
string |
The eventhouse description. Maximum length is 256 characters. |
displayName |
string |
The eventhouse display name. The eventhouse name can contain alphanumeric characters, underscores, periods, and hyphens. Special characters aren't supported. |
ErrorRelatedResource
The error related resource details object.
Name | Type | Description |
---|---|---|
resourceId |
string |
The resource ID that's involved in the error. |
resourceType |
string |
The type of the resource that's involved in the error. |
ErrorResponse
The error response.
Name | Type | Description |
---|---|---|
errorCode |
string |
A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users. |
message |
string |
A human readable representation of the error. |
moreDetails |
List of additional error details. |
|
relatedResource |
The error related resource details. |
|
requestId |
string |
ID of the request associated with the error. |
ErrorResponseDetails
The error response details.
Name | Type | Description |
---|---|---|
errorCode |
string |
A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users. |
message |
string |
A human readable representation of the error. |
relatedResource |
The error related resource details. |
Eventhouse
An eventhouse object.
Name | Type | Description |
---|---|---|
description |
string |
The item description. |
displayName |
string |
The item display name. |
id |
string |
The item ID. |
properties |
The eventhouse properties. |
|
type |
The item type. |
|
workspaceId |
string |
The workspace ID. |
EventhouseDefinition
Eventhouse public definition object.
Name | Type | Description |
---|---|---|
format |
string |
The format of the item definition. |
parts |
A list of definition parts. |
EventhouseDefinitionPart
Eventhouse definition part object.
Name | Type | Description |
---|---|---|
path |
string |
The eventhouse part path. |
payload |
string |
The eventhouse part payload. |
payloadType |
The payload type. |
EventhouseProperties
The eventhouse properties.
Name | Type | Description |
---|---|---|
databasesItemIds |
string[] |
List of all KQL database children |
ingestionServiceUri |
string |
Ingestion service URI. |
queryServiceUri |
string |
Query service URI. |
ItemType
The type of the item. Additional item types may be added over time.
Name | Type | Description |
---|---|---|
Dashboard |
string |
PowerBI dashboard. |
DataPipeline |
string |
A data pipeline. |
Datamart |
string |
PowerBI datamart. |
Environment |
string |
An environment. |
Eventhouse |
string |
An eventhouse. |
Eventstream |
string |
An eventstream. |
KQLDashboard |
string |
A KQL dashboard. |
KQLDatabase |
string |
A KQL database. |
KQLQueryset |
string |
A KQL queryset. |
Lakehouse |
string |
A lakehouse. |
MLExperiment |
string |
A machine learning experiment. |
MLModel |
string |
A machine learning model. |
MirroredDatabase |
string |
A mirrored database. |
MirroredWarehouse |
string |
A mirrored warehouse. |
Notebook |
string |
A notebook. |
PaginatedReport |
string |
PowerBI paginated report. |
Reflex |
string |
A Reflex. |
Report |
string |
PowerBI report. |
SQLEndpoint |
string |
An SQL endpoint. |
SemanticModel |
string |
PowerBI semantic model. |
SparkJobDefinition |
string |
A spark job definition. |
Warehouse |
string |
A warehouse. |
PayloadType
The type of the definition part payload. Additional payload types may be added over time.
Name | Type | Description |
---|---|---|
InlineBase64 |
string |
Inline Base 64. |