次の方法で共有

CbsClient class

  • リファレンス
パッケージ:
@azure/core-amqp

AMQP 接続を介して$cbs エンドポイントと通信する EventHub/ServiceBus Cbs クライアントについて説明します。

コンストラクター

CbsClient(Connection, string)

プロパティ

cbsLock

amqp 接続に対して cbs セッションが存在しない場合に cbs セッションを確立するためのロックを取得するために使用される、接続ごとの$cbsセッションごとの一意のロック名。
connection

AMQP 接続。
connectionLock

amqp 接続が存在しない場合に amqp 接続を確立するためのロックを取得するために使用される、接続ごとの一意のロック名。
endpoint

CBS エンドポイント - "$cbs"
replyTo

CBS replyTo - サービスが応答する受信者リンク名。

メソッド

close()

このクライアントの EventHub/ServiceBus への AMQP cbs セッションを閉じ、切断が完了したときに解決される約束を返します。
init({ abortSignal?: AbortSignalLike, timeoutInMs?: number })

特定の接続で以前に初期化されていない場合は、CBS セッションのシングルトン インスタンスを作成します。
isOpen()

cbs 送信側受信側リンクが開いているか閉じているかを示します。
negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })

CBS 要求を EventHub/ServiceBus サービスとネゴシエートします。
remove()

このクライアントの EventHub/ServiceBus への AMQP cbs セッションを削除します。

コンストラクターの詳細

CbsClient(Connection, string) 

new CbsClient(connection: Connection, connectionLock: string)

パラメーター

connection

Connection

AMQP 接続。

connectionLock

string

接続ごとに一意の文字列 (通常は guid)。

プロパティの詳細

cbsLock

amqp 接続に対して cbs セッションが存在しない場合に cbs セッションを確立するためのロックを取得するために使用される、接続ごとの$cbsセッションごとの一意のロック名。

cbsLock: string

プロパティ値

string

connection

AMQP 接続。

connection: Connection

プロパティ値

Connection

connectionLock

amqp 接続が存在しない場合に amqp 接続を確立するためのロックを取得するために使用される、接続ごとの一意のロック名。

connectionLock: string

プロパティ値

string

endpoint

CBS エンドポイント - "$cbs"

endpoint: string

プロパティ値

string

replyTo

CBS replyTo - サービスが応答する受信者リンク名。

replyTo: string

プロパティ値

string

メソッドの詳細

close()

このクライアントの EventHub/ServiceBus への AMQP cbs セッションを閉じ、切断が完了したときに解決される約束を返します。

function close(): Promise<void>

戻り値

Promise<void>

init({ abortSignal?: AbortSignalLike, timeoutInMs?: number })

特定の接続で以前に初期化されていない場合は、CBS セッションのシングルトン インスタンスを作成します。

function init(options?: { abortSignal?: AbortSignalLike, timeoutInMs?: number }): Promise<void>

パラメーター

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

このメソッドの動作に影響を与えるために使用できる省略可能なパラメーター。 たとえば、 abortSignal を渡して、進行中 init の呼び出しを取り消すことができます。

戻り値

Promise<void>

約束。

isOpen()

cbs 送信側受信側リンクが開いているか閉じているかを示します。

function isOpen(): boolean

戻り値

boolean

true 開く、 false 閉じた。

negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })

CBS 要求を EventHub/ServiceBus サービスとネゴシエートします。

function negotiateClaim(audience: string, token: string, tokenType: TokenType, options?: { abortSignal?: AbortSignalLike, timeoutInMs?: number }): Promise<CbsResponse>

パラメーター

audience

string

トークンが次のいずれかの形式で要求されるエンティティ トークンの対象ユーザー。

  • ServiceBus

    • 送信者

      • "sb://<yournamespace>.servicebus.windows.net/<queue-name>"
      • "sb://<yournamespace>.servicebus.windows.net/<topic-name>"

    • 受信 機 - "sb://<yournamespace>.servicebus.windows.net/<queue-name>" - "sb://<yournamespace>.servicebus.windows.net/<topic-name>"

    • ManagementClient - "sb://<your-namespace>.servicebus.windows.net/<queue-name>/$management"。 - "sb://<your-namespace>.servicebus.windows.net/<topic-name>/$management".

  • EventHubs

    • 送信者

      • "sb://<yournamespace>.servicebus.windows.net/<hubName>"
      • "sb://<yournamespace>.servicebus.windows.net/<hubName>/Partitions/<partitionId>".

    • 受信者

      • "sb://<your-namespace>.servicebus.windows.net/<event-hub-name>/ConsumerGroups/<consumer-group-name>/Partitions/<partition-id>".

    • ManagementClient

      • "sb://<your-namespace>.servicebus.windows.net/<event-hub-name>/$management".
token

string

put-token 要求で送信する必要があるトークン。

tokenType
TokenType

使用されているトークンの種類。 たとえば、'jwt' や 'servicebus.windows.net:sastoken' などです。

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

このメソッドの動作に影響を与えるために使用できる省略可能なパラメーター。 たとえば、 abortSignal を渡して、進行中 negotiateClaim の呼び出しを取り消すことができます。

戻り値

Promise<CbsResponse>

$cbs認証が成功したときに解決し、$cbs認証中にエラーが発生したときに拒否する Promise。

remove()

このクライアントの EventHub/ServiceBus への AMQP cbs セッションを削除します。

function remove()