編輯

共用方式為


Items - Update Eventstream Definition

Updates the definition of a specified eventstream. The update overrides the current definition.
This API supports long running operations (LRO).

Updating the eventstream definition, does not affect its sensitivity label.

Permissions

The API caller must have contributor or higher workspace role.

Required Delegated Scopes

Eventstream.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 Yes
Managed identities Yes

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventstreams/{eventstreamId}/updateDefinition
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventstreams/{eventstreamId}/updateDefinition?updateMetadata={updateMetadata}

URI Parameters

Name In Required Type Description
eventstreamId
path True

string

uuid

The eventstream ID.

workspaceId
path True

string

uuid

The workspace ID.

updateMetadata
query

boolean

Whether to update the item's metadata if it is provided in the .platform file. True - Update the metadata if it is provided in the .platform file as part of the definition, False - Do not update the metadata.

Request Body

Name Required Type Description
definition True

EventstreamDefinition

Eventstream public definition object.

Responses

Name Type Description
200 OK

Request completed successfully.

202 Accepted

Request accepted. Update 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.

  • CorruptedPayload - The provided payload is corrupted.

Examples

Update an eventstream definition example

Sample request

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/eventstreams/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "parts": [
      {
        "path": "eventstream.json",
        "payload": "SSdkIGxpa2UgdG8gdGVsbCBh..IGpva2UgZm9yIHlvdS4K",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Sample response

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Definitions

Name Description
ErrorRelatedResource

The error related resource details object.

ErrorResponse

The error response.

ErrorResponseDetails

The error response details.

EventstreamDefinition

Eventstream public definition object.

EventstreamDefinitionPart

Eventstream definition part object.

PayloadType

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

UpdateEventstreamDefinitionRequest

Update eventstream public definition request payload.

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.

EventstreamDefinition

Eventstream public definition object.

Name Type Description
format

string

The format of the item definition.

parts

EventstreamDefinitionPart[]

A list of definition parts.

EventstreamDefinitionPart

Eventstream definition part object.

Name Type Description
path

string

The eventstream part path.

payload

string

The eventstream part payload.

payloadType

PayloadType

The payload type.

PayloadType

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

Name Type Description
InlineBase64

string

Inline Base 64.

UpdateEventstreamDefinitionRequest

Update eventstream public definition request payload.

Name Type Description
definition

EventstreamDefinition

Eventstream public definition object.