Get-SPOFileArchivePolicySites
Gets the list of sites associated with a file archive policy.
Syntax
Default (Default)
Get-SPOFileArchivePolicySites
-PolicyId <Guid>
[<CommonParameters>]
Description
This cmdlet retrieves the site entries stored for a file archive policy.
For a policy with a PolicyType of SelectedSites, included sites define the policy's scope. For a policy with a PolicyType of AllSites or AllODBSites, excluded sites are exempt from the policy.
The IsIncluded property identifies whether each stored entry is an inclusion or an exclusion. The output retains both types of stored entries rather than filtering them by the current policy type.
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
Each site entry exposes an IsIncluded Boolean property. A value of $true identifies a stored inclusion, and $false identifies a stored exclusion.