Skip to content

Commit

Permalink
Merge pull request #3818 from PowershellScripts/patch-6
Browse files Browse the repository at this point in the history
Some documentation fixes
  • Loading branch information
KoenZomers authored Mar 24, 2024
2 parents 17a5535 + 80a70af commit cd8ccd3
Show file tree
Hide file tree
Showing 11 changed files with 126 additions and 86 deletions.
6 changes: 3 additions & 3 deletions documentation/Set-PnPTenantCdnPolicy.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ This example sets the ExcludeRestrictedSiteClassifications policy for the select
## PARAMETERS

### -CdnType
The type of cdn to retrieve the policies from
The type of cdn to set the policies for.

```yaml
Type: SPOTenantCdnType
Expand Down Expand Up @@ -75,7 +75,7 @@ Accept wildcard characters: False
```
### -PolicyType
The type of the policy to set
The type of the policy to set.
```yaml
Type: SPOTenantCdnPolicyType
Expand All @@ -90,7 +90,7 @@ Accept wildcard characters: False
```
### -PolicyValue
The value of the policy to set
The value of the policy to set.
```yaml
Type: String
Expand Down
26 changes: 20 additions & 6 deletions documentation/Set-PnPTerm.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ online version: https://pnp.github.io/powershell/cmdlets/Set-PnPTerm.html
# Set-PnPTerm

## SYNOPSIS
Updates a term
Updates a term.

## SYNTAX

Expand All @@ -19,15 +19,15 @@ Updates a term
Set-PnPTerm -Identity <Guid> [-Name <String>] [-Lcid <Int32>] [-Description <String>]
[-CustomProperties <Hashtable>] [-LocalCustomProperties <Hashtable>] [-DeleteAllCustomProperties]
[-DeleteAllLocalCustomProperties] [-Deprecated <bool>] [-AvailableForTagging <bool>] [-TermStore <TaxonomyTermStorePipeBind>]
[-Connection <PnPConnection>]
```

### By Term Name
```
Set-PnPTerm -Identity <String> [-Name <String>] [-Lcid <Int32>] [-Description <String>]
[-CustomProperties <Hashtable>] [-LocalCustomProperties <Hashtable>] [-DeleteAllCustomProperties]
[-DeleteAllLocalCustomProperties] [-Deprecated <bool>] [-AvailableForTagging <bool>] -TermSet <TaxonomyTermSetPipeBind> -TermGroup <TaxonomyTermGroupPipeBind>
[-TermStore <TaxonomyTermStorePipeBind>]
[-TermStore <TaxonomyTermStorePipeBind>] [-Connection <PnPConnection>]
```

## DESCRIPTION
Expand Down Expand Up @@ -80,6 +80,20 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Connection
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
```yaml
Type: PnPConnection
Parameter Sets: (All)

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -CustomProperties
Sets custom properties.
Expand All @@ -96,7 +110,7 @@ Accept wildcard characters: False
```
### -DeleteAllCustomProperties
Removes all custom properties
Removes all custom properties.
```yaml
Type: SwitchParameter
Expand All @@ -111,7 +125,7 @@ Accept wildcard characters: False
```
### -DeleteAllLocalCustomProperties
Removes all local custom properties
Removes all local custom properties.
```yaml
Type: SwitchParameter
Expand Down Expand Up @@ -185,7 +199,7 @@ Accept wildcard characters: False
```
### -LocalCustomProperties
Sets local custom properties
Sets local custom properties.
```yaml
Type: Hashtable
Expand Down
22 changes: 17 additions & 5 deletions documentation/Set-PnPTermSet.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Set-PnPTermSet -Identity <TaxonomyTermSetPipeBind> [-TermGroup] <TaxonomyTermGro
[-StakeholderToDelete <String>] [-IsAvailableForTagging <Boolean>] [-IsOpenForTermCreation <Boolean>]
[-UseForSiteNavigation <Boolean>] [-UseForFacetedNavigation <Boolean>] [-SetTargetPageForTerms <String>]
[-RemoveTargetPageForTerms] [-SetCatalogItemPageForCategories <String>] [-RemoveCatalogItemPageForCategories]
[-Connection <PnPConnection>]
```

## DESCRIPTION
Expand All @@ -33,27 +33,39 @@ This cmdlet allows you to update an existing term set.
Set-PnPTermSet -Identity "Departments" -TermGroup "Corporate" -Name "Business Units"
```

This example changes the name of a the "Departments" term set to "Business Units"
This example changes the name of a the "Departments" term set to "Business Units".

### Example 2
```powershell
Set-PnPTermSet -Identity "Departments" -TermGroup "Corporate" -UseForSiteNavigation $true
```

This example allows the terms in the term set "Departments" to be used for site navigation links
This example allows the terms in the term set "Departments" to be used for site navigation links.

### Example 3
```powershell
Set-PnPTermSet -Identity "Departments" -TermGroup "Corporate" -IsAvailableForTagging $false
```

This example makes the terms in the term set "Departments" unavailable to end users and content editors
This example makes the terms in the term set "Departments" unavailable to end users and content editors.

## PARAMETERS

### -Connection
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

```yaml
Type: PnPConnection
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Contact
The contact information
The contact information.
```yaml
Type: String
Expand Down
10 changes: 5 additions & 5 deletions documentation/Set-PnPTheme.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Set-PnPTheme [-ColorPaletteUrl <String>] [-FontSchemeUrl <String>] [-BackgroundI
```

## DESCRIPTION
Sets the theme of the current web, if any of the attributes is not set, that value will be set to null
Sets the theme of the current web. If any of the attributes is not set, that value will be set to null.

## EXAMPLES

Expand Down Expand Up @@ -52,7 +52,7 @@ Sets the theme to the web, and updates all subwebs to inherit the theme from thi
## PARAMETERS

### -BackgroundImageUrl
Specifies the Background Image Url based on the site or server relative url
Specifies the Background Image Url based on the site or server relative url.

```yaml
Type: String
Expand All @@ -66,7 +66,7 @@ Accept wildcard characters: False
```
### -ColorPaletteUrl
Specifies the Color Palette Url based on the site or server relative url
Specifies the Color Palette Url based on the site or server relative url.
```yaml
Type: String
Expand Down Expand Up @@ -94,7 +94,7 @@ Accept wildcard characters: False
```
### -FontSchemeUrl
Specifies the Font Scheme Url based on the site or server relative url
Specifies the Font Scheme Url based on the site or server relative url.
```yaml
Type: String
Expand All @@ -108,7 +108,7 @@ Accept wildcard characters: False
```
### -ResetSubwebsToInherit
Resets subwebs to inherit the theme from the rootweb
Resets subwebs to inherit the theme from the rootweb.
```yaml
Type: SwitchParameter
Expand Down
10 changes: 5 additions & 5 deletions documentation/Set-PnPUserOneDriveQuota.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ online version: https://pnp.github.io/powershell/cmdlets/Set-PnPUserOneDriveQuot

* SharePoint: Access to the SharePoint Tenant Administration site

Sets the quota on the OneDrive for Business site for a specific user
Sets the quota on the OneDrive for Business site for a specific user.

## SYNTAX

Expand All @@ -25,7 +25,7 @@ Set-PnPUserOneDriveQuota [-Account] <String> [-Quota] <Int64> [-QuotaWarning] <I
```

## DESCRIPTION
This command allows you to set the quota on the OneDrive for Business site of a specific user. You must connect to the tenant admin website (https://:<tenant>-admin.sharepoint.com) with Connect-PnPOnline in order to use this cmdlet.
This command allows you to set the quota on the OneDrive for Business site of a specific user. You must connect to the tenant admin website (https://\<tenant\>-admin.sharepoint.com) with Connect-PnPOnline in order to use this cmdlet.

## EXAMPLES

Expand All @@ -34,7 +34,7 @@ This command allows you to set the quota on the OneDrive for Business site of a
Set-PnPUserOneDriveQuota -Account '[email protected]' -Quota 5368709120 -QuotaWarning 4831838208
```

Sets the quota on the OneDrive for Business site for the specified user to 5GB (5368709120 bytes) and sets a warning to be shown at 4.5 GB (4831838208)
Sets the quota on the OneDrive for Business site for the specified user to 5GB (5368709120 bytes) and sets a warning to be shown at 4.5 GB (4831838208).

## PARAMETERS

Expand Down Expand Up @@ -67,7 +67,7 @@ Accept wildcard characters: False
```
### -Quota
The quota to set on the OneDrive for Business site of the user, in bytes
The quota to set on the OneDrive for Business site of the user, in bytes.
```yaml
Type: Int64
Expand All @@ -81,7 +81,7 @@ Accept wildcard characters: False
```
### -QuotaWarning
The quota to set on the OneDrive for Business site of the user when to start showing warnings about the drive nearing being full, in bytes
The quota to set on the OneDrive for Business site of the user when to start showing warnings about the drive nearing being full, in bytes.
```yaml
Type: Int64
Expand Down
14 changes: 7 additions & 7 deletions documentation/Set-PnPUserProfileProperty.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,23 +32,23 @@ Set-PnPUserProfileProperty -Account <String> -PropertyName <String> -Values <Str
```

## DESCRIPTION
Requires a connection to a SharePoint Tenant Admin site.
Updates the value of a specific user profile property for a single user profile in the SharePoint Online environment. Requires a connection to the SharePoint Tenant Admin site.

## EXAMPLES

### EXAMPLE 1
```powershell
Set-PnPUserProfileProperty -Account 'user@domain.com' -Property 'SPS-Location' -Value 'Stockholm'
Set-PnPUserProfileProperty -Account 'john@domain.com' -Property 'SPS-Location' -Value 'Stockholm'
```

Sets the SPS-Location property for the user as specified by the Account parameter
Sets the SPS-Location property to 'Stockholm' for the user [email protected].

### EXAMPLE 2
```powershell
Set-PnPUserProfileProperty -Account 'user@domain.com' -Property 'MyProperty' -Values 'Value 1','Value 2'
Set-PnPUserProfileProperty -Account 'john@domain.com' -Property 'MyProperty' -Values 'Value 1','Value 2'
```

Sets the MyProperty multi value property for the user as specified by the Account parameter
Sets the MyProperty multi value property for the user [email protected].

## PARAMETERS

Expand Down Expand Up @@ -81,7 +81,7 @@ Accept wildcard characters: False
```
### -PropertyName
The property to set, for instance SPS-Skills or SPS-Location
The property to set, for instance SPS-Skills or SPS-Location.
```yaml
Type: String
Expand All @@ -95,7 +95,7 @@ Accept wildcard characters: False
```
### -Value
The value to set in the case of a single value property
The value to set in the case of a single value property.
```yaml
Type: String
Expand Down
18 changes: 9 additions & 9 deletions documentation/Set-PnPView.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ online version: https://pnp.github.io/powershell/cmdlets/Set-PnPView.html
# Set-PnPView

## SYNOPSIS
Change view properties
Change view properties.

## SYNTAX

Expand All @@ -29,28 +29,28 @@ Sets one or more properties of an existing view, see here https://learn.microsof
Set-PnPView -List "Tasks" -Identity "All Tasks" -Values @{JSLink="hierarchytaskslist.js|customrendering.js";Title="My view"}
```

Updates the "All Tasks" view on list "Tasks" to use hierarchytaskslist.js and customrendering.js for the JSLink and changes the title of the view to "My view"
Updates the "All Tasks" view on list "Tasks" to use hierarchytaskslist.js and customrendering.js for the JSLink and changes the title of the view to "My view".

### EXAMPLE 2
```powershell
Get-PnPList -Identity "Tasks" | Get-PnPView | Set-PnPView -Values @{JSLink="hierarchytaskslist.js|customrendering.js"}
```

Updates all views on list "Tasks" to use hierarchytaskslist.js and customrendering.js for the JSLink
Updates all views on list "Tasks" to use hierarchytaskslist.js and customrendering.js for the JSLink.

### EXAMPLE 3
```powershell
Set-PnPView -List "Documents" -Identity "Corporate Documents" -Fields "Title","Created"
```

Updates the Corporate Documents view on the Documents library to have two fields
Updates the Corporate Documents view on the Documents library to have two fields.

### EXAMPLE 4
```powershell
Set-PnPView -List "Documents" -Identity "Corporate Documents" -Fields "Title","Created" -Aggregations "<FieldRef Name='Title' Type='COUNT'/>"
```

Updates the Corporate Documents view on the Documents library and sets the totals (aggregations) to Count on the Title field
Updates the Corporate Documents view on the Documents library and sets the totals (aggregations) to Count on the Title field.


### EXAMPLE 5
Expand All @@ -63,7 +63,7 @@ Updates the Dept Documents view on the Documents library to show items paged in
## PARAMETERS

### -Aggregations
A valid XML fragment containing one or more Aggregations
A valid XML fragment containing one or more Aggregations.

```yaml
Type: String
Expand Down Expand Up @@ -91,7 +91,7 @@ Accept wildcard characters: False
```
### -Fields
An array of fields to use in the view. Notice that specifying this value will remove the existing fields
An array of fields to use in the view. Notice that specifying this value will remove the existing fields.
```yaml
Type: String[]
Expand All @@ -105,7 +105,7 @@ Accept wildcard characters: False
```
### -Identity
The Id, Title or instance of the view
The Id, Title or instance of the view.
```yaml
Type: ViewPipeBind
Expand All @@ -119,7 +119,7 @@ Accept wildcard characters: False
```
### -List
The Id, Title or Url of the list
The Id, Title or Url of the list.
```yaml
Type: ListPipeBind
Expand Down
Loading

0 comments on commit cd8ccd3

Please sign in to comment.