Service Bus
Azure Service Bus に接続してメッセージを送受信します。 キューへの送信、トピックへの送信、キューからの受信、サブスクリプションからの受信などのアクションを実行できます。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC High) |
| ロジック アプリ | Standard | すべての Logic Apps リージョン |
| Power Apps | Premium | 次を除くすべての Power Apps リージョン : - 米国政府 (GCC High) |
| Power Automate | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC High) |
| お問い合わせ | |
|---|---|
| 名前 | Microsoft |
| URL |
Microsoft LogicApps のサポート Microsoft Power Automate のサポート Microsoft Power Apps のサポート |
| コネクタ メタデータ | |
|---|---|
| Publisher | Microsoft |
| Website | https://azure.microsoft.com/services/service-bus/ |
一般的な既知の問題と制限事項
無限ループ
同じコネクタの種類を持つトリガーとアクションの両方を選択し、キューやトピック のサブスクリプションなど、同じエンティティを操作するために使用する場合は注意が必要です。 この組み合わせにより無限ループが作成され、ワークフローが終了することはありません。
たとえば、ワークフローで、キューで新しく受信したメッセージを返す Service Bus トリガーを使用し、そのトリガーに従って、メッセージを同じキューに送り返す Service Bus アクションを使用するとします。 このパターンにより無限ループが作成され、ワークフローが無期限になる可能性があります。
コネクタ キャッシュ内の保存済みセッションの制限
Service Bus コネクタは、サブスクリプションやトピックなどの Service Bus メッセージング エンティティごとに、一度に最大 1,500 個の一意のセッションをコネクタ キャッシュに保存できます。 セッション数がこの制限を超えると、古いセッションはキャッシュから削除されます。 詳細については、メッセージ セッションに関するページを参照してください。
長いポーリング トリガー
Azure Service Bus マネージド コネクタの場合、すべてのトリガーは 長いポーリングです。 このトリガーの種類では、すべてのメッセージを処理し、キューまたはトピック サブスクリプションにさらにメッセージが届くのを 30 秒間待機します。 30 秒以内にメッセージが届かなかった場合、トリガーの実行はスキップされます。 受信した場合、トリガーはキューまたはトピック サブスクリプションが空になるまでメッセージの読み取りを続けます。 次のトリガーのポーリングは、トリガーのプロパティで指定された繰り返し間隔に基づいています。
Microsoft Entra ID 認証
Microsoft Entra ID 認証を使用するには、ユーザー アカウントに特定のロールの割り当てが必要です。 詳細については、「 アクセス権の Azure ロールの割り当て - Azure Service Bus」を参照してください。
マネージド ID の認証
現時点では、 マネージド ID 認証 は Azure Logic Apps でのみサポートされています。
ロジック アプリ ワークフローから Service Bus 名前空間とメッセージング エンティティへのアクセスを認証するマネージド ID を使用するには、対応するレベルでロールのアクセス許可を割り当てるようにします。 たとえば、キューにアクセスする場合、マネージド ID には、そのキューに必要なアクセス許可を持つロールが必要です。
異なるメッセージング エンティティにアクセスする各マネージド ID には、そのエンティティへの個別の接続が必要です。 異なる Azure Service Bus アクションを使用してメッセージを送受信し、それらのアクションに異なるアクセス許可が必要な場合は、必ず異なる接続を使用してください。
Azure Service Bus で使用するマネージド ID を有効にするには、次の大まかな手順に従います。
ロジック アプリ リソースのマネージド ID を有効または作成します。 詳細については、「 Azure Logic Apps でマネージド ID を使用して Azure リソースへのアクセスを認証する」を参照してください。
ID に Azure Service Bus リソースへのアクセス権を付与します。 詳細については、 アクセス権の Azure ロールの割り当てに関するページを参照してください - Azure Service Bus
ユーザー割り当て ID の場合は、ロジック アプリ リソースに ID を追加します。 Azure Logic Apps のマネージド ID の詳細については、「Azure Logic Apps でマネージド ID を使用して Azure リソースへのアクセスを認証する」を参照してください。
コネクタの詳細
この記事では、Azure Logic Apps、Power Automate、Power Apps で使用できる Azure Service Bus マネージド コネクタの操作について説明します。 Azure Service Bus 組み込み コネクタは、Azure Logic Apps の Standard ロジック アプリ ワークフローでのみ使用できます。
Azure Logic Apps の Azure Service Bus 組み込みコネクタとマネージド コネクタの詳細については、「Azure Logic Apps のワークフローから Azure Service Bus に接続する」を参照してください。
接続を作成する
コネクタでは、次の認証の種類がサポートされています。
| アクセス キー | Azure Service Bus にアクセスするための接続文字列を指定します。 | Azure Government と US Government (GCC) と米国政府機関 (GCC-High) の Azure Government および国防総省 (DoD) を除くすべてのリージョン | 共有不可 |
| アクセス キー (Azure Government) | Azure Service Bus にアクセスするための接続文字列を指定します。 | Azure Government および US Government (GCC) と米国政府機関 (GCC-High) の Azure Government および国防総省 (DoD) のみ | 共有不可 |
| クライアント証明書の認証 | PFX 証明書とパスワードを使用して Microsoft Entra ID 資格情報を指定する | すべてのリージョン | 共有可能 |
| ロジック アプリのマネージド ID | LogicApps マネージド ID を使用して接続を作成する | LOGICAPPS のみ | 共有可能 |
| Microsoft Entra ID 統合 | Microsoft Entra ID を使用して Azure Service Bus にアクセスします。 | Azure Government と US Government (GCC) と米国政府機関 (GCC-High) の Azure Government および国防総省 (DoD) を除くすべてのリージョン | 共有不可 |
| Microsoft Entra ID Integrated (Azure Government) | Microsoft Entra ID を使用して Azure Service Bus にアクセスします。 | Azure Government および US Government (GCC) と米国政府機関 (GCC-High) の Azure Government および国防総省 (DoD) のみ | 共有不可 |
| 既定 [非推奨] | このオプションは、明示的な認証の種類がない古い接続に対してのみ行われ、下位互換性のためにのみ提供されます。 | すべてのリージョン | 共有不可 |
アクセス キー
認証 ID: connectionstringauth
適用: Azure Government および米国政府 (GCC) および米国政府 (GCC-High) の Azure Government および国防総省 (DoD) を除くすべてのリージョン
Azure Service Bus にアクセスするための接続文字列を指定します。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| 接続文字列 | securestring | Azure Service Bus 接続文字列 | 正しい |
アクセス キー (Azure Government)
認証 ID: connectionstringauth
適用: Azure Government および米国政府 (GCC) と米国政府 (GCC-High) の Azure Government および国防総省 (DoD) のみ
Azure Service Bus にアクセスするための接続文字列を指定します。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| 接続文字列 | securestring | Azure Service Bus 接続文字列 | 正しい |
クライアント証明書の認証
認証 ID: CertOauth
適用対象: すべてのリージョン
PFX 証明書とパスワードを使用して Microsoft Entra ID 資格情報を指定する
これは共有可能な接続です。 電源アプリが別のユーザーと共有されている場合は、接続も共有されます。 詳細については、 キャンバス アプリのコネクタの概要 - Power Apps |Microsoft Docs
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| Tenant | 文字列 | 正しい | |
| クライアントID | 文字列 | Microsoft Entra ID アプリケーションのクライアント ID | 正しい |
| クライアント証明書シークレット | クライアント証明書 | このアプリケーションで許可されるクライアント証明書シークレット | 正しい |
| 名前空間エンドポイント | 文字列 | Service Bus 名前空間エンドポイントを指定する (例: sb://testsb.servicebus.windows.net/) | 正しい |
Logic Apps マネージド ID
認証 ID: managedIdentityAuth
適用: LOGICAPPS のみ
LogicApps マネージド ID を使用して接続を作成する
これは共有可能な接続です。 電源アプリが別のユーザーと共有されている場合は、接続も共有されます。 詳細については、 キャンバス アプリのコネクタの概要 - Power Apps |Microsoft Docs
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| LogicApps マネージド ID | managedIdentity | Logic Apps マネージド ID を使用してサインインする | 正しい |
| 名前空間エンドポイント | 文字列 | Service Bus 名前空間エンドポイントを指定する (例: sb://testsb.servicebus.windows.net/) | 正しい |
Microsoft Entra ID 統合
認証 ID: aadAuth
適用: Azure Government および米国政府 (GCC) および米国政府 (GCC-High) の Azure Government および国防総省 (DoD) を除くすべてのリージョン
Microsoft Entra ID を使用して Azure Service Bus にアクセスします。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| 名前空間エンドポイント | 文字列 | Service Bus 名前空間エンドポイントを指定する (例: sb://testsb.servicebus.windows.net/) | 正しい |
Microsoft Entra ID Integrated (Azure Government)
認証 ID: aadAuth
適用: Azure Government および米国政府 (GCC) と米国政府 (GCC-High) の Azure Government および国防総省 (DoD) のみ
Microsoft Entra ID を使用して Azure Service Bus にアクセスします。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| 名前空間エンドポイント | 文字列 | Service Bus 名前空間エンドポイントを指定する (例: sb://testsb.servicebus.windows.net/) | 正しい |
既定 [非推奨]
適用対象: すべてのリージョン
このオプションは、明示的な認証の種類がない古い接続に対してのみ行われ、下位互換性のためにのみ提供されます。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| 接続文字列 | securestring | Azure Service Bus 接続文字列 | 正しい |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 6000 | 60 秒 |
アクション
| 1 つ以上のメッセージを送信する |
この操作は、キューまたはトピックに 1 つ以上のメッセージを送信します。 |
| キューからメッセージを取得する (ピーク ロック) |
操作は、ピーク ロックを使用してキューからメッセージを受信します。 最大メッセージ数が指定されていない場合は、20 個のメッセージを読み取ります。 |
| キューから遅延メッセージを取得する |
この操作は、キューから遅延メッセージを取得します。 |
| キュー内のセッションのロックを更新する |
この操作により、キュー内のセッションが更新されます。 |
| キュー内のセッションを閉じる |
この操作により、キュー内のセッションが閉じられます。 |
| キュー内のメッセージのロックを更新する |
この操作により、キュー内のメッセージのロックが更新されます。 |
| キュー内のメッセージの配信不能 |
この操作により、メッセージが Dead-Letter キューに移動されます。 |
| キュー内のメッセージを完了する |
この操作により、キュー内のメッセージが完了します。 |
| キュー内のメッセージを延期する |
この操作により、キュー内のメッセージが延期されます。 |
| キュー内のメッセージを破棄する |
この操作により、キュー内のメッセージが破棄されます。 |
| トピック サブスクリプションからメッセージを取得する (ピーク ロック) |
操作は、ピーク ロックを使用してトピック サブスクリプションからメッセージを受信します。 最大メッセージ数が指定されていない場合は、20 個のメッセージを読み取ります。 |
| トピック サブスクリプションから遅延メッセージを取得する |
この操作は、トピック サブスクリプションから遅延メッセージを取得します。 |
| トピック サブスクリプションでメッセージを完了する |
操作は、トピック サブスクリプション内のメッセージを完了します。 |
| トピック サブスクリプションでメッセージを延期する |
この操作により、トピック サブスクリプション内のメッセージが延期されます。 |
| トピック サブスクリプションでメッセージを破棄する |
この操作は、トピック サブスクリプション内のメッセージを破棄します。 |
| トピック サブスクリプションのセッションのロックを更新する |
この操作により、トピック サブスクリプション内のセッションが更新されます。 |
| トピック サブスクリプションを作成する |
操作によってトピック サブスクリプションが作成されます。 |
| トピック サブスクリプションを削除する |
操作によってトピック サブスクリプションが削除されます。 |
| トピック サブスクリプション内のメッセージのロックを更新する |
この操作により、トピック サブスクリプション内のメッセージのロックが更新されます。 |
| トピック サブスクリプション内のメッセージの配信不能 |
この操作により、メッセージがキュー Dead-Letter トピックに移動されます。 |
| トピックのセッションを閉じる |
この操作は、トピック内のセッションを閉じます。 |
| メッセージの送信 |
この操作により、メッセージがキューまたはトピックに送信されます。 |
1 つ以上のメッセージを送信する
この操作は、キューまたはトピックに 1 つ以上のメッセージを送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キュー/トピック名
|
entityName | True | string |
キューまたはトピックの名前 |
|
Content
|
ContentData | byte |
メッセージの内容 |
|
|
コンテンツ タイプ
|
ContentType | string |
メッセージ コンテンツのコンテンツ タイプ |
|
|
プロパティ
|
Properties | object |
各ブローカー プロパティのキーと値のペア |
|
|
メッセージ ID
|
MessageId | string |
これは、Service Bus が重複するメッセージを識別するために使用できるユーザー定義の値です (有効な場合)。 |
|
|
移行先
|
To | string |
アドレスに送信 |
|
|
返信先
|
ReplyTo | string |
応答するキューのアドレス |
|
|
セッション ID に返信する
|
ReplyToSessionId | string |
返信するセッションの識別子 |
|
|
ラベル
|
Label | string |
アプリケーション固有のラベル |
|
|
ScheduledEnqueueTimeUtc
|
ScheduledEnqueueTimeUtc | date-time |
メッセージがキューに追加される日時 (UTC) |
|
|
セッション ID
|
SessionId | string |
セッションの識別子 |
|
|
関連付け ID
|
CorrelationId | string |
相関関係の識別子 |
|
|
シーケンス番号
|
SequenceNumber | integer |
シーケンス番号の識別子 |
|
|
ロック トークン
|
LockToken | string |
文字列としてのメッセージのロック トークン。 |
|
|
Time To Live
|
TimeToLive | integer |
これは、メッセージが有効な期間 (ティック単位) です。 期間は、メッセージが Service Bus に送信された時点から開始されます。 |
|
|
システム プロパティ
|
systemProperties | string |
システム プロパティ - なしまたは実行の詳細。 実行の詳細では、実行メタデータ プロパティの詳細がカスタム プロパティとしてメッセージに追加されます。 |
キューからメッセージを取得する (ピーク ロック)
操作は、ピーク ロックを使用してキューからメッセージを受信します。 最大メッセージ数が指定されていない場合は、20 個のメッセージを読み取ります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キュー名
|
queueName | True | string |
キューの名前 |
|
最大メッセージ数
|
maxMessageCount | integer |
バッチで返されるメッセージの最大数 |
|
|
[キューの種類]
|
queueType | string |
キューの種類 - Main または DeadLetter |
|
|
セッション ID
|
sessionId | string |
セッション ID |
戻り値
- response
- array of ServiceBusMessage
キューから遅延メッセージを取得する
この操作は、キューから遅延メッセージを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キュー名
|
queueName | True | string |
キューの名前 |
|
メッセージのシーケンス番号
|
sequenceNumber | True | integer |
メッセージのシーケンス番号 |
|
[キューの種類]
|
queueType | string |
キューの種類 - Main または DeadLetter |
|
|
セッション ID
|
sessionId | string |
セッション ID |
戻り値
Service Bus メッセージ
- Body
- ServiceBusMessage
キュー内のセッションのロックを更新する
この操作により、キュー内のセッションが更新されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キュー名
|
queueName | True | string |
キューの名前 |
|
セッション ID
|
sessionId | True | string |
セッション ID |
キュー内のセッションを閉じる
この操作により、キュー内のセッションが閉じられます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キュー名
|
queueName | True | string |
キューの名前 |
|
セッション ID
|
sessionId | True | string |
セッション ID |
キュー内のメッセージのロックを更新する
この操作により、キュー内のメッセージのロックが更新されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キュー名
|
queueName | True | string |
キューの名前 |
|
メッセージのロック トークン
|
lockToken | True | string |
ロックを更新するためのメッセージのロック トークン |
|
[キューの種類]
|
queueType | string |
キューの種類 - Main または DeadLetter |
キュー内のメッセージの配信不能
この操作により、メッセージが Dead-Letter キューに移動されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キュー名
|
queueName | True | string |
キューの名前 |
|
メッセージのロック トークン
|
lockToken | True | string |
メッセージのトークンを配信不能にロックする |
|
セッション ID
|
sessionId | string |
セッション ID |
|
|
配信不能の理由
|
deadLetterReason | string |
配信不能の理由 |
|
|
配信不能エラーの説明
|
deadLetterErrorDescription | string |
配信不能エラーの説明 |
キュー内のメッセージを完了する
この操作により、キュー内のメッセージが完了します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キュー名
|
queueName | True | string |
キューの名前 |
|
メッセージのロック トークン
|
lockToken | True | string |
メッセージのトークンをロックして完了する |
|
[キューの種類]
|
queueType | string |
キューの種類 - Main または DeadLetter |
|
|
セッション ID
|
sessionId | string |
セッション ID |
キュー内のメッセージを延期する
この操作により、キュー内のメッセージが延期されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キュー名
|
queueName | True | string |
キューの名前 |
|
メッセージのロック トークン
|
lockToken | True | string |
メッセージのトークンを保留にロックする |
|
[キューの種類]
|
queueType | string |
キューの種類 - Main または DeadLetter |
|
|
セッション ID
|
sessionId | string |
セッション ID |
キュー内のメッセージを破棄する
この操作により、キュー内のメッセージが破棄されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キュー名
|
queueName | True | string |
キューの名前 |
|
メッセージのロック トークン
|
lockToken | True | string |
破棄するメッセージのロック トークン |
|
[キューの種類]
|
queueType | string |
キューの種類 - Main または DeadLetter |
|
|
セッション ID
|
sessionId | string |
セッション ID |
トピック サブスクリプションからメッセージを取得する (ピーク ロック)
操作は、ピーク ロックを使用してトピック サブスクリプションからメッセージを受信します。 最大メッセージ数が指定されていない場合は、20 個のメッセージを読み取ります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック名
|
topicName | True | string |
トピックの名前 |
|
トピック サブスクリプション名
|
subscriptionName | True | string |
トピック サブスクリプションの名前 |
|
最大メッセージ数
|
maxMessageCount | integer |
バッチで返されるメッセージの最大数 |
|
|
サブスクリプションの種類
|
subscriptionType | string |
サブスクリプションの種類 - Main または DeadLetter |
|
|
セッション ID
|
sessionId | string |
セッション ID |
戻り値
- response
- array of ServiceBusMessage
トピック サブスクリプションから遅延メッセージを取得する
この操作は、トピック サブスクリプションから遅延メッセージを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック名
|
topicName | True | string |
トピックの名前 |
|
トピック サブスクリプション名
|
subscriptionName | True | string |
トピック サブスクリプションの名前 |
|
メッセージのシーケンス番号
|
sequenceNumber | True | integer |
メッセージのシーケンス番号 |
|
サブスクリプションの種類
|
subscriptionType | string |
キューの種類 - Main または DeadLetter |
|
|
セッション ID
|
sessionId | string |
セッション ID |
戻り値
Service Bus メッセージ
- Body
- ServiceBusMessage
トピック サブスクリプションでメッセージを完了する
操作は、トピック サブスクリプション内のメッセージを完了します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック名
|
topicName | True | string |
トピックの名前 |
|
トピック サブスクリプション名
|
subscriptionName | True | string |
トピック サブスクリプションの名前 |
|
メッセージのロック トークン
|
lockToken | True | string |
メッセージのトークンをロックして完了する |
|
サブスクリプションの種類
|
subscriptionType | string |
サブスクリプションの種類 - Main または DeadLetter |
|
|
セッション ID
|
sessionId | string |
セッション ID |
トピック サブスクリプションでメッセージを延期する
この操作により、トピック サブスクリプション内のメッセージが延期されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック名
|
topicName | True | string |
トピックの名前 |
|
トピック サブスクリプション名
|
subscriptionName | True | string |
トピック サブスクリプションの名前 |
|
メッセージのロック トークン
|
lockToken | True | string |
メッセージのトークンを保留にロックする |
|
サブスクリプションの種類
|
subscriptionType | string |
サブスクリプションの種類 - Main または DeadLetter |
|
|
セッション ID
|
sessionId | string |
セッション ID |
トピック サブスクリプションでメッセージを破棄する
この操作は、トピック サブスクリプション内のメッセージを破棄します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック名
|
topicName | True | string |
トピックの名前 |
|
トピック サブスクリプション名
|
subscriptionName | True | string |
トピック サブスクリプションの名前 |
|
メッセージのロック トークン
|
lockToken | True | string |
破棄するメッセージのロック トークン |
|
サブスクリプションの種類
|
subscriptionType | string |
サブスクリプションの種類 - Main または DeadLetter |
|
|
セッション ID
|
sessionId | string |
セッション ID |
トピック サブスクリプションのセッションのロックを更新する
この操作により、トピック サブスクリプション内のセッションが更新されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック名
|
topicName | True | string |
トピックの名前 |
|
トピック サブスクリプション名
|
subscriptionName | True | string |
トピック サブスクリプションの名前 |
|
セッション ID
|
sessionId | True | string |
セッション ID |
トピック サブスクリプションを作成する
操作によってトピック サブスクリプションが作成されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック名
|
topicName | True | string |
トピックの名前 |
|
トピック サブスクリプション名
|
subscriptionName | True | string |
トピック サブスクリプションの名前 |
|
Filter
|
subscriptionFilter | True | dynamic |
サブスクリプション フィルター |
|
フィルターの種類
|
subscriptionFilterType | string |
フィルターの種類 |
戻り値
トピック サブスクリプション。
- Body
- Subscription
トピック サブスクリプションを削除する
操作によってトピック サブスクリプションが削除されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック名
|
topicName | True | string |
トピックの名前 |
|
トピック サブスクリプション名
|
subscriptionName | True | string |
トピック サブスクリプションの名前 |
トピック サブスクリプション内のメッセージのロックを更新する
この操作により、トピック サブスクリプション内のメッセージのロックが更新されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック名
|
topicName | True | string |
トピックの名前 |
|
トピック サブスクリプション名
|
subscriptionName | True | string |
トピック サブスクリプションの名前 |
|
メッセージのロック トークン
|
lockToken | True | string |
ロックを更新するためのメッセージのロック トークン |
|
サブスクリプションの種類
|
subscriptionType | string |
サブスクリプションの種類 - Main または DeadLetter |
トピック サブスクリプション内のメッセージの配信不能
この操作により、メッセージがキュー Dead-Letter トピックに移動されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック名
|
topicName | True | string |
トピックの名前 |
|
トピック サブスクリプション名
|
subscriptionName | True | string |
トピック サブスクリプションの名前 |
|
メッセージのロック トークン
|
lockToken | True | string |
メッセージのトークンを配信不能にロックする |
|
セッション ID
|
sessionId | string |
セッション ID |
|
|
配信不能の理由
|
deadLetterReason | string |
配信不能の理由 |
|
|
配信不能エラーの説明
|
deadLetterErrorDescription | string |
配信不能エラーの説明 |
トピックのセッションを閉じる
この操作は、トピック内のセッションを閉じます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック名
|
topicName | True | string |
トピックの名前 |
|
トピック サブスクリプション名
|
subscriptionName | True | string |
トピック サブスクリプションの名前 |
|
セッション ID
|
sessionId | True | string |
セッション ID |
メッセージの送信
この操作により、メッセージがキューまたはトピックに送信されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キュー/トピック名
|
entityName | True | string |
キューまたはトピックの名前 |
|
Content
|
ContentData | byte |
メッセージの内容 |
|
|
コンテンツ タイプ
|
ContentType | string |
メッセージ コンテンツのコンテンツ タイプ |
|
|
プロパティ
|
Properties | object |
各ブローカー プロパティのキーと値のペア |
|
|
メッセージ ID
|
MessageId | string |
これは、Service Bus が重複するメッセージを識別するために使用できるユーザー定義の値です (有効な場合)。 |
|
|
移行先
|
To | string |
アドレスに送信 |
|
|
返信先
|
ReplyTo | string |
応答するキューのアドレス |
|
|
セッション ID に返信する
|
ReplyToSessionId | string |
返信するセッションの識別子 |
|
|
ラベル
|
Label | string |
アプリケーション固有のラベル |
|
|
ScheduledEnqueueTimeUtc
|
ScheduledEnqueueTimeUtc | date-time |
メッセージがキューに追加される日時 (UTC) |
|
|
セッション ID
|
SessionId | string |
セッションの識別子 |
|
|
関連付け ID
|
CorrelationId | string |
相関関係の識別子 |
|
|
シーケンス番号
|
SequenceNumber | integer |
シーケンス番号の識別子 |
|
|
ロック トークン
|
LockToken | string |
文字列としてのメッセージのロック トークン。 |
|
|
Time To Live
|
TimeToLive | integer |
これは、メッセージが有効な期間 (ティック単位) です。 期間は、メッセージが Service Bus に送信された時点から開始されます。 |
|
|
システム プロパティ
|
systemProperties | string |
システム プロパティ - なしまたは実行の詳細。 実行の詳細では、実行メタデータ プロパティの詳細がカスタム プロパティとしてメッセージに追加されます。 |
トリガー
| 1 つ以上のメッセージがキューに到着したとき (オートコンプリート) |
この操作は、キューから 1 つ以上のメッセージを受信します。 最大メッセージ数が指定されていない場合は、20 個のメッセージを読み取ります。 |
| 1 つ以上のメッセージがキューに到着したとき (ピーク ロック) |
操作は、ピーク ロックを使用してキューから 1 つ以上のメッセージを受信します。 最大メッセージ数が指定されていない場合は、20 個のメッセージを読み取ります。 |
| トピック サブスクリプションでメッセージを受信した場合 (オートコンプリート) |
この操作は、トピック サブスクリプションでメッセージを受信し、メッセージを自動完了したときにフローをトリガーします。 |
| トピック サブスクリプションでメッセージを受信した場合 (ピーク ロック) |
ピーク ロック モードのトピック サブスクリプションでメッセージを受信すると、この操作によってフローがトリガーされます。 |
| トピックに 1 つ以上のメッセージが届いたとき (オートコンプリート) |
操作は、トピックから 1 つ以上のメッセージを受信します。 最大メッセージ数が指定されていない場合は、20 個のメッセージを読み取ります。 |
| トピックに 1 つ以上のメッセージが届いたとき (ピーク ロック) |
操作は、ピーク ロックを使用してトピックから 1 つ以上のメッセージを受信します。 最大メッセージ数が指定されていない場合は、20 個のメッセージを読み取ります。 |
| メッセージがキューで受信されたとき (オートコンプリート) |
この操作は、メッセージがキューで受信され、自動でメッセージが完了したときにフローをトリガーします。 |
| メッセージがキューで受信されたとき (ピーク ロック) |
この操作は、ピーク ロック モードのキューでメッセージを受信したときにフローをトリガーします。 |
1 つ以上のメッセージがキューに到着したとき (オートコンプリート)
この操作は、キューから 1 つ以上のメッセージを受信します。 最大メッセージ数が指定されていない場合は、20 個のメッセージを読み取ります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キュー名
|
queueName | True | string |
キューの名前 |
|
最大メッセージ数
|
maxMessageCount | integer |
バッチで返されるメッセージの最大数 |
|
|
[キューの種類]
|
queueType | string |
キューの種類 - Main または DeadLetter |
戻り値
Service Bus メッセージ
- Body
- ServiceBusMessage
1 つ以上のメッセージがキューに到着したとき (ピーク ロック)
操作は、ピーク ロックを使用してキューから 1 つ以上のメッセージを受信します。 最大メッセージ数が指定されていない場合は、20 個のメッセージを読み取ります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キュー名
|
queueName | True | string |
キューの名前 |
|
最大メッセージ数
|
maxMessageCount | integer |
バッチで返されるメッセージの最大数 |
|
|
[キューの種類]
|
queueType | string |
キューの種類 - Main または DeadLetter |
|
|
セッション ID
|
sessionId | string |
セッション ID - [なし] または [次に使用可能] または [セッション ID を指定] |
戻り値
Service Bus メッセージ
- Body
- ServiceBusMessage
トピック サブスクリプションでメッセージを受信した場合 (オートコンプリート)
この操作は、トピック サブスクリプションでメッセージを受信し、メッセージを自動完了したときにフローをトリガーします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック名
|
topicName | True | string |
トピックの名前 |
|
トピック サブスクリプション名
|
subscriptionName | True | string |
トピック サブスクリプションの名前 |
|
サブスクリプションの種類
|
subscriptionType | string |
サブスクリプションの種類 - Main または DeadLetter |
戻り値
Service Bus メッセージ
- Body
- ServiceBusMessage
トピック サブスクリプションでメッセージを受信した場合 (ピーク ロック)
ピーク ロック モードのトピック サブスクリプションでメッセージを受信すると、この操作によってフローがトリガーされます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック名
|
topicName | True | string |
トピックの名前 |
|
トピック サブスクリプション名
|
subscriptionName | True | string |
トピック サブスクリプションの名前 |
|
サブスクリプションの種類
|
subscriptionType | string |
サブスクリプションの種類 - Main または DeadLetter |
|
|
セッション ID
|
sessionId | string |
セッション ID - [なし] または [次に使用可能] または [セッション ID を指定] |
戻り値
Service Bus メッセージ
- Body
- ServiceBusMessage
トピックに 1 つ以上のメッセージが届いたとき (オートコンプリート)
操作は、トピックから 1 つ以上のメッセージを受信します。 最大メッセージ数が指定されていない場合は、20 個のメッセージを読み取ります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック名
|
topicName | True | string |
トピックの名前 |
|
トピック サブスクリプション名
|
subscriptionName | True | string |
トピック サブスクリプションの名前 |
|
最大メッセージ数
|
maxMessageCount | integer |
バッチで返されるメッセージの最大数 |
|
|
サブスクリプションの種類
|
subscriptionType | string |
サブスクリプションの種類 - Main または DeadLetter |
戻り値
Service Bus メッセージ
- Body
- ServiceBusMessage
トピックに 1 つ以上のメッセージが届いたとき (ピーク ロック)
操作は、ピーク ロックを使用してトピックから 1 つ以上のメッセージを受信します。 最大メッセージ数が指定されていない場合は、20 個のメッセージを読み取ります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック名
|
topicName | True | string |
トピックの名前 |
|
トピック サブスクリプション名
|
subscriptionName | True | string |
トピック サブスクリプションの名前 |
|
最大メッセージ数
|
maxMessageCount | integer |
バッチで返されるメッセージの最大数 |
|
|
サブスクリプションの種類
|
subscriptionType | string |
サブスクリプションの種類 - Main または DeadLetter |
|
|
セッション ID
|
sessionId | string |
セッション ID - [なし] または [次に使用可能] または [セッション ID を指定] |
戻り値
Service Bus メッセージ
- Body
- ServiceBusMessage
メッセージがキューで受信されたとき (オートコンプリート)
この操作は、メッセージがキューで受信され、自動でメッセージが完了したときにフローをトリガーします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キュー名
|
queueName | True | string |
キューの名前 |
|
[キューの種類]
|
queueType | string |
キューの種類 - Main または DeadLetter |
戻り値
Service Bus メッセージ
- Body
- ServiceBusMessage
メッセージがキューで受信されたとき (ピーク ロック)
この操作は、ピーク ロック モードのキューでメッセージを受信したときにフローをトリガーします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キュー名
|
queueName | True | string |
キューの名前 |
|
[キューの種類]
|
queueType | string |
キューの種類 - Main または DeadLetter |
|
|
セッション ID
|
sessionId | string |
セッション ID - [なし] または [次に使用可能] または [セッション ID を指定] |
戻り値
Service Bus メッセージ
- Body
- ServiceBusMessage
定義
ServiceBusMessage
Service Bus メッセージ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Content
|
ContentData | byte |
メッセージの内容 |
|
コンテンツ タイプ
|
ContentType | string |
メッセージ コンテンツのコンテンツ タイプ |
|
プロパティ
|
Properties | object |
各ブローカー プロパティのキーと値のペア |
|
メッセージ ID
|
MessageId | string |
これは、Service Bus が重複するメッセージを識別するために使用できるユーザー定義の値です (有効な場合)。 |
|
移行先
|
To | string |
アドレスに送信 |
|
返信先
|
ReplyTo | string |
応答するキューのアドレス |
|
セッション ID に返信する
|
ReplyToSessionId | string |
返信するセッションの識別子 |
|
ラベル
|
Label | string |
アプリケーション固有のラベル |
|
ScheduledEnqueueTimeUtc
|
ScheduledEnqueueTimeUtc | date-time |
メッセージがキューに追加される日時 (UTC) |
|
セッション ID
|
SessionId | string |
セッションの識別子 |
|
関連付け ID
|
CorrelationId | string |
相関関係の識別子 |
|
シーケンス番号
|
SequenceNumber | integer |
シーケンス番号の識別子 |
|
ロック トークン
|
LockToken | string |
文字列としてのメッセージのロック トークン。 |
|
Time To Live
|
TimeToLive | integer |
これは、メッセージが有効な期間 (ティック単位) です。 期間は、メッセージが Service Bus に送信された時点から開始されます。 |
Subscription
トピック サブスクリプション。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
サブスクリプション名
|
SubscriptionName | string |
サブスクリプション名。 |