編集

次の方法で共有

Items - Get Eventhouse Definition

  • Reference
Service:
Eventhouse
API Version:
v1

Returns the specified eventhouse public definition.
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

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/{eventhouseId}/getDefinition
With optional parameters: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventhouses/{eventhouseId}/getDefinition?format={format}

URI Parameters

Name In Required Type Description
eventhouseId
 path True

string

uuid

The eventhouse ID.
workspaceId
 path True

string

uuid

The workspace ID.
format
 query

string

The format of the eventhouse public definition.

Responses

Name Type Description
200 OK

EventhouseDefinitionResponse

Request completed successfully.
202 Accepted

Request accepted. Retrieving the definition is in progress.

Headers

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

ErrorResponse

Common error codes:

  • OperationNotSupportedForItem - Operation not supported for requested item.

Examples

Get an eventhouse definition example

Sample request

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/eventhouses/5b218778-e7a5-4d73-8187-f10824047715/getDefinition

Sample response

Status code:
200 
{
  "definition": {
    "parts": [
      {
        "path": "EventhouseProperties.json",
        "payload": "e30=",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
Status code:
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

Definitions

Name Description
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
EventhouseDefinition

Eventhouse public definition object.
EventhouseDefinitionPart

Eventhouse definition part object.
EventhouseDefinitionResponse

Eventhouse public definition response.
PayloadType

The type of the definition part payload. Additional payload types may be added over time.

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.

EventhouseDefinition

Eventhouse public definition object.

Name Type Description
format

string

The format of the item definition.
parts

EventhouseDefinitionPart[]

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

PayloadType

The payload type.

EventhouseDefinitionResponse

Eventhouse public definition response.

Name Type Description
definition

EventhouseDefinition

Eventhouse public definition object.

PayloadType

The type of the definition part payload. Additional payload types may be added over time.

Name Type Description
InlineBase64

string

Inline Base 64.