Skip to content

Commit

Permalink
Commit from GitHub Actions (Build Documentation Site)
Browse files Browse the repository at this point in the history
  • Loading branch information
@erwinvanhunen
erwinvanhunen committed Mar 25, 2024
1 parent c7f827a commit 81649e5
Show file tree
Hide file tree
Showing 12 changed files with 129 additions and 95 deletions.
6 changes: 3 additions & 3 deletions cmdlets/Set-PnPTenantCdnPolicy.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ <h3 id="example-2">EXAMPLE 2</h3>
<p>This example sets the ExcludeRestrictedSiteClassifications policy for the selected CdnType to a policy value of listed excluded site classifications.</p>
<h2 id="parameters">PARAMETERS</h2>
<h3 id="-cdntype">-CdnType</h3>
<p>The type of cdn to retrieve the policies from</p>
<p>The type of cdn to set the policies for.</p>
<pre><code class="lang-yaml">Type: SPOTenantCdnType
Parameter Sets: (All)
Accepted values: Public, Private
Expand All @@ -129,7 +129,7 @@ <h3 id="-connection">-Connection</h3>
Accept wildcard characters: False
</code></pre>
<h3 id="-policytype">-PolicyType</h3>
<p>The type of the policy to set</p>
<p>The type of the policy to set.</p>
<pre><code class="lang-yaml">Type: SPOTenantCdnPolicyType
Parameter Sets: (All)
Accepted values: IncludeFileExtensions, ExcludeRestrictedSiteClassifications, ExcludeIfNoScriptDisabled
Expand All @@ -141,7 +141,7 @@ <h3 id="-policytype">-PolicyType</h3>
Accept wildcard characters: False
</code></pre>
<h3 id="-policyvalue">-PolicyValue</h3>
<p>The value of the policy to set</p>
<p>The value of the policy to set.</p>
<pre><code class="lang-yaml">Type: String
Parameter Sets: (All)

Expand Down
23 changes: 17 additions & 6 deletions cmdlets/Set-PnPTerm.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,19 +84,19 @@
<h1 id="set-pnpterm">Set-PnPTerm</h1>

<h2 id="synopsis">SYNOPSIS</h2>
<p>Updates a term</p>
<p>Updates a term.</p>
<h2 id="syntax">SYNTAX</h2>
<h3 id="by-term-id">By Term Id</h3>
<pre><code>Set-PnPTerm -Identity &lt;Guid&gt; [-Name &lt;String&gt;] [-Lcid &lt;Int32&gt;] [-Description &lt;String&gt;]
[-CustomProperties &lt;Hashtable&gt;] [-LocalCustomProperties &lt;Hashtable&gt;] [-DeleteAllCustomProperties]
[-DeleteAllLocalCustomProperties] [-Deprecated &lt;bool&gt;] [-AvailableForTagging &lt;bool&gt;] [-TermStore &lt;TaxonomyTermStorePipeBind&gt;]

[-Connection &lt;PnPConnection&gt;]
</code></pre>
<h3 id="by-term-name">By Term Name</h3>
<pre><code>Set-PnPTerm -Identity &lt;String&gt; [-Name &lt;String&gt;] [-Lcid &lt;Int32&gt;] [-Description &lt;String&gt;]
[-CustomProperties &lt;Hashtable&gt;] [-LocalCustomProperties &lt;Hashtable&gt;] [-DeleteAllCustomProperties]
[-DeleteAllLocalCustomProperties] [-Deprecated &lt;bool&gt;] [-AvailableForTagging &lt;bool&gt;] -TermSet &lt;TaxonomyTermSetPipeBind&gt; -TermGroup &lt;TaxonomyTermGroupPipeBind&gt;
[-TermStore &lt;TaxonomyTermStorePipeBind&gt;]
[-TermStore &lt;TaxonomyTermStorePipeBind&gt;] [-Connection &lt;PnPConnection&gt;]
</code></pre>
<h2 id="description">DESCRIPTION</h2>
<p>This cmdlet allows you to update an existing term.</p>
Expand Down Expand Up @@ -124,6 +124,17 @@ <h3 id="-availablefortagging">-AvailableForTagging</h3>
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
</code></pre>
<h3 id="-connection">-Connection</h3>
<p>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.</p>
<pre><code class="lang-yaml">Type: PnPConnection
Parameter Sets: (All)

Required: False
Position: Named
Default value: None
Expand All @@ -143,7 +154,7 @@ <h3 id="-customproperties">-CustomProperties</h3>
Accept wildcard characters: False
</code></pre>
<h3 id="-deleteallcustomproperties">-DeleteAllCustomProperties</h3>
<p>Removes all custom properties</p>
<p>Removes all custom properties.</p>
<pre><code class="lang-yaml">Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Expand All @@ -155,7 +166,7 @@ <h3 id="-deleteallcustomproperties">-DeleteAllCustomProperties</h3>
Accept wildcard characters: False
</code></pre>
<h3 id="-deletealllocalcustomproperties">-DeleteAllLocalCustomProperties</h3>
<p>Removes all local custom properties</p>
<p>Removes all local custom properties.</p>
<pre><code class="lang-yaml">Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Expand Down Expand Up @@ -215,7 +226,7 @@ <h3 id="-lcid">-Lcid</h3>
Accept wildcard characters: False
</code></pre>
<h3 id="-localcustomproperties">-LocalCustomProperties</h3>
<p>Sets local custom properties</p>
<p>Sets local custom properties.</p>
<pre><code class="lang-yaml">Type: Hashtable
Parameter Sets: (All)
Aliases:
Expand Down
20 changes: 15 additions & 5 deletions cmdlets/Set-PnPTermSet.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,26 +92,36 @@ <h2 id="syntax">SYNTAX</h2>
[-StakeholderToDelete &lt;String&gt;] [-IsAvailableForTagging &lt;Boolean&gt;] [-IsOpenForTermCreation &lt;Boolean&gt;]
[-UseForSiteNavigation &lt;Boolean&gt;] [-UseForFacetedNavigation &lt;Boolean&gt;] [-SetTargetPageForTerms &lt;String&gt;]
[-RemoveTargetPageForTerms] [-SetCatalogItemPageForCategories &lt;String&gt;] [-RemoveCatalogItemPageForCategories]

[-Connection &lt;PnPConnection&gt;]
</code></pre>
<h2 id="description">DESCRIPTION</h2>
<p>This cmdlet allows you to update an existing term set.</p>
<h2 id="examples">EXAMPLES</h2>
<h3 id="example-1">Example 1</h3>
<pre><code class="lang-powershell">Set-PnPTermSet -Identity &quot;Departments&quot; -TermGroup &quot;Corporate&quot; -Name &quot;Business Units&quot;
</code></pre>
<p>This example changes the name of a the &quot;Departments&quot; term set to &quot;Business Units&quot;</p>
<p>This example changes the name of a the &quot;Departments&quot; term set to &quot;Business Units&quot;.</p>
<h3 id="example-2">Example 2</h3>
<pre><code class="lang-powershell">Set-PnPTermSet -Identity &quot;Departments&quot; -TermGroup &quot;Corporate&quot; -UseForSiteNavigation $true
</code></pre>
<p>This example allows the terms in the term set &quot;Departments&quot; to be used for site navigation links</p>
<p>This example allows the terms in the term set &quot;Departments&quot; to be used for site navigation links.</p>
<h3 id="example-3">Example 3</h3>
<pre><code class="lang-powershell">Set-PnPTermSet -Identity &quot;Departments&quot; -TermGroup &quot;Corporate&quot; -IsAvailableForTagging $false
</code></pre>
<p>This example makes the terms in the term set &quot;Departments&quot; unavailable to end users and content editors</p>
<p>This example makes the terms in the term set &quot;Departments&quot; unavailable to end users and content editors.</p>
<h2 id="parameters">PARAMETERS</h2>
<h3 id="-connection">-Connection</h3>
<p>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.</p>
<pre><code class="lang-yaml">Type: PnPConnection
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
</code></pre>
<h3 id="-contact">-Contact</h3>
<p>The contact information</p>
<p>The contact information.</p>
<pre><code class="lang-yaml">Type: String
Parameter Sets: (All)
Aliases:
Expand Down
10 changes: 5 additions & 5 deletions cmdlets/Set-PnPTheme.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ <h2 id="syntax">SYNTAX</h2>

</code></pre>
<h2 id="description">DESCRIPTION</h2>
<p>Sets the theme of the current web, if any of the attributes is not set, that value will be set to null</p>
<p>Sets the theme of the current web. If any of the attributes is not set, that value will be set to null.</p>
<h2 id="examples">EXAMPLES</h2>
<h3 id="example-1">EXAMPLE 1</h3>
<pre><code class="lang-powershell">Set-PnPTheme
Expand All @@ -109,7 +109,7 @@ <h3 id="example-4">EXAMPLE 4</h3>
<p>Sets the theme to the web, and updates all subwebs to inherit the theme from this web.</p>
<h2 id="parameters">PARAMETERS</h2>
<h3 id="-backgroundimageurl">-BackgroundImageUrl</h3>
<p>Specifies the Background Image Url based on the site or server relative url</p>
<p>Specifies the Background Image Url based on the site or server relative url.</p>
<pre><code class="lang-yaml">Type: String
Parameter Sets: (All)

Expand All @@ -120,7 +120,7 @@ <h3 id="-backgroundimageurl">-BackgroundImageUrl</h3>
Accept wildcard characters: False
</code></pre>
<h3 id="-colorpaletteurl">-ColorPaletteUrl</h3>
<p>Specifies the Color Palette Url based on the site or server relative url</p>
<p>Specifies the Color Palette Url based on the site or server relative url.</p>
<pre><code class="lang-yaml">Type: String
Parameter Sets: (All)

Expand All @@ -142,7 +142,7 @@ <h3 id="-connection">-Connection</h3>
Accept wildcard characters: False
</code></pre>
<h3 id="-fontschemeurl">-FontSchemeUrl</h3>
<p>Specifies the Font Scheme Url based on the site or server relative url</p>
<p>Specifies the Font Scheme Url based on the site or server relative url.</p>
<pre><code class="lang-yaml">Type: String
Parameter Sets: (All)

Expand All @@ -153,7 +153,7 @@ <h3 id="-fontschemeurl">-FontSchemeUrl</h3>
Accept wildcard characters: False
</code></pre>
<h3 id="-resetsubwebstoinherit">-ResetSubwebsToInherit</h3>
<p>Resets subwebs to inherit the theme from the rootweb</p>
<p>Resets subwebs to inherit the theme from the rootweb.</p>
<pre><code class="lang-yaml">Type: SwitchParameter
Parameter Sets: (All)

Expand Down
10 changes: 5 additions & 5 deletions cmdlets/Set-PnPUserOneDriveQuota.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,18 +88,18 @@ <h2 id="synopsis">SYNOPSIS</h2>
<ul>
<li>SharePoint: Access to the SharePoint Tenant Administration site</li>
</ul>
<p>Sets the quota on the OneDrive for Business site for a specific user</p>
<p>Sets the quota on the OneDrive for Business site for a specific user.</p>
<h2 id="syntax">SYNTAX</h2>
<pre><code class="lang-powershell">Set-PnPUserOneDriveQuota [-Account] &lt;String&gt; [-Quota] &lt;Int64&gt; [-QuotaWarning] &lt;Int64&gt;
[-Connection &lt;PnPConnection&gt;]
</code></pre>
<h2 id="description">DESCRIPTION</h2>
<p>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.</tenant></p>
<p>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://&lt;tenant&gt;-admin.sharepoint.com) with Connect-PnPOnline in order to use this cmdlet.</p>
<h2 id="examples">EXAMPLES</h2>
<h3 id="example-1">EXAMPLE 1</h3>
<pre><code class="lang-powershell">Set-PnPUserOneDriveQuota -Account '[email protected]' -Quota 5368709120 -QuotaWarning 4831838208
</code></pre>
<p>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)</p>
<p>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).</p>
<h2 id="parameters">PARAMETERS</h2>
<h3 id="-account">-Account</h3>
<p>The account of the user, formatted either as a login name, or as a claims identity, e.g. i:0#.f|membership|[email protected]</p>
Expand All @@ -124,7 +124,7 @@ <h3 id="-connection">-Connection</h3>
Accept wildcard characters: False
</code></pre>
<h3 id="-quota">-Quota</h3>
<p>The quota to set on the OneDrive for Business site of the user, in bytes</p>
<p>The quota to set on the OneDrive for Business site of the user, in bytes.</p>
<pre><code class="lang-yaml">Type: Int64
Parameter Sets: (All)

Expand All @@ -135,7 +135,7 @@ <h3 id="-quota">-Quota</h3>
Accept wildcard characters: False
</code></pre>
<h3 id="-quotawarning">-QuotaWarning</h3>
<p>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</p>
<p>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.</p>
<pre><code class="lang-yaml">Type: Int64
Parameter Sets: (All)

Expand Down
14 changes: 7 additions & 7 deletions cmdlets/Set-PnPUserProfileProperty.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,16 +99,16 @@ <h3 id="multi">Multi</h3>
[-Connection &lt;PnPConnection&gt;]
</code></pre>
<h2 id="description">DESCRIPTION</h2>
<p>Requires a connection to a SharePoint Tenant Admin site.</p>
<p>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.</p>
<h2 id="examples">EXAMPLES</h2>
<h3 id="example-1">EXAMPLE 1</h3>
<pre><code class="lang-powershell">Set-PnPUserProfileProperty -Account 'user@domain.com' -Property 'SPS-Location' -Value 'Stockholm'
<pre><code class="lang-powershell">Set-PnPUserProfileProperty -Account 'john@domain.com' -Property 'SPS-Location' -Value 'Stockholm'
</code></pre>
<p>Sets the SPS-Location property for the user as specified by the Account parameter</p>
<p>Sets the SPS-Location property to 'Stockholm' for the user [email protected].</p>
<h3 id="example-2">EXAMPLE 2</h3>
<pre><code class="lang-powershell">Set-PnPUserProfileProperty -Account 'user@domain.com' -Property 'MyProperty' -Values 'Value 1','Value 2'
<pre><code class="lang-powershell">Set-PnPUserProfileProperty -Account 'john@domain.com' -Property 'MyProperty' -Values 'Value 1','Value 2'
</code></pre>
<p>Sets the MyProperty multi value property for the user as specified by the Account parameter</p>
<p>Sets the MyProperty multi value property for the user [email protected].</p>
<h2 id="parameters">PARAMETERS</h2>
<h3 id="-account">-Account</h3>
<p>The account of the user, formatted either as a login name, or as a claims identity, e.g. i:0#.f|membership|[email protected]</p>
Expand All @@ -133,7 +133,7 @@ <h3 id="-connection">-Connection</h3>
Accept wildcard characters: False
</code></pre>
<h3 id="-propertyname">-PropertyName</h3>
<p>The property to set, for instance SPS-Skills or SPS-Location</p>
<p>The property to set, for instance SPS-Skills or SPS-Location.</p>
<pre><code class="lang-yaml">Type: String
Parameter Sets: (All)

Expand All @@ -144,7 +144,7 @@ <h3 id="-propertyname">-PropertyName</h3>
Accept wildcard characters: False
</code></pre>
<h3 id="-value">-Value</h3>
<p>The value to set in the case of a single value property</p>
<p>The value to set in the case of a single value property.</p>
<pre><code class="lang-yaml">Type: String
Parameter Sets: Single

Expand Down
18 changes: 9 additions & 9 deletions cmdlets/Set-PnPView.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@
<h1 id="set-pnpview">Set-PnPView</h1>

<h2 id="synopsis">SYNOPSIS</h2>
<p>Change view properties</p>
<p>Change view properties.</p>
<h2 id="syntax">SYNTAX</h2>
<pre><code class="lang-powershell">Set-PnPView [[-List] &lt;ListPipeBind&gt;] -Identity &lt;ViewPipeBind&gt; [-Values &lt;Hashtable&gt;] [-Fields &lt;String[]&gt;]
[-Aggregations &lt;String&gt;] [-Connection &lt;PnPConnection&gt;]
Expand All @@ -95,26 +95,26 @@ <h2 id="examples">EXAMPLES</h2>
<h3 id="example-1">EXAMPLE 1</h3>
<pre><code class="lang-powershell">Set-PnPView -List &quot;Tasks&quot; -Identity &quot;All Tasks&quot; -Values @{JSLink=&quot;hierarchytaskslist.js|customrendering.js&quot;;Title=&quot;My view&quot;}
</code></pre>
<p>Updates the &quot;All Tasks&quot; view on list &quot;Tasks&quot; to use hierarchytaskslist.js and customrendering.js for the JSLink and changes the title of the view to &quot;My view&quot;</p>
<p>Updates the &quot;All Tasks&quot; view on list &quot;Tasks&quot; to use hierarchytaskslist.js and customrendering.js for the JSLink and changes the title of the view to &quot;My view&quot;.</p>
<h3 id="example-2">EXAMPLE 2</h3>
<pre><code class="lang-powershell">Get-PnPList -Identity &quot;Tasks&quot; | Get-PnPView | Set-PnPView -Values @{JSLink=&quot;hierarchytaskslist.js|customrendering.js&quot;}
</code></pre>
<p>Updates all views on list &quot;Tasks&quot; to use hierarchytaskslist.js and customrendering.js for the JSLink</p>
<p>Updates all views on list &quot;Tasks&quot; to use hierarchytaskslist.js and customrendering.js for the JSLink.</p>
<h3 id="example-3">EXAMPLE 3</h3>
<pre><code class="lang-powershell">Set-PnPView -List &quot;Documents&quot; -Identity &quot;Corporate Documents&quot; -Fields &quot;Title&quot;,&quot;Created&quot;
</code></pre>
<p>Updates the Corporate Documents view on the Documents library to have two fields</p>
<p>Updates the Corporate Documents view on the Documents library to have two fields.</p>
<h3 id="example-4">EXAMPLE 4</h3>
<pre><code class="lang-powershell">Set-PnPView -List &quot;Documents&quot; -Identity &quot;Corporate Documents&quot; -Fields &quot;Title&quot;,&quot;Created&quot; -Aggregations &quot;&lt;FieldRef Name='Title' Type='COUNT'/&gt;&quot;
</code></pre>
<p>Updates the Corporate Documents view on the Documents library and sets the totals (aggregations) to Count on the Title field</p>
<p>Updates the Corporate Documents view on the Documents library and sets the totals (aggregations) to Count on the Title field.</p>
<h3 id="example-5">EXAMPLE 5</h3>
<pre><code class="lang-powershell">Set-PnPView -List &quot;Documents&quot; -Identity &quot;Dept Documents&quot; -Fields &quot;Title,&quot;Created&quot; -Values @{Paged=$true;RowLimit=[UInt32]&quot;100&quot;}
</code></pre>
<p>Updates the Dept Documents view on the Documents library to show items paged in batches of 100, note the type casting on the value to prevent warnings.</p>
<h2 id="parameters">PARAMETERS</h2>
<h3 id="-aggregations">-Aggregations</h3>
<p>A valid XML fragment containing one or more Aggregations</p>
<p>A valid XML fragment containing one or more Aggregations.</p>
<pre><code class="lang-yaml">Type: String
Parameter Sets: (All)

Expand All @@ -136,7 +136,7 @@ <h3 id="-connection">-Connection</h3>
Accept wildcard characters: False
</code></pre>
<h3 id="-fields">-Fields</h3>
<p>An array of fields to use in the view. Notice that specifying this value will remove the existing fields</p>
<p>An array of fields to use in the view. Notice that specifying this value will remove the existing fields.</p>
<pre><code class="lang-yaml">Type: String[]
Parameter Sets: (All)

Expand All @@ -147,7 +147,7 @@ <h3 id="-fields">-Fields</h3>
Accept wildcard characters: False
</code></pre>
<h3 id="-identity">-Identity</h3>
<p>The Id, Title or instance of the view</p>
<p>The Id, Title or instance of the view.</p>
<pre><code class="lang-yaml">Type: ViewPipeBind
Parameter Sets: (All)

Expand All @@ -158,7 +158,7 @@ <h3 id="-identity">-Identity</h3>
Accept wildcard characters: False
</code></pre>
<h3 id="-list">-List</h3>
<p>The Id, Title or Url of the list</p>
<p>The Id, Title or Url of the list.</p>
<pre><code class="lang-yaml">Type: ListPipeBind
Parameter Sets: (All)

Expand Down
Loading

0 comments on commit 81649e5

Please sign in to comment.