通过

Items - Update Eventstream Definition

服务:
Eventstream
API 版本:
v1

更新指定事件流的定义。 更新将替代当前定义。
此 API 支持 长时间运行的作（LRO）。

更新事件流定义不会影响其敏感度标签。

权限

调用方必须具有事件流的 读取和写入 权限。

所需的委派范围

Eventstream.ReadWrite.All 或 Item.ReadWrite.All

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

身份 支持
用户 是的
服务主体和托管标识 是的

接口

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 参数

名称 在 必需 类型 说明
eventstreamId
 path True

string (uuid)

事件流标识符。
workspaceId
 path True

string (uuid)

工作区 ID。
updateMetadata
 query

boolean

是否更新项的元数据（如果该文件中 .platform 提供）。 True - 如果元数据作为定义的一部分在 .platform 文件中提供，则更新元数据，False - 请勿更新元数据。

请求正文

名称 必需 类型 说明
definition True

EventstreamDefinition

Eventstream 公共定义对象。

响应

名称 类型 说明
200 OK

请求成功完成。
202 Accepted

请求已接受。 更新定义正在进行中。

标头

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

ErrorResponse

常见错误代码：

  • OperationNotSupportedForItem - 请求的项不支持作。

  • CorruptedPayload - 提供的有效负载已损坏。

示例

Update an eventstream definition example

示例请求

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": "eventstreamProperties.json",
        "payload": "ewogICJyZXRlbnRpb25UaW1l..V2ZWwiOiAiTG93Igp9",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

示例响应

状态代码:
200
状态代码:
202 
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

定义

名称 说明
ErrorRelatedResource

与错误相关的资源详细信息对象。
ErrorResponse

错误响应。
ErrorResponseDetails

错误响应详细信息。
EventstreamDefinition

Eventstream 公共定义对象。
EventstreamDefinitionPart

事件流定义部件对象。
PayloadType

定义部件有效负载的类型。 可能会随着时间的推移添加其他有效负载类型。
UpdateEventstreamDefinitionRequest

更新事件流公共定义请求有效负载。

ErrorRelatedResource

Object

与错误相关的资源详细信息对象。

名称 类型 说明
resourceId

string

错误中涉及的资源 ID。
resourceType

string

错误中涉及的资源的类型。

ErrorResponse

Object

错误响应。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
moreDetails

ErrorResponseDetails[]

其他错误详细信息的列表。
relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。
requestId

string

与错误关联的请求的 ID。

ErrorResponseDetails

Object

错误响应详细信息。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。

EventstreamDefinition

Object

Eventstream 公共定义对象。

名称 类型 说明
format

string

项定义的格式。
parts

EventstreamDefinitionPart[]

定义部件的列表。

EventstreamDefinitionPart

Object

事件流定义部件对象。

名称 类型 说明
path

string

事件流部件路径。
payload

string

事件流部分有效负载。
payloadType

PayloadType

有效负载类型。

PayloadType

枚举

定义部件有效负载的类型。 可能会随着时间的推移添加其他有效负载类型。

值 说明
InlineBase64

内联基线 64。

UpdateEventstreamDefinitionRequest

Object

更新事件流公共定义请求有效负载。

名称 类型 说明
definition

EventstreamDefinition

Eventstream 公共定义对象。