@pnp/cli-microsoft365 6.0.0 → 6.1.0-beta.11542c0

package/docs/docs/cmd/spo/roledefinition/roledefinition-get.md

@@ -11,7 +11,7 @@ m365 spo roledefinition get [options]
 ## Options
 
 `-u, --webUrl <webUrl>`
-: URL of the site for which to retrieve the role definition
+: URL of the site for which to retrieve the role definition.
 
 `-i, --id <id>`
 : The Id of the role definition to retrieve.
@@ -20,8 +20,86 @@ m365 spo roledefinition get [options]
 
 ## Examples
 
-Retrieve the role definition for site _https://contoso.sharepoint.com/sites/project-x_ with id _1_
+Retrieve the role definition for the given site
 
 ```sh
 m365 spo roledefinition get --webUrl https://contoso.sharepoint.com/sites/project-x --id 1
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "BasePermissions": {
+        "High": "2147483647",
+        "Low": "4294967295"
+      },
+      "Description": "Has full control.",
+      "Hidden": false,
+      "Id": 1073741829,
+      "Name": "Full Control",
+      "Order": 1,
+      "RoleTypeKind": 5,
+      "BasePermissionsValue": [
+        "ViewListItems",
+        "AddListItems",
+        "EditListItems",
+        "DeleteListItems",
+        "ApproveItems",
+        "OpenItems",
+        "ViewVersions",
+        "DeleteVersions",
+        "CancelCheckout",
+        "ManagePersonalViews",
+        "ManageLists",
+        "ViewFormPages",
+        "AnonymousSearchAccessList",
+        "Open",
+        "ViewPages",
+        "AddAndCustomizePages",
+        "ApplyThemeAndBorder",
+        "ApplyStyleSheets",
+        "ViewUsageData",
+        "CreateSSCSite",
+        "ManageSubwebs",
+        "CreateGroups",
+        "ManagePermissions",
+        "BrowseDirectories",
+        "BrowseUserInfo",
+        "AddDelPrivateWebParts",
+        "UpdatePersonalWebParts",
+        "ManageWeb",
+        "AnonymousSearchAccessWebLists",
+        "UseClientIntegration",
+        "UseRemoteAPIs",
+        "ManageAlerts",
+        "CreateAlerts",
+        "EditMyUserInfo",
+        "EnumeratePermissions"
+      ],
+      "RoleTypeKindValue": "Administrator"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    BasePermissions     : {"High":"2147483647","Low":"4294967295"}
+    BasePermissionsValue: ["ViewListItems","AddListItems","EditListItems","DeleteListItems","ApproveItems","OpenItems","ViewVersions","DeleteVersions","CancelCheckout","ManagePersonalViews","ManageLists","ViewFormPages","AnonymousSearchAccessList","Open","ViewPages","AddAndCustomizePages","ApplyThemeAndBorder","ApplyStyleSheets","ViewUsageData","CreateSSCSite","ManageSubwebs","CreateGroups","ManagePermissions","BrowseDirectories","BrowseUserInfo","AddDelPrivateWebParts","UpdatePersonalWebParts","ManageWeb","AnonymousSearchAccessWebLists","UseClientIntegration","UseRemoteAPIs","ManageAlerts","CreateAlerts","EditMyUserInfo","EnumeratePermissions"]
+    Description         : Has full control.
+    Hidden              : false
+    Id                  : 1073741829
+    Name                : Full Control
+    Order               : 1
+    RoleTypeKind        : 5
+    RoleTypeKindValue   : Administrator
+    ```
+
+=== "CSV"
+
+    ```csv
+    BasePermissions,Description,Hidden,Id,Name,Order,RoleTypeKind,BasePermissionsValue,RoleTypeKindValue
+    "{""High"":""2147483647"",""Low"":""4294967295""}",Has full control.,,1073741829,Full Control,1,5,"[""ViewListItems"",""AddListItems"",""EditListItems"",""DeleteListItems"",""ApproveItems"",""OpenItems"",""ViewVersions"",""DeleteVersions"",""CancelCheckout"",""ManagePersonalViews"",""ManageLists"",""ViewFormPages"",""AnonymousSearchAccessList"",""Open"",""ViewPages"",""AddAndCustomizePages"",""ApplyThemeAndBorder"",""ApplyStyleSheets"",""ViewUsageData"",""CreateSSCSite"",""ManageSubwebs"",""CreateGroups"",""ManagePermissions"",""BrowseDirectories"",""BrowseUserInfo"",""AddDelPrivateWebParts"",""UpdatePersonalWebParts"",""ManageWeb"",""AnonymousSearchAccessWebLists"",""UseClientIntegration"",""UseRemoteAPIs"",""ManageAlerts"",""CreateAlerts"",""EditMyUserInfo"",""EnumeratePermissions""]",Administrator
+    ```

package/docs/docs/cmd/spo/roledefinition/roledefinition-list.md

@@ -11,14 +11,88 @@ m365 spo roledefinition list [options]
 ## Options
 
 `-u, --webUrl <webUrl>`
-: URL of the site for which to retrieve role definitions
+: URL of the site for which to retrieve role definitions.
 
 --8<-- "docs/cmd/_global.md"
 
 ## Examples
 
-Return list of role definitions for site _https://contoso.sharepoint.com/sites/project-x_
+Return list of role definitions for the given site
 
 ```sh
 m365 spo roledefinition list --webUrl https://contoso.sharepoint.com/sites/project-x
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "BasePermissions": {
+          "High": 2147483647,
+          "Low": 4294967295
+        },
+        "Description": "Has full control.",
+        "Hidden": false,
+        "Id": 1073741829,
+        "Name": "Full Control",
+        "Order": 1,
+        "RoleTypeKind": 5,
+        "BasePermissionsValue": [
+          "ViewListItems",
+          "AddListItems",
+          "EditListItems",
+          "DeleteListItems",
+          "ApproveItems",
+          "OpenItems",
+          "ViewVersions",
+          "DeleteVersions",
+          "CancelCheckout",
+          "ManagePersonalViews",
+          "ManageLists",
+          "ViewFormPages",
+          "AnonymousSearchAccessList",
+          "Open",
+          "ViewPages",
+          "AddAndCustomizePages",
+          "ApplyThemeAndBorder",
+          "ApplyStyleSheets",
+          "ViewUsageData",
+          "CreateSSCSite",
+          "ManageSubwebs",
+          "CreateGroups",
+          "ManagePermissions",
+          "BrowseDirectories",
+          "BrowseUserInfo",
+          "AddDelPrivateWebParts",
+          "UpdatePersonalWebParts",
+          "ManageWeb",
+          "AnonymousSearchAccessWebLists",
+          "UseClientIntegration",
+          "UseRemoteAPIs",
+          "ManageAlerts",
+          "CreateAlerts",
+          "EditMyUserInfo",
+          "EnumeratePermissions"
+        ],
+        "RoleTypeKindValue": "Administrator"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    Id          Name
+    ----------  -----------------------
+    1073741829  Full Control
+    ```
+
+=== "CSV"
+
+    ```csv
+    Id,Name
+    1073741829,Full Control
+    ```

package/docs/docs/cmd/spo/roledefinition/roledefinition-remove.md

@@ -11,26 +11,30 @@ m365 spo roledefinition remove [options]
 ## Options
 
 `-u, --webUrl <webUrl>`
-: URL of the site from which role should be removed
+: URL of the site from which role should be removed.
 
 `-i, --id <id>`
-: ID of the role definition to remove
+: ID of the role definition to remove.
 
 `--confirm`
-: Don't prompt for confirming removing the role definition
+: Don't prompt for confirming removing the role definition.
 
 --8<-- "docs/cmd/_global.md"
 
 ## Examples
 
-Remove the role definition from site  _https://contoso.sharepoint.com/sites/project-x_ with id _1_
+Remove the role definition from the given site
 
 ```sh
 m365 spo roledefinition remove --webUrl https://contoso.sharepoint.com/sites/project-x --id 1
 ```
 
-Remove the role definition from site  _https://contoso.sharepoint.com/sites/project-x_ with id _1_ and don't prompt for confirmation
+Remove the role definition from the given site and don't prompt for confirmation
 
 ```sh
 m365 spo roledefinition remove --webUrl https://contoso.sharepoint.com/sites/project-x --id 1 --confirm
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-add.md

@@ -17,10 +17,10 @@ m365 spo sp grant add
 ## Options
 
 `-r, --resource <resource>`
-: The name of the resource for which permissions should be granted
+: The name of the resource for which permissions should be granted.
 
 `-s, --scope <scope>`
-: The name of the permission that should be granted
+: The name of the permission that should be granted.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -42,3 +42,40 @@ Grant the service principal permission to a custom API
 ```sh
 m365 spo serviceprincipal grant add --resource 'contoso-api' --scope 'user_impersonation'
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "ClientId": "6004a642-185c-479a-992a-15d1c23e2229",
+      "ConsentType": "AllPrincipals",
+      "IsDomainIsolated": false,
+      "ObjectId": "QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY",
+      "PackageName": null,
+      "Resource": "Microsoft Graph",
+      "ResourceId": "a46b0017-21e2-4db1-bc69-ca63576a38d6",
+      "Scope": "Mail.Read"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    ClientId        : 6004a642-185c-479a-992a-15d1c23e2229
+    ConsentType     : AllPrincipals
+    IsDomainIsolated: false
+    ObjectId        : QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY
+    PackageName     : null
+    Resource        : Microsoft Graph
+    ResourceId      : a46b0017-21e2-4db1-bc69-ca63576a38d6
+    Scope           : Mail.Read
+    ```
+
+=== "CSV"
+
+    ```csv
+    ClientId,ConsentType,IsDomainIsolated,ObjectId,PackageName,Resource,ResourceId,Scope
+    6004a642-185c-479a-992a-15d1c23e2229,AllPrincipals,,QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY,,Microsoft Graph,a46b0017-21e2-4db1-bc69-ca63576a38d6,Mail.Read
+    ```

package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-list.md

@@ -30,3 +30,35 @@ List all permissions granted to the service principal
 ```sh
 m365 spo serviceprincipal grant list
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "IsDomainIsolated": false,
+        "ObjectId": "QqYEYFwYmkeZKhXRwj4iKV5QwbD60RVCo6xeMUG407E",
+        "PackageName": null,
+        "Resource": "Windows Azure Active Directory",
+        "ResourceId": "b0c1505e-d1fa-4215-a3ac-5e3141b8d3b1",
+        "Scope": "User.Read"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    IsDomainIsolated  ObjectId                                     PackageName  Resource                        ResourceId                            Scope
+    ----------------  -------------------------------------------  -----------  ------------------------------  ------------------------------------  --------------------------
+    false             QqYEYFwYmkeZKhXRwj4iKV5QwbD60RVCo6xeMUG407E  null         Windows Azure Active Directory  b0c1505e-d1fa-4215-a3ac-5e3141b8d3b1  User.Read
+    ```
+
+=== "CSV"
+
+    ```csv
+    IsDomainIsolated,ObjectId,PackageName,Resource,ResourceId,Scope
+    ,QqYEYFwYmkeZKhXRwj4iKV5QwbD60RVCo6xeMUG407E,,Windows Azure Active Directory,b0c1505e-d1fa-4215-a3ac-5e3141b8d3b1,User.Read
+    ```

package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-revoke.md

@@ -17,7 +17,7 @@ m365 spo sp grant revoke
 ## Options
 
 `-i, --id <id>`
-: `ObjectId` of the permission grant to revoke
+: `ObjectId` of the permission grant to revoke.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -30,8 +30,12 @@ The permission grant you want to revoke is denoted using its `ObjectId`. You can
 
 ## Examples
 
-Revoke permission grant with ObjectId _50NAzUm3C0K9B6p8ORLtIsQccg4rMERGvFGRtBsk2fA_
+Revoke permission grant
 
 ```sh
 m365 spo serviceprincipal grant revoke --id 50NAzUm3C0K9B6p8ORLtIsQccg4rMERGvFGRtBsk2fA
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-approve.md

@@ -17,7 +17,13 @@ m365 spo sp permissionrequest approve
 ## Options
 
 `-i, --id <id>`
-: ID of the permission request to approve
+: ID of the permission request to approve.
+
+`--all`
+: approve all pending permission requests.
+
+`--resource [resource]`
+: The resource of the permissions requests to approve.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -30,8 +36,45 @@ The permission request you want to approve is denoted using its `ID`. You can re
 
 ## Examples
 
-Approve permission request with id _4dc4c043-25ee-40f2-81d3-b3bf63da7538_
+Approve permission request
 
 ```sh
 m365 spo serviceprincipal permissionrequest approve --id 4dc4c043-25ee-40f2-81d3-b3bf63da7538
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "ClientId": "6004a642-185c-479a-992a-15d1c23e2229",
+      "ConsentType": "AllPrincipals",
+      "IsDomainIsolated": false,
+      "ObjectId": "QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY",
+      "PackageName": null,
+      "Resource": "Microsoft Graph",
+      "ResourceId": "a46b0017-21e2-4db1-bc69-ca63576a38d6",
+      "Scope": "Reports.Read.All"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    ClientId        : 6004a642-185c-479a-992a-15d1c23e2229
+    ConsentType     : AllPrincipals
+    IsDomainIsolated: false
+    ObjectId        : QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY
+    PackageName     : null
+    Resource        : Microsoft Graph
+    ResourceId      : a46b0017-21e2-4db1-bc69-ca63576a38d6
+    Scope           : Directory.ReadWrite.All
+    ```
+
+=== "CSV"
+
+    ```csv
+    ClientId,ConsentType,IsDomainIsolated,ObjectId,PackageName,Resource,ResourceId,Scope
+    6004a642-185c-479a-992a-15d1c23e2229,AllPrincipals,false,QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY,null,Microsoft Graph,a46b0017-21e2-4db1-bc69-ca63576a38d6,Directory.ReadWrite.All
+    ```

package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-deny.md

@@ -17,7 +17,7 @@ m365 spo sp permissionrequest deny
 ## Options
 
 `-i, --id <id>`
-: ID of the permission request to deny
+: ID of the permission request to deny.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -30,8 +30,12 @@ The permission request you want to approve is denoted using its `ID`. You can re
 
 ## Examples
 
-Deny permission request with id _4dc4c043-25ee-40f2-81d3-b3bf63da7538_
+Deny permission request
 
 ```sh
 m365 spo serviceprincipal permissionrequest deny --id 4dc4c043-25ee-40f2-81d3-b3bf63da7538
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-list.md

@@ -30,3 +30,33 @@ List all pending permission requests
 ```sh
 m365 spo serviceprincipal permissionrequest list
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "Id": "6eceed61-77e4-424d-ae1d-696a0de4d768",
+        "Resource": "Microsoft Graph",
+        "ResourceId": "Microsoft Graph",
+        "Scope": "Reports.Read.All"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    Id                                    Resource         ResourceId       Scope
+    ------------------------------------  ---------------  ---------------  -----------------------
+    6eceed61-77e4-424d-ae1d-696a0de4d768  Microsoft Graph  Microsoft Graph  Reports.Read.All
+    ```
+
+=== "CSV"
+
+    ```csv
+    Id,Resource,ResourceId,Scope
+    6eceed61-77e4-424d-ae1d-696a0de4d768,Microsoft Graph,Microsoft Graph,Reports.Read.All
+    ```

package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-set.md

@@ -17,10 +17,10 @@ m365 spo sp set
 ## Options
 
 `-e, --enabled <enabled>`
-: Set to `true` to enable the service principal or to `false` to disable it. Valid values are `true,false`
+: Set to `true` to enable the service principal or to `false` to disable it. Valid values are `true`, `false`.
 
 `--confirm`
-: Don't prompt for confirming enabling/disabling the service principal
+: Don't prompt for confirming enabling/disabling the service principal.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -50,3 +50,37 @@ Enable the service principal without prompting for confirmation
 ```sh
 m365 spo serviceprincipal set --enabled true --confirm
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "AccountEnabled": true,
+      "AppId": "48535560-3cc0-442e-a1b4-94c084b3ff59",
+      "ReplyUrls": [
+        "https://fluidpreview.office.net/spfxsinglesignon",
+        "https://dev.fluidpreview.office.net/spfxsinglesignon",
+        "https://contoso.sharepoint.com/",
+        "https://contoso.sharepoint.com/_forms/spfxsinglesignon.aspx",
+        "https://contoso.sharepoint.com/_forms/spfxsinglesignon.aspx?redirect",
+        "https://contoso-admin.sharepoint.com/_forms/spfxsinglesignon.aspx"
+      ]
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    AccountEnabled: true
+    AppId         : 48535560-3cc0-442e-a1b4-94c084b3ff59
+    ReplyUrls     : ["https://fluidpreview.office.net/spfxsinglesignon","https://dev.fluidpreview.office.net/spfxsinglesignon","https://contoso.sharepoint.com/","https://contoso.sharepoint.com/_forms/spfxsinglesignon.aspx","https://contoso.sharepoint.com/_forms/spfxsinglesignon.aspx?redirect","https://contoso-admin.sharepoint.com/_forms/spfxsinglesignon.aspx"]
+    ```
+
+=== "CSV"
+
+    ```csv
+    AccountEnabled,AppId,ReplyUrls
+    1,48535560-3cc0-442e-a1b4-94c084b3ff59,"[""https://fluidpreview.office.net/spfxsinglesignon"",""https://dev.fluidpreview.office.net/spfxsinglesignon"",""https://contoso.sharepoint.com/"",""https://contoso.sharepoint.com/_forms/spfxsinglesignon.aspx"",""https://contoso.sharepoint.com/_forms/spfxsinglesignon.aspx?redirect"",""https://contoso-admin.sharepoint.com/_forms/spfxsinglesignon.aspx""]"
+    ```

package/docs/docs/cmd/spo/site/site-appcatalog-list.md

@@ -0,0 +1,55 @@
+# spo site appcatalog list
+
+List all site collection app catalogs within the tenant
+
+## Usage
+
+```sh
+m365 spo site appcatalog list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! important
+    To use this command you need to have at least read permissions on the SharePoint root site.
+
+## Examples
+
+List all site collection app catalogs within the tenant
+
+```sh
+m365 spo site appcatalog list
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "AbsoluteUrl": "https://contoso.sharepoint.com/sites/site1",
+        "ErrorMessage": "Success",
+        "SiteID": "9798e615-b586-455e-8486-84913f492c49"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    AbsoluteUrl                                          SiteID
+    ---------------------------------------------------  ------------------------------------
+    https://contoso.sharepoint.com/sites/site1           9798e615-b586-455e-8486-84913f492c49
+    ```
+
+=== "CSV"
+
+    ```csv
+    AbsoluteUrl,SiteID
+    https://contoso.sharepoint.com/sites/site1,9798e615-b586-455e-8486-84913f492c49
+    ```

package/docs/docs/cmd/spo/web/web-retentionlabel-list.md

@@ -0,0 +1,74 @@
+# spo web retentionlabel list
+
+Get a list of retention labels that are available on a site.
+
+## Usage
+
+```sh
+m365 spo web retentionlabel list [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get a list of retention labels for the _Sales_ site
+
+```sh
+m365 spo web retentionlabel list --webUrl 'https://contoso.sharepoint.com/sites/sales'
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "AcceptMessagesOnlyFromSendersOrMembers": false,
+        "AccessType": null,
+        "AllowAccessFromUnmanagedDevice": null,
+        "AutoDelete": true,
+        "BlockDelete": true,
+        "BlockEdit": false,
+        "ComplianceFlags": 1,
+        "ContainsSiteLabel": false,
+        "DisplayName": "",
+        "EncryptionRMSTemplateId": null,
+        "HasRetentionAction": true,
+        "IsEventTag": false,
+        "MultiStageReviewerEmail": null,
+        "NextStageComplianceTag": null,
+        "Notes": null,
+        "RequireSenderAuthenticationEnabled": false,
+        "ReviewerEmail": null,
+        "SharingCapabilities": null,
+        "SuperLock": false,
+        "TagDuration": 2555,
+        "TagId": "def61080-111c-4aea-b72f-5b60e516e36c",
+        "TagName": "Some label",
+        "TagRetentionBasedOn": "CreationAgeInDays",
+        "UnlockedAsDefault": false
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    TagId                                 TagName
+    ------------------------------------  --------------
+    def61080-111c-4aea-b72f-5b60e516e36c  Some label
+    ```
+
+=== "CSV"
+
+    ```csv
+    TagId,TagName
+    def61080-111c-4aea-b72f-5b60e516e36c,Some label,true
+    ```