مشاركة عبر

ServiceBusAdministrationClient.TopicExistsAsync Method

  • Reference

Definition

Namespace:
Azure.Messaging.ServiceBus.Administration
Assembly:
Azure.Messaging.ServiceBus.dll
Package:
Azure.Messaging.ServiceBus v7.18.2
Package:
Azure.Messaging.ServiceBus v7.18.0-beta.1
Source:
ServiceBusAdministrationClient.cs
Source:
ServiceBusAdministrationClient.cs

Checks whether a given topic exists or not.

public virtual System.Threading.Tasks.Task<Azure.Response<bool>> TopicExistsAsync (string name, System.Threading.CancellationToken cancellationToken = default);
abstract member TopicExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>
override this.TopicExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>
Public Overridable Function TopicExistsAsync (name As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of Boolean))

Parameters

name
String

Name of the topic entity to check.

cancellationToken
CancellationToken

An optional CancellationToken instance to signal the request to cancel the operation.

Returns

Task<Response<Boolean>>

True if topic exists, false otherwise.

Exceptions

ServiceTimeout

The operation times out.

ServiceBusy

The server is busy. You should wait before you retry the operation.

ArgumentNullException

The topic name is null or empty..

ArgumentOutOfRangeException

The topic name name exceeds the maximum allowed length.

ArgumentException

The topic name is otherwise invalid.

UnauthorizedAccessException

Insufficient permission to perform this operation. You should check to ensure that your ServiceBusAdministrationClient has the necessary claims to perform this operation. https://learn.microsoft.com/azure/service-bus-messaging/service-bus-sas#rights-required-for-service-bus-operations

ServiceBusException
  • The operation timed out. The Reason will be set to ServiceTimeout in this case.
  • The server is busy. You should wait before you retry the operation. The failure reason will be set to ServiceBusy in this case.
  • An internal error or unexpected exception occurs. The failure reason will be set to GeneralError in this case.

Applies to