Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[FileVersion] Revision for set file version on site command #3428

Merged
merged 1 commit into from
Sep 21, 2023
Merged

[FileVersion] Revision for set file version on site command #3428

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
79 changes: 58 additions & 21 deletions documentation/Set-PnPSite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,10 @@ Set-PnPSite [-Identity <String>]
[-ExpireVersionsAfterDays <UInt32>]
[-MajorVersions <UInt32>]
[-MinorVersions <UInt32>]
[-InheritTenantVersionPolicySettings]
[-StartApplyVersionPolicySettingToExistingDocLibs]
[-CancelApplyVersionPolicySettingToExistingDocLibs]
[-InheritTenantVPForNewDocLibs]
[-ApplyForNewLibs]
[-ApplyForExistingLibs]
[-CancelVPForExistingLibs]
[-Connection <PnPConnection>]
```

Expand Down Expand Up @@ -115,53 +116,74 @@ Allows custom script on a specific site. See [Allow or prevent custom script](ht
Set-PnPSite -EnableAutoExpirationVersionTrim $true
```

Set AutoExpiration file version trim mode for a site. The new document libraries will use this version setting.
Set AutoExpiration file version trim mode for a site. The new document libraries will use this version setting. Also create a request to set the file version trim mode as AutoExpiration for existing document libraries that enabled versioning.

### EXAMPLE 8
```powershell
Set-PnPSite -EnableAutoExpirationVersionTrim $false -MajorVersions 100 -ExpireVersionsAfterDays 200
Set-PnPSite -EnableAutoExpirationVersionTrim $false -MajorVersions 100 -MinorVersions 10 -ExpireVersionsAfterDays 200
```

Set ExpireAfter file version trim mode for a site. The new document libraries will use this version setting.
Set ExpireAfter file version trim mode for a site. The new document libraries will use this version setting. Also create a request to set the file version trim mode as ExpireAfter for existing document libraries that enabled versioning.

### EXAMPLE 9
```powershell
Set-PnPSite -EnableAutoExpirationVersionTrim $false -MajorVersions 300 -ExpireVersionsAfterDays 0
Set-PnPSite -EnableAutoExpirationVersionTrim $false -MajorVersions 300 -MinorVersions 20 -ExpireVersionsAfterDays 0
```

Set NoExpiration file version trim mode for a site. The new document libraries will use this version setting.
Set NoExpiration file version trim mode for a site. The new document libraries will use this version setting. Also create a request to set the file version trim mode as NoExpiration for existing document libraries that enabled versioning.

### EXAMPLE 10
```powershell
Set-PnPSite -InheritTenantVersionPolicySettings
Set-PnPSite -InheritTenantVPForNewDocLibs
```

Clear the file version setting on a site. The new document libraries will use the tenant level setting.

### EXAMPLE 11
```powershell
Set-PnPSite -EnableAutoExpirationVersionTrim $true -StartApplyVersionPolicySettingToExistingDocLibs
Set-PnPSite -EnableAutoExpirationVersionTrim $true -ApplyForNewLibs
```

Create a request to set the file version trim mode as AutoExpiration for existing document libraries that enabled versioning.
Set AutoExpiration file version trim mode for a site. The new document libraries will use this version setting.

### EXAMPLE 12
```powershell
Set-PnPSite -EnableAutoExpirationVersionTrim $false -MajorVersions 100 -MinorVersions 5 -ExpireVersionsAfterDays 200 -StartApplyVersionPolicySettingToExistingDocLibs
Set-PnPSite -EnableAutoExpirationVersionTrim $false -MajorVersions 100 -ExpireVersionsAfterDays 200 -ApplyForNewLibs
```

Create a request to set the file version trim mode as ExpireAfter for existing document libraries that enabled versioning.
Set ExpireAfter file version trim mode for a site. The new document libraries will use this version setting.

### EXAMPLE 13
```powershell
Set-PnPSite -EnableAutoExpirationVersionTrim $false -MajorVersions 100 -MinorVersions 5 -ExpireVersionsAfterDays 0 -StartApplyVersionPolicySettingToExistingDocLibs
Set-PnPSite -EnableAutoExpirationVersionTrim $false -MajorVersions 300 -ExpireVersionsAfterDays 0 -ApplyForNewLibs
```

Create a request to set the file version trim mode as NoExpiration for existing document libraries that enabled versioning.
Set NoExpiration file version trim mode for a site. The new document libraries will use this version setting.

### EXAMPLE 14
```powershell
Set-PnPSite -CancelApplyVersionPolicySettingToExistingDocLibs
Set-PnPSite -EnableAutoExpirationVersionTrim $true -ApplyForExistingLibs
```

Create a request to set the file version trim mode as AutoExpiration for existing document libraries that enabled versioning.

### EXAMPLE 15
```powershell
Set-PnPSite -EnableAutoExpirationVersionTrim $false -MajorVersions 100 -MinorVersions 5 -ExpireVersionsAfterDays 200 -ApplyForExistingLibs
```

Create a request to set the file version trim mode as ExpireAfter for existing document libraries that enabled versioning.

### EXAMPLE 16
```powershell
Set-PnPSite -EnableAutoExpirationVersionTrim $false -MajorVersions 100 -MinorVersions 5 -ExpireVersionsAfterDays 0 -ApplyForExistingLibs
```

Create a request to set the file version trim mode as NoExpiration for existing document libraries that enabled versioning.

### EXAMPLE 17
```powershell
Set-PnPSite -CancelVPForExistingLibs
```

Cancel the existing request which sets the file version trim mode for existing document libraries on a site.
Expand Down Expand Up @@ -682,7 +704,8 @@ Enable or disable AutoExpiration version trim for the document libraries on the
Parameter ExpireVersionsAfterDays is required when EnableAutoExpirationVersionTrim is false. Set it to 0 for NoExpiration, set it to greater or equal to 30 for ExpireAfter.

Parameter MajorVersions is required when EnableAutoExpirationVersionTrim is false.
Parameter MinorVersions is required when EnableAutoExpirationVersionTrim is false and StartApplyVersionPolicySettingToExistingDocLibs is specified. It is used when minor version is enabled on the document libraries.

Parameter MinorVersions is required when EnableAutoExpirationVersionTrim is false and the setting is for document libraries that including existing ones. It is used when minor version is enabled on the document libraries.

```yaml
Type: Boolean
Expand Down Expand Up @@ -724,7 +747,7 @@ Accept wildcard characters: False
```

### -MinorVersions
Work with parameter EnableAutoExpirationVersionTrim and StartApplyVersionPolicySettingToExistingDocLibs. Please see description in EnableAutoExpirationVersionTrim.
Work with parameter EnableAutoExpirationVersionTrim. Please see description in EnableAutoExpirationVersionTrim.

```yaml
Type: UInt32
Expand All @@ -737,7 +760,7 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -InheritTenantVersionPolicySettings
### -InheritTenantVPForNewDocLibs
Clear the file version setting on a site. The new document libraries will use the tenant level setting.

```yaml
Expand All @@ -751,7 +774,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -StartApplyVersionPolicySettingToExistingDocLibs
### -ApplyForNewLibs
Set site version policy for new document libraries. Work with parameters EnableAutoExpirationVersionTrim, ExpireVersionsAfterDays, MajorVersions and MinorVersions.

```yaml
Type: SwitchParameter
Parameter Sets: Set Properties

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

### -ApplyForExistingLibs
Create a request to set the file version trim mode for existing document libraries that enabled versioning. Work with parameters EnableAutoExpirationVersionTrim, ExpireVersionsAfterDays, MajorVersions and MinorVersions.

```yaml
Expand All @@ -765,7 +802,7 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -CancelApplyVersionPolicySettingToExistingDocLibs
### -CancelVPForExistingLibs
Cancel the existing request which sets the file version trim mode for existing document libraries on a site.

```yaml
Expand Down
Loading
Loading