Get-SPOFileArchivePolicyReport

Module:
Microsoft.Online.SharePoint.PowerShell Module

Gets run reports for a file archive policy.

Syntax

Default (Default) 

Get-SPOFileArchivePolicyReport
    -PolicyId <Guid>
    [<CommonParameters>]

Description

This cmdlet retrieves the run reports for a file archive policy. Reports are kept for the past 12 months and include details about each policy run such as how many sites were processed, how many files were archived, and the total storage archived.

For policies running in WhatIf mode, reports show how many files and how much storage would have been archived instead.

Note

This cmdlet is part of the file archive policies feature which is currently in preview.

Examples

Example 1

Get-SPOFileArchivePolicyReport -PolicyId "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Returns all run reports for the specified file archive policy from the past 12 months.

Parameters

-PolicyId

Specifies the unique identifier (GUID) of the policy to retrieve run reports for.

Parameter properties

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

Parameter sets

(All)
Position:Named
Mandatory:True
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

None

Outputs

System.Object