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 role on the workspace.

Required Delegated Scopes

Eventhouse.ReadWrite.All or Item.ReadWrite.All

Limitations

Interface

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

URI Parameters

Name In Required Type Description
workspaceId
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.

description

string

The eventhouse description. Maximum length is 256 characters.

Responses

Name Type Description
202 Accepted

Request accepted, eventhouse provisioning in progress

Headers

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Common error codes:

  • InvalidItemType - Item type is invalid

  • ItemDisplayNameAlreadyInUse - Item display name is already used

  • CorruptedPayload - The provided payload is corrupted

Examples

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

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
CreateEventhouseRequest

Create eventhouse request.

ErrorRelatedResource

The error related resource details object.

ErrorResponse

The error response.

ErrorResponseDetails

The error response details.

CreateEventhouseRequest

Create eventhouse request.

Name Type Description
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

ErrorResponseDetails[]

List of additional error details.

relatedResource

ErrorRelatedResource

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

ErrorRelatedResource

The error related resource details.