Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ActivityLogs

Package version

Interface representing a ActivityLogs.

Hierarchy

  • ActivityLogs

Implemented by

Index

Methods

Methods

list

  • Provides the list of records from the activity logs.

    Parameters

    • filter: string

      Reduces the set of data collected.
      This argument is required and it also requires at least the start date/time.
      The $filter argument is very restricted and allows only the following patterns.
      - 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'.
      - 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'.
      - 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'.
      - 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'.
      - 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'.

      NOTE: No other syntax is allowed.

    • Optional options: ActivityLogsListOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<EventData>

Generated using TypeDoc