ServiceBusSender interface

送信者が作成されたエンティティのパス。

entityPath: string

プロパティ値

送信者を識別するために使用される名前。 これは、ログと例外を関連付けるために使用できます。 指定しない場合、または空の場合は、ランダムな一意のものが生成されます。

identifier: string

プロパティ値

true送信者または作成したクライアントのいずれかが閉じられている場合は を返します。

isClosed: boolean

プロパティ値

ServiceBus キュー/サブスクリプションに表示されるようにスケジュールされた複数のメッセージを取り消します。

function cancelScheduledMessages(sequenceNumbers: Long | Long[], options?: OperationOptionsBase): Promise<void>

パラメーター

戻り値

基になる AMQP 送信者リンクを閉じます。 いったん閉じると、送信者はそれ以上の操作に使用できません。 createSender QueueClient または TopicClient の 関数を使用して、新しい Sender をインスタンス化する

function close(): Promise<void>

戻り値

サポートされている最大サイズに達するまでメッセージを追加できる のインスタンス ServiceBusMessageBatch を作成します。 バッチを メソッドに渡して、<xref:send>メッセージをAzure Service Busに送信できます。

function createMessageBatch(options?: CreateMessageBatchOptions): Promise<ServiceBusMessageBatch>

パラメーター

戻り値

指定されたメッセージを Service Bus キュー/サブスクリプションに後で表示するようにスケジュールします。

function scheduleMessages(messages: ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], scheduledEnqueueTimeUtc: Date, options?: OperationOptionsBase): Promise<Long[]>

パラメーター

戻り値

スケジュールされたメッセージのシーケンス番号。 メッセージのスケジュール設定を取り消す場合は、シーケンス番号が必要です。 型を Long 数値に変換せずに、アプリケーションにそのまま保存します。 JavaScript では 53 ビット数値のみがサポートされるため、 を 数値に変換 Long すると精度が低下します。

AMQP Sender リンクがまだ存在しない場合は、作成後に指定されたメッセージを送信します。

• 有効なキュー/トピックまたは有効な session キュー/ partition トピックにメッセージを送信するには、メッセージに sessionId それぞれ プロパティまたは partitionKey プロパティを設定します。
• 同じ sendMessages() 呼び出しに渡されるすべてのメッセージは、同じ (セッションを使用している場合) と同じ sessionIdpartitionKey (パーティションを使用している場合) である必要があります。

注:

サイズが 1 MB を超えるメッセージを送信する場合は、バッチメッセージや以下のようなメッセージの配列を送信するのではなく、個々のメッセージを送信してください。

await sender.sendMessages(message);

これは、バッチ処理されたメッセージが大きなメッセージをまだ送信できないためです。 それ以外の場合は、 force detached この場合にエラーが発生します。 service-bus-premium-messaging#large-messages-support を読み取る。 詳細については、 #23014 を参照してください。

function sendMessages(messages: ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], options?: OperationOptionsBase): Promise<void>

パラメーター

戻り値