MonitorExtensions.GetTenantActivityLogsAsync Method

Definition

Namespace:

Azure.ResourceManager.Monitor

Assembly:

Azure.ResourceManager.Monitor.dll

Package:

Azure.ResourceManager.Monitor v1.3.1

Source:

MonitorExtensions.cs

Gets the Activity Logs for the Tenant.<br>Everything that is applicable to the API to get the Activity Logs for the subscription is applicable to this API (the parameters, $filter, etc.).<br>One thing to point out here is that this API does not retrieve the logs at the individual subscription of the tenant but only surfaces the logs that were generated at the tenant level.

• Request Path: /providers/Microsoft.Insights/eventtypes/management/values
• Operation Id: TenantActivityLogs_List
• Default Api Version: 2015-04-01

public static Azure.AsyncPageable<Azure.ResourceManager.Monitor.Models.EventDataInfo> GetTenantActivityLogsAsync (this Azure.ResourceManager.Resources.TenantResource tenantResource, string filter = default, string select = default, System.Threading.CancellationToken cancellationToken = default);

static member GetTenantActivityLogsAsync : Azure.ResourceManager.Resources.TenantResource * string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Monitor.Models.EventDataInfo>

<Extension()>
Public Function GetTenantActivityLogsAsync (tenantResource As TenantResource, Optional filter As String = Nothing, Optional select As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of EventDataInfo)

Parameters

tenantResource

TenantResource

The TenantResource instance the method will execute against.

filter

String

Reduces the set of data collected. <br>The $filter is very restricted and allows only the following patterns.<br>- List events for a resource group: $filter=eventTimestamp ge '<Start Time>' and eventTimestamp le '<End Time>' and eventChannels eq 'Admin, Operation' and resourceGroupName eq '<ResourceGroupName>'.<br>- List events for resource: $filter=eventTimestamp ge '<Start Time>' and eventTimestamp le '<End Time>' and eventChannels eq 'Admin, Operation' and resourceUri eq '<ResourceURI>'.<br>- List events for a subscription: $filter=eventTimestamp ge '<Start Time>' and eventTimestamp le '<End Time>' and eventChannels eq 'Admin, Operation'.<br>- List events for a resource provider: $filter=eventTimestamp ge '<Start Time>' and eventTimestamp le '<End Time>' and eventChannels eq 'Admin, Operation' and resourceProvider eq '<ResourceProviderName>'.<br>- List events for a correlation Id: api-version=2014-04-01&$filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp le '2014-07-20T04:36:37.6407898Z' and eventChannels eq 'Admin, Operation' and correlationId eq '<CorrelationID>'.<br>NOTE: No other syntax is allowed.

select

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

CancellationToken

The cancellation token to use.

Returns

AsyncPageable<EventDataInfo>

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

Exceptions

ArgumentNullException

tenantResource is null.