ServiceBusAdministrationClient.GetTopicsAsync(CancellationToken) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Retrieves the set of topics present in the namespace.
public virtual Azure.AsyncPageable<Azure.Messaging.ServiceBus.Administration.TopicProperties> GetTopicsAsync (System.Threading.CancellationToken cancellationToken = default);
abstract member GetTopicsAsync : System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Messaging.ServiceBus.Administration.TopicProperties>
override this.GetTopicsAsync : System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Messaging.ServiceBus.Administration.TopicProperties>
Public Overridable Function GetTopicsAsync (Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of TopicProperties)
Parameters
- cancellationToken
- CancellationToken
An optional CancellationToken instance to signal the request to cancel the operation.
Returns
An AsyncPageable<T> describing the topics.
Exceptions
If the parameters are out of range.
The operation times out. The timeout period is initialized through the ServiceBusAdministrationClientOptions class (see Retry property). You may need to increase the value of timeout to avoid this exception if the timeout value is relatively low.
The server is busy. You should wait before you retry the operation.
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
- 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.
Remarks
Maximum value allowed is 100 per page.