次の方法で共有

Items - Get Eventstream Definition

サービス:
Eventstream
API バージョン:
v1

指定した eventstream パブリック定義を返します。
この API は、実行時間の長い操作 (LRO)をサポートします。

eventstream パブリック定義を取得する場合、秘密度ラベルは定義の一部ではありません。

権限

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

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

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

制限事項

この API は、暗号化された秘密度ラベルを持つイベントストリームに対してブロックされます。

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

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

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

インターフェイス

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventstreams/{eventstreamId}/getDefinition
省略可能なパラメーターを含む: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventstreams/{eventstreamId}/getDefinition?format={format}

URI パラメーター

名前 / 必須 型 説明
eventstreamId
 path True

string (uuid)

イベントストリーム ID。
workspaceId
 path True

string (uuid)

ワークスペース ID。
format
 query

string

eventstream パブリック定義の形式。

応答

名前 型 説明
200 OK

EventstreamDefinitionResponse

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

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

ヘッダー

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

ErrorResponse

一般的なエラー コード:

  • OperationNotSupportedForItem - 要求された項目に対する操作はサポートされていません。

例

Get an eventstream definition example

要求のサンプル

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/eventstreams/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

応答のサンプル

状態コード:
200 
{
  "definition": {
    "parts": [
      {
        "path": "eventstream.json",
        "payload": "SSdkIGxpa2UgdG8gdGVsbCBh..IGpva2UgZm9yIHlvdS4K",
        "payloadType": "InlineBase64"
      },
      {
        "path": "eventstreamProperties.json",
        "payload": "ewogICJyZXRlbnRpb25UaW1l..V2ZWwiOiAiTG93Igp9",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
状態コード:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

定義

名前 説明
ErrorRelatedResource

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

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
EventstreamDefinition

Eventstream パブリック定義オブジェクト。
EventstreamDefinitionPart

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

Eventstream パブリック定義の応答。
PayloadType

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

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

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

名前 型 説明
path

string

eventstream パーツのパス。
payload

string

eventstream パーツのペイロード。
payloadType

PayloadType

ペイロードの種類。

EventstreamDefinitionResponse

Object

Eventstream パブリック定義の応答。

名前 型 説明
definition

EventstreamDefinition

Eventstream パブリック定義オブジェクト。

PayloadType

列挙

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

値 説明
InlineBase64

インライン ベース 64。