Partilhar via

Get-MgAuditLogDirectoryAudit

Module:
Microsoft.Graph.Reports Module

Get a specific Microsoft Entra audit log item. This includes an audit log item generated by various services within Microsoft Entra ID like user, application, device and group management, privileged identity management (PIM), access reviews, terms of use, identity protection, password management (self-service and admin password resets), self-service group management, and so on.

Note

To view the beta release of this cmdlet, view Get-MgBetaAuditLogDirectoryAudit

Syntax

List (Default) 

Get-MgAuditLogDirectoryAudit
    [-ExpandProperty <String[]>]
    [-Property <String[]>]
    [-Filter <String>]
    [-Search <String>]
    [-Skip <Int32>]
    [-Sort <String[]>]
    [-Top <Int32>]
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-PageSize <Int32>]
    [-All]
    [-CountVariable <String>]
    [<CommonParameters>]

Get 

Get-MgAuditLogDirectoryAudit
    -DirectoryAuditId <String>
    [-ExpandProperty <String[]>]
    [-Property <String[]>]
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [<CommonParameters>]

GetViaIdentity 

Get-MgAuditLogDirectoryAudit
    -InputObject <IReportsIdentity>
    [-ExpandProperty <String[]>]
    [-Property <String[]>]
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [<CommonParameters>]

Description

Get a specific Microsoft Entra audit log item. This includes an audit log item generated by various services within Microsoft Entra ID like user, application, device and group management, privileged identity management (PIM), access reviews, terms of use, identity protection, password management (self-service and admin password resets), self-service group management, and so on.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) AuditLog.Read.All, Directory.Read.All,
Delegated (personal Microsoft account) Not supported
Application AuditLog.Read.All, Directory.Read.All,

Examples

Example 1: Retrieve the list of audit logs


Import-Module Microsoft.Graph.Reports

Get-MgAuditLogDirectoryAudit

This example will retrieve the list of audit logs

Example 2: Retrieve the list of audit logs with a filter on initiatedBy/user


Import-Module Microsoft.Graph.Reports

Get-MgAuditLogDirectoryAudit -Filter "initiatedBy/user/id eq '00000000-0000-0000-0000-000000000000'"

This example will retrieve the list of audit logs with a filter on initiatedby/user

Parameters

-All

List all pages.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CountVariable

Specifies a count of the total number of items in a collection. By default, this variable will be set in the global scope.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:CV

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DirectoryAuditId

The unique identifier of directoryAudit

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ExpandProperty

Expand related entities

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Expand

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Filter

Filter items by property values

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:IDictionary
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:IReportsIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-PageSize

Sets the page size of results.

Parameter properties

Type:Int32
Default value:0
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Property

Select properties to be returned

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Select

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:RHV

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Search

Search items by search phrases

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Skip

Skip the first n items

Parameter properties

Type:Int32
Default value:0
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Sort

Order items by property values

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:OrderBy

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Top

Show only the first n items

Parameter properties

Type:Int32
Default value:0
Supports wildcards:False
DontShow:False
Aliases:Limit

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Graph.PowerShell.Models.IReportsIdentity

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphDirectoryAudit

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IReportsIdentity>: Identity Parameter

  • [Date <DateTime?>]: Usage: date={date}
  • [DeviceManagementExportJobId <String>]: The unique identifier of deviceManagementExportJob
  • [DirectoryAuditId <String>]: The unique identifier of directoryAudit
  • [EndDateTime <DateTime?>]: Usage: endDateTime={endDateTime}
  • [Filter <String>]: Usage: filter='{filter}'
  • [GroupId <String>]: Usage: groupId='{groupId}'
  • [IncludedUserRoles <String>]: Usage: includedUserRoles='{includedUserRoles}'
  • [IncludedUserTypes <String>]: Usage: includedUserTypes='{includedUserTypes}'
  • [ManifestId <String>]: The unique identifier of manifest
  • [OperationId <String>]: The unique identifier of operation
  • [Period <String>]: Usage: period='{period}'
  • [PrintUsageByPrinterId <String>]: The unique identifier of printUsageByPrinter
  • [PrintUsageByUserId <String>]: The unique identifier of printUsageByUser
  • [PrinterId <String>]: Usage: printerId='{printerId}'
  • [ProvisioningObjectSummaryId <String>]: The unique identifier of provisioningObjectSummary
  • [SignInId <String>]: The unique identifier of signIn
  • [Skip <Int32?>]: Usage: skip={skip}
  • [SkipToken <String>]: Usage: skipToken='{skipToken}'
  • [StartDateTime <DateTime?>]: Usage: startDateTime={startDateTime}
  • [Top <Int32?>]: Usage: top={top}
  • [UserId <String>]: Usage: userId='{userId}'
  • [UserRegistrationDetailsId <String>]: The unique identifier of userRegistrationDetails