EventGridExtensions.GetRegionalEventSubscriptionsDataForTopicTypeAsync Method

Definition

Namespace:

Azure.ResourceManager.EventGrid

Assembly:

Azure.ResourceManager.EventGrid.dll

Package:

Azure.ResourceManager.EventGrid v1.0.1

Overloads

GetRegionalEventSubscriptionsDataForTopicTypeAsync(ResourceGroupResource, AzureLocation, String, String, Nullable<Int32>, CancellationToken)	List all event subscriptions from the given location under a specific Azure subscription and resource group and topic type. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/locations/{location}/topicTypes/{topicTypeName}/eventSubscriptions Operation Id: EventSubscriptions_ListRegionalByResourceGroupForTopicType
GetRegionalEventSubscriptionsDataForTopicTypeAsync(SubscriptionResource, AzureLocation, String, String, Nullable<Int32>, CancellationToken)	List all event subscriptions from the given location under a specific Azure subscription and topic type. Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/locations/{location}/topicTypes/{topicTypeName}/eventSubscriptions Operation Id: EventSubscriptions_ListRegionalBySubscriptionForTopicType

GetRegionalEventSubscriptionsDataForTopicTypeAsync(ResourceGroupResource, AzureLocation, String, String, Nullable<Int32>, CancellationToken)

Source:

EventGridExtensions.cs

List all event subscriptions from the given location under a specific Azure subscription and resource group and topic type.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/locations/{location}/topicTypes/{topicTypeName}/eventSubscriptions
• Operation Id: EventSubscriptions_ListRegionalByResourceGroupForTopicType

public static Azure.AsyncPageable<Azure.ResourceManager.EventGrid.EventGridSubscriptionData> GetRegionalEventSubscriptionsDataForTopicTypeAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, Azure.Core.AzureLocation location, string topicTypeName, string filter = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);

static member GetRegionalEventSubscriptionsDataForTopicTypeAsync : Azure.ResourceManager.Resources.ResourceGroupResource * Azure.Core.AzureLocation * string * string * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.EventGrid.EventGridSubscriptionData>

<Extension()>
Public Function GetRegionalEventSubscriptionsDataForTopicTypeAsync (resourceGroupResource As ResourceGroupResource, location As AzureLocation, 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.

location

AzureLocation

Name of the location.

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

AsyncPageable<EventGridSubscriptionData>

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

Exceptions

ArgumentException

topicTypeName is an empty string, and was expected to be non-empty.

ArgumentNullException

topicTypeName is null.

GetRegionalEventSubscriptionsDataForTopicTypeAsync(SubscriptionResource, AzureLocation, String, String, Nullable<Int32>, CancellationToken)

Source:

EventGridExtensions.cs

List all event subscriptions from the given location under a specific Azure subscription and topic type.

• Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/locations/{location}/topicTypes/{topicTypeName}/eventSubscriptions
• Operation Id: EventSubscriptions_ListRegionalBySubscriptionForTopicType

public static Azure.AsyncPageable<Azure.ResourceManager.EventGrid.EventGridSubscriptionData> GetRegionalEventSubscriptionsDataForTopicTypeAsync (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, Azure.Core.AzureLocation location, string topicTypeName, string filter = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);

static member GetRegionalEventSubscriptionsDataForTopicTypeAsync : Azure.ResourceManager.Resources.SubscriptionResource * Azure.Core.AzureLocation * string * string * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.EventGrid.EventGridSubscriptionData>

<Extension()>
Public Function GetRegionalEventSubscriptionsDataForTopicTypeAsync (subscriptionResource As SubscriptionResource, location As AzureLocation, 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.

location

AzureLocation

Name of the location.

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

AsyncPageable<EventGridSubscriptionData>

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

Exceptions

ArgumentException

topicTypeName is an empty string, and was expected to be non-empty.

ArgumentNullException

topicTypeName is null.