[AutoPublish] main to live - 06/17 20:44 PDT | 06/18 09:14 IST

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteToFileArchivePolicy.md

@@ -0,0 +1,104 @@
+---
+external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
+Module Name: Microsoft.Online.SharePoint.PowerShell
+online version: https://learn.microsoft.com/powershell/module/microsoft.online.sharepoint.powershell/add-spositetofilearchivepolicy
+applicable: SharePoint Online
+title: Add-SPOSiteToFileArchivePolicy
+schema: 2.0.0
+author: HectorRMota
+ms.author: hemota
+ms.reviewer:
+---
+
+# Add-SPOSiteToFileArchivePolicy
+
+## SYNOPSIS
+
+Adds a site to a file archive policy.
+
+## SYNTAX
+
+```
+Add-SPOSiteToFileArchivePolicy -PolicyId <Guid> -Site <SpoSitePipeBind> [<CommonParameters>]
+```
+
+## DESCRIPTION
+
+This cmdlet adds a site to an existing file archive policy that has a PolicyType of `SelectedSites`. The site must exist and be eligible for archiving. At least one site must be added before a `SelectedSites` policy can be activated.
+
+> [!NOTE]
+> This cmdlet is part of the file archive policies feature which is currently in preview.
+
+## EXAMPLES
+
+### Example 1
+
+```powershell
+Add-SPOSiteToFileArchivePolicy -PolicyId "a1b2c3d4-e5f6-7890-abcd-ef1234567890" -Site "https://contoso.sharepoint.com/sites/marketing"
+```
+
+Adds the marketing site to the specified file archive policy.
+
+## PARAMETERS
+
+### -PolicyId
+
+Specifies the unique identifier (GUID) of the policy to add the site to.
+
+```yaml
+Type: Guid
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Site
+
+Specifies the URL of the site to add to the policy. The site must exist and be eligible for archiving.
+
+```yaml
+Type: SpoSitePipeBind
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+
+This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
+
+## INPUTS
+
+### None
+
+## OUTPUTS
+
+### System.Object
+
+## NOTES
+
+## RELATED LINKS
+
+[Get-SPOFileArchivePolicy](Get-SPOFileArchivePolicy.md)
+
+[Get-SPOFileArchivePolicyReport](Get-SPOFileArchivePolicyReport.md)
+
+[Get-SPOFileArchivePolicySites](Get-SPOFileArchivePolicySites.md)
+
+[New-SPOFileArchivePolicy](New-SPOFileArchivePolicy.md)
+
+[Remove-SPOFileArchivePolicy](Remove-SPOFileArchivePolicy.md)
+
+[Remove-SPOSiteToFileArchivePolicy](Remove-SPOSiteToFileArchivePolicy.md)
+
+[Set-SPOFileArchivePolicy](Set-SPOFileArchivePolicy.md)

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOFileArchivePolicy.md

@@ -0,0 +1,96 @@
+---
+external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
+Module Name: Microsoft.Online.SharePoint.PowerShell
+online version: https://learn.microsoft.com/powershell/module/microsoft.online.sharepoint.powershell/get-spofilearchivepolicy
+applicable: SharePoint Online
+title: Get-SPOFileArchivePolicy
+schema: 2.0.0
+author: HectorRMota
+ms.author: hemota
+ms.reviewer:
+---
+
+# Get-SPOFileArchivePolicy
+
+## SYNOPSIS
+
+Gets one or all file archive policies for the tenant.
+
+## SYNTAX
+
+```
+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
+
+```powershell
+Get-SPOFileArchivePolicy
+```
+
+Returns all file archive policies configured for the tenant.
+
+### Example 2
+
+```powershell
+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.
+
+```yaml
+Type: Guid
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+
+This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
+
+## INPUTS
+
+### None
+
+## OUTPUTS
+
+### System.Object
+
+## NOTES
+
+## RELATED LINKS
+
+[Add-SPOSiteToFileArchivePolicy](Add-SPOSiteToFileArchivePolicy.md)
+
+[Get-SPOFileArchivePolicyReport](Get-SPOFileArchivePolicyReport.md)
+
+[Get-SPOFileArchivePolicySites](Get-SPOFileArchivePolicySites.md)
+
+[New-SPOFileArchivePolicy](New-SPOFileArchivePolicy.md)
+
+[Remove-SPOFileArchivePolicy](Remove-SPOFileArchivePolicy.md)
+
+[Remove-SPOSiteToFileArchivePolicy](Remove-SPOSiteToFileArchivePolicy.md)
+
+[Set-SPOFileArchivePolicy](Set-SPOFileArchivePolicy.md)

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOFileArchivePolicyReport.md

@@ -0,0 +1,90 @@
+---
+external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
+Module Name: Microsoft.Online.SharePoint.PowerShell
+online version: https://learn.microsoft.com/powershell/module/microsoft.online.sharepoint.powershell/get-spofilearchivepolicyreport
+applicable: SharePoint Online
+title: Get-SPOFileArchivePolicyReport
+schema: 2.0.0
+author: HectorRMota
+ms.author: hemota
+ms.reviewer:
+---
+
+# Get-SPOFileArchivePolicyReport
+
+## SYNOPSIS
+
+Gets run reports for a file archive policy.
+
+## SYNTAX
+
+```
+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
+
+```powershell
+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.
+
+```yaml
+Type: Guid
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+
+This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
+
+## INPUTS
+
+### None
+
+## OUTPUTS
+
+### System.Object
+
+## NOTES
+
+## RELATED LINKS
+
+[Add-SPOSiteToFileArchivePolicy](Add-SPOSiteToFileArchivePolicy.md)
+
+[Get-SPOFileArchivePolicy](Get-SPOFileArchivePolicy.md)
+
+[Get-SPOFileArchivePolicySites](Get-SPOFileArchivePolicySites.md)
+
+[New-SPOFileArchivePolicy](New-SPOFileArchivePolicy.md)
+
+[Remove-SPOFileArchivePolicy](Remove-SPOFileArchivePolicy.md)
+
+[Remove-SPOSiteToFileArchivePolicy](Remove-SPOSiteToFileArchivePolicy.md)
+
+[Set-SPOFileArchivePolicy](Set-SPOFileArchivePolicy.md)

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOFileArchivePolicySites.md

@@ -0,0 +1,88 @@
+---
+external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
+Module Name: Microsoft.Online.SharePoint.PowerShell
+online version: https://learn.microsoft.com/powershell/module/microsoft.online.sharepoint.powershell/get-spofilearchivepolicysites
+applicable: SharePoint Online
+title: Get-SPOFileArchivePolicySites
+schema: 2.0.0
+author: HectorRMota
+ms.author: hemota
+ms.reviewer:
+---
+
+# Get-SPOFileArchivePolicySites
+
+## SYNOPSIS
+
+Gets the list of sites associated with a file archive policy.
+
+## SYNTAX
+
+```
+Get-SPOFileArchivePolicySites -PolicyId <Guid> [<CommonParameters>]
+```
+
+## DESCRIPTION
+
+This cmdlet retrieves the list of sites that have been added to a file archive policy. This is applicable to policies with a PolicyType of `SelectedSites`.
+
+> [!NOTE]
+> This cmdlet is part of the file archive policies feature which is currently in preview.
+
+## EXAMPLES
+
+### Example 1
+
+```powershell
+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.
+
+```yaml
+Type: Guid
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+
+This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
+
+## INPUTS
+
+### None
+
+## OUTPUTS
+
+### System.Object
+
+## NOTES
+
+## RELATED LINKS
+
+[Add-SPOSiteToFileArchivePolicy](Add-SPOSiteToFileArchivePolicy.md)
+
+[Get-SPOFileArchivePolicy](Get-SPOFileArchivePolicy.md)
+
+[Get-SPOFileArchivePolicyReport](Get-SPOFileArchivePolicyReport.md)
+
+[New-SPOFileArchivePolicy](New-SPOFileArchivePolicy.md)
+
+[Remove-SPOFileArchivePolicy](Remove-SPOFileArchivePolicy.md)
+
+[Remove-SPOSiteToFileArchivePolicy](Remove-SPOSiteToFileArchivePolicy.md)
+
+[Set-SPOFileArchivePolicy](Set-SPOFileArchivePolicy.md)