Items - Update Eventstream Definition

指定したイベントストリームの定義を更新します。 更新プログラムは、現在の定義をオーバーライドします。
この API は、実行時間の長い操作 (LRO)をサポートします。

eventstream 定義を更新しても、その秘密度ラベルには影響しません。

権限

呼び出し元には、eventstream の 読み取りと書き込みの アクセス許可が必要です。

必要な委任されたスコープ

Eventstream.ReadWrite.All または Item.ReadWrite.All

Microsoft Entra でサポートされている ID

この API では、このセクションに記載されている Microsoft ID がサポートされています。

アイデンティティ 支援
ユーザー イエス
サービス プリンシパルとマネージド ID イエス

インターフェイス

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 パラメーター

Name / 必須 型 説明
eventstreamId
path True

string (uuid)

イベントストリーム ID。

workspaceId
path True

string (uuid)

ワークスペース ID。

updateMetadata
query

boolean

.platform ファイルにアイテムのメタデータが指定されている場合に、そのメタデータを更新するかどうか。 True - メタデータが定義の一部として .platform ファイルに指定されている場合は更新します。False - メタデータを更新しないでください。

要求本文

Name 必須 型 説明
definition True

EventstreamDefinition

Eventstream パブリック定義オブジェクト。 Eventstream 定義の構造の詳細については、この 記事 を参照してください。

応答

Name 型 説明
200 OK

要求は正常に完了しました。

202 Accepted

要求は受け入れ済み。 更新の定義が進行中です。

ヘッダー

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

サービス レートの制限を超えました。 サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す Retry-After ヘッダーを返します。

ヘッダー

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"
      }
    ]
  }
}

応答のサンプル

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

定義

Name 説明
ErrorParameter

エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。

ErrorRelatedResource

エラー関連のリソース詳細オブジェクト。

ErrorResponse

エラー応答。

ErrorResponseDetails

エラー応答の詳細。

EventstreamDefinition

Eventstream パブリック定義オブジェクト。 Eventstream 定義の構造の詳細については、この 記事 を参照してください。

EventstreamDefinitionPart

Eventstream 定義パーツ オブジェクト。

PayloadType

定義パーツペイロードの型。 追加のペイロードの種類は、時間の経過と同時に追加される場合があります。

UpdateEventstreamDefinitionRequest

eventstream パブリック定義要求ペイロードを更新します。

ErrorParameter

エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。

Name 型 説明
message

string

パラメーターの意味を人間が判読できる説明。

name

string

パラメータ識別子です。

value

string

パラメーターの値を指定します。

ErrorRelatedResource

エラー関連のリソース詳細オブジェクト。

Name 型 説明
resourceId

string

エラーに関係するリソース ID。

resourceType

string

エラーに関係するリソースの種類。

ErrorResponse

エラー応答。

Name 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。

isRetriable

boolean

true の場合、要求を再試行できます。 Retry-After応答ヘッダーを使用して、遅延 (使用可能な場合) を決定します。

message

string

エラーの人間が判読できる表現。

moreDetails

ErrorResponseDetails[]

その他のエラーの詳細の一覧。

parameters

ErrorParameter[]

エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。

relatedResource

ErrorRelatedResource

エラー関連のリソースの詳細。

requestId

string (uuid)

エラーに関連付けられている要求の ID。

ErrorResponseDetails

エラー応答の詳細。

Name 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。

message

string

エラーの人間が判読できる表現。

parameters

ErrorParameter[]

エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。

relatedResource

ErrorRelatedResource

エラー関連のリソースの詳細。

EventstreamDefinition

Eventstream パブリック定義オブジェクト。 Eventstream 定義の構造の詳細については、この 記事 を参照してください。

Name 型 説明
format

string

イベントストリーム定義の形式。

parts

EventstreamDefinitionPart[]

定義パーツの一覧。

EventstreamDefinitionPart

Eventstream 定義パーツ オブジェクト。

Name 型 説明
path

string

eventstream パーツのパス。

payload

string

eventstream パーツのペイロード。

payloadType

PayloadType

ペイロードの種類。

PayloadType

定義パーツペイロードの型。 追加のペイロードの種類は、時間の経過と同時に追加される場合があります。

値 説明
InlineBase64

インライン ベース 64。

UpdateEventstreamDefinitionRequest

eventstream パブリック定義要求ペイロードを更新します。

Name 型 説明
definition

EventstreamDefinition

Eventstream パブリック定義オブジェクト。 Eventstream 定義の構造の詳細については、この 記事 を参照してください。