Get-AadrmAdminLog

Reference

Module:: AADRM

Generates logs for all Rights Management administrative commands.

Syntax

Get-AadrmAdminLog
   -Path <String>
   [-FromTime <DateTime>]
   [-ToTime <DateTime>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Note

This cmdlet from the AADRM module is now deprecated. After July 15, 2020, this cmdlet name will be supported only as an alias to its replacement in the AIPService module.

For more information, see the overview page.

The Get-AadrmAdminLog cmdlet generates logs for all Rights Management administrative commands. You can specify a start time and stop time of entries to include.

You must use PowerShell to get these admin logs; you cannot do this action by using a management portal.

Examples

Example 1: Generate a log of all commands

PS C:\>Get-AadrmAdminLog -Path "C:\Temp\AdminLog.log"

This command generates a log that contains all the Rights Management administrative commands that have been run for your organization's Azure Rights Management service.

Example 2: Generate a log of commands for a specified time period

PS C:\>Get-AadrmAdminLog -Path "C:\Temp\AdminLog.log" -FromTime "05/01/2015 00:00:00" -ToTime "05/31/2015 23:59:59"

This command generates a log of administrative commands for your Azure RMS tenant, limited to items that fall within the specific time period by using the FromTime and ToTime parameters. In this example, the time period is all days in May 2015, using the US date format.

Example 3: Generate a log of commands for the last 45 days

PS C:\>$days = (Get-Date).AddDays(-45) 
PS C:\>Get-AadrmAdminLog -Path "C:\Temp\AdminLog.log" -FromTime $days

This command generates a log of administrative commands for your Azure RMS tenant, limited to items within the last 45 days (inclusive). The first command sets the variable for the FromTime parameter to be today's date minus 45 days. Then the second command gets the entries from the log for this time period, by using this variable.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

Indicates that the cmdlet overwrites, without prompting for confirmation, an existing log file that has the same path.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Path

Specifies an existing path and a file name for the log.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	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.

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Get-Date