EventGridExtensions.GetEventGridTopicsAsync Method

Definition

Namespace:

Azure.ResourceManager.EventGrid

Assembly:

Azure.ResourceManager.EventGrid.dll

Package:

Azure.ResourceManager.EventGrid v1.0.1

Source:

EventGridExtensions.cs

List all the topics under an Azure subscription.

• Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topics
• Operation Id: Topics_ListBySubscription
• Default Api Version: 2024-06-01-preview
• Resource: EventGridTopicResource

public static Azure.AsyncPageable<Azure.ResourceManager.EventGrid.EventGridTopicResource> GetEventGridTopicsAsync (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, string filter = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);

static member GetEventGridTopicsAsync : Azure.ResourceManager.Resources.SubscriptionResource * string * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.EventGrid.EventGridTopicResource>

<Extension()>
Public Function GetEventGridTopicsAsync (subscriptionResource As SubscriptionResource, Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of EventGridTopicResource)

Parameters

subscriptionResource

SubscriptionResource

The SubscriptionResource instance the method will execute against.

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'.

top

Nullable<Int32>

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 to use.

Returns

AsyncPageable<EventGridTopicResource>

An async collection of EventGridTopicResource that may take multiple service requests to iterate over.

Exceptions

ArgumentNullException

subscriptionResource is null.