Share via

ServiceBusAdministrationClient class

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

すべての操作は、関連する出力を持つオブジェクトに解決される promise を返します。 これらのオブジェクトには、 という _response プロパティもあります。サービスからの直接応答にアクセスする場合に使用できます。

Extends
ServiceClient

コンストラクター

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

ServiceBusAdministrationClient クラスの新しいインスタンスを初期化します。
ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

継承されたプロパティ

pipeline

このクライアントが要求を行うために使用するパイプライン

メソッド

createQueue(string, CreateQueueOptions)

指定されたオプションを使用して構成された、指定された名前のキューを作成します
createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, OperationOptions)

指定したオプションを使用して構成された、指定された名前のルールを作成します。
createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, SqlRuleAction, OperationOptions)

指定したオプションを使用して構成された、指定された名前のルールを作成します。
createSubscription(string, string, CreateSubscriptionOptions)

指定したオプションを使用して構成された、指定された名前のサブスクリプションを作成します
createTopic(string, CreateTopicOptions)

指定したオプションを使用して構成された、指定された名前のトピックを作成します
deleteQueue(string, OperationOptions)

キューを削除します。
deleteRule(string, string, string, OperationOptions)

ルールを削除します。
deleteSubscription(string, string, OperationOptions)

サブスクリプションを削除します。
deleteTopic(string, OperationOptions)

トピックを削除します。
getNamespaceProperties(OperationOptions)

Service Bus 名前空間に関連するメタデータを表す オブジェクトを返します。
getQueue(string, OperationOptions)

Queue とそのプロパティを表す オブジェクトを返します。 メッセージ数の詳細などのキュー ランタイム情報を取得する場合は、API を使用 getQueueRuntimeProperties します。
getQueueRuntimeProperties(string, OperationOptions)

メッセージ数の詳細などのキュー ランタイム情報を表す オブジェクトを返します。
getRule(string, string, string, OperationOptions)

指定した名前の Rule とそのすべてのプロパティを表すオブジェクトを返します。
getSubscription(string, string, OperationOptions)

Subscription とそのプロパティを表すオブジェクトを返します。 メッセージ数の詳細などのサブスクリプション ランタイム情報を取得する場合は、API を使用 getSubscriptionRuntimeProperties します。
getSubscriptionRuntimeProperties(string, string, OperationOptions)

メッセージ数の詳細などのサブスクリプション ランタイム情報を表す オブジェクトを返します。
getTopic(string, OperationOptions)

Topic とそのプロパティを表すオブジェクトを返します。 サブスクリプション数の詳細などのトピック ランタイム情報を取得する場合は、API を使用 getTopicRuntimeProperties します。
getTopicRuntimeProperties(string, OperationOptions)

サブスクリプション数などの Topic ランタイム情報を表す オブジェクトを返します。
listQueues(OperationOptions)

すべてのキューを一覧表示する非同期反復可能反復子を返します。

.byPage() は、ページ内のキューを一覧表示する非同期反復可能な反復子を返します。
listQueuesRuntimeProperties(OperationOptions)

キューのランタイム情報を一覧表示する非同期反復可能反復子を返します。

.byPage() は非同期反復可能な反復子を返して、ページ内のキューのランタイム情報を一覧表示します。
listRules(string, string, OperationOptions)

指定したサブスクリプションのすべてのルールを一覧表示する非同期反復可能反復子を返します。

.byPage() は、ページ内のルールを一覧表示する非同期反復可能反復子を返します。
listSubscriptions(string, OperationOptions)

指定したトピックのすべてのサブスクリプションを一覧表示する非同期反復可能反復子を返します。

.byPage() は、ページ内のサブスクリプションを一覧表示する非同期反復可能反復子を返します。
listSubscriptionsRuntimeProperties(string, OperationOptions)

指定したトピックのサブスクリプションのランタイム情報を一覧表示する非同期反復可能反復子を返します。

.byPage() は、ページ内のサブスクリプションのランタイム情報を一覧表示する非同期反復可能反復子を返します。
listTopics(OperationOptions)

すべてのトピックを一覧表示する非同期反復可能反復子を返します。

.byPage() は、ページ内のトピックを一覧表示する非同期反復可能反復子を返します。
listTopicsRuntimeProperties(OperationOptions)

トピックのランタイム情報を一覧表示する非同期反復可能反復子を返します。

.byPage() は非同期反復可能な反復子を返して、ページ内のトピックのランタイム情報を一覧表示します。
queueExists(string, OperationOptions)

特定のキューが存在するかどうかを確認します。
ruleExists(string, string, string, OperationOptions)

特定のルールが存在するかどうかを確認します。
subscriptionExists(string, string, OperationOptions)

特定のサブスクリプションがトピックに存在するかどうかを確認します。
topicExists(string, OperationOptions)

特定のトピックが存在するかどうかを確認します。
updateQueue(WithResponse<QueueProperties>, OperationOptions)

指定されたキューのプロパティに基づいてキューを更新します。 実際に更新可能なのは、キューのプロパティのサブセットのみであっても、すべてのキュー プロパティを設定する必要があります。 したがって、推奨されるフローは、 からの getQueue()出力を使用して、その中の目的のプロパティを更新し、変更したオブジェクトを に updateQueue()渡すことです。

更新できないプロパティは、インターフェイスで QueueProperties 読み取り時としてマークされます。
updateRule(string, string, WithResponse<RuleProperties>, OperationOptions)

指定したオプションに基づいて、指定した名前で Rule のプロパティを更新します。 いずれかのプロパティが更新されている場合でも、すべてのルール プロパティを設定する必要があります。 したがって、推奨されるフローは、 からの getRule()出力を使用して、その中の目的のプロパティを更新し、変更したオブジェクトを に updateRule()渡すことです。
updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)

指定されたサブスクリプションプロパティに基づいてサブスクリプションを更新します。 すべてのサブスクリプション プロパティは、それらのサブセットのみが実際に更新可能であっても設定する必要があります。 したがって、推奨されるフローは、 からの getSubscription()出力を使用して、その中の目的のプロパティを更新し、変更したオブジェクトを に updateSubscription()渡すことです。

更新できないプロパティは、インターフェイスで SubscriptionProperties 読み取り時としてマークされます。
updateTopic(WithResponse<TopicProperties>, OperationOptions)

指定されたトピック プロパティに基づいてトピックを更新します。 トピックのプロパティのサブセットのみが実際に更新可能であっても、すべてのトピック プロパティを設定する必要があります。 したがって、推奨されるフローは、 からの getTopic()出力を使用して、その中の目的のプロパティを更新し、変更したオブジェクトを に updateTopic()渡すことです。

更新できないプロパティは、インターフェイスで TopicProperties 読み取り時としてマークされます。

継承されたメソッド

sendOperationRequest<T>(OperationArguments, OperationSpec)

指定された OperationSpec を使用して設定された HTTP 要求を送信します。
sendRequest(PipelineRequest)

指定された httpRequest を送信します。

コンストラクターの詳細

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

ServiceBusAdministrationClient クラスの新しいインスタンスを初期化します。

new ServiceBusAdministrationClient(connectionString: string, options?: ServiceBusAdministrationClientOptions)

パラメーター

connectionString

string

クライアントが Azure に接続するために必要な接続文字列。

options
ServiceBusAdministrationClientOptions

PipelineOptions

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions) 

new ServiceBusAdministrationClient(fullyQualifiedNamespace: string, credential: TokenCredential | NamedKeyCredential, options?: ServiceBusAdministrationClientOptions)

パラメーター

fullyQualifiedNamespace

string

Service Bus インスタンスの完全修飾名前空間 。.servicebus.windows.net と似ている可能性があります。

credential

TokenCredential | NamedKeyCredential

Azure Service Busとの接続を認証するためのトークンを取得するためにクライアントによって使用される資格情報オブジェクト。 資格情報の作成については、「@azure/ID」を参照してください。 AAD に対してインターフェイスの独自の実装を TokenCredential 使用している場合は、service-bus の "スコープ" を に ["https://servicebus.azure.net//user_impersonation"] 設定して、適切なトークンを取得します。 接続文字列を使用せずに と をAzureNamedKeyCredential渡SharedAccessKeyNameSharedAccessKeyす場合は、from @azure/core-auth を使用します。 これらのフィールドは、 name の フィールドと key フィールドにそれぞれ AzureNamedKeyCredentialマップされます。

options
ServiceBusAdministrationClientOptions

PipelineOptions

継承されたプロパティの詳細

pipeline

このクライアントが要求を行うために使用するパイプライン

pipeline: Pipeline

プロパティ値

Pipeline

継承元 ServiceClient.pipeline

メソッドの詳細

createQueue(string, CreateQueueOptions)

指定されたオプションを使用して構成された、指定された名前のキューを作成します

function createQueue(queueName: string, options?: CreateQueueOptions): Promise<WithResponse<QueueProperties>>

パラメーター

queueName

string

options
CreateQueueOptions

作成されるキューを構成するためのオプション (たとえば、パーティションまたはセッションをサポートするようにキューを構成できます) と、HTTP 要求で他の構成を中止、トレース、制御するために使用できる操作オプション。

この操作で発生する可能性があるエラーを次に示します。

戻り値

Promise<WithResponse<QueueProperties>>

createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, OperationOptions)

指定したオプションを使用して構成された、指定された名前のルールを作成します。

function createRule(topicName: string, subscriptionName: string, ruleName: string, ruleFilter: CorrelationRuleFilter | SqlRuleFilter, operationOptions?: OperationOptions): Promise<WithResponse<RuleProperties>>

パラメーター

topicName

string

subscriptionName

string

ruleName

string

ruleFilter

CorrelationRuleFilter | SqlRuleFilter

ルールが評価するフィルター式を定義します。

operationOptions
OperationOptions

HTTP 要求で他の構成を中止、トレース、および制御するために使用できるオプション。

この操作で発生する可能性があるエラーを次に示します。

戻り値

Promise<WithResponse<RuleProperties>>

createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, SqlRuleAction, OperationOptions)

指定したオプションを使用して構成された、指定された名前のルールを作成します。

function createRule(topicName: string, subscriptionName: string, ruleName: string, ruleFilter: CorrelationRuleFilter | SqlRuleFilter, ruleAction: SqlRuleAction, operationOptions?: OperationOptions): Promise<WithResponse<RuleProperties>>

パラメーター

topicName

string

subscriptionName

string

ruleName

string

ruleFilter

CorrelationRuleFilter | SqlRuleFilter

ルールが評価するフィルター式を定義します。

ruleAction
SqlRuleAction

関連付けられたフィルターが適用された場合にメッセージで実行できる SQL like 式。

operationOptions
OperationOptions

HTTP 要求で他の構成を中止、トレース、および制御するために使用できるオプション。

この操作で発生する可能性があるエラーを次に示します。

戻り値

Promise<WithResponse<RuleProperties>>

createSubscription(string, string, CreateSubscriptionOptions)

指定したオプションを使用して構成された、指定された名前のサブスクリプションを作成します

function createSubscription(topicName: string, subscriptionName: string, options?: CreateSubscriptionOptions): Promise<WithResponse<SubscriptionProperties>>

パラメーター

topicName

string

subscriptionName

string

options
CreateSubscriptionOptions

作成されるサブスクリプションを構成するためのオプション (たとえば、パーティションまたはセッションをサポートするようにサブスクリプションを構成できます)、および HTTP 要求で他の構成を中止、トレース、制御するために使用できる操作オプション。

この操作で発生する可能性があるエラーを次に示します。

戻り値

Promise<WithResponse<SubscriptionProperties>>

createTopic(string, CreateTopicOptions)

指定したオプションを使用して構成された、指定された名前のトピックを作成します

function createTopic(topicName: string, options?: CreateTopicOptions): Promise<WithResponse<TopicProperties>>

パラメーター

topicName

string

options
CreateTopicOptions

作成するトピックを構成するためのオプション (たとえば、パーティションをサポートするようにトピックを構成できます)、および HTTP 要求で他の構成を中止、トレース、および制御するために使用できる操作オプション。

この操作で発生する可能性があるエラーを次に示します。

戻り値

Promise<WithResponse<TopicProperties>>

deleteQueue(string, OperationOptions)

キューを削除します。

function deleteQueue(queueName: string, operationOptions?: OperationOptions): Promise<{ _response: HttpResponse }>

パラメーター

queueName

string

operationOptions
OperationOptions

HTTP 要求で他の構成を中止、トレース、および制御するために使用できるオプション。

この操作で発生する可能性があるエラーを次に示します。

戻り値

Promise<{ _response: HttpResponse }>

deleteRule(string, string, string, OperationOptions)

ルールを削除します。

function deleteRule(topicName: string, subscriptionName: string, ruleName: string, operationOptions?: OperationOptions): Promise<{ _response: HttpResponse }>

パラメーター

topicName

string

subscriptionName

string

ruleName

string

operationOptions
OperationOptions

HTTP 要求で他の構成を中止、トレース、および制御するために使用できるオプション。

この操作で発生する可能性があるエラーを次に示します。

戻り値

Promise<{ _response: HttpResponse }>

deleteSubscription(string, string, OperationOptions)

サブスクリプションを削除します。

function deleteSubscription(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<{ _response: HttpResponse }>

パラメーター

topicName

string

subscriptionName

string

operationOptions
OperationOptions

HTTP 要求で他の構成を中止、トレース、および制御するために使用できるオプション。

この操作で発生する可能性があるエラーを次に示します。

戻り値

Promise<{ _response: HttpResponse }>

deleteTopic(string, OperationOptions)

トピックを削除します。

function deleteTopic(topicName: string, operationOptions?: OperationOptions): Promise<{ _response: HttpResponse }>

パラメーター

topicName

string

operationOptions
OperationOptions

HTTP 要求で他の構成を中止、トレース、および制御するために使用できるオプション。

この操作で発生する可能性があるエラーを次に示します。

戻り値

Promise<{ _response: HttpResponse }>

getNamespaceProperties(OperationOptions)

Service Bus 名前空間に関連するメタデータを表す オブジェクトを返します。

function getNamespaceProperties(operationOptions?: OperationOptions): Promise<WithResponse<NamespaceProperties>>

パラメーター

operationOptions
OperationOptions

HTTP 要求で他の構成を中止、トレース、および制御するために使用できるオプション。

戻り値

Promise<WithResponse<NamespaceProperties>>

getQueue(string, OperationOptions)

Queue とそのプロパティを表す オブジェクトを返します。 メッセージ数の詳細などのキュー ランタイム情報を取得する場合は、API を使用 getQueueRuntimeProperties します。

function getQueue(queueName: string, operationOptions?: OperationOptions): Promise<WithResponse<QueueProperties>>

パラメーター

queueName

string

operationOptions
OperationOptions

HTTP 要求で他の構成を中止、トレース、および制御するために使用できるオプション。

この操作で発生する可能性があるエラーを次に示します。

戻り値

Promise<WithResponse<QueueProperties>>

getQueueRuntimeProperties(string, OperationOptions)

メッセージ数の詳細などのキュー ランタイム情報を表す オブジェクトを返します。

function getQueueRuntimeProperties(queueName: string, operationOptions?: OperationOptions): Promise<WithResponse<QueueRuntimeProperties>>

パラメーター

queueName

string

operationOptions
OperationOptions

HTTP 要求で他の構成を中止、トレース、および制御するために使用できるオプション。

この操作で発生する可能性があるエラーを次に示します。

戻り値

Promise<WithResponse<QueueRuntimeProperties>>

getRule(string, string, string, OperationOptions)

指定した名前の Rule とそのすべてのプロパティを表すオブジェクトを返します。

function getRule(topicName: string, subscriptionName: string, ruleName: string, operationOptions?: OperationOptions): Promise<WithResponse<RuleProperties>>

パラメーター

topicName

string

subscriptionName

string

ruleName

string

operationOptions
OperationOptions

HTTP 要求で他の構成を中止、トレース、および制御するために使用できるオプション。

この操作で発生する可能性があるエラーを次に示します。

戻り値

Promise<WithResponse<RuleProperties>>

getSubscription(string, string, OperationOptions)

Subscription とそのプロパティを表すオブジェクトを返します。 メッセージ数の詳細などのサブスクリプション ランタイム情報を取得する場合は、API を使用 getSubscriptionRuntimeProperties します。

function getSubscription(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<WithResponse<SubscriptionProperties>>

パラメーター

topicName

string

subscriptionName

string

operationOptions
OperationOptions

HTTP 要求で他の構成を中止、トレース、および制御するために使用できるオプション。

この操作で発生する可能性があるエラーを次に示します。

戻り値

Promise<WithResponse<SubscriptionProperties>>

getSubscriptionRuntimeProperties(string, string, OperationOptions)

メッセージ数の詳細などのサブスクリプション ランタイム情報を表す オブジェクトを返します。

function getSubscriptionRuntimeProperties(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<WithResponse<SubscriptionRuntimeProperties>>

パラメーター

topicName

string

subscriptionName

string

operationOptions
OperationOptions

HTTP 要求で他の構成を中止、トレース、および制御するために使用できるオプション。

この操作で発生する可能性があるエラーを次に示します。

戻り値

Promise<WithResponse<SubscriptionRuntimeProperties>>

getTopic(string, OperationOptions)

Topic とそのプロパティを表すオブジェクトを返します。 サブスクリプション数の詳細などのトピック ランタイム情報を取得する場合は、API を使用 getTopicRuntimeProperties します。

function getTopic(topicName: string, operationOptions?: OperationOptions): Promise<WithResponse<TopicProperties>>

パラメーター

topicName

string

operationOptions
OperationOptions

HTTP 要求で他の構成を中止、トレース、および制御するために使用できるオプション。

この操作で発生する可能性があるエラーを次に示します。

戻り値

Promise<WithResponse<TopicProperties>>

getTopicRuntimeProperties(string, OperationOptions)

サブスクリプション数などの Topic ランタイム情報を表す オブジェクトを返します。

function getTopicRuntimeProperties(topicName: string, operationOptions?: OperationOptions): Promise<WithResponse<TopicRuntimeProperties>>

パラメーター

topicName

string

operationOptions
OperationOptions

HTTP 要求で他の構成を中止、トレース、および制御するために使用できるオプション。

この操作で発生する可能性があるエラーを次に示します。

戻り値

Promise<WithResponse<TopicRuntimeProperties>>

listQueues(OperationOptions)

すべてのキューを一覧表示する非同期反復可能反復子を返します。

.byPage() は、ページ内のキューを一覧表示する非同期反復可能な反復子を返します。

function listQueues(options?: OperationOptions): PagedAsyncIterableIterator<QueueProperties, EntitiesResponse<QueueProperties>, PageSettings>

パラメーター

options
OperationOptions

戻り値

PagedAsyncIterableIterator<QueueProperties, EntitiesResponse<QueueProperties>, PageSettings>

ページングをサポートする asyncIterableIterator。

listQueuesRuntimeProperties(OperationOptions)

キューのランタイム情報を一覧表示する非同期反復可能反復子を返します。

.byPage() は非同期反復可能な反復子を返して、ページ内のキューのランタイム情報を一覧表示します。

function listQueuesRuntimeProperties(options?: OperationOptions): PagedAsyncIterableIterator<QueueRuntimeProperties, EntitiesResponse<QueueRuntimeProperties>, PageSettings>

パラメーター

options
OperationOptions

戻り値

PagedAsyncIterableIterator<QueueRuntimeProperties, EntitiesResponse<QueueRuntimeProperties>, PageSettings>

ページングをサポートする asyncIterableIterator。

listRules(string, string, OperationOptions)

指定したサブスクリプションのすべてのルールを一覧表示する非同期反復可能反復子を返します。

.byPage() は、ページ内のルールを一覧表示する非同期反復可能反復子を返します。

function listRules(topicName: string, subscriptionName: string, options?: OperationOptions): PagedAsyncIterableIterator<RuleProperties, EntitiesResponse<RuleProperties>, PageSettings>

パラメーター

topicName

string

subscriptionName

string

options
OperationOptions

戻り値

PagedAsyncIterableIterator<RuleProperties, EntitiesResponse<RuleProperties>, PageSettings>

ページングをサポートする asyncIterableIterator。

listSubscriptions(string, OperationOptions)

指定したトピックのすべてのサブスクリプションを一覧表示する非同期反復可能反復子を返します。

.byPage() は、ページ内のサブスクリプションを一覧表示する非同期反復可能反復子を返します。

function listSubscriptions(topicName: string, options?: OperationOptions): PagedAsyncIterableIterator<SubscriptionProperties, EntitiesResponse<SubscriptionProperties>, PageSettings>

パラメーター

topicName

string

options
OperationOptions

戻り値

PagedAsyncIterableIterator<SubscriptionProperties, EntitiesResponse<SubscriptionProperties>, PageSettings>

ページングをサポートする asyncIterableIterator。

listSubscriptionsRuntimeProperties(string, OperationOptions)

指定したトピックのサブスクリプションのランタイム情報を一覧表示する非同期反復可能反復子を返します。

.byPage() は、ページ内のサブスクリプションのランタイム情報を一覧表示する非同期反復可能反復子を返します。

function listSubscriptionsRuntimeProperties(topicName: string, options?: OperationOptions): PagedAsyncIterableIterator<SubscriptionRuntimeProperties, EntitiesResponse<SubscriptionRuntimeProperties>, PageSettings>

パラメーター

topicName

string

options
OperationOptions

戻り値

PagedAsyncIterableIterator<SubscriptionRuntimeProperties, EntitiesResponse<SubscriptionRuntimeProperties>, PageSettings>

ページングをサポートする asyncIterableIterator。

listTopics(OperationOptions)

すべてのトピックを一覧表示する非同期反復可能反復子を返します。

.byPage() は、ページ内のトピックを一覧表示する非同期反復可能反復子を返します。

function listTopics(options?: OperationOptions): PagedAsyncIterableIterator<TopicProperties, EntitiesResponse<TopicProperties>, PageSettings>

パラメーター

options
OperationOptions

戻り値

PagedAsyncIterableIterator<TopicProperties, EntitiesResponse<TopicProperties>, PageSettings>

ページングをサポートする asyncIterableIterator。

listTopicsRuntimeProperties(OperationOptions)

トピックのランタイム情報を一覧表示する非同期反復可能反復子を返します。

.byPage() は非同期反復可能な反復子を返して、ページ内のトピックのランタイム情報を一覧表示します。

function listTopicsRuntimeProperties(options?: OperationOptions): PagedAsyncIterableIterator<TopicRuntimeProperties, EntitiesResponse<TopicRuntimeProperties>, PageSettings>

パラメーター

options
OperationOptions

戻り値

PagedAsyncIterableIterator<TopicRuntimeProperties, EntitiesResponse<TopicRuntimeProperties>, PageSettings>

ページングをサポートする asyncIterableIterator。

queueExists(string, OperationOptions)

特定のキューが存在するかどうかを確認します。

function queueExists(queueName: string, operationOptions?: OperationOptions): Promise<boolean>

パラメーター

queueName

string

operationOptions
OperationOptions

HTTP 要求で他の構成を中止、トレース、および制御するために使用できるオプション。

戻り値

Promise<boolean>

ruleExists(string, string, string, OperationOptions)

特定のルールが存在するかどうかを確認します。

function ruleExists(topicName: string, subscriptionName: string, ruleName: string, operationOptions?: OperationOptions): Promise<boolean>

パラメーター

topicName

string

subscriptionName

string

ruleName

string

operationOptions
OperationOptions

戻り値

Promise<boolean>

subscriptionExists(string, string, OperationOptions)

特定のサブスクリプションがトピックに存在するかどうかを確認します。

function subscriptionExists(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<boolean>

パラメーター

topicName

string

subscriptionName

string

operationOptions
OperationOptions

HTTP 要求で他の構成を中止、トレース、および制御するために使用できるオプション。

戻り値

Promise<boolean>

topicExists(string, OperationOptions)

特定のトピックが存在するかどうかを確認します。

function topicExists(topicName: string, operationOptions?: OperationOptions): Promise<boolean>

パラメーター

topicName

string

operationOptions
OperationOptions

HTTP 要求で他の構成を中止、トレース、および制御するために使用できるオプション。

戻り値

Promise<boolean>

updateQueue(WithResponse<QueueProperties>, OperationOptions)

指定されたキューのプロパティに基づいてキューを更新します。 実際に更新可能なのは、キューのプロパティのサブセットのみであっても、すべてのキュー プロパティを設定する必要があります。 したがって、推奨されるフローは、 からの getQueue()出力を使用して、その中の目的のプロパティを更新し、変更したオブジェクトを に updateQueue()渡すことです。

更新できないプロパティは、インターフェイスで QueueProperties 読み取り時としてマークされます。

function updateQueue(queue: WithResponse<QueueProperties>, operationOptions?: OperationOptions): Promise<WithResponse<QueueProperties>>

パラメーター

queue

WithResponse<QueueProperties>

キューのプロパティと未加工の応答を表す オブジェクト。 requiresSession、 requiresDuplicateDetection、 enablePartitioning、および name は、キューの作成後に更新できません。

operationOptions
OperationOptions

HTTP 要求で他の構成を中止、トレース、および制御するために使用できるオプション。

この操作で発生する可能性があるエラーを次に示します。

戻り値

Promise<WithResponse<QueueProperties>>

updateRule(string, string, WithResponse<RuleProperties>, OperationOptions)

指定したオプションに基づいて、指定した名前で Rule のプロパティを更新します。 いずれかのプロパティが更新されている場合でも、すべてのルール プロパティを設定する必要があります。 したがって、推奨されるフローは、 からの getRule()出力を使用して、その中の目的のプロパティを更新し、変更したオブジェクトを に updateRule()渡すことです。

function updateRule(topicName: string, subscriptionName: string, rule: WithResponse<RuleProperties>, operationOptions?: OperationOptions): Promise<WithResponse<RuleProperties>>

パラメーター

topicName

string

subscriptionName

string

rule

WithResponse<RuleProperties>

更新されるルールと未加工の応答を構成するためのオプション。 たとえば、関連付けられているトピック/サブスクリプションに適用するようにフィルターを構成できます。

operationOptions
OperationOptions

HTTP 要求で他の構成を中止、トレース、および制御するために使用できるオプション。

この操作で発生する可能性があるエラーを次に示します。

戻り値

Promise<WithResponse<RuleProperties>>

updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)

指定されたサブスクリプションプロパティに基づいてサブスクリプションを更新します。 すべてのサブスクリプション プロパティは、それらのサブセットのみが実際に更新可能であっても設定する必要があります。 したがって、推奨されるフローは、 からの getSubscription()出力を使用して、その中の目的のプロパティを更新し、変更したオブジェクトを に updateSubscription()渡すことです。

更新できないプロパティは、インターフェイスで SubscriptionProperties 読み取り時としてマークされます。

function updateSubscription(subscription: WithResponse<SubscriptionProperties>, operationOptions?: OperationOptions): Promise<WithResponse<SubscriptionProperties>>

パラメーター

subscription

WithResponse<SubscriptionProperties>

サブスクリプションのプロパティと生の応答を表す オブジェクト。 subscriptionName、 topicName、および requiresSession は、サブスクリプションの作成後に更新できません。

operationOptions
OperationOptions

HTTP 要求で他の構成を中止、トレース、および制御するために使用できるオプション。

この操作で発生する可能性があるエラーを次に示します。

戻り値

Promise<WithResponse<SubscriptionProperties>>

updateTopic(WithResponse<TopicProperties>, OperationOptions)

指定されたトピック プロパティに基づいてトピックを更新します。 トピックのプロパティのサブセットのみが実際に更新可能であっても、すべてのトピック プロパティを設定する必要があります。 したがって、推奨されるフローは、 からの getTopic()出力を使用して、その中の目的のプロパティを更新し、変更したオブジェクトを に updateTopic()渡すことです。

更新できないプロパティは、インターフェイスで TopicProperties 読み取り時としてマークされます。

function updateTopic(topic: WithResponse<TopicProperties>, operationOptions?: OperationOptions): Promise<WithResponse<TopicProperties>>

パラメーター

topic

WithResponse<TopicProperties>

トピックのプロパティと未加工の応答を表す オブジェクト。 requiresDuplicateDetection、 enablePartitioning、および name は、トピックの作成後に更新できません。

operationOptions
OperationOptions

HTTP 要求で他の構成を中止、トレース、および制御するために使用できるオプション。

この操作で発生する可能性があるエラーを次に示します。

戻り値

Promise<WithResponse<TopicProperties>>

継承済みメソッドの詳細

sendOperationRequest<T>(OperationArguments, OperationSpec)

指定された OperationSpec を使用して設定された HTTP 要求を送信します。

function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>

パラメーター

operationArguments
OperationArguments

HTTP 要求のテンプレート値が設定される引数。

operationSpec
OperationSpec

httpRequest の設定に使用する OperationSpec。

戻り値

Promise<T>

継承元 ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

指定された httpRequest を送信します。

function sendRequest(request: PipelineRequest): Promise<PipelineResponse>

パラメーター

request
PipelineRequest

戻り値

Promise<PipelineResponse>

継承元 ServiceClient.sendRequest