Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -86,22 +86,6 @@ Accept wildcard characters: False

Use this parameter to get details about applications registered in the specified tenant.

The following details are returned:

- OwningApplicationId

- OwningApplicationName

- Applications (by id)

- SharingCapability

- OverrideTenantSharingCapability

- CopilotEmbeddedChatHosts

- ItemMajorVersionLimit

```yaml
Type: System.Guid
Parameter Sets: (All)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
---
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-spocontainertenantapplyfileversionpolicyjobimpact
applicable: SharePoint Online
title: Get-SPOContainerTenantApplyFileVersionPolicyJobImpact
schema: 2.0.0
author: guptapriyan2001
ms.author: guptapriyan
ms.reviewer:
manager: srikrg
---

# Get-SPOContainerTenantApplyFileVersionPolicyJobImpact

## SYNOPSIS

Estimates how many versions would be trimmed and how much storage would be freed if a trimming job were run with the given version policy for a SharePoint Embedded (SPE) container type. SharePoint Advanced Management license or Copilot license is required to run this cmdlet.

> [!NOTE]
> This feature is currently in preview and may not be available in your tenant.

## SYNTAX

```
Get-SPOContainerTenantApplyFileVersionPolicyJobImpact -ContainerTypeId <Guid>
-VersionPolicy <SPOFileVersionPolicySettings> [<CommonParameters>]
```

## DESCRIPTION

Queries the version dataset collected by a previously completed `New-SPOContainerTenantApplyFileVersionPolicyJob -CollectVersionData` job for the specified SharePoint Embedded (SPE) container type, and returns an estimated impact object showing how many versions would be trimmed and how much storage would be freed if a trimming job were run with the given version policy.

> [!NOTE]
> - A completed job that was started with `-CollectVersionData` for the same container type is required before running this cmdlet. Use `Get-SPOContainerTenantApplyFileVersionPolicyJobProgress` to confirm the job has completed.
> - The estimate is based on a snapshot collected during the job and may not reflect changes made to the container type after the job ran.
> - The estimate does not account for versions protected by retention policies, retention labels, or eDiscovery holds. Actual versions deleted may be fewer than estimated.

## EXAMPLES

### Example 1
```powershell
$policy = Get-SPOTenantVersionPolicy | Get-SPOVersionPolicyWithChanges -MajorVersionLimit 50
Get-SPOContainerTenantApplyFileVersionPolicyJobImpact -ContainerTypeId <ContainerTypeId> -VersionPolicy $policy
```

Estimates the impact of a trimming job run with a modified policy that limits to 50 major versions for the specified container type.

## PARAMETERS

### -ContainerTypeId
The ID of the SharePoint Embedded container type to evaluate.

```yaml
Type: Guid
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -VersionPolicy
The version policy to evaluate. Use `Get-SPOTenantVersionPolicy` and `Get-SPOVersionPolicyWithChanges` to build this value.

```yaml
Type: SPOFileVersionPolicySettings
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

### Microsoft.Online.SharePoint.TenantAdministration.SPOTenantVersionPolicyImpact

## NOTES

## RELATED LINKS

[New-SPOContainerTenantApplyFileVersionPolicyJob](New-SPOContainerTenantApplyFileVersionPolicyJob.md)

[Get-SPOContainerTenantApplyFileVersionPolicyJobProgress](Get-SPOContainerTenantApplyFileVersionPolicyJobProgress.md)

[Get-SPOTenantVersionPolicy](Get-SPOTenantVersionPolicy.md)

[Get-SPOVersionPolicyWithChanges](Get-SPOVersionPolicyWithChanges.md)

[SharePoint Advanced Management](/sharepoint/sharepoint-advanced-management-licensing)

[Microsoft 365 Copilot](/microsoft-365/copilot/microsoft-365-copilot-licensing)
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
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-spocontainertenantapplyfileversionpolicyjobprogress
applicable: SharePoint Online
title: Get-SPOContainerTenantApplyFileVersionPolicyJobProgress
schema: 2.0.0
author: guptapriyan2001
ms.author: guptapriyan
ms.reviewer:
manager: srikrg
---

# Get-SPOContainerTenantApplyFileVersionPolicyJobProgress

## SYNOPSIS

Gets the status for an apply file version policy job for a SharePoint Embedded (SPE) container type. SharePoint Advanced Management license or Copilot license is required to run this cmdlet.

> [!NOTE]
> This feature is currently in preview and may not be available in your tenant.

## SYNTAX

```
Get-SPOContainerTenantApplyFileVersionPolicyJobProgress -ContainerTypeId <Guid> [<CommonParameters>]
```

## DESCRIPTION

Gets the status for an apply file version policy job that was queued for the specified SharePoint Embedded (SPE) container type.

## EXAMPLES

### Example 1
```powershell
Get-SPOContainerTenantApplyFileVersionPolicyJobProgress -ContainerTypeId <ContainerTypeId>
```

Example 1 gets the status for the apply file version policy job of the specified container type.

## PARAMETERS

### -ContainerTypeId
The ID of the SharePoint Embedded container type whose job status is retrieved.

```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

[New-SPOContainerTenantApplyFileVersionPolicyJob](New-SPOContainerTenantApplyFileVersionPolicyJob.md)

[Remove-SPOContainerTenantApplyFileVersionPolicyJob](Remove-SPOContainerTenantApplyFileVersionPolicyJob.md)

[SharePoint Advanced Management](/sharepoint/sharepoint-advanced-management-licensing)

[Microsoft 365 Copilot](/microsoft-365/copilot/microsoft-365-copilot-licensing)
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,12 @@ Get the current state of Microsoft-provided SharePoint site templates displayed
### [Get-SPOContainer](Get-SPOContainer.md)
Returns one or more containers in a SharePoint Embedded application.

### [Get-SPOContainerTenantApplyFileVersionPolicyJobImpact](Get-SPOContainerTenantApplyFileVersionPolicyJobImpact.md)
Estimates the impact of applying a file version policy across all containers of a SharePoint Embedded container type.

### [Get-SPOContainerTenantApplyFileVersionPolicyJobProgress](Get-SPOContainerTenantApplyFileVersionPolicyJobProgress.md)
Returns the progress of the file version policy job for a SharePoint Embedded container type.

### [Get-SPOContainerType](Get-SPOContainerType.md)
Returns one or more container types created in the tenant.

Expand Down Expand Up @@ -473,6 +479,9 @@ Invokes a job to swap the location of a site with another site while archiving t
### [New-SPOAppBillingPolicy](New-SPOAppBillingPolicy.md)
Creates a new billing policy for an application owned by the tenant.

### [New-SPOContainerTenantApplyFileVersionPolicyJob](New-SPOContainerTenantApplyFileVersionPolicyJob.md)
Queues a job to apply a file version policy across all containers of a SharePoint Embedded container type.

### [New-SPOContainerType](New-SPOContainerType.md)
This cmdlet creates a new container type of standard or trial status. The standard container type can be created with the regular billing structure or direct to customer billing structure.

Expand Down Expand Up @@ -533,6 +542,9 @@ Removes billing policy associated with the application.
### [Remove-SPOContainer](Remove-SPOContainer.md)
Sends a Container to the Recycle Bin.

### [Remove-SPOContainerTenantApplyFileVersionPolicyJob](Remove-SPOContainerTenantApplyFileVersionPolicyJob.md)
Cancels the file version policy job for a SharePoint Embedded container type.

### [Remove-SPOContainerType](Remove-SPOContainerType.md)
This cmdlet removes the container type specified from the tenant.

Expand Down
Loading
Loading