--- schema_version: "1" id: bc8f8629eb197f8e551be8e3ea648292f677a90d9a6ec988c1e93b0a5ed04ee7 title: Azure Event Hubs Connector リファレンス 1.1 collection: mulesoft version: current locale: ja-jp portal_url: https://docs.salesforce.com/mulesoft/current/ja-jp/azure-event-hubs-connector/1.1/azure-event-hubs-connector-reference.md canonical_url: https://docs.mulesoft.com/jp/azure-event-hubs-connector/1.1/azure-event-hubs-connector-reference source_site: docs.mulesoft.com content_type: documentation content_hash: 63d45dadb10e05f6272e36ad10475c8db13cb1036528ee99a9f9409c6947d162 description: MuleSoft Documentation Site release: "1.1" latest: false --- # Azure Event Hubs Connector リファレンス 1.1 Azure Event Hubs 用 Anypoint Connector (Azure Event Hubs Connector) を使用すると、イベントの生成とコンシュームをサポートできます。 ## [](#設定)設定 * * * ### [](#AzureEventhubs)Azure Event Hubs このクラスは拡張機能設定を表します。このクラスで設定された値は拡張機能のコアを表すため、複数の操作で一般的に使用されます。 #### [](#パラメーター)パラメーター
名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Connection (接続)

この設定の接続種別。

x

Name (名前)

String (文字列)

この設定の参照に使用される ID。

x

Expiration Policy (有効期限ポリシー)

Expiration Policy (有効期限ポリシー)

設定の有効期限ポリシーを設定します。
#### [](#接続種別)接続種別 ##### [](#AzureEventhubs_ActiveDirectoryAuthentication)Active Directory 認証 Azure Event Hubs Connector には、Active Directory を使用して Azure Event Hubs に接続するための 2 つのメカニズムがあります。 - サービスプリンシパル認証でトークンログイン情報プロパティ (TenantId、ClientId、ClientSecret) を使用して接続する。 - Azure.Identity ライブラリに属する DefaultAzureCredential を使用して接続する。 ###### [](#パラメーター-2)パラメーター
名前 型 説明 デフォルト値 必須

Token Credential Properties (トークンログイン情報プロパティ)

Token Credential Properties (トークンログイン情報プロパティ)

サービスプリンシパル認証を介してトークンを取得します。

Use Azure Default Credential (Azure のデフォルトログイン情報を使用)

Boolean (ブール)

DefaultAzureCredentials メカニズムを使用します。

false

Namespace (名前空間)

String (文字列)

Event Hubs 名前空間名。

x

Azure Endpoint (Azure エンドポイント)

String (文字列)

Event Hubs 名前空間の完全修飾ドメイン名。

servicebus.windows.net

Authority Host (機関ホスト)

String (文字列)

Azure Active Directory ホストを指定します。

https://login.microsoftonline.com/

Event Hub Name (イベントハブ名)

String (文字列)

イベントハブ名。

x

Share Connection (共有接続)

Boolean (ブール)

プロデューサーまたはコンシューマーの同じ接続を使用するビルダーを切り替えます。

false

Checkpoint Store Type (チェックポイントストア種別)

次のいずれかになります。

チェックポイント接続プロバイダーを選択します。

Reconnection (再接続)

[Reconnection]

コネクタ操作で外部サーバーへの接続に失敗した場合に使用する再接続戦略を設定します。
##### [](#AzureEventhubs_SasAuthentication)SAS 認証 共有アクセス署名 (SAS) により、イベントハブ名前空間のリソースへの制限付きアクセスを付与できます。SAS は、認証ルールに基づいて Event Hubs リソースへのアクセスを保護します。名前空間またはイベントハブのいずれかでこれらのルールを設定します。 ###### [](#パラメーター-3)パラメーター
名前 型 説明 デフォルト値 必須

Namespace (名前空間)

String (文字列)

Event Hubs 名前空間名。

x

Shared Access Key Name (共有アクセスキー名)

String (文字列)

Azure から提供される共有アクセスキー名。

x

Shared Access Key (共有アクセスキー)

String (文字列)

Azure から提供される共有アクセスキー値。

x

Event Hub Name (イベントハブ名)

String (文字列)

イベントハブ名。

x

Share Connection (共有接続)

Boolean (ブール)

プロデューサーまたはコンシューマーの同じ接続を使用するビルダーを切り替えます。

false

Checkpoint Store Type (チェックポイントストア種別)

次のいずれかになります。

Azure Blob Storage 接続プロバイダーを選択します。

Reconnection (再接続)

[Reconnection]

コネクタ操作で外部サーバーへの接続に失敗した場合に使用する再接続戦略を設定します。
## [](#サポートされている操作)サポートされている操作 - [Publish in bulk](#BulkPublish)​ - [Send a single event](#Publish)​ ## [](#関連付けられたソース)関連付けられたソース - [Partition Listener](#PartitionListener)​ - [Eventhub Listener](#EventhubListener)​ ## [](#操作)操作 ## [](#BulkPublish)Publish in bulk `` 指定されたイベントハブにイベントを一括送信します。 ### [](#パラメーター-4)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

この設定の参照に使用される ID。

x

Events (イベント)

Event (イベント)​ の配列

イベントのコンテンツ。

#[payload]

Correlation Id (相関 ID)

String (文字列)

相関 ID。

Content Type (コンテンツタイプ)

String (文字列)

EventBody に含まれるデータを記述する MIME タイプ。コンシューマーがイベントの調査および処理で情報に基づいた意思決定を行うことができるようにすることを目的としています。

Max Batch Size In Bytes (最大バッチサイズ (バイト))

Number (数値)

24 よりも大きな数値を使用できます。設定されていない場合、Azure アカウントで設定されたデフォルト値が使用されます。

0

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Partition Id (パーティション ID)

String (文字列)

パーティション ID。

Partition Key (パーティションキー)

String (文字列)

パーティションキー。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
### [](#次の設定の場合)次の設定の場合 - [Azure Event Hubs](#AzureEventhubs)​ ### [](#スロー)スロー - AZURE-EVENTHUBS:AEH\_ERROR​ - AZURE-EVENTHUBS:AUTHENTICATION - AZURE-EVENTHUBS:CONNECTIVITY - AZURE-EVENTHUBS:INVALID\_INPUT​ - AZURE-EVENTHUBS:RETRY\_EXHAUSTED​ ## [](#Publish)Send a single event `` 指定されたイベントハブにイベントを送信します。 ### [](#パラメーター-5)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Event (イベント)

Event (イベント)

イベントのコンテンツ。

#[payload]

Correlation Id (相関 ID)

String (文字列)

相関 ID。

Content Type (コンテンツタイプ)

String (文字列)

EventBody に含まれるデータを記述する MIME タイプ。コンシューマーがイベントの調査および処理で情報に基づいた意思決定を行うことができるようにすることを目的としています。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Partition Id (パーティション ID)

String (文字列)

パーティション ID。

Partition Key (パーティションキー)

String (文字列)

パーティションキー。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
### [](#次の設定の場合-2)次の設定の場合 - [Azure Event Hubs](#AzureEventhubs)​ ### [](#スロー-2)スロー - AZURE-EVENTHUBS:AEH\_ERROR​ - AZURE-EVENTHUBS:AUTHENTICATION - AZURE-EVENTHUBS:CONNECTIVITY - AZURE-EVENTHUBS:INVALID\_INPUT​ - AZURE-EVENTHUBS:RETRY\_EXHAUSTED​ ## [](#ソース)ソース ## [](#PartitionListener)Partition Listener `` 特定のイベントハブパーティションの名前空間のイベントを読み取ります。 ### [](#パラメーター-6)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

この設定の参照に使用される ID。

x

Partition Id (パーティション ID)

String (文字列)

イベントハブのパーティション ID。

x

Consumer Group (コンシューマーグループ)

String (文字列)

属するコンシューマーグループ。

Event Position Type (イベント位置種別)

次のいずれかになります。

イベントハブパーティションのイベントの位置を定義します。位置は、エンキュー時間、オフセット、連番、ストリームの開始、ストリームの終了になります。

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Output Encoding (出力エンコード)

String (文字列)

この操作で出力されるペイロードのエンコード。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Primary Node Only (プライマリノードのみ)

Boolean (ブール)

クラスターでの Mule インスタンスの実行時、このソースをプライマリノード上でのみ実行するかどうかを決定します。

true

On Capacity Overload (容量過負荷時)

Enumeration (列挙)。次のいずれかになります。

  • DROP

  • WAIT

フローで管理可能な容量を超えたメッセージを受信した場合に Mule が適用する戦略。

DROP

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Redelivery Policy (再配信ポリシー)

Redelivery Policy (再配信ポリシー)

同じメッセージの再配信を処理するためのポリシーを定義します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。
### [](#出力)出力

型

Any (任意)

Attributes Type (属性型)

イベント属性
### [](#次の設定の場合-3)次の設定の場合 - [Azure Event Hubs](#AzureEventhubs)​ ## [](#EventhubListener)Eventhub Listener `` イベントハブの名前空間のイベントを読み取ります。 ### [](#パラメーター-7)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

この設定の参照に使用される ID。

x

Consumer Group (コンシューマーグループ)

String (文字列)

属するコンシューマーグループ。

Checkpoint Frequency (チェックポイント頻度)

Number (数値)

チェックポイントを更新する頻度。例: 1000 件のイベントを受信するたび。

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Output Encoding (出力エンコード)

String (文字列)

この操作で出力されるペイロードのエンコード。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Primary Node Only (プライマリノードのみ)

Boolean (ブール)

クラスターでの Mule インスタンスの実行時、このソースをプライマリノード上でのみ実行するかどうかを決定します。

On Capacity Overload (容量過負荷時)

Enumeration (列挙)。次のいずれかになります。

  • DROP

  • WAIT

フローで管理可能な容量を超えたメッセージを受信した場合に Mule が適用する戦略。

DROP

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Redelivery Policy (再配信ポリシー)

Redelivery Policy (再配信ポリシー)

同じメッセージの再配信を処理するためのポリシーを定義します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。
### [](#出力-2)出力

型

Any (任意)

Attributes Type (属性型)

イベント属性
### [](#次の設定の場合-4)次の設定の場合 - [Azure Event Hubs](#AzureEventhubs)​ ## [](#型)型 ### [](#TokenCredentialProperties)Token Credential Properties (トークンログイン情報プロパティ)
項目 型 説明 デフォルト値 必須

Tenant Id (テナント ID)

String (文字列)

テナント ID。

Client Id (クライアント ID)

String (文字列)

クライアント ID。

Client Secret (クライアントシークレット)

String (文字列)

クライアントシークレット。
### [](#reconnection-再接続)Reconnection (再接続) 操作の再接続戦略を設定します。
項目 型 説明 デフォルト値 必須

Fails Deployment (デプロイメントに失敗)

Boolean (ブール)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。
### [](#reconnect-再接続)Reconnect (再接続) 標準再接続戦略を設定し、再接続の頻度と、コネクタソースまたは操作で実行できる再接続の試行回数を指定します。
項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続を試行する頻度 (ミリ秒)。

Blocking (ブロック)

Boolean (ブール)

false​ の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

Count (数)

Number (数値)

Mule アプリケーションで実行できる再接続の試行回数。
### [](#ReconnectForever)Reconnect Forever (繰り返し再接続) Mule アプリケーションが実行されている間はコネクタソースや操作によって指定された頻度で再接続が試行される Forever 再接続戦略を設定します。
項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続を試行する頻度 (ミリ秒)。

Blocking (ブロック)

Boolean (ブール)

false​ の場合、再接続戦略が個別の非ブロックスレッドで実行されます。
### [](#ExpirationPolicy)Expiration Policy (有効期限ポリシー) 有効期限ポリシー戦略を設定します。
項目 型 説明 デフォルト値 必須

Max Idle Time (最大アイドル時間)

Number (数値)

動的設定インスタンスがアイドル状態を続けられる最大時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。

Time Unit (時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Max Idle Time (最大アイドル時間)]​ 項目の時間単位。
### [](#EventAttributes)イベント属性
項目 型 説明 デフォルト値 必須

Content Type (コンテンツタイプ)

String (文字列)

EventBody に含まれるデータを記述する MIME タイプ。コンシューマーがイベントの調査および処理で情報に基づいた意思決定を行うことができるようにすることを目的としています。

Correlation Id (相関 ID)

String (文字列)

相関 ID。

Enqueued Time (エンキュー時間)

DateTime (日時)

イベントハブパーティションにイベントがエンキューされた日時 (UTC)。

Message Id (メッセージ ID)

String (文字列)

イベントを一意に識別するアプリケーションで定義された値。この識別子は自由形式の値で、GUID やアプリケーションコンテキストから派生した識別子を反映させることもできます。

Metadata (メタデータ)

Object (オブジェクト)

イベントに追加されるカスタムデータ。イベントパブリッシャーとコンシューマー間の調整を行うためにのみ存在します。

Offset (オフセット)

Number (数値)

オフセットは、パーティション内のイベントの位置です。

Sequence Number (連番)

Number (数値)

関連付けられたイベントハブパーティションにイベントがエンキューされたときにイベントに割り当てられる連番。
### [](#RepeatableInMemoryStream)Repeatable In Memory Stream (反復可能なメモリ内ストリーム) データが最大バッファサイズを超えた場合に要求が失敗するメモリ内ストリーミング戦略を設定します。ユースケースで最適なバッファサイズは、必ずパフォーマンステストを実施して決めてください。
項目 型 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

データストリームに割り当てるメモリの初期容量。ストリーミングされたデータがこの値を超える場合は、​[Buffer Size Increment (バッファサイズ増分)]​ の単位で ​[Max In Memory Size (最大メモリ内サイズ)]​ 値を上限としてバッファが拡張されます。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。

Max Buffer Size (最大バッファサイズ)

Number (数値)

バッファの最大サイズ。バッファサイズがこの値を超える場合、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。​0​ 以下の値は無制限を意味します。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE

  • KB

  • MB

  • GB

[Initial Buffer Size (初期バッファサイズ)]​ 項目、​[Buffer Size Increment (バッファサイズ増分)]​ 項目、​[Buffer Unit (バッファ単位)]​ 項目の単位。
### [](#RepeatableFileStoreStream)Repeatable File Store Stream (反復可能なファイルストアストリーム) 反復可能なファイルストアストリーミング戦略を設定します。この戦略では、ストリームコンテンツの一部がメモリ内に格納されます。ストリームのコンテンツが、設定されたバッファサイズよりも大きい場合、Mule はバッファのコンテンツをディスクにバックアップしてからメモリをクリアします。
項目 型 説明 デフォルト値 必須

In Memory Size (メモリ内サイズ)

Number (数値)

ストリームのデータで使用できるメモリの最大量。メモリ量がこの値を超えると、コンテンツはディスクにバッファされます。パフォーマンスを最適化する方法は、次のとおりです。

  • バッファサイズを大きくすると、Mule がバッファをディスクに書き込む回数を減らせます。これによってパフォーマンスが高まりますが、より多くのメモリが必要になるため、アプリケーションが処理できる同時要求数が制限されます。

  • バッファサイズを小さくすると、メモリの負荷は低減しますが、応答時間が長くなります。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE

  • KB

  • MB

  • GB

[In Memory Size (メモリ内サイズ)]​ 項目の単位。
### [](#RedeliveryPolicy)Redelivery Policy (再配信ポリシー) エラーを生成する要求を実行するための再配信ポリシーを設定します。再配信ポリシーは、フロー内のあらゆる提供元に追加できます。
項目 型 説明 デフォルト値 必須

Max Redelivery Count (最大再配信数)

Number (数値)

再配信される要求の最大処理失敗回数。この回数を超えると、​REDELIVERY_EXHAUSTED​ エラーが返されます。

Message Digest Algorithm (メッセージダイジェストアルゴリズム)

String (文字列)

[Use Secure Hash (セキュアハッシュを使用)]​ 項目が ​true​ の場合に使用するセキュアハッシュアルゴリズム。メッセージのペイロードが Java オブジェクトの場合、Mule ではこの値が無視され、ペイロードの ​hashCode()​ が返した値が返されます。

Message Identifier (メッセージ識別子)

Redelivery Policy Message Identifier (再配信ポリシーメッセージ識別子)

メッセージが再配信されたかどうかを判断する 1 つ以上の式。このプロパティは、​[Use Secure Hash (セキュアハッシュを使用)]​ 項目が ​false​ の場合にのみ設定できます。

Object Store (オブジェクトストア)

ObjectStore

各メッセージの再配信カウンターが保存されるオブジェクトストアを設定します。
### [](#RedeliveryPolicyMessageIdentifier)Redelivery Policy Message Identifier (再配信ポリシーメッセージ識別子) 再配信されたメッセージを識別する方法と、メッセージがいつ再配信されたのかを見つける方法を設定します。
項目 型 説明 デフォルト値 必須

Use Secure Hash (セキュアハッシュを使用)

Boolean (ブール)

true​ の場合、Mule では再配信されたメッセージの識別にセキュアハッシュアルゴリズムを使用します。

Id Expression (ID 式)

String (文字列)

メッセージがいつ再配信されたのかを判断する 1 つ以上の式。このプロパティは、​[Use Secure Hash (セキュアハッシュを使用)]​ 項目が ​false​ の場合にのみ設定できます。
### [](#Event)Event (イベント)
項目 型 説明 デフォルト値 必須

Body (本文)

String (文字列)

イベントの本文。

Metadata (メタデータ)

Object (オブジェクト)

イベントのメタデータ。
### [](#OffSet)Off Set (オフセット)
項目 型 説明 デフォルト値 必須

オフセット

Number (数値)

オフセットは、パーティション内のイベントの位置です。

x
### [](#Sequence)連番
項目 型 説明 デフォルト値 必須

連番

Number (数値)

関連付けられたイベントハブパーティションにイベントがエンキューされたときにイベントに割り当てられる連番。

x
### [](#EnqueuedTime)Enqueued Time (エンキュー時間)
項目 型 説明 デフォルト値 必須

Instant (即時)

String (文字列)

イベントの検索を開始するエンキュー時間を選択します。

x
### [](#AzureBlobStorageSasAuthentication)Azure Blob Storage SAS 認証
項目 型 説明 デフォルト値 必須

Container Name (コンテナ名)

String (文字列)

コンテナ名。

x

Account Name (アカウント名)

String (文字列)

Azure アカウントのアカウント名。

x

Account Key (アカウントキー)

String (文字列)

Azure アカウントのアカウントキー。

x
### [](#AzureBlobStorageActiveDirectoryAuthentication)Azure Blob Storage Active Directory 認証
項目 型 説明 デフォルト値 必須

Token Credential Properties (トークンログイン情報プロパティ)

Token Credential Properties (トークンログイン情報プロパティ)

サービスプリンシパル認証を介してトークンを取得します。

Use Azure Default Credential (Azure のデフォルトログイン情報を使用)

Boolean (ブール)

このフラグを ​true​ に設定すると、認証するトークンを取得するための DefaultAzureCredential Class(Azure.Identity) が作成されます。

false

Container Name (コンテナ名)

String (文字列)

コンテナ名。

x

Account Name (アカウント名)

String (文字列)

Azure アカウントのアカウント名。

x

Authority Host (機関ホスト)

String (文字列)

Azure Active Directory ホストを指定します。

https://login.microsoftonline.com/
### [](#SasAuthentication)SAS 認証
項目 型 説明 デフォルト値 必須

Namespace (名前空間)

String (文字列)

Event Hubs 名前空間名。

x

Shared Access Key Name (共有アクセスキー名)

String (文字列)

Azure から提供される共有アクセスキー名。

x

Shared Access Key (共有アクセスキー)

String (文字列)

Azure から提供される共有アクセスキー値。

x

Event Hub Name (イベントハブ名)

String (文字列)

イベントハブ名。

x

Share Connection (共有接続)

Boolean (ブール)

プロデューサーまたはコンシューマーの同じ接続を使用するビルダーを切り替えます。

false

Checkpoint Store Type (チェックポイントストア種別)

次のいずれかになります。

チェックポイント接続プロバイダーを選択します。
### [](#ActiveDirectoryAuthentication)Active Directory 認証
項目 型 説明 デフォルト値 必須

Token Credential Properties (トークンログイン情報プロパティ)

Token Credential Properties (トークンログイン情報プロパティ)

サービスプリンシパル認証を介してトークンを取得します。

Use Azure Default Credential (Azure のデフォルトログイン情報を使用)

Boolean (ブール)

このフラグを ​true​ に設定すると、認証するトークンを取得するための DefaultAzureCredential Class(Azure.Identity) が作成されます。

false

Namespace (名前空間)

String (文字列)

Event Hubs 名前空間名。

x

Authority Host (機関ホスト)

String (文字列)

Azure Active Directory ホストを指定します。

https://login.microsoftonline.com/

Event Hub Name (イベントハブ名)

String (文字列)

イベントハブ名。

x

Share Connection (共有接続)

Boolean (ブール)

プロデューサーまたはコンシューマーの同じ接続を使用するビルダーを切り替えます。

false

Checkpoint Store Type (チェックポイントストア種別)

次のいずれかになります。

チェックポイント接続プロバイダーを選択します。