Get-AipServiceTrackingLog
Gets tracking information for documents protected by Azure Information Protection.
This cmdlet is supported by both the Azure Information Protection classic and unified labeling clients, with different usage, as described below.
Syntax
Default (Default)
Get-AipServiceTrackingLog
-ContentId <Guid>
[-FromTime <DateTime>]
[-ToTime <DateTime>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Get-AipServiceTrackingLog cmdlet runs a query to return protection information about tracked documents.
Information returned includes:
- The document content ID, with the document name if available.
- The Rights Management issuer.
- The users who accessed the document, when, and from what location.
- What protection template ID or specific usage rights were used to protect the document and whether access was granted or denied.
- The IsHiddenInfo property, which will always be false. This property is used to hide events for users where tracking is disabled.
You can specify a start time and stop time of entries to include. The output is returned as a list of PowerShell objects in the PowerShell console.
The Get-AipServiceTracking cmdlet returns tracking information about a protected document with a specified contentID.
To retrieve the contentID for a specific document, use the Get-AipServiceDocumentLog cmdlet.
Examples
Example 1: Get tracking data for a specific document, using its contentId
PS C:\>Get-AipServiceDocumentLog -ContentId c03bf90c-6e40-4f3f-9ba0-2bcd77524b87
This command runs a query to return tracking information for a specific document, with a contentID value of c03bf90c-6e40-4f3f-9ba0-2bcd77524b87
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ContentId
Specifies the contentID value for the document you want to return tracking data for.
To retrieve the contentID for a specific document, use the Get-AipServiceDocumentLog cmdlet.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-FromTime
Specifies the start time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date cmdlet. Specify the date and time according to your system locale settings. For more information, type Get-Help Get-Date.
Parameter properties
| Type: | DateTime |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ToTime
Specifies the stop time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date cmdlet. Specify the date and time according to your system locale settings. For more information, type Get-Help Get-Date.
Parameter properties
| Type: | DateTime |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UserEmail
Specifies the email address of the user. The cmdlet gets the tracking information for documents that were protected by, or accessed by the user who has this email address.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| 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.