EventGridExtensions.GetSystemTopics 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
GetSystemTopics(SubscriptionResource, String, Nullable<Int32>, CancellationToken) |
List all the system topics under an Azure subscription.
|
GetSystemTopics(ResourceGroupResource) |
Gets a collection of SystemTopicResources in the ResourceGroupResource. MockingTo mock this method, please mock GetSystemTopics() instead. |
GetSystemTopics(SubscriptionResource, String, Nullable<Int32>, CancellationToken)
- Source:
- EventGridExtensions.cs
- Source:
- EventGridExtensions.cs
List all the system topics under an Azure subscription.
- Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/systemTopics
- Operation Id: SystemTopics_ListBySubscription
- Default Api Version: 2024-06-01-preview
- Resource: SystemTopicResource
public static Azure.Pageable<Azure.ResourceManager.EventGrid.SystemTopicResource> GetSystemTopics (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, string filter = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);
static member GetSystemTopics : Azure.ResourceManager.Resources.SubscriptionResource * string * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.EventGrid.SystemTopicResource>
<Extension()>
Public Function GetSystemTopics (subscriptionResource As SubscriptionResource, Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of SystemTopicResource)
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 SystemTopicResource that may take multiple service requests to iterate over.
Exceptions
subscriptionResource
is null.
Applies to
GetSystemTopics(ResourceGroupResource)
- Source:
- EventGridExtensions.cs
- Source:
- EventGridExtensions.cs
Gets a collection of SystemTopicResources in the ResourceGroupResource. MockingTo mock this method, please mock GetSystemTopics() instead.
public static Azure.ResourceManager.EventGrid.SystemTopicCollection GetSystemTopics (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource);
static member GetSystemTopics : Azure.ResourceManager.Resources.ResourceGroupResource -> Azure.ResourceManager.EventGrid.SystemTopicCollection
<Extension()>
Public Function GetSystemTopics (resourceGroupResource As ResourceGroupResource) As SystemTopicCollection
Parameters
- resourceGroupResource
- ResourceGroupResource
The ResourceGroupResource instance the method will execute against.
Returns
An object representing collection of SystemTopicResources and their operations over a SystemTopicResource.
Exceptions
resourceGroupResource
is null.
Applies to
Azure SDK for .NET