TopicEventSubscriptionsOperationsExtensions.ListAsync 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.
List all event subscriptions for a specific topic.
public static System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.EventGrid.Models.EventSubscription>> ListAsync (this Microsoft.Azure.Management.EventGrid.ITopicEventSubscriptionsOperations operations, string resourceGroupName, string topicName, string filter = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);
static member ListAsync : Microsoft.Azure.Management.EventGrid.ITopicEventSubscriptionsOperations * string * string * string * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.EventGrid.Models.EventSubscription>>
<Extension()>
Public Function ListAsync (operations As ITopicEventSubscriptionsOperations, resourceGroupName As String, topicName As String, Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IPage(Of EventSubscription))
Parameters
- operations
- ITopicEventSubscriptionsOperations
The operations group for this extension method.
- resourceGroupName
- String
The name of the resource group within the user's subscription.
- topicName
- String
Name of the topic.
- filter
- String
The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.
The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.
- cancellationToken
- CancellationToken
The cancellation token.
Returns
Remarks
List all event subscriptions that have been created for a specific topic.