ActivityLogsOperations.List(String, String, CancellationToken) Method

Definition

Provides the list of records from the activity logs.

public virtual Azure.Pageable<Azure.ResourceManager.Insights.Models.EventData> List (string filter, string select = default, System.Threading.CancellationToken cancellationToken = default);
abstract member List : string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Insights.Models.EventData>
override this.List : string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Insights.Models.EventData>
Public Overridable Function List (filter As String, Optional select As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of EventData)

Parameters

filter
System.String

Reduces the set of data collected.<br>This argument is required and it also requires at least the start date/time.<br>The $filter argument is very restricted and allows only the following patterns.<br>- List events for a resource group: $filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp le '2014-07-20T04:36:37.6407898Z' and resourceGroupName eq 'resourceGroupName'.<br>- List events for resource: $filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp le '2014-07-20T04:36:37.6407898Z' and resourceUri eq 'resourceURI'.<br>- List events for a subscription in a time range: $filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp le '2014-07-20T04:36:37.6407898Z'.<br>- List events for a resource provider: $filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp le '2014-07-20T04:36:37.6407898Z' and resourceProvider eq 'resourceProviderName'.<br>- List events for a correlation Id: $filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp le '2014-07-20T04:36:37.6407898Z' and correlationId eq 'correlationID'.<br><br>NOTE: No other syntax is allowed.

select
System.String

Used to fetch events with only the given properties.<br>The $select argument is a comma separated list of property names to be returned. Possible values are: authorization, claims, correlationId, description, eventDataId, eventName, eventTimestamp, httpRequest, level, operationId, operationName, properties, resourceGroupName, resourceProviderName, resourceId, status, submissionTimestamp, subStatus, subscriptionId.

cancellationToken
System.Threading.CancellationToken

The cancellation token to use.

Returns

Pageable<EventData>

Exceptions

System.ArgumentNullException

filter is null.

Applies to