@pnp/cli-microsoft365 6.8.0-beta.a10f6e4 → 6.8.0-beta.bb09db9

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 (120) hide show
  1. package/.eslintrc.js +2 -0
  2. package/README.md +6 -1
  3. package/dist/m365/commands/commands.js +1 -0
  4. package/dist/m365/commands/docs.js +42 -0
  5. package/dist/m365/commands/login.js +1 -1
  6. package/dist/m365/pa/commands/app/app-consent-set.js +101 -0
  7. package/dist/m365/pa/commands.js +1 -0
  8. package/dist/m365/purview/commands/sensitivitylabel/sensitivitylabel-get.js +97 -0
  9. package/dist/m365/purview/commands/sensitivitylabel/sensitivitylabel-list.js +85 -0
  10. package/dist/m365/purview/commands/sensitivitylabel/sensitivitylabel-policysettings-list.js +89 -0
  11. package/dist/m365/purview/commands.js +3 -0
  12. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.15.2.js +2 -0
  13. package/dist/m365/spo/commands/file/file-list.js +15 -4
  14. package/dist/m365/spo/commands/file/file-remove.js +3 -0
  15. package/dist/m365/spo/commands/list/list-get.js +30 -3
  16. package/dist/m365/spo/commands/list/list-list.js +39 -2
  17. package/dist/m365/spo/commands/page/page-section-add.js +2 -3
  18. package/dist/m365/spo/commands/term/term-add.js +13 -4
  19. package/dist/m365/spo/commands/term/term-get.js +14 -5
  20. package/dist/m365/spo/commands/term/term-group-get.js +12 -3
  21. package/dist/m365/spo/commands/term/term-group-list.js +39 -4
  22. package/dist/m365/spo/commands/term/term-list.js +18 -9
  23. package/dist/m365/spo/commands/term/term-set-add.js +13 -4
  24. package/dist/m365/spo/commands/term/term-set-get.js +12 -3
  25. package/dist/m365/spo/commands/term/term-set-list.js +12 -3
  26. package/dist/m365/spo/commands.js +1 -0
  27. package/docs/docs/cmd/aad/o365group/o365group-get.md +0 -12
  28. package/docs/docs/cmd/cli/cli-consent.md +6 -0
  29. package/docs/docs/cmd/cli/cli-doctor.md +17 -0
  30. package/docs/docs/cmd/cli/cli-issue.md +6 -0
  31. package/docs/docs/cmd/cli/cli-reconsent.md +6 -0
  32. package/docs/docs/cmd/cli/completion/completion-sh-setup.md +6 -0
  33. package/docs/docs/cmd/cli/config/config-get.md +6 -0
  34. package/docs/docs/cmd/docs.md +51 -0
  35. package/docs/docs/cmd/flow/environment/environment-list.md +18 -0
  36. package/docs/docs/cmd/flow/flow-get.md +20 -0
  37. package/docs/docs/cmd/flow/flow-list.md +17 -0
  38. package/docs/docs/cmd/login.md +1 -1
  39. package/docs/docs/cmd/pa/app/app-consent-set.md +47 -0
  40. package/docs/docs/cmd/planner/task/task-get.md +0 -6
  41. package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-get.md +118 -0
  42. package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-list.md +111 -0
  43. package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-policysettings-list.md +97 -0
  44. package/docs/docs/cmd/search/externalconnection/externalconnection-get.md +17 -0
  45. package/docs/docs/cmd/search/externalconnection/externalconnection-list.md +17 -0
  46. package/docs/docs/cmd/spo/file/file-list.md +9 -6
  47. package/docs/docs/cmd/spo/file/file-remove.md +12 -0
  48. package/docs/docs/cmd/spo/list/list-get.md +10 -0
  49. package/docs/docs/cmd/spo/list/list-list.md +28 -0
  50. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-list.md +19 -0
  51. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-remove.md +12 -0
  52. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-list.md +6 -0
  53. package/docs/docs/cmd/spo/page/page-column-get.md +15 -0
  54. package/docs/docs/cmd/spo/page/page-column-list.md +16 -0
  55. package/docs/docs/cmd/spo/page/page-control-get.md +18 -0
  56. package/docs/docs/cmd/spo/page/page-control-list.md +18 -0
  57. package/docs/docs/cmd/spo/page/page-copy.md +35 -0
  58. package/docs/docs/cmd/spo/page/page-get.md +39 -0
  59. package/docs/docs/cmd/spo/page/page-list.md +53 -0
  60. package/docs/docs/cmd/spo/page/page-section-get.md +12 -0
  61. package/docs/docs/cmd/spo/page/page-section-list.md +13 -0
  62. package/docs/docs/cmd/spo/page/page-template-list.md +31 -0
  63. package/docs/docs/cmd/spo/propertybag/propertybag-get.md +6 -0
  64. package/docs/docs/cmd/spo/propertybag/propertybag-list.md +13 -0
  65. package/docs/docs/cmd/spo/report/report-activityfilecounts.md +7 -0
  66. package/docs/docs/cmd/spo/report/report-activitypages.md +7 -0
  67. package/docs/docs/cmd/spo/report/report-activityusercounts.md +7 -0
  68. package/docs/docs/cmd/spo/report/report-activityuserdetail.md +7 -0
  69. package/docs/docs/cmd/spo/report/report-siteusagedetail.md +7 -0
  70. package/docs/docs/cmd/spo/report/report-siteusagefilecounts.md +7 -0
  71. package/docs/docs/cmd/spo/report/report-siteusagepages.md +7 -0
  72. package/docs/docs/cmd/spo/report/report-siteusagesitecounts.md +7 -0
  73. package/docs/docs/cmd/spo/report/report-siteusagestorage.md +7 -0
  74. package/docs/docs/cmd/spo/roledefinition/roledefinition-get.md +20 -0
  75. package/docs/docs/cmd/spo/roledefinition/roledefinition-list.md +20 -0
  76. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-add.md +20 -0
  77. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-list.md +18 -0
  78. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-approve.md +20 -0
  79. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-list.md +17 -0
  80. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-set.md +13 -0
  81. package/docs/docs/cmd/spo/term/term-add.md +107 -6
  82. package/docs/docs/cmd/spo/term/term-get.md +111 -10
  83. package/docs/docs/cmd/spo/term/term-group-get.md +71 -5
  84. package/docs/docs/cmd/spo/term/term-group-list.md +70 -2
  85. package/docs/docs/cmd/spo/term/term-list.md +80 -8
  86. package/docs/docs/cmd/spo/term/term-set-add.md +95 -11
  87. package/docs/docs/cmd/spo/term/term-set-get.md +92 -8
  88. package/docs/docs/cmd/spo/term/term-set-list.md +85 -5
  89. package/docs/docs/cmd/teams/app/app-list.md +17 -0
  90. package/docs/docs/cmd/teams/app/app-publish.md +18 -1
  91. package/docs/docs/cmd/teams/channel/channel-add.md +20 -0
  92. package/docs/docs/cmd/teams/channel/channel-get.md +21 -0
  93. package/docs/docs/cmd/teams/channel/channel-list.md +21 -0
  94. package/docs/docs/cmd/teams/channel/channel-member-list.md +20 -0
  95. package/docs/docs/cmd/teams/channel/channel-member-set.md +21 -0
  96. package/docs/docs/cmd/teams/chat/chat-get.md +22 -0
  97. package/docs/docs/cmd/teams/chat/chat-list.md +22 -0
  98. package/docs/docs/cmd/teams/chat/chat-member-list.md +20 -0
  99. package/docs/docs/cmd/teams/chat/chat-message-list.md +23 -0
  100. package/docs/docs/cmd/teams/funsettings/funsettings-list.md +15 -0
  101. package/docs/docs/cmd/teams/guestsettings/guestsettings-list.md +13 -0
  102. package/docs/docs/cmd/teams/membersettings/membersettings-list.md +17 -0
  103. package/docs/docs/cmd/yammer/group/group-list.md +42 -0
  104. package/docs/docs/cmd/yammer/message/message-add.md +32 -0
  105. package/docs/docs/cmd/yammer/message/message-get.md +32 -0
  106. package/docs/docs/cmd/yammer/message/message-list.md +34 -0
  107. package/docs/docs/cmd/yammer/network/network-list.md +70 -0
  108. package/docs/docs/cmd/yammer/report/report-activitycounts.md +7 -0
  109. package/docs/docs/cmd/yammer/report/report-activityusercounts.md +7 -0
  110. package/docs/docs/cmd/yammer/report/report-activityuserdetail.md +7 -0
  111. package/docs/docs/cmd/yammer/report/report-deviceusagedistributionusercounts.md +7 -0
  112. package/docs/docs/cmd/yammer/report/report-deviceusageusercounts.md +7 -0
  113. package/docs/docs/cmd/yammer/report/report-deviceusageuserdetail.md +7 -0
  114. package/docs/docs/cmd/yammer/report/report-groupsactivitycounts.md +7 -0
  115. package/docs/docs/cmd/yammer/report/report-groupsactivitydetail.md +7 -0
  116. package/docs/docs/cmd/yammer/report/report-groupsactivitygroupcounts.md +7 -0
  117. package/docs/docs/cmd/yammer/user/user-get.md +55 -0
  118. package/docs/docs/cmd/yammer/user/user-list.md +55 -0
  119. package/docs/docs/cmd/yammer/yammer-search.md +15 -3
  120. package/package.json +1 -1
@@ -90,3 +90,10 @@ m365 spo report siteusagedetail --period D7 --output json > "siteusagedetail.jso
90
90
  Report Refresh Date,Site Id,Site URL,Owner Display Name,Is Deleted,Last Activity Date,File Count,Active File Count,Page View Count,Visited Page Count,Storage Used (Byte),Storage Allocated (Byte),Root Web Template,Owner Principal Name,Report Period
91
91
  2022-11-26,002caf24-2672-4bc4-bc41-2811d5dba62c,https://contoso.sharepoint.com/sites/ElMontePythons,El Monte Pythons Owners,False,,2,0,0,0,1475974,27487790694400,Group,ElMontePythons@contoso.onmicrosoft.com,7
92
92
  ```
93
+
94
+ === "Markdown"
95
+
96
+ ```md
97
+ Report Refresh Date,Site Id,Site URL,Owner Display Name,Is Deleted,Last Activity Date,File Count,Active File Count,Page View Count,Visited Page Count,Storage Used (Byte),Storage Allocated (Byte),Root Web Template,Owner Principal Name,Report Period
98
+ 2023-05-04,00000000-0000-0000-0000-000000000000,2D7F5EEA85EDC827EB4E800B9843699A,9CB5FBB74CCA99D813491DF81BD9445D,False,2023-04-21,11,0,0,0,5979747,27487790694400,Group,C1B73ABEAE1BC69423799C66FE6D115F,7
99
+ ```
@@ -72,3 +72,10 @@ m365 spo report siteusagefilecounts --period D7 --output json > "siteusagefileco
72
72
  Report Refresh Date,Site Type,Total,Active,Report Date,Report Period
73
73
  2022-11-26,All,1320,3,2022-11-26,7
74
74
  ```
75
+
76
+ === "Markdown"
77
+
78
+ ```md
79
+ Report Refresh Date,Site Type,Total,Active,Report Date,Report Period
80
+ 2023-05-04,All,2006,10,2023-05-04,7
81
+ ```
@@ -67,3 +67,10 @@ m365 spo report siteusagepages --period D7 --output json > "siteusagepages.json"
67
67
  Report Refresh Date,Site Type,Page View Count,Report Date,Report Period
68
68
  2022-11-26,All,14,2022-11-26,7
69
69
  ```
70
+
71
+ === "Markdown"
72
+
73
+ ```md
74
+ Report Refresh Date,Site Type,Page View Count,Report Date,Report Period
75
+ 2023-05-04,All,12,2023-05-04,7
76
+ ```
@@ -72,3 +72,10 @@ m365 spo report siteusagesitecounts --period D7 --output json > "siteusagesiteco
72
72
  Report Refresh Date,Site Type,Total,Active,Report Date,Report Period
73
73
  2022-11-26,All,159,2,2022-11-26,7
74
74
  ```
75
+
76
+ === "Markdown"
77
+
78
+ ```md
79
+ Report Refresh Date,Site Type,Total,Active,Report Date,Report Period
80
+ 2023-05-04,All,33,3,2023-05-04,7
81
+ ```
@@ -67,3 +67,10 @@ m365 spo report siteusagestorage --period D7 --output json > "siteusagestorage.j
67
67
  Report Refresh Date,Site Type,Storage Used (Byte),Report Date,Report Period
68
68
  2022-11-26,All,2348104595,2022-11-26,7
69
69
  ```
70
+
71
+ === "Markdown"
72
+
73
+ ```md
74
+ Report Refresh Date,Site Type,Storage Used (Byte),Report Date,Report Period
75
+ 2023-05-04,All,272942096,2023-05-04,7
76
+ ```
@@ -103,3 +103,23 @@ m365 spo roledefinition get --webUrl https://contoso.sharepoint.com/sites/projec
103
103
  BasePermissions,Description,Hidden,Id,Name,Order,RoleTypeKind,BasePermissionsValue,RoleTypeKindValue
104
104
  "{""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
105
105
  ```
106
+
107
+ === "Markdown"
108
+
109
+ ```md
110
+ # spo roledefinition get --webUrl "https://contoso.sharepoint.com/sites/project-x" --id "1073741829"
111
+
112
+ Date: 5/6/2023
113
+
114
+ ## Full Control (1073741829)
115
+
116
+ Property | Value
117
+ ---------|-------
118
+ Description | Has full control.
119
+ Hidden | false
120
+ Id | 1073741829
121
+ Name | Full Control
122
+ Order | 1
123
+ RoleTypeKind | 5
124
+ RoleTypeKindValue | Administrator
125
+ ```
@@ -96,3 +96,23 @@ m365 spo roledefinition list --webUrl https://contoso.sharepoint.com/sites/proje
96
96
  Id,Name
97
97
  1073741829,Full Control
98
98
  ```
99
+
100
+ === "Markdown"
101
+
102
+ ```md
103
+ # spo roledefinition list --webUrl "https://contoso.sharepoint.com/sites/project-x"
104
+
105
+ Date: 5/6/2023
106
+
107
+ ## Full Control (1073741829)
108
+
109
+ Property | Value
110
+ ---------|-------
111
+ Description | Has full control.
112
+ Hidden | false
113
+ Id | 1073741829
114
+ Name | Full Control
115
+ Order | 1
116
+ RoleTypeKind | 5
117
+ RoleTypeKindValue | Administrator
118
+ ```
@@ -79,3 +79,23 @@ m365 spo serviceprincipal grant add --resource 'contoso-api' --scope 'user_imper
79
79
  ClientId,ConsentType,IsDomainIsolated,ObjectId,PackageName,Resource,ResourceId,Scope
80
80
  6004a642-185c-479a-992a-15d1c23e2229,AllPrincipals,,QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY,,Microsoft Graph,a46b0017-21e2-4db1-bc69-ca63576a38d6,Mail.Read
81
81
  ```
82
+
83
+ === "Markdown"
84
+
85
+ ```md
86
+ # spo serviceprincipal grant add --resource "Microsoft Graph" --scope "Mail.Read"
87
+
88
+ Date: 5/7/2023
89
+
90
+ ## 4WtBzD8u5kW-sYuikIWL_8ZYTP5mJB1LnC6OT4Ibr94
91
+
92
+ Property | Value
93
+ ---------|-------
94
+ ClientId | cc416be1-2e3f-45e6-beb1-8ba290858bff
95
+ ConsentType | AllPrincipals
96
+ IsDomainIsolated | false
97
+ ObjectId | 4WtBzD8u5kW-sYuikIWL\_8ZYTP5mJB1LnC6OT4Ibr94
98
+ Resource | Microsoft Graph
99
+ ResourceId | fe4c58c6-2466-4b1d-9c2e-8e4f821bafde
100
+ Scope | Mail.Read
101
+ ```
@@ -62,3 +62,21 @@ m365 spo serviceprincipal grant list
62
62
  IsDomainIsolated,ObjectId,PackageName,Resource,ResourceId,Scope
63
63
  ,QqYEYFwYmkeZKhXRwj4iKV5QwbD60RVCo6xeMUG407E,,Windows Azure Active Directory,b0c1505e-d1fa-4215-a3ac-5e3141b8d3b1,User.Read
64
64
  ```
65
+
66
+ === "Markdown"
67
+
68
+ ```md
69
+ # spo serviceprincipal grant list
70
+
71
+ Date: 5/7/2023
72
+
73
+ ## 4WtBzD8u5kW-sYuikIWL_8ZYTP5mJB1LnC6OT4Ibr94
74
+
75
+ Property | Value
76
+ ---------|-------
77
+ IsDomainIsolated | false
78
+ ObjectId | 4WtBzD8u5kW-sYuikIWL\_8ZYTP5mJB1LnC6OT4Ibr94
79
+ Resource | Microsoft Graph
80
+ ResourceId | fe4c58c6-2466-4b1d-9c2e-8e4f821bafde
81
+ Scope | Mail.Read
82
+ ```
@@ -78,3 +78,23 @@ m365 spo serviceprincipal permissionrequest approve --id 4dc4c043-25ee-40f2-81d3
78
78
  ClientId,ConsentType,IsDomainIsolated,ObjectId,PackageName,Resource,ResourceId,Scope
79
79
  6004a642-185c-479a-992a-15d1c23e2229,AllPrincipals,false,QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY,null,Microsoft Graph,a46b0017-21e2-4db1-bc69-ca63576a38d6,Directory.ReadWrite.All
80
80
  ```
81
+
82
+ === "Markdown"
83
+
84
+ ```md
85
+ # spo serviceprincipal permissionrequest approve --id "ecc2f667-e219-4c65-908e-957d68244d0c"
86
+
87
+ Date: 5/7/2023
88
+
89
+ ## 4WtBzD8u5kW-sYuikIWL_8ZYTP5mJB1LnC6OT4Ibr94
90
+
91
+ Property | Value
92
+ ---------|-------
93
+ ClientId | cc416be1-2e3f-45e6-beb1-8ba290858bff
94
+ ConsentType | AllPrincipals
95
+ IsDomainIsolated | false
96
+ ObjectId | 4WtBzD8u5kW-sYuikIWL\_8ZYTP5mJB1LnC6OT4Ibr94
97
+ Resource | Microsoft Graph
98
+ ResourceId | fe4c58c6-2466-4b1d-9c2e-8e4f821bafde
99
+ Scope | Calendars.Read
100
+ ```
@@ -60,3 +60,20 @@ m365 spo serviceprincipal permissionrequest list
60
60
  Id,Resource,ResourceId,Scope
61
61
  6eceed61-77e4-424d-ae1d-696a0de4d768,Microsoft Graph,Microsoft Graph,Reports.Read.All
62
62
  ```
63
+
64
+ === "Markdown"
65
+
66
+ ```md
67
+ # spo serviceprincipal permissionrequest list
68
+
69
+ Date: 5/7/2023
70
+
71
+ ## ecc2f667-e219-4c65-908e-957d68244d0c
72
+
73
+ Property | Value
74
+ ---------|-------
75
+ Id | ecc2f667-e219-4c65-908e-957d68244d0c
76
+ Resource | Microsoft Graph
77
+ ResourceId | Microsoft Graph
78
+ Scope | Calendars.Read
79
+ ```
@@ -84,3 +84,16 @@ m365 spo serviceprincipal set --enabled true --confirm
84
84
  AccountEnabled,AppId,ReplyUrls
85
85
  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""]"
86
86
  ```
87
+
88
+ === "Markdown"
89
+
90
+ ```md
91
+ # spo serviceprincipal set --enabled "true"
92
+
93
+ Date: 5/6/2023
94
+
95
+ Property | Value
96
+ ---------|-------
97
+ AccountEnabled | true
98
+ AppId | 83defbc2-a963-42c9-9952-1ba92e4bead3
99
+ ```
@@ -13,6 +13,9 @@ m365 spo term add [options]
13
13
  `-n, --name <name>`
14
14
  : Name of the term to add
15
15
 
16
+ `-u, --webUrl [webUrl]`
17
+ : If specified, allows you to add a term to the tenant term store as well as the sitecollection specific term store. Defaults to the tenant admin site.
18
+
16
19
  `--termSetId [termSetId]`
17
20
  : ID of the term set in which to create the term. Specify `termSetId` or `termSetName` but not both
18
21
 
@@ -48,36 +51,134 @@ m365 spo term add [options]
48
51
  When using the `--customProperties` and/or `--localCustomProperties` options it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
49
52
 
50
53
  !!! important
51
- To use this command you have to have permissions to access the tenant admin site.
54
+ To use this command without the `--webUrl` option you have to have permissions to access the tenant admin site.
55
+
56
+ When using the `--webUrl` option you can connect to the term store with limited permissions, and do not need the SharePoint Administrator role. It allows you to add a term to a term set in the tenant term store if you are listed as a term store administrator. It allows you to add terms to a term set in the sitecollection term store if you are a site owner.
52
57
 
53
58
  ## Examples
54
59
 
55
- Add taxonomy term with the specified name to the term group and term set specified by their names
60
+ Add taxonomy term with the specified name to the term group and term set specified by their names.
56
61
 
57
62
  ```sh
58
63
  m365 spo term add --name IT --termSetName Department --termGroupName People
59
64
  ```
60
65
 
61
- Add taxonomy term with the specified name to the term group and term set specified by their IDs
66
+ Add taxonomy term with the specified name to the term group and term set specified by their IDs.
62
67
 
63
68
  ```sh
64
69
  m365 spo term add --name IT --termSetId 8ed8c9ea-7052-4c1d-a4d7-b9c10bffea6f --termGroupId 5c928151-c140-4d48-aab9-54da901c7fef
65
70
  ```
66
71
 
67
- Add taxonomy term with the specified name and ID
72
+ Add taxonomy term with the specified name and ID.
68
73
 
69
74
  ```sh
70
75
  m365 spo term add --name IT --id 5c928151-c140-4d48-aab9-54da901c7fef --termSetName Department --termGroupName People
71
76
  ```
72
77
 
73
- Add taxonomy term with custom properties
78
+ Add taxonomy term to the specified sitecollection with the specified name and ID.
79
+
80
+ ```sh
81
+ m365 spo term add --name IT --id 5c928151-c140-4d48-aab9-54da901c7fef --termSetName Department --termGroupName People --webUrl https://contoso.sharepoint.com/sites/project-x
82
+ ```
83
+
84
+ Add taxonomy term with custom properties.
74
85
 
75
86
  ```sh
76
87
  m365 spo term add --name IT --termSetName Department --termGroupName People --customProperties '{"Property": "Value"}'
77
88
  ```
78
89
 
79
- Add taxonomy term below the specified term
90
+ Add taxonomy term below the specified term.
80
91
 
81
92
  ```sh
82
93
  m365 spo term add --name IT --parentTermId 5c928151-c140-4d48-aab9-54da901c7fef --termGroupName People
83
94
  ```
95
+
96
+ ## Response
97
+
98
+ === "JSON"
99
+
100
+ ```json
101
+ {
102
+ "CreatedDate": "2023-05-10T06:21:33.873Z",
103
+ "Id": "346f49b0-3d1c-4ed3-b590-df303294cc16",
104
+ "LastModifiedDate": "2023-05-10T06:21:33.873Z",
105
+ "Name": "IT",
106
+ "CustomProperties": {},
107
+ "CustomSortOrder": null,
108
+ "IsAvailableForTagging": true,
109
+ "Owner": "i:0#.f|membership|john.doe@contoso.onmicrosoft.com",
110
+ "Description": "",
111
+ "IsDeprecated": false,
112
+ "IsKeyword": false,
113
+ "IsPinned": false,
114
+ "IsPinnedRoot": false,
115
+ "IsReused": false,
116
+ "IsRoot": true,
117
+ "IsSourceTerm": true,
118
+ "LocalCustomProperties": {},
119
+ "MergedTermIds": [],
120
+ "PathOfTerm": "IT",
121
+ "TermsCount": 0
122
+ }
123
+ ```
124
+
125
+ === "Text"
126
+
127
+ ```text
128
+ CreatedDate : 2023-05-10T06:22:34.686Z
129
+ CustomProperties : {}
130
+ CustomSortOrder : null
131
+ Description :
132
+ Id : 53156df9-5485-4724-9f4f-6670a3d41f88
133
+ IsAvailableForTagging: true
134
+ IsDeprecated : false
135
+ IsKeyword : false
136
+ IsPinned : false
137
+ IsPinnedRoot : false
138
+ IsReused : false
139
+ IsRoot : true
140
+ IsSourceTerm : true
141
+ LastModifiedDate : 2023-05-10T06:22:34.686Z
142
+ LocalCustomProperties: {}
143
+ MergedTermIds : []
144
+ Name : IT
145
+ Owner : i:0#.f|membership|john.doe@contoso.onmicrosoft.com
146
+ PathOfTerm : IT
147
+ TermsCount : 0
148
+ ```
149
+
150
+ === "CSV"
151
+
152
+ ```csv
153
+ CreatedDate,Id,LastModifiedDate,Name,IsAvailableForTagging,Owner,Description,IsDeprecated,IsKeyword,IsPinned,IsPinnedRoot,IsReused,IsRoot,IsSourceTerm,PathOfTerm,TermsCount
154
+ 2023-05-10T06:23:13.490Z,0f1e0630-9f45-42d1-a64e-e82fe76826da,2023-05-10T06:23:13.490Z,IT,1,i:0#.f|membership|john.doe@contoso.onmicrosoft.com,,,,,,,1,1,IT,0
155
+ ```
156
+
157
+ === "Markdown"
158
+
159
+ ```md
160
+ # spo term add --termGroupName "People" --termSetName "Department" --name "IT"
161
+
162
+ Date: 5/10/2023
163
+
164
+ ## IT (6e72d493-000d-4517-aa3e-2afb3a3d4bc8)
165
+
166
+ Property | Value
167
+ ---------|-------
168
+ CreatedDate | 2023-05-10T06:23:49.970Z
169
+ Id | 6e72d493-000d-4517-aa3e-2afb3a3d4bc8
170
+ LastModifiedDate | 2023-05-10T06:23:49.970Z
171
+ Name | IT
172
+ IsAvailableForTagging | true
173
+ Owner | i:0#.f\|membership\|john.doe@contoso.onmicrosoft.com
174
+ Description |
175
+ IsDeprecated | false
176
+ IsKeyword | false
177
+ IsPinned | false
178
+ IsPinnedRoot | false
179
+ IsReused | false
180
+ IsRoot | true
181
+ IsSourceTerm | true
182
+ PathOfTerm | IT
183
+ TermsCount | 0
184
+ ```
@@ -10,23 +10,26 @@ m365 spo term get [options]
10
10
 
11
11
  ## Options
12
12
 
13
+ `-u, --webUrl [webUrl]`
14
+ : If specified, allows you to get a term from the tenant term store as well as the sitecollection specific term store. Defaults to the tenant admin site.
15
+
13
16
  `-i, --id [id]`
14
- : ID of the term to retrieve. Specify `name` or `id` but not both
17
+ : ID of the term to retrieve. Specify `name` or `id` but not both.
15
18
 
16
19
  `-n, --name [name]`
17
- : Name of the term to retrieve. Specify `name` or `id` but not both
20
+ : Name of the term to retrieve. Specify `name` or `id` but not both.
18
21
 
19
22
  `--termGroupId [termGroupId]`
20
- : ID of the term group to which the term set belongs. Specify `termGroupId` or `termGroupName` but not both
23
+ : ID of the term group to which the term set belongs. Specify `termGroupId` or `termGroupName` but not both.
21
24
 
22
25
  `--termGroupName [termGroupName]`
23
- : Name of the term group to which the term set belongs. Specify `termGroupId` or `termGroupName` but not both
26
+ : Name of the term group to which the term set belongs. Specify `termGroupId` or `termGroupName` but not both.
24
27
 
25
28
  `--termSetId [termSetId]`
26
- : ID of the term set to which the term belongs. Specify `termSetId` or `termSetName` but not both
29
+ : ID of the term set to which the term belongs. Specify `termSetId` or `termSetName` but not both.
27
30
 
28
31
  `--termSetName [termSetName]`
29
- : Name of the term set to which the term belongs. Specify `termSetId` or `termSetName` but not both
32
+ : Name of the term set to which the term belongs. Specify `termSetId` or `termSetName` but not both.
30
33
 
31
34
  --8<-- "docs/cmd/_global.md"
32
35
 
@@ -35,24 +38,122 @@ m365 spo term get [options]
35
38
  When retrieving term by its ID, it's sufficient to specify just the ID. When retrieving it by its name however, you need to specify the parent term group and term set using either their names or IDs.
36
39
 
37
40
  !!! important
38
- To use this command you have to have permissions to access the tenant admin site.
41
+ To use this command without the --webUrl option you have to have permissions to access the tenant admin site.
39
42
 
43
+ When using the `--webUrl` option you can connect to the term store with limited permissions, and do not need the SharePoint Administrator role. You need to be a site visitor or more. It allows you to get a term from the tenant term store as well as a term from the sitecollection term store.
44
+
40
45
  ## Examples
41
46
 
42
- Get information about a taxonomy term using its ID
47
+ Get information about a taxonomy term using its ID from the specified sitecollection.
48
+
49
+ ```sh
50
+ m365 spo term get --webUrl https://contoso.sharepoint.com/sites/project-x --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb
51
+ ```
52
+
53
+ Get information about a taxonomy term using its ID.
43
54
 
44
55
  ```sh
45
56
  m365 spo term get --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb
46
57
  ```
47
58
 
48
- Get information about a taxonomy term using its name, retrieving the parent term group and term set using their names
59
+ Get information about a taxonomy term using its name, retrieving the parent term group and term set using their names.
49
60
 
50
61
  ```sh
51
62
  m365 spo term get --name IT --termGroupName People --termSetName Department
52
63
  ```
53
64
 
54
- Get information about a taxonomy term using its name, retrieving the parent term group and term set using their IDs
65
+ Get information about a taxonomy term using its name, retrieving the parent term group and term set using their IDs.
55
66
 
56
67
  ```sh
57
68
  m365 spo term get --name IT --termGroupId 5c928151-c140-4d48-aab9-54da901c7fef --termSetId 8ed8c9ea-7052-4c1d-a4d7-b9c10bffea6f
58
69
  ```
70
+
71
+ ## Response
72
+
73
+ === "JSON"
74
+
75
+ ```json
76
+ {
77
+ "CreatedDate": "2021-07-07T09:42:02.283Z",
78
+ "Id": "2b5c71a6-d72b-49a8-a3bf-d80636d85b44",
79
+ "LastModifiedDate": "2021-07-07T09:42:02.283Z",
80
+ "Name": "IT",
81
+ "CustomProperties": {},
82
+ "CustomSortOrder": null,
83
+ "IsAvailableForTagging": true,
84
+ "Owner": "NT Service\\SPTimerV4",
85
+ "Description": "",
86
+ "IsDeprecated": false,
87
+ "IsKeyword": false,
88
+ "IsPinned": false,
89
+ "IsPinnedRoot": false,
90
+ "IsReused": false,
91
+ "IsRoot": true,
92
+ "IsSourceTerm": true,
93
+ "LocalCustomProperties": {},
94
+ "MergedTermIds": [],
95
+ "PathOfTerm": "IT",
96
+ "TermsCount": 1
97
+ }
98
+ ```
99
+
100
+ === "Text"
101
+
102
+ ```text
103
+ CreatedDate : 2021-07-07T09:42:02.283Z
104
+ CustomProperties : {}
105
+ CustomSortOrder : null
106
+ Description :
107
+ Id : 2b5c71a6-d72b-49a8-a3bf-d80636d85b44
108
+ IsAvailableForTagging: true
109
+ IsDeprecated : false
110
+ IsKeyword : false
111
+ IsPinned : false
112
+ IsPinnedRoot : false
113
+ IsReused : false
114
+ IsRoot : true
115
+ IsSourceTerm : true
116
+ LastModifiedDate : 2021-07-07T09:42:02.283Z
117
+ LocalCustomProperties: {}
118
+ MergedTermIds : []
119
+ Name : IT
120
+ Owner : NT Service\SPTimerV4
121
+ PathOfTerm : IT
122
+ TermsCount : 1
123
+ ```
124
+
125
+ === "CSV"
126
+
127
+ ```csv
128
+ CreatedDate,Id,LastModifiedDate,Name,IsAvailableForTagging,Owner,Description,IsDeprecated,IsKeyword,IsPinned,IsPinnedRoot,IsReused,IsRoot,IsSourceTerm,PathOfTerm,TermsCount
129
+ 2021-07-07T09:42:02.283Z,2b5c71a6-d72b-49a8-a3bf-d80636d85b44,2021-07-07T09:42:02.283Z,IT,1,NT Service\SPTimerV4,,,,,,,1,1,IT,1
130
+ ```
131
+
132
+ === "Markdown"
133
+
134
+ ```md
135
+ # spo term get --termGroupName "People" --termSetName "Department" --name "IT"
136
+
137
+ Date: 5/8/2023
138
+
139
+ ## IT (2b5c71a6-d72b-49a8-a3bf-d80636d85b44)
140
+
141
+ Property | Value
142
+ ---------|-------
143
+ CreatedDate | 2021-07-07T09:42:02.283Z
144
+ Id | 2b5c71a6-d72b-49a8-a3bf-d80636d85b44
145
+ LastModifiedDate | 2021-07-07T09:42:02.283Z
146
+ Name | IT
147
+ IsAvailableForTagging | true
148
+ Owner | NT Service\SPTimerV4
149
+ Description |
150
+ IsDeprecated | false
151
+ IsKeyword | false
152
+ IsPinned | false
153
+ IsPinnedRoot | false
154
+ IsReused | false
155
+ IsRoot | true
156
+ IsSourceTerm | true
157
+ PathOfTerm | IT
158
+ TermsCount | 1
159
+ ```
@@ -10,29 +10,95 @@ m365 spo term group get [options]
10
10
 
11
11
  ## Options
12
12
 
13
+ `-u, --webUrl [webUrl]`
14
+ : If specified, allows you to get a term group from the tenant term store as well as the sitecollection specific term store. Defaults to the tenant admin site.
15
+
13
16
  `-i, --id [id]`
14
- : ID of the term group to retrieve. Specify `name` or `id` but not both
17
+ : ID of the term group to retrieve. Specify `name` or `id` but not both.
15
18
 
16
19
  `-n, --name [name]`
17
- : Name of the term group to retrieve. Specify `name` or `id` but not both
20
+ : Name of the term group to retrieve. Specify `name` or `id` but not both.
18
21
 
19
22
  --8<-- "docs/cmd/_global.md"
20
23
 
21
24
  ## Remarks
22
25
 
23
26
  !!! important
24
- To use this command you have to have permissions to access the tenant admin site.
27
+ To use this command without the `--webUrl` option you have to have permissions to access the tenant admin site.
28
+
29
+ When using the `--webUrl` option you can connect to the term store with limited permissions, and do not need the SharePoint Administrator role. You need to be a site visitor or more. It allows you to get a term group from the tenant term store as well as a term group from the sitecollection term store.
25
30
 
26
31
  ## Examples
27
32
 
28
- Get information about a taxonomy term group using its ID
33
+ Get information about a taxonomy term group using its ID.
29
34
 
30
35
  ```sh
31
36
  m365 spo term group get --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb
32
37
  ```
33
38
 
34
- Get information about a taxonomy term group using its name
39
+ Get information about a taxonomy term group using its name.
35
40
 
36
41
  ```sh
37
42
  m365 spo term group get --name PnPTermSets
38
43
  ```
44
+
45
+ Get information about a taxonomy term group from the specified sitecollection using its ID.
46
+
47
+ ```sh
48
+ m365 spo term group get --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb --webUrl https://contoso.sharepoint.com/sites/project-x
49
+ ```
50
+
51
+ ## Response
52
+
53
+ === "JSON"
54
+
55
+ ```json
56
+ {
57
+ "CreatedDate": "2019-09-03T06:41:32.070Z",
58
+ "Id": "0e8f395e-ff58-4d45-9ff7-e331ab728beb",
59
+ "LastModifiedDate": "2019-09-03T06:41:32.070Z",
60
+ "Name": "PnPTermSets",
61
+ "Description": "",
62
+ "IsSiteCollectionGroup": false,
63
+ "IsSystemGroup": false
64
+ }
65
+ ```
66
+
67
+ === "Text"
68
+
69
+ ```text
70
+ CreatedDate : 2019-09-03T06:41:32.070Z
71
+ Description :
72
+ Id : 0e8f395e-ff58-4d45-9ff7-e331ab728beb
73
+ IsSiteCollectionGroup: false
74
+ IsSystemGroup : false
75
+ LastModifiedDate : 2019-09-03T06:41:32.070Z
76
+ Name : PnPTermSets
77
+ ```
78
+
79
+ === "CSV"
80
+
81
+ ```csv
82
+ CreatedDate,Id,LastModifiedDate,Name,Description,IsSiteCollectionGroup,IsSystemGroup
83
+ 2019-09-03T06:41:32.070Z,0e8f395e-ff58-4d45-9ff7-e331ab728beb,2019-09-03T06:41:32.070Z,PnPTermSets,,,
84
+ ```
85
+
86
+ === "Markdown"
87
+
88
+ ```md
89
+ # spo term group get --id "0e8f395e-ff58-4d45-9ff7-e331ab728beb"
90
+
91
+ Date: 5/14/2023
92
+
93
+ ## PnPTermSets (0e8f395e-ff58-4d45-9ff7-e331ab728beb)
94
+
95
+ Property | Value
96
+ ---------|-------
97
+ CreatedDate | 2019-09-03T06:41:32.070Z
98
+ Id | 0e8f395e-ff58-4d45-9ff7-e331ab728beb
99
+ LastModifiedDate | 2019-09-03T06:41:32.070Z
100
+ Name | PnPTermSets
101
+ Description |
102
+ IsSiteCollectionGroup | false
103
+ IsSystemGroup | false
104
+ ```