@pnp/cli-microsoft365 6.0.0-beta.27b9708 → 6.0.0-beta.291f17c

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

@@ -33,6 +33,100 @@ List hub sites, including their associated sites, in the current tenant. Associa
 m365 spo hubsite list --includeAssociatedSites --output json
 ```
 
+## Response
+
+### Standard response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "Description": "Intranet Hub Site",
+        "EnablePermissionsSync": false,
+        "EnforcedECTs": null,
+        "EnforcedECTsVersion": 0,
+        "HideNameInNavigation": false,
+        "ID": "af80c11f-0138-4d72-bb37-514542c3aabb",
+        "LogoUrl": "https://contoso.sharepoint.com/sites/intra/SiteAssets/work.png",
+        "ParentHubSiteId": "ec78f3aa-5a74-4f16-be49-3396df045f34",
+        "PermissionsSyncTag": 0,
+        "RequiresJoinApproval": false,
+        "SiteDesignId": "184644fb-90ed-4841-a7ad-6930cf819060",
+        "SiteId": "af80c11f-0138-4d72-bb37-514542c3aabb",
+        "SiteUrl": "https://contoso.sharepoint.com/sites/intra",
+        "Targets": null,
+        "TenantInstanceId": "5d128b52-7228-46b5-8765-5b338476054d",
+        "Title": "Intranet"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    ID                                    SiteUrl                                     Title
+    ------------------------------------  ------------------------------------------  --------
+    af80c11f-0138-4d72-bb37-514542c3aabb  https://contoso.sharepoint.com/sites/intra  Intranet
+    ```
+
+=== "CSV"
+
+    ```csv
+    ID,SiteUrl,Title
+    af80c11f-0138-4d72-bb37-514542c3aabb,https://contoso.sharepoint.com/sites/intra,Intranet
+    ```
+
+### `includeAssociatedSites` response
+
+When we make use of the option `includeAssociatedSites` the response will differ. 
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "Description": "Intranet Hub Site",
+        "EnablePermissionsSync": false,
+        "EnforcedECTs": null,
+        "EnforcedECTsVersion": 0,
+        "HideNameInNavigation": false,
+        "ID": "af80c11f-0138-4d72-bb37-514542c3aabb",
+        "LogoUrl": "https://contoso.sharepoint.com/sites/intra/SiteAssets/work.png",
+        "ParentHubSiteId": "ec78f3aa-5a74-4f16-be49-3396df045f34",
+        "PermissionsSyncTag": 0,
+        "RequiresJoinApproval": false,
+        "SiteDesignId": "184644fb-90ed-4841-a7ad-6930cf819060",
+        "SiteId": "af80c11f-0138-4d72-bb37-514542c3aabb",
+        "SiteUrl": "https://contoso.sharepoint.com/sites/intra",
+        "Targets": null,
+        "TenantInstanceId": "5d128b52-7228-46b5-8765-5b338476054d",
+        "Title": "Intranet",
+        "AssociatedSites": [
+          {
+            "Title": "About Us",
+            "SiteUrl": "https://contoso.sharepoint.com/sites/about-us"
+          }
+        ]
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    ID                                    SiteUrl                                     Title
+    ------------------------------------  ------------------------------------------  --------
+    af80c11f-0138-4d72-bb37-514542c3aabb  https://contoso.sharepoint.com/sites/intra  Intranet
+    ```
+
+=== "CSV"
+
+    ```csv
+    ID,SiteUrl,Title
+    af80c11f-0138-4d72-bb37-514542c3aabb,https://contoso.sharepoint.com/sites/intra,Intranet
+    ```
+
 ## More information
 
 - SharePoint hub sites new in Microsoft 365: [https://techcommunity.microsoft.com/t5/SharePoint-Blog/SharePoint-hub-sites-new-in-Office-365/ba-p/109547](https://techcommunity.microsoft.com/t5/SharePoint-Blog/SharePoint-hub-sites-new-in-Office-365/ba-p/109547)

package/docs/docs/cmd/spo/hubsite/hubsite-register.md

@@ -17,8 +17,8 @@ m365 spo hubsite register [options]
 
 ## Remarks
 
-!!! attention
-    This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.
+!!! important
+    To use this command you must be a Global or SharePoint administrator.
 
 If the specified site collection is already registered as a hub site, you will get a `This site is already a HubSite.` error.
 
@@ -30,6 +30,59 @@ Register the site collection with URL _https://contoso.sharepoint.com/sites/sale
 m365 spo hubsite register --siteUrl https://contoso.sharepoint.com/sites/sales
 ```
 
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "Description": "",
+      "EnablePermissionsSync": false,
+      "EnforcedECTs": null,
+      "EnforcedECTsVersion": 0,
+      "HideNameInNavigation": false,
+      "ID": "0f9b8f4f-0e8e-4630-bb0a-501442db9b64",
+      "LogoUrl": null,
+      "ParentHubSiteId": "00000000-0000-0000-0000-000000000000",
+      "PermissionsSyncTag": 0,
+      "RequiresJoinApproval": false,
+      "SiteDesignId": "00000000-0000-0000-0000-000000000000",
+      "SiteId": "0f9b8f4f-0e8e-4630-bb0a-501442db9b64",
+      "SiteUrl": "https://contoso.sharepoint.com/sites/newHubSite",
+      "Targets": null,
+      "TenantInstanceId": "4d128b52-7228-46b5-8765-5b338476054d",
+      "Title": "New Hub Site"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    Description          : null
+    EnablePermissionsSync: false
+    EnforcedECTs         : null
+    EnforcedECTsVersion  : 0
+    HideNameInNavigation : false
+    ID                   : 0f9b8f4f-0e8e-4630-bb0a-501442db9b64
+    LogoUrl              : null
+    ParentHubSiteId      : 00000000-0000-0000-0000-000000000000
+    PermissionsSyncTag   : 0
+    RequiresJoinApproval : false
+    SiteDesignId         : 00000000-0000-0000-0000-000000000000
+    SiteId               : 0f9b8f4f-0e8e-4630-bb0a-501442db9b64
+    SiteUrl              : https://contoso.sharepoint.com/sites/newHubsite
+    Targets              : null
+    TenantInstanceId     : 4d128b52-7228-46b5-8765-5b338476054d
+    Title                : New Hub Site
+    ```
+
+=== "CSV"
+
+    ```csv
+    Description,EnablePermissionsSync,EnforcedECTs,EnforcedECTsVersion,HideNameInNavigation,ID,LogoUrl,ParentHubSiteId,PermissionsSyncTag,RequiresJoinApproval,SiteDesignId,SiteId,SiteUrl,Targets,TenantInstanceId,Title
+    ,,,0,,0f9b8f4f-0e8e-4630-bb0a-501442db9b64,,00000000-0000-0000-0000-000000000000,0,,00000000-0000-0000-0000-000000000000,0f9b8f4f-0e8e-4630-bb0a-501442db9b64,https://contoso.sharepoint.com/sites/newHubSite,,4d128b52-7228-46b5-8765-5b338476054d,New Hub Site
+    ```
+
 ## More information
 
 - SharePoint hub sites new in Microsoft 365: [https://techcommunity.microsoft.com/t5/SharePoint-Blog/SharePoint-hub-sites-new-in-Office-365/ba-p/109547](https://techcommunity.microsoft.com/t5/SharePoint-Blog/SharePoint-hub-sites-new-in-Office-365/ba-p/109547)

package/docs/docs/cmd/spo/hubsite/hubsite-rights-grant.md

@@ -21,13 +21,10 @@ m365 spo hubsite rights grant [options]
 
 --8<-- "docs/cmd/_global.md"
 
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-
 ## Remarks
 
-!!! attention
-    This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.
+!!! important
+    To use this command you must be a Global or SharePoint administrator.
 
 ## Examples
 
@@ -49,6 +46,10 @@ Grant user with email _PattiF@contoso.com_ permission to join sites to the hub s
 m365 spo hubsite rights grant --hubSiteUrl https://contoso.sharepoint.com/sites/sales --principals PattiF@contoso.com --rights Join
 ```
 
+## Response
+
+The command won't return a response on success.
+
 ## More information
 
 - SharePoint hub sites new in Microsoft 365: [https://techcommunity.microsoft.com/t5/SharePoint-Blog/SharePoint-hub-sites-new-in-Office-365/ba-p/109547](https://techcommunity.microsoft.com/t5/SharePoint-Blog/SharePoint-hub-sites-new-in-Office-365/ba-p/109547)

package/docs/docs/cmd/spo/hubsite/hubsite-rights-revoke.md

@@ -21,13 +21,10 @@ m365 spo hubsite rights revoke [options]
 
 --8<-- "docs/cmd/_global.md"
 
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-
 ## Remarks
 
-!!! attention
-    This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.
+!!! important
+    To use this command you must be a Global or SharePoint administrator.
 
 ## Examples
 
@@ -43,6 +40,10 @@ Revoke rights to join sites to the hub site with URL _https://contoso.sharepoint
 m365 spo hubsite rights revoke --hubSiteUrl https://contoso.sharepoint.com/sites/sales --principals "PattiF,AdeleV" --confirm
 ```
 
+## Response
+
+The command won't return a response on success.
+
 ## More information
 
 - SharePoint hub sites new in Microsoft 365: [https://techcommunity.microsoft.com/t5/SharePoint-Blog/SharePoint-hub-sites-new-in-Office-365/ba-p/109547](https://techcommunity.microsoft.com/t5/SharePoint-Blog/SharePoint-hub-sites-new-in-Office-365/ba-p/109547)

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

@@ -24,13 +24,10 @@ m365 spo hubsite set [options]
 
 --8<-- "docs/cmd/_global.md"
 
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-
 ## Remarks
 
-!!! attention
-    This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.
+!!! important
+    To use this command you must be a Global or SharePoint administrator.
 
 If the specified `id` doesn't refer to an existing hub site, you will get an `Unknown Error` error.
 
@@ -48,6 +45,51 @@ Update hub site's title and description
 m365 spo hubsite set --id 255a50b2-527f-4413-8485-57f4c17a24d1 --title Sales --description "All things sales"
 ```
 
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "Description": "Hello",
+      "EnablePermissionsSync": false,
+      "HideNameInNavigation": false,
+      "ID": "af80c11f-0138-4d72-bb37-514542c3aabb",
+      "LogoUrl": "https://contoso.sharepoint.com/sites/intra/SiteAssets/teapoint.png",
+      "ParentHubSiteId": "/Guid(00000000-0000-0000-0000-000000000000)/",
+      "Permissions": null,
+      "RequiresJoinApproval": false,
+      "SiteDesignId": "/Guid(184644fb-90ed-4841-a7ad-6930cf819060)/",
+      "SiteId": "af80c11f-0138-4d72-bb37-514542c3aabb",
+      "SiteUrl": "https://contoso.sharepoint.com/sites/intra",
+      "Title": "Intranet"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    Description          : Hello
+    EnablePermissionsSync: false
+    HideNameInNavigation : false
+    ID                   : af80c11f-0138-4d72-bb37-514542c3aabb
+    LogoUrl              : https://contoso.sharepoint.com/sites/intra/SiteAssets/teapoint.png
+    ParentHubSiteId      : /Guid(00000000-0000-0000-0000-000000000000)/
+    Permissions          : null
+    RequiresJoinApproval : false
+    SiteDesignId         : /Guid(184644fb-90ed-4841-a7ad-6930cf819060)/
+    SiteId               : af80c11f-0138-4d72-bb37-514542c3aabb
+    SiteUrl              : https://contoso.sharepoint.com/sites/intra
+    Title                : Intranet
+    ```
+
+=== "CSV"
+
+    ```csv
+    Description,EnablePermissionsSync,HideNameInNavigation,ID,LogoUrl,ParentHubSiteId,Permissions,RequiresJoinApproval,SiteDesignId,SiteId,SiteUrl,Title
+    Hello,,,af80c11f-0138-4d72-bb37-514542c3aabb,https://contoso.sharepoint.com/sites/intra/SiteAssets/teapoint.png,/Guid(00000000-0000-0000-0000-000000000000)/,,,/Guid(184644fb-90ed-4841-a7ad-6930cf819060)/,af80c11f-0138-4d72-bb37-514542c3aabb,https://contoso.sharepoint.com/sites/intra,Intranet
+    ```
+
 ## More information
 
 - SharePoint hub sites new in Microsoft 365: [https://techcommunity.microsoft.com/t5/SharePoint-Blog/SharePoint-hub-sites-new-in-Office-365/ba-p/109547](https://techcommunity.microsoft.com/t5/SharePoint-Blog/SharePoint-hub-sites-new-in-Office-365/ba-p/109547)

package/docs/docs/cmd/spo/hubsite/hubsite-unregister.md

@@ -20,8 +20,8 @@ m365 spo hubsite unregister [options]
 
 ## Remarks
 
-!!! attention
-    This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.
+!!! important
+    To use this command you must be a Global or SharePoint administrator.
 
 If the specified site collection is not registered as a hub site, you will get a `hubSiteId` error.
 
@@ -39,6 +39,10 @@ Unregister the site collection with URL _https://contoso.sharepoint.com/sites/sa
 m365 spo hubsite unregister --url https://contoso.sharepoint.com/sites/sales --confirm
 ```
 
+## Response
+
+The command won't return a response on success.
+
 ## More information
 
 - SharePoint hub sites new in Microsoft 365: [https://techcommunity.microsoft.com/t5/SharePoint-Blog/SharePoint-hub-sites-new-in-Office-365/ba-p/109547](https://techcommunity.microsoft.com/t5/SharePoint-Blog/SharePoint-hub-sites-new-in-Office-365/ba-p/109547)

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

@@ -22,3 +22,23 @@ Gets the Knowledge Hub Site URL for your tenant
 ```sh
 m365 spo knowledgehub get
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    "https://contoso.sharepoint.com"
+    ```
+
+=== "Text"
+
+    ```text
+    https://contoso.sharepoint.com
+    ```
+
+=== "CSV"
+
+    ```csv
+    https://contoso.sharepoint.com
+    ```

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

@@ -31,3 +31,23 @@ Removes the Knowledge Hub Site setting for your tenant without confirmation
 ```sh
 m365 spo knowledgehub remove --confirm
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    "The knowledge hub site setting was removed."
+    ```
+
+=== "Text"
+
+    ```text
+    The knowledge hub site setting was removed.
+    ```
+
+=== "CSV"
+
+    ```csv
+    The knowledge hub site setting was removed.
+    ```

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

@@ -29,3 +29,23 @@ Sets the Knowledge Hub Site for your tenant
 ```sh
 m365 spo knowledgehub set --siteUrl https://contoso.sharepoint.com/sites/knowledgesite
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    "The knowledge hub site with url \"https://contoso.sharepoint.com\" is added to list."
+    ```
+
+=== "Text"
+
+    ```text
+    The knowledge hub site with url "https://contoso.sharepoint.com" is added to list.
+    ```
+
+=== "CSV"
+
+    ```csv
+    The knowledge hub site with url "https://contoso.sharepoint.com" is added to list.
+    ```

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

@@ -221,6 +221,139 @@ Add a list with title _Announcements_, baseTemplate _Announcements_ in site _htt
 m365 spo list add --webUrl https://contoso.sharepoint.com/sites/project-x --title Announcements --baseTemplate Announcements --contentTypesEnabled true --enableVersioning true --majorVersionLimit 50
 ```
 
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "AllowContentTypes": true,
+      "BaseTemplate": 100,
+      "BaseType": 0,
+      "ContentTypesEnabled": false,
+      "CrawlNonDefaultViews": false,
+      "Created": "2022-11-16T19:51:42Z",
+      "CurrentChangeToken": {
+        "StringValue": "1;3;ea3dc19f-bc1f-4b77-afb8-14e08f4c0f6d;638042251016970000;564165920"
+      },
+      "DefaultContentApprovalWorkflowId": "00000000-0000-0000-0000-000000000000",
+      "DefaultItemOpenUseListSetting": false,
+      "Description": "",
+      "Direction": "none",
+      "DisableCommenting": false,
+      "DisableGridEditing": false,
+      "DocumentTemplateUrl": null,
+      "DraftVersionVisibility": 0,
+      "EnableAttachments": true,
+      "EnableFolderCreation": false,
+      "EnableMinorVersions": false,
+      "EnableModeration": false,
+      "EnableRequestSignOff": true,
+      "EnableVersioning": true,
+      "EntityTypeName": "TestList",
+      "ExemptFromBlockDownloadOfNonViewableFiles": false,
+      "FileSavePostProcessingEnabled": false,
+      "ForceCheckout": false,
+      "HasExternalDataSource": false,
+      "Hidden": false,
+      "Id": "ea3dc19f-bc1f-4b77-afb8-14e08f4c0f6d",
+      "ImagePath": {
+        "DecodedUrl": "/_layouts/15/images/itgen.png?rev=47"
+      },
+      "ImageUrl": "/_layouts/15/images/itgen.png?rev=47",
+      "DefaultSensitivityLabelForLibrary": "",
+      "IrmEnabled": false,
+      "IrmExpire": false,
+      "IrmReject": false,
+      "IsApplicationList": false,
+      "IsCatalog": false,
+      "IsPrivate": false,
+      "ItemCount": 0,
+      "LastItemDeletedDate": "2022-11-16T19:51:42Z",
+      "LastItemModifiedDate": "2022-11-16T19:51:42Z",
+      "LastItemUserModifiedDate": "2022-11-16T19:51:42Z",
+      "ListExperienceOptions": 0,
+      "ListItemEntityTypeFullName": "SP.Data.TestListItem",
+      "MajorVersionLimit": 50,
+      "MajorWithMinorVersionsLimit": 0,
+      "MultipleDataList": false,
+      "NoCrawl": false,
+      "ParentWebPath": {
+        "DecodedUrl": "/"
+      },
+      "ParentWebUrl": "/",
+      "ParserDisabled": false,
+      "ServerTemplateCanCreateFolders": true,
+      "TemplateFeatureId": "00bfea71-de22-43b2-a848-c05709900100",
+      "Title": "Test"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    AllowContentTypes                        : true
+    BaseTemplate                             : 100
+    BaseType                                 : 0
+    ContentTypesEnabled                      : false
+    CrawlNonDefaultViews                     : false
+    Created                                  : 2022-11-16T19:52:16Z
+    CurrentChangeToken                       : {"StringValue":"1;3;4d66e81a-ac73-4894-9e33-7999edaa36bc;638042251364530000;564166119"}
+    DefaultContentApprovalWorkflowId         : 00000000-0000-0000-0000-000000000000
+    DefaultItemOpenUseListSetting            : false
+    DefaultSensitivityLabelForLibrary        :
+    Description                              :
+    Direction                                : none
+    DisableCommenting                        : false
+    DisableGridEditing                       : false
+    DocumentTemplateUrl                      : null
+    DraftVersionVisibility                   : 0
+    EnableAttachments                        : true
+    EnableFolderCreation                     : false
+    EnableMinorVersions                      : false
+    EnableModeration                         : false
+    EnableRequestSignOff                     : true
+    EnableVersioning                         : true
+    EntityTypeName                           : TestList
+    ExemptFromBlockDownloadOfNonViewableFiles: false
+    FileSavePostProcessingEnabled            : false
+    ForceCheckout                            : false
+    HasExternalDataSource                    : false
+    Hidden                                   : false
+    Id                                       : 4d66e81a-ac73-4894-9e33-7999edaa36bc
+    ImagePath                                : {"DecodedUrl":"/_layouts/15/images/itgen.png?rev=47"}
+    ImageUrl                                 : /_layouts/15/images/itgen.png?rev=47
+    IrmEnabled                               : false
+    IrmExpire                                : false
+    IrmReject                                : false
+    IsApplicationList                        : false
+    IsCatalog                                : false
+    IsPrivate                                : false
+    ItemCount                                : 0
+    LastItemDeletedDate                      : 2022-11-16T19:52:16Z
+    LastItemModifiedDate                     : 2022-11-16T19:52:16Z
+    LastItemUserModifiedDate                 : 2022-11-16T19:52:16Z
+    ListExperienceOptions                    : 0
+    ListItemEntityTypeFullName               : SP.Data.TestListItem
+    MajorVersionLimit                        : 50
+    MajorWithMinorVersionsLimit              : 0
+    MultipleDataList                         : false
+    NoCrawl                                  : false
+    ParentWebPath                            : {"DecodedUrl":"/"}
+    ParentWebUrl                             : /
+    ParserDisabled                           : false
+    ServerTemplateCanCreateFolders           : true
+    TemplateFeatureId                        : 00bfea71-de22-43b2-a848-c05709900100
+    Title                                    : Test
+    ```
+
+=== "CSV"
+
+    ```csv
+    AllowContentTypes,BaseTemplate,BaseType,ContentTypesEnabled,CrawlNonDefaultViews,Created,CurrentChangeToken,DefaultContentApprovalWorkflowId,DefaultItemOpenUseListSetting,Description,Direction,DisableCommenting,DisableGridEditing,DocumentTemplateUrl,DraftVersionVisibility,EnableAttachments,EnableFolderCreation,EnableMinorVersions,EnableModeration,EnableRequestSignOff,EnableVersioning,EntityTypeName,ExemptFromBlockDownloadOfNonViewableFiles,FileSavePostProcessingEnabled,ForceCheckout,HasExternalDataSource,Hidden,Id,ImagePath,ImageUrl,DefaultSensitivityLabelForLibrary,IrmEnabled,IrmExpire,IrmReject,IsApplicationList,IsCatalog,IsPrivate,ItemCount,LastItemDeletedDate,LastItemModifiedDate,LastItemUserModifiedDate,ListExperienceOptions,ListItemEntityTypeFullName,MajorVersionLimit,MajorWithMinorVersionsLimit,MultipleDataList,NoCrawl,ParentWebPath,ParentWebUrl,ParserDisabled,ServerTemplateCanCreateFolders,TemplateFeatureId,Title
+    1,100,0,,,2022-11-16T19:52:41Z,"{""StringValue"":""1;3;3b6bd39e-1e62-4ddf-ac8e-020bf5353891;638042251616230000;564166296""}",00000000-0000-0000-0000-000000000000,,,none,,,,0,1,,,,1,1,TestList,,,,,,3b6bd39e-1e62-4ddf-ac8e-020bf5353891,"{""DecodedUrl"":""/_layouts/15/images/itgen.png?rev=47""}",/_layouts/15/images/itgen.png?rev=47,,,,,,,,0,2022-11-16T19:52:41Z,2022-11-16T19:52:42Z,2022-11-16T19:52:41Z,0,SP.Data.TestListItem,50,0,,,"{""DecodedUrl"":""/""}",/,,1,00bfea71-de22-43b2-a848-c05709900100,Test
+    ```
+
 ## More information
 
 - SPList Class Members information: [https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.list_members.aspx](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.list_members.aspx)