Commit from GitHub Actions (Build Documentation Site)

pnp · Jan 24, 2024 · c0233aa · c0233aa
1 parent 66f8320
commit c0233aa
Show file tree

Hide file tree

Showing 5 changed files with 186 additions and 2 deletions.
diff --git a/cmdlets/Get-PnPWebPermission.html b/cmdlets/Get-PnPWebPermission.html
@@ -0,0 +1,165 @@
+<!DOCTYPE html>
+<!--[if IE]><![endif]-->
+<html lang="en">
+
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+    <title>Get-PnPWebPermission | PnP PowerShell </title>
+    <meta name="viewport" content="width=device-width">
+    <meta name="title" content="Get-PnPWebPermission | PnP PowerShell ">
+    <meta name="generator" content="docfx ">
+  <meta name="description" content="PnP PowerShell is an open source, community driven, PowerShell Module designed to work with Microsoft 365.">
+    <link rel="shortcut icon" href="https://c.s-microsoft.com/favicon.ico?v2">
+    <link rel="stylesheet" href="../styles/docfx.vendor.css">
+    <link rel="stylesheet" href="../styles/docfx.css">
+    <link rel="stylesheet" href="../styles/main.css">
+    <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet"> 
+    <meta property="docfx:navrel" content="../toc.html">
+    <meta property="docfx:tocrel" content="toc.html">
+
+  <meta property="docfx:rel" content="../">
+  <meta property="docfx:newtab" content="true">
+  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">
+    <div id="wrapper">
+      <header>
+
+        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
+          <div class="container">
+            <div class="navbar-header">
+              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
+                <span class="sr-only">Toggle navigation</span>
+                <span class="icon-bar"></span>
+                <span class="icon-bar"></span>
+                <span class="icon-bar"></span>
+              </button>
+
+              <a class="navbar-brand" href="../index.html">
+                <img id="logo" class="svg" src="../images/logo.svg" alt="">
+              </a>
+            </div>
+            <div class="collapse navbar-collapse" id="navbar">
+              <form class="navbar-form navbar-right" role="search" id="search">
+                <div class="form-group">
+                  <label class="glyphicon glyphicon-search" for="search-query"></label>
+                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
+                </div>
+              </form>
+            </div>
+          </div>
+        </nav>
+        <div class="subnav navbar navbar-default">
+          <div class="container hide-when-search" id="breadcrumb">
+            <ul class="breadcrumb">
+              <li></li>
+            </ul>
+          </div>
+        </div>
+      </header>
+      <div class="container body-content">
+
+        <div id="search-results">
+          <div class="search-list">Search Results for <span></span></div>
+          <div class="sr-items">
+            <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
+          </div>
+          <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
+        </div>
+      </div>
+      <div role="main" class="container body-content hide-when-search">
+
+        <div class="sidenav hide-when-search">
+          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
+          <div class="sidetoggle collapse" id="sidetoggle">
+            <div id="sidetoc"></div>
+          </div>
+        </div>
+        <div class="article row grid-right">
+          <div class="col-md-10">
+            <article class="content wrap" id="_content" data-uid="">
+                <div class="pnp_tags">Available in the current Nightly Release only.</div>
+                  <div class="contribution-panel mobile-hide pull-right">
+                      <a href="https://github.com/pnp/powershell/blob/dev/documentation/#L1" title="Edit this page" class="improve-doc-lg"><i class="glyphicon glyphicon-pencil"></i></a>
+                  </div>
+  <h1 id="get-pnpwebpermission">Get-PnPWebPermission</h1>
+
+<h2 id="synopsis">SYNOPSIS</h2>
+<p>Returns the explicit permissions for a specific SharePoint Web given a user or group by id.</p>
+<h2 id="syntax">SYNTAX</h2>
+<pre><code class="lang-powershell">Get-PnPWebPermission [-Identity] &lt;WebPipeBind&gt; -PrincipalId &lt;Int32&gt;
+</code></pre>
+<h2 id="description">DESCRIPTION</h2>
+<p>This cmdlet retrieves the web permissions (role definitions) for a specific user or group in a provided web.</p>
+<h2 id="examples">EXAMPLES</h2>
+<h3 id="example-1">EXAMPLE 1</h3>
+<pre><code class="lang-powershell">Get-PnPWebPermission -Identity (Get-PnPWeb) -PrincipalId 60
+</code></pre>
+<p>Returns the permissions for the SharePoint group with id for the current Web.</p>
+<h3 id="example-2">EXAMPLE 2</h3>
+<pre><code class="lang-powershell">Get-PnPWebPermission -Identity &quot;subsite&quot; -PrincipalId (Get-PnPGroup -Identity DemoGroup).Id
+</code></pre>
+<p>Returns the permissions for the SharePoint group called DemoGroup for a given subsite path.</p>
+<h2 id="parameters">PARAMETERS</h2>
+<h3 id="-identity">-Identity</h3>
+<p>The id, name or server relative url of the Web to retrieve the permissions for.</p>
+<pre><code class="lang-yaml">Type: WebPipeBand
+Parameter Sets: (All)
+Aliases: Name
+
+Required: False
+Position: 0
+Default value: (CurrentWeb)
+Accept pipeline input: True (ByValue)
+Accept wildcard characters: False
+</code></pre>
+<h3 id="-principalid">-PrincipalId</h3>
+<p>The id of a user or a SharePoint group. See Get-PnPUser and Get-PnPGroup.</p>
+<pre><code class="lang-yaml">Type: Int32
+Parameter Sets: (All)
+Aliases: Name
+
+Required: True
+Position: 0
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+</code></pre>
+<h2 id="related-links">RELATED LINKS</h2>
+<p><a href="https://aka.ms/m365pnp">Microsoft 365 Patterns and Practices</a></p>
+
+</article>
+          </div>
+          <div class="hidden-sm col-md-2" role="complementary">
+            <div class="sideaffix">
+              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
+              </nav>
+            </div>
+          </div>        </div>
+      </div>
+
+      <footer>
+        <div class="grad-bottom"></div>
+        <div class="footer">
+          <div class="container">
+            <span class="pull-right">
+              <a href="#top">Back to top</a>
+            </span>
+
+      <span>Generated by <strong>DocFX</strong></span>
+            <img src="https://m365-visitor-stats.azurewebsites.net/@pnp.github.io/index/" alt="spacer">
+          </div>
+        </div>
+      </footer>
+    </div>
+
+    <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
+    <script type="text/javascript" src="../styles/docfx.js"></script>
+    <script type="text/javascript" src="../styles/main.js"></script>
+    <script type="text/javascript">
+        (function(c,l,a,r,i,t,y){
+            c[a]=c[a]||function(){(c[a].q=c[a].q||[]).push(arguments)};
+            t=l.createElement(r);t.async=1;t.src="https://www.clarity.ms/tag/"+i;
+            y=l.getElementsByTagName(r)[0];y.parentNode.insertBefore(t,y);
+        })(window, document, "clarity", "script", "ag6usxufyq");
+    </script>  </body>
+</html>
diff --git a/cmdlets/index.html b/cmdlets/index.html
@@ -83,7 +83,7 @@
                   </div>
   <h1 id="pnp-powershell-cmdlets">PnP PowerShell cmdlets</h1>
 
-<p>PnP PowerShell exists out of 692 cmdlets which can help you in setting up, configuring, maintaining and using various Microsoft 365 products from one single connection. Each of the cmdlets is documented to aid in learning how to use it. Find the available cmdlets below.</p>
+<p>PnP PowerShell exists out of 693 cmdlets which can help you in setting up, configuring, maintaining and using various Microsoft 365 products from one single connection. Each of the cmdlets is documented to aid in learning how to use it. Find the available cmdlets below.</p>
 <p><sup>1</sup>: Only available in the latest nightly build. All the others can also be used using the latest stable release.<br>
 <sup>2</sup>: Cmdlet is an alias of another cmdlet, used to provide backwards compatibility.</p>
 <h2 id="add">Add</h2>
@@ -506,6 +506,7 @@ <h2 id="get">Get</h2>
 <li><a href="Get-PnPWebPart.html">Get-PnPWebPart</a></li>
 <li><a href="Get-PnPWebPartProperty.html">Get-PnPWebPartProperty</a></li>
 <li><a href="Get-PnPWebPartXml.html">Get-PnPWebPartXml</a></li>
+<li><a href="Get-PnPWebPermission.html">Get-PnPWebPermission</a> <sup>1</sup></li>
 <li><a href="Get-PnPWebTemplates.html">Get-PnPWebTemplates</a></li>
 <li><a href="Get-PnPWikiPageContent.html">Get-PnPWikiPageContent</a></li>
 </ul>

diff --git a/cmdlets/toc.html b/cmdlets/toc.html
@@ -1149,6 +1149,9 @@
                 <li>
                     <a href="Get-PnPWebPartXml.html" name="" title="Get-PnPWebPartXml">Get-PnPWebPartXml</a>
                 </li>
+                <li>
+                    <a href="Get-PnPWebPermission.html" name="" title="Get-PnPWebPermission">Get-PnPWebPermission</a>
+                </li>
                 <li>
                     <a href="Get-PnPWebTemplates.html" name="" title="Get-PnPWebTemplates">Get-PnPWebTemplates</a>
                 </li>