EventGridExtensions.GetGlobalEventSubscriptionsDataForTopicTypeAsync 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
| GetGlobalEventSubscriptionsDataForTopicTypeAsync(ResourceGroupResource, String, String, Nullable<Int32>, CancellationToken) |
List all global event subscriptions under a resource group for a specific topic type.
|
| GetGlobalEventSubscriptionsDataForTopicTypeAsync(SubscriptionResource, String, String, Nullable<Int32>, CancellationToken) |
List all global event subscriptions under an Azure subscription for a topic type.
|
GetGlobalEventSubscriptionsDataForTopicTypeAsync(ResourceGroupResource, String, String, Nullable<Int32>, CancellationToken)
- Source:
- EventGridExtensions.cs
- Source:
- EventGridExtensions.cs
List all global event subscriptions under a resource group for a specific topic type.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions
- Operation Id: EventSubscriptions_ListGlobalByResourceGroupForTopicType
public static Azure.AsyncPageable<Azure.ResourceManager.EventGrid.EventGridSubscriptionData> GetGlobalEventSubscriptionsDataForTopicTypeAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string topicTypeName, string filter = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);static member GetGlobalEventSubscriptionsDataForTopicTypeAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * string * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.EventGrid.EventGridSubscriptionData><Extension()>
Public Function GetGlobalEventSubscriptionsDataForTopicTypeAsync (resourceGroupResource As ResourceGroupResource, topicTypeName As String, Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of EventGridSubscriptionData)Parameters
- resourceGroupResource
- ResourceGroupResource
The ResourceGroupResource instance the method will execute against.
- topicTypeName
- String
Name of the topic type.
- 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
An async collection of EventGridSubscriptionData that may take multiple service requests to iterate over.
Exceptions
topicTypeName is an empty string, and was expected to be non-empty.
topicTypeName is null.
Applies to
GetGlobalEventSubscriptionsDataForTopicTypeAsync(SubscriptionResource, String, String, Nullable<Int32>, CancellationToken)
- Source:
- EventGridExtensions.cs
- Source:
- EventGridExtensions.cs
List all global event subscriptions under an Azure subscription for a topic type.
- Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions
- Operation Id: EventSubscriptions_ListGlobalBySubscriptionForTopicType
public static Azure.AsyncPageable<Azure.ResourceManager.EventGrid.EventGridSubscriptionData> GetGlobalEventSubscriptionsDataForTopicTypeAsync (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, string topicTypeName, string filter = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);static member GetGlobalEventSubscriptionsDataForTopicTypeAsync : Azure.ResourceManager.Resources.SubscriptionResource * string * string * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.EventGrid.EventGridSubscriptionData><Extension()>
Public Function GetGlobalEventSubscriptionsDataForTopicTypeAsync (subscriptionResource As SubscriptionResource, topicTypeName As String, Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of EventGridSubscriptionData)Parameters
- subscriptionResource
- SubscriptionResource
The SubscriptionResource instance the method will execute against.
- topicTypeName
- String
Name of the topic type.
- 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
An async collection of EventGridSubscriptionData that may take multiple service requests to iterate over.
Exceptions
topicTypeName is an empty string, and was expected to be non-empty.
topicTypeName is null.
