@pnp/cli-microsoft365 6.3.0-beta.e0fa4e0 → 6.3.0-beta.e40d7b4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/dist/m365/aad/commands/user/user-add.js +223 -0
  2. package/dist/m365/aad/commands/user/user-license-list.js +99 -0
  3. package/dist/m365/aad/commands/user/user-recyclebinitem-list.js +41 -0
  4. package/dist/m365/aad/commands/user/user-remove.js +107 -0
  5. package/dist/m365/aad/commands.js +4 -0
  6. package/dist/m365/flow/commands/environment/FlowEnvironmentDetails.js +3 -0
  7. package/dist/m365/flow/commands/environment/environment-get.js +26 -11
  8. package/docs/docs/cmd/aad/user/user-add.md +168 -0
  9. package/docs/docs/cmd/aad/user/user-license-list.md +98 -0
  10. package/docs/docs/cmd/aad/user/user-recyclebinitem-clear.md +1 -1
  11. package/docs/docs/cmd/aad/user/user-recyclebinitem-list.md +82 -0
  12. package/docs/docs/cmd/aad/user/user-recyclebinitem-remove.md +1 -1
  13. package/docs/docs/cmd/aad/user/user-remove.md +51 -0
  14. package/docs/docs/cmd/aad/user/user-set.md +1 -1
  15. package/docs/docs/cmd/flow/environment/environment-get.md +31 -3
  16. package/docs/docs/cmd/spo/homesite/homesite-get.md +20 -1
  17. package/docs/docs/cmd/spo/homesite/homesite-remove.md +8 -2
  18. package/docs/docs/cmd/spo/homesite/homesite-set.md +8 -2
  19. package/docs/docs/cmd/spo/hubsite/hubsite-connect.md +9 -9
  20. package/docs/docs/cmd/spo/hubsite/hubsite-data-get.md +34 -5
  21. package/docs/docs/cmd/spo/hubsite/hubsite-disconnect.md +6 -6
  22. package/docs/docs/cmd/spo/hubsite/hubsite-get.md +36 -19
  23. package/docs/docs/cmd/spo/hubsite/hubsite-list.md +59 -1
  24. package/docs/docs/cmd/spo/hubsite/hubsite-register.md +30 -1
  25. package/docs/docs/cmd/spo/hubsite/hubsite-rights-grant.md +6 -6
  26. package/docs/docs/cmd/spo/hubsite/hubsite-rights-revoke.md +4 -4
  27. package/docs/docs/cmd/spo/hubsite/hubsite-set.md +40 -15
  28. package/docs/docs/cmd/spo/hubsite/hubsite-unregister.md +4 -4
  29. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-get.md +7 -1
  30. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-remove.md +9 -3
  31. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-set.md +8 -2
  32. package/docs/docs/cmd/spo/list/list-add.md +123 -57
  33. package/docs/docs/cmd/spo/list/list-contenttype-add.md +49 -4
  34. package/docs/docs/cmd/spo/list/list-contenttype-default-set.md +3 -3
  35. package/docs/docs/cmd/spo/list/list-contenttype-list.md +48 -3
  36. package/docs/docs/cmd/spo/list/list-contenttype-remove.md +5 -5
  37. package/docs/docs/cmd/spo/list/list-get.md +70 -4
  38. package/docs/docs/cmd/spo/list/list-list.md +70 -2
  39. package/docs/docs/cmd/spo/list/list-remove.md +6 -6
  40. package/docs/docs/cmd/spo/list/list-retentionlabel-ensure.md +2 -2
  41. package/docs/docs/cmd/spo/list/list-retentionlabel-get.md +36 -3
  42. package/docs/docs/cmd/spo/list/list-retentionlabel-remove.md +3 -3
  43. package/docs/docs/cmd/spo/list/list-roleassignment-add.md +6 -6
  44. package/docs/docs/cmd/spo/list/list-roleassignment-remove.md +3 -3
  45. package/docs/docs/cmd/spo/list/list-roleinheritance-break.md +9 -9
  46. package/docs/docs/cmd/spo/list/list-roleinheritance-reset.md +7 -7
  47. package/docs/docs/cmd/spo/list/list-set.md +61 -61
  48. package/docs/docs/cmd/spo/list/list-sitescript-get.md +35 -3
  49. package/docs/docs/cmd/spo/list/list-view-add.md +66 -5
  50. package/docs/docs/cmd/spo/list/list-view-field-add.md +10 -10
  51. package/docs/docs/cmd/spo/list/list-view-get.md +61 -0
  52. package/docs/docs/cmd/spo/list/list-view-list.md +61 -0
  53. package/docs/docs/cmd/spo/list/list-view-set.md +1 -1
  54. package/docs/docs/cmd/spo/list/list-webhook-add.md +19 -0
  55. package/docs/docs/cmd/spo/list/list-webhook-get.md +19 -0
  56. package/docs/docs/cmd/spo/list/list-webhook-list.md +19 -0
  57. package/docs/docs/cmd/spo/listitem/listitem-add.md +29 -0
  58. package/docs/docs/cmd/spo/listitem/listitem-attachment-list.md +17 -2
  59. package/docs/docs/cmd/spo/listitem/listitem-get.md +57 -0
  60. package/docs/docs/cmd/spo/listitem/listitem-isrecord.md +6 -0
  61. package/docs/docs/cmd/spo/listitem/listitem-list.md +28 -0
  62. package/docs/docs/cmd/spo/listitem/listitem-record-declare.md +15 -0
  63. package/docs/docs/cmd/spo/listitem/listitem-set.md +30 -0
  64. package/docs/docs/cmd/spo/navigation/navigation-node-add.md +22 -0
  65. package/package.json +1 -1
@@ -11,23 +11,22 @@ m365 spo hubsite data get [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site for which to retrieve hub site data
14
+ : URL of the site for which to retrieve hub site data.
15
15
 
16
16
  `-f, --forceRefresh`
17
- : Set, to refresh the server cache with the latest updates
17
+ : Set, to refresh the server cache with the latest updates.
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
21
21
  ## Remarks
22
22
 
23
- By default, the hub site data is returned from the server's cache. To refresh the data with the latest updates, use the `-f, --forceRefresh` option. Use this option, if you just made changes and need to see them right
24
- away.
23
+ By default, the hub site data is returned from the server's cache. To refresh the data with the latest updates, use the `-f, --forceRefresh` option. Use this option, if you just made changes and need to see them right away.
25
24
 
26
25
  If the specified site is not connected to a hub site site and is not a hub site itself, no data will be retrieved.
27
26
 
28
27
  ## Examples
29
28
 
30
- Get information about the hub site data for a site with URL https://contoso.sharepoint.com/sites/project-x
29
+ Get information about the hub site data for a specific site with URL.
31
30
 
32
31
  ```sh
33
32
  m365 spo hubsite data get --webUrl https://contoso.sharepoint.com/sites/project-x
@@ -90,6 +89,36 @@ m365 spo hubsite data get --webUrl https://contoso.sharepoint.com/sites/project-
90
89
  None,7EDE94FF,Intranet,https://contoso.sharepoint.com/sites/intra,https://contoso.sharepoint.com/sites/intra/SiteAssets/work.png,637696294610000000,false,1,[],false,184644fb-90ed-4841-a7ad-6930cf819060,,,1e1232eb-1a78-4726-8bb9-56af3640228d,"[""af80c11f-0138-4d72-bb37-514542c3aabb""]",4d128b52-7228-46b5-8765-5b338476054d,1
91
90
  ```
92
91
 
92
+ === "Markdown"
93
+
94
+ ```md
95
+ # spo hubsite data get --webUrl "https://contoso.sharepoint.com/sites/intra"
96
+
97
+ Date: 2/20/2023
98
+
99
+ ## Intranet (https://contoso.sharepoint.com/sites/intra)
100
+
101
+ Property | Value
102
+ ---------|-------
103
+ headerEmphasis | None
104
+ themeKey | 7EDE94FF
105
+ name | Intranet
106
+ url | https://contoso.sharepoint.com/sites/intra
107
+ logoUrl | https://contoso.sharepoint.com/sites/intra/SiteAssets/work.png
108
+ logoFileHash | 637696294610000000
109
+ usesMetadataNavigation | false
110
+ megaMenuEnabled | true
111
+ navigation | []
112
+ isNavAudienceTargeted | false
113
+ siteDesignId | 184644fb-90ed-4841-a7ad-6930cf819060
114
+ requiresJoinApproval | false
115
+ hideNameInNavigation | false
116
+ parentHubSiteId | 1e1232eb-1a78-4726-8bb9-56af3640228d
117
+ relatedHubSiteIds | ["af80c11f-0138-4d72-bb37-514542c3aabb"]
118
+ tenantInstanceId | 4d128b52-7228-46b5-8765-5b338476054d
119
+ isSameTenantInstance | true
120
+ ```
121
+
93
122
  ## More information
94
123
 
95
124
  - 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)
@@ -11,13 +11,13 @@ m365 spo hubsite disconnect [options]
11
11
  ## Options
12
12
 
13
13
  `-i, --id [id]`
14
- : ID of the hub site. Specify either `id`, `title` or `url` but not multiple.
14
+ : ID of the hub site. Specify either `id`, `title`, or `url` but not multiple.
15
15
 
16
16
  `-t, --title [title]`
17
- : Title of the hub site. Specify either `id`, `title` or `url` but not multiple.
17
+ : Title of the hub site. Specify either `id`, `title`, or `url` but not multiple.
18
18
 
19
19
  `-u, --url [url]`
20
- : Absolute or server-relative URL of the hub site. Specify either `id`, `title` or `url` but not multiple.
20
+ : Absolute or server-relative URL of the hub site. Specify either `id`, `title`, or `url` but not multiple.
21
21
 
22
22
  `--confirm`
23
23
  : Don't prompt for confirmation.
@@ -35,19 +35,19 @@ If the specified id doesn't point to a valid hub site, you will get a ResourceNo
35
35
 
36
36
  ## Examples
37
37
 
38
- Disconnect a specific hub site with id from its parent hub site
38
+ Disconnect a specific hub site with id from its parent hub site.
39
39
 
40
40
  ```sh
41
41
  m365 spo hubsite disconnect --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
42
42
  ```
43
43
 
44
- Disconnect a specific hub site with url from its parent hub site
44
+ Disconnect a specific hub site with url from its parent hub site.
45
45
 
46
46
  ```sh
47
47
  m365 spo hubsite disconnect --url https://contoso.sharepoint.com/sites/project-x
48
48
  ```
49
49
 
50
- Disconnect a specific hub site with title from its parent hub site
50
+ Disconnect a specific hub site with title from its parent hub site.
51
51
 
52
52
  ```sh
53
53
  m365 spo hubsite disconnect --title "My hub site"
@@ -11,13 +11,13 @@ m365 spo hubsite get [options]
11
11
  ## Options
12
12
 
13
13
  `-i, --id [id]`
14
- : ID of the hub site. Specify either `id`, `title` or `url` but not multiple.
14
+ : ID of the hub site. Specify either `id`, `title`, or `url` but not multiple.
15
15
 
16
16
  `-t, --title [title]`
17
- : Title of the hub site. Specify either `id`, `title` or `url` but not multiple.
17
+ : Title of the hub site. Specify either `id`, `title`, or `url` but not multiple.
18
18
 
19
19
  `-u, --url [url]`
20
- : URL of the hub site. Specify either `id`, `title` or `url` but not multiple.
20
+ : URL of the hub site. Specify either `id`, `title`, or `url` but not multiple.
21
21
 
22
22
  `--includeAssociatedSites`
23
23
  : Include the associated sites in the result (only in JSON output)
@@ -26,42 +26,30 @@ m365 spo hubsite get [options]
26
26
 
27
27
  ## Examples
28
28
 
29
- Get information about the hub site with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_
29
+ Get information about the hub site with specific ID.
30
30
 
31
31
  ```sh
32
32
  m365 spo hubsite get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
33
33
  ```
34
34
 
35
- Get information about the hub site with Title _My Hub Site_
35
+ Get information about the hub site with specific title.
36
36
 
37
37
  ```sh
38
38
  m365 spo hubsite get --title 'My Hub Site'
39
39
  ```
40
40
 
41
- Get information about the hub site with URL _https://contoso.sharepoint.com/sites/HubSite_
41
+ Get information about the hub site with specific URL.
42
42
 
43
43
  ```sh
44
44
  m365 spo hubsite get --url 'https://contoso.sharepoint.com/sites/HubSite'
45
45
  ```
46
46
 
47
- Get information about the hub site with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_, including its associated sites. Associated site info is only shown in JSON output.
47
+ Get information about the hub site with specific ID, including its associated sites. Associated site info is only shown in JSON output.
48
48
 
49
49
  ```sh
50
50
  m365 spo hubsite get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --includeAssociatedSites --output json
51
51
  ```
52
52
 
53
- Get information about the hub site with Title _My Hub Site_
54
-
55
- ```sh
56
- m365 spo hubsite get --title "My Hub Site"
57
- ```
58
-
59
- Get information about the hub site with URL _https://contoso.sharepoint.com/sites/HubSite_
60
-
61
- ```sh
62
- m365 spo hubsite get --url "https://contoso.sharepoint.com/sites/HubSite"
63
- ```
64
-
65
53
  ## Response
66
54
 
67
55
  ### Standard response
@@ -117,6 +105,35 @@ m365 spo hubsite get --url "https://contoso.sharepoint.com/sites/HubSite"
117
105
  Intranet Hub Site,false,,0,false,af80c11f-0138-4d72-bb37-514542c3aabb,https://contoso.sharepoint.com/sites/intra/SiteAssets/work.png,ec78f3aa-5a74-4f16-be49-3396df045f34,0,false,184644fb-90ed-4841-a7ad-6930cf819060,af80c11f-0138-4d72-bb37-514542c3aabb,https://contoso.sharepoint.com/sites/intra,,5d128b52-7228-46b5-8765-5b338476054d,Intranet
118
106
  ```
119
107
 
108
+ === "Markdown"
109
+
110
+ ```md
111
+ # spo hubsite get --url "https://contoso.sharepoint.com/sites/intra"
112
+
113
+ Date: 2/20/2023
114
+
115
+ ## Intranet (af80c11f-0138-4d72-bb37-514542c3aabb)
116
+
117
+ Property | Value
118
+ ---------|-------
119
+ Description | null
120
+ EnablePermissionsSync | false
121
+ EnforcedECTs | null
122
+ EnforcedECTsVersion | 0
123
+ HideNameInNavigation | false
124
+ ID | af80c11f-0138-4d72-bb37-514542c3aabb
125
+ LogoUrl | https://contoso.sharepoint.com/sites/intra/SiteAssets/work.png
126
+ ParentHubSiteId | ec78f3aa-5a74-4f16-be49-3396df045f34
127
+ PermissionsSyncTag | 0
128
+ RequiresJoinApproval | false
129
+ SiteDesignId | 184644fb-90ed-4841-a7ad-6930cf819060
130
+ SiteId | af80c11f-0138-4d72-bb37-514542c3aabb
131
+ SiteUrl | https://contoso.sharepoint.com/sites/intra
132
+ Targets | null
133
+ TenantInstanceId | 5d128b52-7228-46b5-8765-5b338476054d
134
+ Title | Intranet
135
+ ```
136
+
120
137
  ### `includeAssociatedSites` response
121
138
 
122
139
  When we make use of the option `includeAssociatedSites` the response will differ. This command can only be executed using --output json or an error will be thrown.
@@ -11,7 +11,7 @@ m365 spo hubsite list [options]
11
11
  ## Options
12
12
 
13
13
  `-i, --includeAssociatedSites`
14
- : Include the associated sites in the result (only in JSON output)
14
+ : Include the associated sites in the result (only in JSON output).
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
@@ -77,6 +77,35 @@ m365 spo hubsite list --includeAssociatedSites --output json
77
77
  af80c11f-0138-4d72-bb37-514542c3aabb,https://contoso.sharepoint.com/sites/intra,Intranet
78
78
  ```
79
79
 
80
+ === "Markdown"
81
+
82
+ ```md
83
+ # spo hubsite list
84
+
85
+ Date: 2/20/2023
86
+
87
+ ## Intranet (af80c11f-0138-4d72-bb37-514542c3aabb)
88
+
89
+ Property | Value
90
+ ---------|-------
91
+ Description | Intranet Hub Site
92
+ EnablePermissionsSync | false
93
+ EnforcedECTs | null
94
+ EnforcedECTsVersion | 0
95
+ HideNameInNavigation | false
96
+ ID | af80c11f-0138-4d72-bb37-514542c3aabb
97
+ LogoUrl | https://contoso.sharepoint.com/sites/intra/SiteAssets/work.png
98
+ ParentHubSiteId | ec78f3aa-5a74-4f16-be49-3396df045f34
99
+ PermissionsSyncTag | 0
100
+ RequiresJoinApproval | false
101
+ SiteDesignId | 184644fb-90ed-4841-a7ad-6930cf819060
102
+ SiteId | af80c11f-0138-4d72-bb37-514542c3aabb
103
+ SiteUrl | https://contoso.sharepoint.com/sites/intra
104
+ Targets | null
105
+ TenantInstanceId | 5d128b52-7228-46b5-8765-5b338476054d
106
+ Title | Intranet
107
+ ```
108
+
80
109
  ### `includeAssociatedSites` response
81
110
 
82
111
  When we make use of the option `includeAssociatedSites` the response will differ.
@@ -127,6 +156,35 @@ When we make use of the option `includeAssociatedSites` the response will differ
127
156
  af80c11f-0138-4d72-bb37-514542c3aabb,https://contoso.sharepoint.com/sites/intra,Intranet
128
157
  ```
129
158
 
159
+ === "Markdown"
160
+
161
+ ```md
162
+ # spo hubsite list --includeAssociatedSites "true"
163
+
164
+ Date: 2/20/2023
165
+
166
+ ## Intranet (af80c11f-0138-4d72-bb37-514542c3aabb)
167
+
168
+ Property | Value
169
+ ---------|-------
170
+ Description | Intranet Hub Site
171
+ EnablePermissionsSync | false
172
+ EnforcedECTs | null
173
+ EnforcedECTsVersion | 0
174
+ HideNameInNavigation | false
175
+ ID | af80c11f-0138-4d72-bb37-514542c3aabb
176
+ LogoUrl | https://contoso.sharepoint.com/sites/intra/SiteAssets/work.png
177
+ ParentHubSiteId | ec78f3aa-5a74-4f16-be49-3396df045f34
178
+ PermissionsSyncTag | 0
179
+ RequiresJoinApproval | false
180
+ SiteDesignId | 184644fb-90ed-4841-a7ad-6930cf819060
181
+ SiteId | af80c11f-0138-4d72-bb37-514542c3aabb
182
+ SiteUrl | https://contoso.sharepoint.com/sites/intra
183
+ Targets | null
184
+ TenantInstanceId | 5d128b52-7228-46b5-8765-5b338476054d
185
+ Title | Intranet
186
+ ```
187
+
130
188
  ## More information
131
189
 
132
190
  - 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)
@@ -11,7 +11,7 @@ m365 spo hubsite register [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --siteUrl <siteUrl>`
14
- : URL of the site collection to register as a hub site
14
+ : URL of the site collection to register as a hub site.
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
@@ -83,6 +83,35 @@ m365 spo hubsite register --siteUrl https://contoso.sharepoint.com/sites/sales
83
83
  ,,,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
84
84
  ```
85
85
 
86
+ === "Markdown"
87
+
88
+ ```md
89
+ # spo hubsite register --siteUrl "https://contoso.sharepoint.com/sites/newHubSite"
90
+
91
+ Date: 2/20/2023
92
+
93
+ ## New Hub Site (0f9b8f4f-0e8e-4630-bb0a-501442db9b64)
94
+
95
+ Property | Value
96
+ ---------|-------
97
+ Description | null
98
+ EnablePermissionsSync | false
99
+ EnforcedECTs | null
100
+ EnforcedECTsVersion | 0
101
+ HideNameInNavigation | false
102
+ ID | 0f9b8f4f-0e8e-4630-bb0a-501442db9b64
103
+ LogoUrl | null
104
+ ParentHubSiteId | 00000000-0000-0000-0000-000000000000
105
+ PermissionsSyncTag | 0
106
+ RequiresJoinApproval | false
107
+ SiteDesignId | 00000000-0000-0000-0000-000000000000
108
+ SiteId | 0f9b8f4f-0e8e-4630-bb0a-501442db9b64
109
+ SiteUrl | https://contoso.sharepoint.com/sites/newHubSite
110
+ Targets | null
111
+ TenantInstanceId | 4d128b52-7228-46b5-8765-5b338476054d
112
+ Title | New Hub Site
113
+ ```
114
+
86
115
  ## More information
87
116
 
88
117
  - 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)
@@ -11,13 +11,13 @@ m365 spo hubsite rights grant [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --hubSiteUrl <hubSiteUrl>`
14
- : The URL of the hub site to grant rights on
14
+ : The URL of the hub site to grant rights on.
15
15
 
16
16
  `-p, --principals <principals>`
17
- : Comma-separated list of principals to grant join rights. Principals can be users or mail-enabled security groups in the form of `alias` or `alias@<domain name>.com`
17
+ : Comma-separated list of principals to grant join rights. Principals can be users or mail-enabled security groups in the form of `alias` or `alias@<domain name>.com`.
18
18
 
19
19
  `-r, --rights <rights>`
20
- : Rights to grant to principals. Available values `Join`
20
+ : Rights to grant to principals. Available values `Join`.
21
21
 
22
22
  --8<-- "docs/cmd/_global.md"
23
23
 
@@ -28,19 +28,19 @@ m365 spo hubsite rights grant [options]
28
28
 
29
29
  ## Examples
30
30
 
31
- Grant user with alias _PattiF_ permission to join sites to the hub site with URL _https://contoso.sharepoint.com/sites/sales_
31
+ Grant user with specific alias, permission to join sites to the hub site with specific URL.
32
32
 
33
33
  ```sh
34
34
  m365 spo hubsite rights grant --hubSiteUrl https://contoso.sharepoint.com/sites/sales --principals PattiF --rights Join
35
35
  ```
36
36
 
37
- Grant users with aliases _PattiF_ and _AdeleV_ permission to join sites to the hub site with URL _https://contoso.sharepoint.com/sites/sales_
37
+ Grant users with specific aliases, permission to join sites to the hub site with specific URL.
38
38
 
39
39
  ```sh
40
40
  m365 spo hubsite rights grant --hubSiteUrl https://contoso.sharepoint.com/sites/sales --principals "PattiF,AdeleV" --rights Join
41
41
  ```
42
42
 
43
- Grant user with email _PattiF@contoso.com_ permission to join sites to the hub site with URL _https://contoso.sharepoint.com/sites/sales_
43
+ Grant user with specific email, permission to join sites to the hub site with specific URL.
44
44
 
45
45
  ```sh
46
46
  m365 spo hubsite rights grant --hubSiteUrl https://contoso.sharepoint.com/sites/sales --principals PattiF@contoso.com --rights Join
@@ -11,10 +11,10 @@ m365 spo hubsite rights revoke [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --hubSiteUrl <hubSiteUrl>`
14
- : The URL of the hub site to revoke rights on
14
+ : The URL of the hub site to revoke rights on.
15
15
 
16
16
  `-p, --principals <principals>`
17
- : Comma-separated list of principals to revoke join rights. Principals can be users or mail-enabled security groups in the form of `alias` or `alias@<domain name>.com`
17
+ : Comma-separated list of principals to revoke join rights. Principals can be users or mail-enabled security groups in the form of `alias` or `alias@<domain name>.com`.
18
18
 
19
19
  `--confirm`
20
20
  : Don't prompt for confirming revoking rights
@@ -28,13 +28,13 @@ m365 spo hubsite rights revoke [options]
28
28
 
29
29
  ## Examples
30
30
 
31
- Revoke rights to join sites to the hub site with URL _https://contoso.sharepoint.com/sites/sales_ from user with alias _PattiF_. Will prompt for confirmation before revoking the rights
31
+ Revoke rights to join sites to the hub site with specific URL. from user with specific alias. Will prompt for confirmation before revoking the rights.
32
32
 
33
33
  ```sh
34
34
  m365 spo hubsite rights revoke --hubSiteUrl https://contoso.sharepoint.com/sites/sales --principals PattiF
35
35
  ```
36
36
 
37
- Revoke rights to join sites to the hub site with URL _https://contoso.sharepoint.com/sites/sales_ from user with aliases _PattiF_ and _AdeleV_ without prompting for confirmation
37
+ Revoke rights to join sites to the hub site with specific URL. from user with specific aliases without prompting for confirmation.
38
38
 
39
39
  ```sh
40
40
  m365 spo hubsite rights revoke --hubSiteUrl https://contoso.sharepoint.com/sites/sales --principals "PattiF,AdeleV" --confirm
@@ -11,16 +11,16 @@ m365 spo hubsite set [options]
11
11
  ## Options
12
12
 
13
13
  `-i, --id <id>`
14
- : ID of the hub site to update
14
+ : ID of the hub site.
15
15
 
16
16
  `-t, --title [title]`
17
- : The new title for the hub site
17
+ : The new title for the hub site.
18
18
 
19
19
  `-d, --description [description]`
20
- : The new description for the hub site
20
+ : The new description for the hub site.
21
21
 
22
22
  `-l, --logoUrl [logoUrl]`
23
- : The URL of the new logo for the hub site
23
+ : The URL of the new logo for the hub site.
24
24
 
25
25
  --8<-- "docs/cmd/_global.md"
26
26
 
@@ -33,13 +33,13 @@ If the specified `id` doesn't refer to an existing hub site, you will get an `Un
33
33
 
34
34
  ## Examples
35
35
 
36
- Update hub site's title
36
+ Update hub site's title.
37
37
 
38
38
  ```sh
39
39
  m365 spo hubsite set --id 255a50b2-527f-4413-8485-57f4c17a24d1 --title Sales
40
40
  ```
41
41
 
42
- Update hub site's title and description
42
+ Update hub site's title and description.
43
43
 
44
44
  ```sh
45
45
  m365 spo hubsite set --id 255a50b2-527f-4413-8485-57f4c17a24d1 --title Sales --description "All things sales"
@@ -51,43 +51,68 @@ m365 spo hubsite set --id 255a50b2-527f-4413-8485-57f4c17a24d1 --title Sales --d
51
51
 
52
52
  ```json
53
53
  {
54
- "Description": "Hello",
54
+ "Description": "All things sales",
55
55
  "EnablePermissionsSync": false,
56
56
  "HideNameInNavigation": false,
57
- "ID": "af80c11f-0138-4d72-bb37-514542c3aabb",
57
+ "ID": "255a50b2-527f-4413-8485-57f4c17a24d1",
58
58
  "LogoUrl": "https://contoso.sharepoint.com/sites/intra/SiteAssets/teapoint.png",
59
59
  "ParentHubSiteId": "/Guid(00000000-0000-0000-0000-000000000000)/",
60
60
  "Permissions": null,
61
61
  "RequiresJoinApproval": false,
62
62
  "SiteDesignId": "/Guid(184644fb-90ed-4841-a7ad-6930cf819060)/",
63
- "SiteId": "af80c11f-0138-4d72-bb37-514542c3aabb",
63
+ "SiteId": "255a50b2-527f-4413-8485-57f4c17a24d1",
64
64
  "SiteUrl": "https://contoso.sharepoint.com/sites/intra",
65
- "Title": "Intranet"
65
+ "Title": "Sales"
66
66
  }
67
67
  ```
68
68
 
69
69
  === "Text"
70
70
 
71
71
  ```text
72
- Description : Hello
72
+ Description : All things sales
73
73
  EnablePermissionsSync: false
74
74
  HideNameInNavigation : false
75
- ID : af80c11f-0138-4d72-bb37-514542c3aabb
75
+ ID : 255a50b2-527f-4413-8485-57f4c17a24d1
76
76
  LogoUrl : https://contoso.sharepoint.com/sites/intra/SiteAssets/teapoint.png
77
77
  ParentHubSiteId : /Guid(00000000-0000-0000-0000-000000000000)/
78
78
  Permissions : null
79
79
  RequiresJoinApproval : false
80
80
  SiteDesignId : /Guid(184644fb-90ed-4841-a7ad-6930cf819060)/
81
- SiteId : af80c11f-0138-4d72-bb37-514542c3aabb
81
+ SiteId : 255a50b2-527f-4413-8485-57f4c17a24d1
82
82
  SiteUrl : https://contoso.sharepoint.com/sites/intra
83
- Title : Intranet
83
+ Title : Sales
84
84
  ```
85
85
 
86
86
  === "CSV"
87
87
 
88
88
  ```csv
89
89
  Description,EnablePermissionsSync,HideNameInNavigation,ID,LogoUrl,ParentHubSiteId,Permissions,RequiresJoinApproval,SiteDesignId,SiteId,SiteUrl,Title
90
- 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
90
+ All things sales,,,255a50b2-527f-4413-8485-57f4c17a24d1,https://contoso.sharepoint.com/sites/intra/SiteAssets/teapoint.png,/Guid(00000000-0000-0000-0000-000000000000)/,,,/Guid(184644fb-90ed-4841-a7ad-6930cf819060)/,255a50b2-527f-4413-8485-57f4c17a24d1,https://contoso.sharepoint.com/sites/intra,Sales
91
+ ```
92
+
93
+ === "Markdown"
94
+
95
+ ```md
96
+ # spo hubsite set --id "255a50b2-527f-4413-8485-57f4c17a24d1" --title "Sales" --description "All things sales"
97
+
98
+ Date: 2/20/2023
99
+
100
+ ## Sales (255a50b2-527f-4413-8485-57f4c17a24d1)
101
+
102
+ Property | Value
103
+ ---------|-------
104
+ Description | All things sales
105
+ EnablePermissionsSync | false
106
+ HideNameInNavigation | false
107
+ ID | 255a50b2-527f-4413-8485-57f4c17a24d1
108
+ LogoUrl | https://contoso.sharepoint.com/sites/intra/SiteAssets/teapoint.png
109
+ ParentHubSiteId | /Guid(00000000-0000-0000-0000-000000000000)/
110
+ Permissions | null
111
+ RequiresJoinApproval | false
112
+ SiteDesignId | /Guid(00000000-0000-0000-0000-000000000000)/
113
+ SiteId | 255a50b2-527f-4413-8485-57f4c17a24d1
114
+ SiteUrl | https://contoso.sharepoint.com/sites/intra
115
+ Title | Sales
91
116
  ```
92
117
 
93
118
  ## More information
@@ -11,10 +11,10 @@ m365 spo hubsite unregister [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --url <url>`
14
- : URL of the site collection to unregister as a hub site
14
+ : URL of the site collection.
15
15
 
16
16
  `--confirm`
17
- : Don't prompt for confirming unregistering the hub site
17
+ : Don't prompt for confirmation.
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
@@ -27,13 +27,13 @@ If the specified site collection is not registered as a hub site, you will get a
27
27
 
28
28
  ## Examples
29
29
 
30
- Unregister the site collection with URL _https://contoso.sharepoint.com/sites/sales_ as a hub site. Will prompt for confirmation before unregistering the hub site.
30
+ Unregister the site collection with specific URL. as a hub site. Will prompt for confirmation before unregistering the hub site.
31
31
 
32
32
  ```sh
33
33
  m365 spo hubsite unregister --url https://contoso.sharepoint.com/sites/sales
34
34
  ```
35
35
 
36
- Unregister the site collection with URL _https://contoso.sharepoint.com/sites/sales_ as a hub site without prompting for confirmation.
36
+ Unregister the site collection with specific URL. as a hub site without prompting for confirmation.
37
37
 
38
38
  ```sh
39
39
  m365 spo hubsite unregister --url https://contoso.sharepoint.com/sites/sales --confirm
@@ -17,7 +17,7 @@ m365 spo knowledgehub get [options]
17
17
 
18
18
  ## Examples
19
19
 
20
- Gets the Knowledge Hub Site URL for your tenant
20
+ Gets the Knowledge Hub Site URL for your tenant.
21
21
 
22
22
  ```sh
23
23
  m365 spo knowledgehub get
@@ -42,3 +42,9 @@ m365 spo knowledgehub get
42
42
  ```csv
43
43
  https://contoso.sharepoint.com
44
44
  ```
45
+
46
+ === "Markdown"
47
+
48
+ ```md
49
+ https://contoso.sharepoint.com
50
+ ```
@@ -11,7 +11,7 @@ m365 spo knowledgehub remove [options]
11
11
  ## Options
12
12
 
13
13
  `--confirm`
14
- : Do not prompt for confirmation before removing the Knowledge Hub Site setting for your tenant
14
+ : Do not prompt for confirmation before removing the Knowledge Hub Site setting for your tenant.
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
@@ -20,13 +20,13 @@ m365 spo knowledgehub remove [options]
20
20
 
21
21
  ## Examples
22
22
 
23
- Removes the Knowledge Hub Site setting for your tenant
23
+ Removes the Knowledge Hub Site setting for your tenant.
24
24
 
25
25
  ```sh
26
26
  m365 spo knowledgehub remove
27
27
  ```
28
28
 
29
- Removes the Knowledge Hub Site setting for your tenant without confirmation
29
+ Removes the Knowledge Hub Site setting for your tenant without confirmation.
30
30
 
31
31
  ```sh
32
32
  m365 spo knowledgehub remove --confirm
@@ -51,3 +51,9 @@ m365 spo knowledgehub remove --confirm
51
51
  ```csv
52
52
  The knowledge hub site setting was removed.
53
53
  ```
54
+
55
+ === "Markdown"
56
+
57
+ ```md
58
+ The knowledge hub site setting was removed.
59
+ ```
@@ -11,7 +11,7 @@ m365 spo knowledgehub set [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --siteUrl <siteUrl>`
14
- : URL of the site to set as Knowledge Hub
14
+ : URL of the site to set as Knowledge Hub.
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
@@ -24,7 +24,7 @@ If the specified url doesn't refer to an existing site collection, you will get
24
24
 
25
25
  ## Examples
26
26
 
27
- Sets the Knowledge Hub Site for your tenant
27
+ Sets the Knowledge Hub Site for your tenant.
28
28
 
29
29
  ```sh
30
30
  m365 spo knowledgehub set --siteUrl https://contoso.sharepoint.com/sites/knowledgesite
@@ -49,3 +49,9 @@ m365 spo knowledgehub set --siteUrl https://contoso.sharepoint.com/sites/knowled
49
49
  ```csv
50
50
  The knowledge hub site with url "https://contoso.sharepoint.com" is added to list.
51
51
  ```
52
+
53
+ === "Markdown"
54
+
55
+ ```md
56
+ The knowledge hub site with url "https://contoso.sharepoint.com" is added to list.
57
+ ```