ISystemTopicEventSubscriptionsOperations.ListBySystemTopicWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.Management.EventGrid

Assembly:

Microsoft.Azure.Management.EventGrid.dll

Package:

Microsoft.Azure.Management.EventGrid v9.0.0

List event subscriptions of a system topic.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.EventGrid.Models.EventSubscription>>> ListBySystemTopicWithHttpMessagesAsync (string resourceGroupName, string systemTopicName, string filter = default, int? top = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ListBySystemTopicWithHttpMessagesAsync : string * string * string * Nullable<int> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.EventGrid.Models.EventSubscription>>>

Public Function ListBySystemTopicWithHttpMessagesAsync (resourceGroupName As String, systemTopicName As String, Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of IPage(Of EventSubscription)))

Parameters

resourceGroupName

String

The name of the resource group within the user's subscription.

systemTopicName

String

Name of the system topic.

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.

customHeaders

Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<IPage<EventSubscription>>>

Exceptions

CloudException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null

Remarks

List event subscriptions that belong to a specific system topic.