Get-SPOFileArchivePolicy
Gets one or all file archive policies for the tenant.
Syntax
Default (Default)
Get-SPOFileArchivePolicy
[-PolicyId <Guid>]
[<CommonParameters>]
Description
This cmdlet retrieves the properties of file archive policies for the connected SharePoint Online tenant. If the -PolicyId parameter is specified, returns only the matching policy. If omitted, returns all file archive policies under the tenant.
Note
This cmdlet is part of the file archive policies feature which is currently in preview.
Examples
Example 1
Get-SPOFileArchivePolicy
Returns all file archive policies configured for the tenant.
Example 2
Get-SPOFileArchivePolicy -PolicyId "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
Returns the file archive policy with the specified ID.
Parameters
-PolicyId
Specifies the unique identifier (GUID) of the policy to retrieve. If not specified, all policies under the tenant are returned.
Parameter properties
| Type: | Guid |
| 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 |
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.