Get-SPOFileArchivePolicySites

Module:
Microsoft.Online.SharePoint.PowerShell Module

Gets the list of sites associated with a file archive policy.

Syntax

Default (Default) 

Get-SPOFileArchivePolicySites
    -PolicyId 
    []

Description

This cmdlet retrieves the list of sites that have been added to a file archive policy.

For a policy with a PolicyType of SelectedSites, this returns the included sites that the policy applies to. For a policy with a PolicyType of AllSites or AllODBSites, this returns the excluded sites that are exempt from the policy.

Note

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

Examples

Example 1

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

Returns all sites associated with the specified file archive policy.

Parameters

-PolicyId

Specifies the unique identifier (GUID) of the policy to retrieve the site list 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