EventGridExtensions.GetEventGridTopics 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.
Overloads
| GetEventGridTopics(ResourceGroupResource) |
Gets a collection of EventGridTopicResources in the ResourceGroupResource. MockingTo mock this method, please mock GetEventGridTopics() instead. |
| GetEventGridTopics(SubscriptionResource, String, Nullable<Int32>, CancellationToken) |
List all the topics under an Azure subscription.
|
GetEventGridTopics(ResourceGroupResource)
- Source:
- EventGridExtensions.cs
- Source:
- EventGridExtensions.cs
Gets a collection of EventGridTopicResources in the ResourceGroupResource. MockingTo mock this method, please mock GetEventGridTopics() instead.
public static Azure.ResourceManager.EventGrid.EventGridTopicCollection GetEventGridTopics (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource);static member GetEventGridTopics : Azure.ResourceManager.Resources.ResourceGroupResource -> Azure.ResourceManager.EventGrid.EventGridTopicCollection<Extension()>
Public Function GetEventGridTopics (resourceGroupResource As ResourceGroupResource) As EventGridTopicCollectionParameters
- resourceGroupResource
- ResourceGroupResource
The ResourceGroupResource instance the method will execute against.
Returns
An object representing collection of EventGridTopicResources and their operations over a EventGridTopicResource.
Exceptions
resourceGroupResource is null.
Applies to
GetEventGridTopics(SubscriptionResource, String, Nullable<Int32>, CancellationToken)
- Source:
- EventGridExtensions.cs
- 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.Pageable<Azure.ResourceManager.EventGrid.EventGridTopicResource> GetEventGridTopics (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, string filter = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);static member GetEventGridTopics : Azure.ResourceManager.Resources.SubscriptionResource * string * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.EventGrid.EventGridTopicResource><Extension()>
Public Function GetEventGridTopics (subscriptionResource As SubscriptionResource, Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(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'.
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
A collection of EventGridTopicResource that may take multiple service requests to iterate over.
Exceptions
subscriptionResource is null.
