Share via


EventGridExtensions.GetGlobalEventSubscriptionsDataForTopicType Method

Definition

Overloads

GetGlobalEventSubscriptionsDataForTopicType(ResourceGroupResource, String, String, Nullable<Int32>, CancellationToken)

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
GetGlobalEventSubscriptionsDataForTopicType(SubscriptionResource, String, String, Nullable<Int32>, CancellationToken)

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

GetGlobalEventSubscriptionsDataForTopicType(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.Pageable<Azure.ResourceManager.EventGrid.EventGridSubscriptionData> GetGlobalEventSubscriptionsDataForTopicType (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string topicTypeName, string filter = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);
static member GetGlobalEventSubscriptionsDataForTopicType : Azure.ResourceManager.Resources.ResourceGroupResource * string * string * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.EventGrid.EventGridSubscriptionData>
<Extension()>
Public Function GetGlobalEventSubscriptionsDataForTopicType (resourceGroupResource As ResourceGroupResource, topicTypeName As String, Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(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'.

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

A 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

GetGlobalEventSubscriptionsDataForTopicType(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.Pageable<Azure.ResourceManager.EventGrid.EventGridSubscriptionData> GetGlobalEventSubscriptionsDataForTopicType (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, string topicTypeName, string filter = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);
static member GetGlobalEventSubscriptionsDataForTopicType : Azure.ResourceManager.Resources.SubscriptionResource * string * string * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.EventGrid.EventGridSubscriptionData>
<Extension()>
Public Function GetGlobalEventSubscriptionsDataForTopicType (subscriptionResource As SubscriptionResource, topicTypeName As String, Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(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'.

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

A 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