@pnp/cli-microsoft365 7.0.0-beta.68abdfc → 7.0.0-beta.68fea7b

package/docs/docs/cmd/spo/sitedesign/sitedesign-apply.mdx

@@ -1,4 +1,6 @@
 import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
 
 # spo sitedesign apply
 
@@ -39,6 +41,129 @@ Apply large site design to the specified site
 m365 spo sitedesign apply --id 9b142c22-037f-4a7f-9017-e9d8c0e34b98 --webUrl https://contoso.sharepoint.com/sites/project-x --asTask
 ```
 
+## Response
+
+### Standard response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "ErrorCode": 0,
+      "Outcome": "0",
+      "OutcomeText": null,
+      "Target": null,
+      "TargetId": null,
+      "Title": "Activate feature f151bb39-7c3b-414f-bb36-6bf18872052f"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  ErrorCode  : 0
+  Outcome    : 0
+  OutcomeText: null
+  Target     : null
+  TargetId   : null
+  Title      : Activate feature f151bb39-7c3b-414f-bb36-6bf18872052f
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  ErrorCode,Outcome,Title
+  0,0,Activate feature f151bb39-7c3b-414f-bb36-6bf18872052f
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo sitedesign apply --id "00281728-3bc1-41d3-92b6-8fc493dcf4cc" --webUrl "https://contoso.sharepoint.com/teams/spoteam1"
+
+  Date: 2023-06-22
+
+  ## Activate feature f151bb39-7c3b-414f-bb36-6bf18872052f
+
+  Property | Value
+  ---------|-------
+  ErrorCode | 0
+  Outcome | 0
+  Title | Activate feature f151bb39-7c3b-414f-bb36-6bf18872052f
+  ```
+
+  </TabItem>
+</Tabs>
+
+### `asTask` response
+
+When we make use of the option `asTask`, the response will differ. 
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "ID": "781e7556-4489-42bc-aa94-1decf6a395d6",
+    "LogonName": "i:0#.f|membership|john@contoso.onmicrosoft.com",
+    "SiteDesignID": "00281728-3bc1-41d3-92b6-8fc493dcf4cc",
+    "SiteDesignStore": 0,
+    "SiteID": "5fc2ea61-7204-41be-9d05-d44f017f958b",
+    "WebID": "1c6a5768-89b1-4a68-8c85-9f8db4609bcf"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  ID             : 781e7556-4489-42bc-aa94-1decf6a395d6
+  LogonName      : i:0#.f|membership|john@contoso.onmicrosoft.com
+  SiteDesignID   : 00281728-3bc1-41d3-92b6-8fc493dcf4cc
+  SiteDesignStore: 0
+  SiteID         : 5fc2ea61-7204-41be-9d05-d44f017f958b
+  WebID          : 1c6a5768-89b1-4a68-8c85-9f8db4609bcf
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  ID,LogonName,SiteDesignID,SiteDesignStore,SiteID,WebID
+  781e7556-4489-42bc-aa94-1decf6a395d6,i:0#.f|membership|john@contoso.onmicrosoft.com,00281728-3bc1-41d3-92b6-8fc493dcf4cc,0,5fc2ea61-7204-41be-9d05-d44f017f958b,1c6a5768-89b1-4a68-8c85-9f8db4609bcf
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo sitedesign apply --id "00281728-3bc1-41d3-92b6-8fc493dcf4cc" --webUrl "https://contoso.sharepoint.com/teams/spoteam1" --asTask "true"
+
+  Date: 2023-06-22
+
+  ## 781e7556-4489-42bc-aa94-1decf6a395d6
+
+  Property | Value
+  ---------|-------
+  ID | 781e7556-4489-42bc-aa94-1decf6a395d6
+  LogonName | i:0#.f\|membership\|john@contoso.onmicrosoft.com
+  SiteDesignID | 00281728-3bc1-41d3-92b6-8fc493dcf4cc
+  SiteDesignStore | 0
+  SiteID | 5fc2ea61-7204-41be-9d05-d44f017f958b
+  WebID | 1c6a5768-89b1-4a68-8c85-9f8db4609bcf
+  ```
+
+  </TabItem>
+</Tabs>
+
 ## More information
 
 - SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)

package/docs/docs/cmd/spo/sitedesign/sitedesign-get.mdx

@@ -1,4 +1,6 @@
 import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
 
 # spo sitedesign get
 
@@ -40,6 +42,121 @@ Get information about the site design with title _Contoso Site Design_
 m365 spo sitedesign get --title "Contoso Site Design"
 ```
 
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "Description": null,
+    "DesignPackageId": "00000000-0000-0000-0000-000000000000",
+    "DesignType": "0",
+    "ExpandedPreviewImages": [],
+    "InternalName": null,
+    "IsDefault": false,
+    "IsOutOfBoxTemplate": false,
+    "IsTenantAdminOnly": false,
+    "ListColor": "0",
+    "ListIcon": "0",
+    "PreviewImageAltText": null,
+    "PreviewImageUrl": null,
+    "RequiresClassConnected": false,
+    "RequiresGroupConnected": false,
+    "RequiresSyntexLicense": false,
+    "RequiresTeamsConnected": false,
+    "RequiresYammerConnected": false,
+    "SiteScriptIds": [
+      "0c88bed7-943b-42aa-8fef-8fb69eebe3fe"
+    ],
+    "SupportedWebTemplates": [],
+    "TargetPlatforms": [],
+    "TemplateAssets": [],
+    "TemplateFeatures": [],
+    "ThumbnailUrl": null,
+    "Title": "Contoso team site",
+    "WebTemplate": "64",
+    "Id": "00281728-3bc1-41d3-92b6-8fc493dcf4cc",
+    "Order": null,
+    "Version": 1
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Description            : null
+  DesignPackageId        : 00000000-0000-0000-0000-000000000000
+  DesignType             : 0
+  ExpandedPreviewImages  : []
+  Id                     : 00281728-3bc1-41d3-92b6-8fc493dcf4cc
+  InternalName           : null
+  IsDefault              : false
+  IsOutOfBoxTemplate     : false
+  IsTenantAdminOnly      : false
+  ListColor              : 0
+  ListIcon               : 0
+  Order                  : null
+  PreviewImageAltText    : null
+  PreviewImageUrl        : null
+  RequiresClassConnected : false
+  RequiresGroupConnected : false
+  RequiresSyntexLicense  : false
+  RequiresTeamsConnected : false
+  RequiresYammerConnected: false
+  SiteScriptIds          : ["0c88bed7-943b-42aa-8fef-8fb69eebe3fe"]
+  SupportedWebTemplates  : []
+  TargetPlatforms        : []
+  TemplateAssets         : []
+  TemplateFeatures       : []
+  ThumbnailUrl           : null
+  Title                  : Contoso team site
+  Version                : 1
+  WebTemplate            : 64
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  DesignPackageId,DesignType,IsDefault,IsOutOfBoxTemplate,IsTenantAdminOnly,ListColor,ListIcon,RequiresClassConnected,RequiresGroupConnected,RequiresSyntexLicense,RequiresTeamsConnected,RequiresYammerConnected,Title,WebTemplate,Id,Version
+  00000000-0000-0000-0000-000000000000,0,,,,0,0,,,,,,Contoso team site,64,00281728-3bc1-41d3-92b6-8fc493dcf4cc,1
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo sitedesign get --id "00281728-3bc1-41d3-92b6-8fc493dcf4cc"
+
+  Date: 2023-06-22
+
+  ## Contoso team site (00281728-3bc1-41d3-92b6-8fc493dcf4cc)
+
+  Property | Value
+  ---------|-------
+  DesignPackageId | 00000000-0000-0000-0000-000000000000
+  DesignType | 0
+  IsDefault | false
+  IsOutOfBoxTemplate | false
+  IsTenantAdminOnly | false
+  ListColor | 0
+  ListIcon | 0
+  RequiresClassConnected | false
+  RequiresGroupConnected | false
+  RequiresSyntexLicense | false
+  RequiresTeamsConnected | false
+  RequiresYammerConnected | false
+  Title | Contoso team site
+  WebTemplate | 64
+  Id | 00281728-3bc1-41d3-92b6-8fc493dcf4cc
+  Version | 1
+  ```
+
+  </TabItem>
+</Tabs>
+
 ## More information
 
 - SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)

package/docs/docs/cmd/spo/sitedesign/sitedesign-list.mdx

@@ -1,4 +1,6 @@
 import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
 
 # spo sitedesign list
 
@@ -22,6 +24,98 @@ List available site designs
 m365 spo sitedesign list
 ```
 
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Description": null,
+      "DesignPackageId": "00000000-0000-0000-0000-000000000000",
+      "DesignType": "0",
+      "ExpandedPreviewImages": [],
+      "InternalName": null,
+      "IsDefault": false,
+      "IsOutOfBoxTemplate": false,
+      "IsTenantAdminOnly": false,
+      "ListColor": "0",
+      "ListIcon": "0",
+      "PreviewImageAltText": null,
+      "PreviewImageUrl": null,
+      "RequiresClassConnected": false,
+      "RequiresGroupConnected": false,
+      "RequiresSyntexLicense": false,
+      "RequiresTeamsConnected": false,
+      "RequiresYammerConnected": false,
+      "SiteScriptIds": [
+        "0c88bed7-943b-42aa-8fef-8fb69eebe3fe"
+      ],
+      "SupportedWebTemplates": [],
+      "TargetPlatforms": [],
+      "TemplateAssets": [],
+      "TemplateFeatures": [],
+      "ThumbnailUrl": null,
+      "Title": "Contoso team site",
+      "WebTemplate": "64",
+      "Id": "00281728-3bc1-41d3-92b6-8fc493dcf4cc",
+      "Order": null,
+      "Version": 1
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Id                                    IsDefault  Title                      Version  WebTemplate
+  ------------------------------------  ---------  -------------------------  -------  -----------
+  00281728-3bc1-41d3-92b6-8fc493dcf4cc  false      Contoso team site          1        64
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Description,DesignPackageId,DesignType,IsDefault,IsOutOfBoxTemplate,IsTenantAdminOnly,ListColor,ListIcon,PreviewImageAltText,RequiresClassConnected,RequiresGroupConnected,RequiresSyntexLicense,RequiresTeamsConnected,RequiresYammerConnected,ThumbnailUrl,Title,WebTemplate,Id,Version
+  "",00000000-0000-0000-0000-000000000000,0,,,,0,0,,,,,,,,Contoso team site,64,00281728-3bc1-41d3-92b6-8fc493dcf4cc,1
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo sitedesign list
+
+  Date: 2023-06-22
+
+  ## Contoso team site (00281728-3bc1-41d3-92b6-8fc493dcf4cc)
+
+  Property | Value
+  ---------|-------
+  DesignPackageId | 00000000-0000-0000-0000-000000000000
+  DesignType | 0
+  IsDefault | false
+  IsOutOfBoxTemplate | false
+  IsTenantAdminOnly | false
+  ListColor | 0
+  ListIcon | 0
+  RequiresClassConnected | false
+  RequiresGroupConnected | false
+  RequiresSyntexLicense | false
+  RequiresTeamsConnected | false
+  RequiresYammerConnected | false
+  Title | Contoso team site
+  WebTemplate | 64
+  Id | 00281728-3bc1-41d3-92b6-8fc493dcf4cc
+  Version | 1
+  ```
+
+  </TabItem>
+</Tabs>
+
 ## More information
 
 - SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)

package/docs/docs/cmd/spo/sitedesign/sitedesign-remove.mdx

@@ -40,6 +40,10 @@ Remove site design with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_ without prompt
 m365 spo sitedesign remove --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --force
 ```
 
+## Response
+
+The command won't return a response on success.
+
 ## More information
 
 - SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)

package/docs/docs/cmd/spo/sitedesign/sitedesign-rights-grant.mdx

@@ -45,6 +45,10 @@ Grant user by email view permission to the specified site design
 m365 spo sitedesign rights grant --siteDesignId 9b142c22-037f-4a7f-9017-e9d8c0e34b98 --principals PattiF@contoso.com --rights View
 ```
 
+## Response
+
+The command won't return a response on success.
+
 ## More information
 
 - SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)

package/docs/docs/cmd/spo/sitedesign/sitedesign-rights-list.mdx

@@ -1,4 +1,6 @@
 import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
 
 # spo sitedesign rights list
 
@@ -33,6 +35,58 @@ Get information about rights granted for the site design with ID _2c1ba4c4-cd9b-
 m365 spo sitedesign rights list --siteDesignId 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
 ```
 
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "DisplayName": "John",
+      "PrincipalName": "i:0#.f|membership|john@contoso.onmicrosoft.com",
+      "Rights": "View"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  DisplayName  PrincipalName                                  Rights
+  -----------  ---------------------------------------------  ------
+  John         i:0#.f|membership|john@contoso.onmicrosoft.com  View
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  DisplayName,PrincipalName,Rights
+  John,i:0#.f|membership|john@contoso.onmicrosoft.com,View
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo sitedesign rights list --siteDesignId "00281728-3bc1-41d3-92b6-8fc493dcf4cc"
+
+  Date: 2023-06-22
+
+  ## John
+
+  Property | Value
+  ---------|-------
+  DisplayName | John
+  PrincipalName | i:0#.f\|membership\|john@contoso.onmicrosoft.com
+  Rights | View
+  ```
+
+  </TabItem>
+</Tabs>
+
 ## More information
 
 - SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)

package/docs/docs/cmd/spo/sitedesign/sitedesign-rights-revoke.mdx

@@ -47,6 +47,10 @@ Revoke access to the site design with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_
 m365 spo sitedesign rights revoke --siteDesignId 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --principals "PattiF,AdeleV" --force
 ```
 
+## Response
+
+The command won't return a response on success.
+
 ## More information
 
 - SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)

package/docs/docs/cmd/spo/sitedesign/sitedesign-run-list.mdx

@@ -1,4 +1,6 @@
 import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
 
 # spo sitedesign run list
 
@@ -36,6 +38,70 @@ List information about the specified site design applied to the specified site
 m365 spo sitedesign run list --webUrl https://contoso.sharepoint.com/sites/team-a --siteDesignId 6ec3ca5b-d04b-4381-b169-61378556d76e
 ```
 
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "ActionTrigger": 0,
+      "ID": "8d41a2b7-ffb9-487c-994a-d25cf1b74f6a",
+      "InvokedBy": "John",
+      "SiteDesignID": "00281728-3bc1-41d3-92b6-8fc493dcf4cc",
+      "SiteDesignTitle": "Contoso team site",
+      "SiteDesignVersion": 1,
+      "SiteID": "5fc2ea61-7204-41be-9d05-d44f017f958b",
+      "StartTime": "1687422166000",
+      "WebID": "1c6a5768-89b1-4a68-8c85-9f8db4609bcf"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  ID                                    SiteDesignID                          SiteDesignTitle    StartTime
+  ------------------------------------  ------------------------------------  -----------------  --------------------
+  8d41a2b7-ffb9-487c-994a-d25cf1b74f6a  00281728-3bc1-41d3-92b6-8fc493dcf4cc  Contoso team site  2023-06-22, 10:22:46
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  ActionTrigger,ID,InvokedBy,SiteDesignID,SiteDesignTitle,SiteDesignVersion,SiteID,StartTime,WebID
+  0,8d41a2b7-ffb9-487c-994a-d25cf1b74f6a,John,00281728-3bc1-41d3-92b6-8fc493dcf4cc,Contoso team site,1,5fc2ea61-7204-41be-9d05-d44f017f958b,"2023-06-22, 10:22:46",1c6a5768-89b1-4a68-8c85-9f8db4609bcf
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo sitedesign run list --webUrl "https://contoso.sharepoint.com/teams/team1"
+
+  Date: 2023-06-22
+
+  ## 8d41a2b7-ffb9-487c-994a-d25cf1b74f6a
+
+  Property | Value
+  ---------|-------
+  ActionTrigger | 0
+  ID | 8d41a2b7-ffb9-487c-994a-d25cf1b74f6a
+  InvokedBy | John
+  SiteDesignID | 00281728-3bc1-41d3-92b6-8fc493dcf4cc
+  SiteDesignTitle | Contoso team site
+  SiteDesignVersion | 1
+  SiteID | 5fc2ea61-7204-41be-9d05-d44f017f958b
+  StartTime | 2023-06-22, 10:22:46
+  WebID | 1c6a5768-89b1-4a68-8c85-9f8db4609bcf
+  ```
+
+  </TabItem>
+</Tabs>
+
 ## More information
 
 - SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)

package/docs/docs/cmd/spo/sitedesign/sitedesign-run-status-get.mdx

@@ -1,4 +1,6 @@
 import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
 
 # spo sitedesign run status get
 
@@ -34,6 +36,69 @@ List information about site scripts executed for the specified site design
 m365 spo sitedesign run status get --webUrl https://contoso.sharepoint.com/sites/team-a --runId b4411557-308b-4545-a3c4-55297d5cd8c8
 ```
 
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "ActionIndex": 0,
+      "ActionKey": "00000000-0000-0000-0000-000000000000",
+      "ActionTitle": "Activate feature f151bb39-7c3b-414f-bb36-6bf18872052f",
+      "LastModified": "1687422166000",
+      "OrdinalIndex": 0,
+      "OutcomeCode": 0,
+      "OutcomeText": null,
+      "SiteScriptID": "0c88bed7-943b-42aa-8fef-8fb69eebe3fe",
+      "SiteScriptIndex": 0,
+      "SiteScriptTitle": "Contoso"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  ActionTitle    : Activate feature f151bb39-7c3b-414f-bb36-6bf18872052f
+  OutcomeText    : null
+  SiteScriptTitle: Contoso
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  ActionIndex,ActionKey,ActionTitle,LastModified,OrdinalIndex,OutcomeCode,SiteScriptID,SiteScriptIndex,SiteScriptTitle
+  0,00000000-0000-0000-0000-000000000000,Activate feature f151bb39-7c3b-414f-bb36-6bf18872052f,1687422166000,0,0,0c88bed7-943b-42aa-8fef-8fb69eebe3fe,0,Contoso
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo sitedesign run status get --webUrl "https://contoso.sharepoint.com/teams/team1" --runId "8d41a2b7-ffb9-487c-994a-d25cf1b74f6a"
+
+  Date: 2023-06-22
+
+  Property | Value
+  ---------|-------
+  ActionIndex | 0
+  ActionKey | 00000000-0000-0000-0000-000000000000
+  ActionTitle | Activate feature f151bb39-7c3b-414f-bb36-6bf18872052f
+  LastModified | 1687422166000
+  OrdinalIndex | 0
+  OutcomeCode | 0
+  SiteScriptID | 0c88bed7-943b-42aa-8fef-8fb69eebe3fe
+  SiteScriptIndex | 0
+  SiteScriptTitle | Contoso
+  ```
+
+  </TabItem>
+</Tabs>
+
 ## More information
 
 - SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)