ActivityLogsClient Interface

public interface ActivityLogsClient

An instance of this class provides access to all the operations defined in ActivityLogsClient.

Method Summary

Modifier and Type Method and Description
abstract PagedIterable<EventDataInner> list(String filter)

Provides the list of records from the activity logs.

abstract PagedIterable<EventDataInner> list(String filter, String select, Context context)

Provides the list of records from the activity logs.

abstract PagedFlux<EventDataInner> listAsync(String filter)

Provides the list of records from the activity logs.

abstract PagedFlux<EventDataInner> listAsync(String filter, String select)

Provides the list of records from the activity logs.

Method Details

list

public abstract PagedIterable list(String filter)

Provides the list of records from the activity logs.

Parameters:

filter - 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.

Returns:

represents collection of events as paginated response with PagedIterable<T>.

list

public abstract PagedIterable list(String filter, String select, Context context)

Provides the list of records from the activity logs.

Parameters:

filter - 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 - 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.
context - The context to associate with this operation.

Returns:

represents collection of events as paginated response with PagedIterable<T>.

listAsync

public abstract PagedFlux listAsync(String filter)

Provides the list of records from the activity logs.

Parameters:

filter - 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.

Returns:

represents collection of events as paginated response with PagedFlux<T>.

listAsync

public abstract PagedFlux listAsync(String filter, String select)

Provides the list of records from the activity logs.

Parameters:

filter - 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 - 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.

Returns:

represents collection of events as paginated response with PagedFlux<T>.

Applies to