Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Search-AdminAuditLog

 

Applies to: Exchange Server 2013, Exchange Online Protection, Exchange Online

Topic Last Modified: 2013-10-14

Use the Search-AdminAuditLog cmdlet to search the contents of the administrator audit log.

For information about the parameter sets in the Syntax section below, see Syntax.

Search-AdminAuditLog [-Cmdlets <MultiValuedProperty>] [-EndDate <ExDateTime>] [-ExternalAccess <$true | $false>] [-Identity <OrganizationIdParameter>] [-IsSuccess <$true | $false>] [-ObjectIds <MultiValuedProperty>] [-Parameters <MultiValuedProperty>] [-ResultSize <Int32>] [-StartDate <ExDateTime>] [-StartIndex <Int32>] [-UserIds <MultiValuedProperty>] [-DomainController <Fqdn>]

This example finds all the administrator audit log entries that contain either the New-RoleGroup or the New-ManagementRoleAssignment cmdlet.

Search-AdminAuditLog -Cmdlets New-RoleGroup, New-ManagementRoleAssignment

This example finds all the administrator audit log entries that match the following criteria:

  • Cmdlets   Set-Mailbox

  • Parameters   UseDatabaseQuotaDefaults, ProhibitSendReceiveQuota, ProhibitSendQuota

  • StartDate   01/24/2012

  • EndDate   02/12/2012

  • The command completed successfully

Search-AdminAuditLog -Cmdlets Set-Mailbox -Parameters UseDatabaseQuotaDefaults, ProhibitSendReceiveQuota, ProhibitSendQuota -StartDate 01/24/2012 -EndDate 02/12/2012 -IsSuccess $true

This example displays all the comments written to the administrator audit log by the Write-AdminAuditLog cmdlet.

First, store the audit log entries in a temporary variable using the following command.

$LogEntries = Search-AdminAuditLog -Cmdlets Write-AdminAuditLog

Then, iterate through all the audit log entries returned and display the Parameters property using the following command.

$LogEntries | ForEach { $_.CmdletParameters }

This example returns entries in the administrator audit log of an Exchange Online organization for cmdlets run by Microsoft datacenter administrators between September 17, 2013 and October 2, 2013.

Search-AdminAuditLog -ExternalAccess $true -StartDate 09/17/2013 -EndDate 10/02/2013

If you run the Search-AdminAuditLog cmdlet without any parameters, up to 1,000 log entries are returned by default.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "View-only administrator audit logging" entry in the Exchange and Shell Infrastructure Permissions topic.

 

Parameter Required Type Description

Cmdlets

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The Cmdlets parameter specifies the cmdlets you want to search for in the administrator audit log. Only the log entries that contain the cmdlets you specify are returned.

If you want to specify more than one cmdlet, separate each cmdlet with a comma.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory.

EndDate

Optional

Microsoft.Exchange.ExchangeSystem.ExDateTime

The EndDate parameter specifies the scope of the administrator audit log results to log entries that occurred on or before the specified date.

Specify the day, month, and year in the format specified in your regional settings.

ExternalAccess

Optional

System.Boolean

The ExternalAccess parameter returns only audit log entries for cmdlets that were run by a user outside of your organization. In Exchange Online, use this parameter to return audit log entries for cmdlets run by Microsoft datacenter administrators.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

This parameter is reserved for internal Microsoft use.

IsSuccess

Optional

System.Boolean

The IsSuccess parameter specifies whether only administrator audit log entries that indicated a success or failure should be returned. Valid values are $true and $false.

ObjectIds

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ObjectIds parameter specifies that only administrator audit log entries that contain the specified changed objects should be returned. This parameter accepts a variety of objects, such as mailbox aliases, Send connector names, and so on.

If you want to specify more than one object ID, separate each ID with a comma.

Parameters

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The Parameters parameter specifies the parameters you want to search for in the administrator audit log. Only the log entries that contain the parameters you specify are returned. You can only use this parameter if you use the Cmdlets parameter.

If you want to specify more than one parameter, separate each parameter with a comma.

ResultSize

Optional

System.Int32

The ResultSize parameter specifies the maximum number of administrator audit log entries to return. The minimum value is 1 and the maximum value is 250000. The default value is 1000.

StartDate

Optional

Microsoft.Exchange.ExchangeSystem.ExDateTime

The StartDate parameter specifies the scope of the administrator audit log results to log entries that occurred on or after the specified date.

Specify the day, month, and year in the format specified in your regional settings.

StartIndex

Optional

System.Int32

The StartIndex parameter specifies the position in the result set where the displayed results start.

UserIds

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The UserIds parameter specifies that only the administrator audit log entries that contain the specified ID of the user who ran the cmdlet should be returned.

If you want to specify more than one user ID, separate each ID with a comma.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.