ServiceBusAdministrationClient class

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

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

パラメーター

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

パラメーター

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

pipeline: Pipeline

プロパティ値

継承元 ServiceClient.pipeline

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

キューを削除します。

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

パラメーター

戻り値

ルールを削除します。

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

パラメーター

戻り値

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

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

パラメーター

戻り値

トピックを削除します。

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

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

パラメーター

戻り値

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

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

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

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

パラメーター

戻り値

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

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

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

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

パラメーター

戻り値

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

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

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

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

パラメーター

戻り値

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

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

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

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

パラメーター

戻り値

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

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

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

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

パラメーター

戻り値

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

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

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

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

パラメーター

戻り値

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

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

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

パラメーター

戻り値

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

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

継承元 ServiceClient.sendOperationRequest

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

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

パラメーター

戻り値

継承元 ServiceClient.sendRequest