@pnp/cli-microsoft365 6.8.0-beta.9f8a015 → 6.8.0-beta.c5c3c32

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 (31) hide show
  1. package/.eslintrc.js +2 -0
  2. package/dist/m365/commands/commands.js +1 -0
  3. package/dist/m365/commands/docs.js +42 -0
  4. package/dist/m365/commands/login.js +1 -1
  5. package/dist/m365/pa/commands/app/app-consent-set.js +101 -0
  6. package/dist/m365/pa/commands.js +1 -0
  7. package/dist/m365/purview/commands/sensitivitylabel/sensitivitylabel-get.js +97 -0
  8. package/dist/m365/purview/commands/sensitivitylabel/sensitivitylabel-list.js +85 -0
  9. package/dist/m365/purview/commands/sensitivitylabel/sensitivitylabel-policysettings-list.js +89 -0
  10. package/dist/m365/purview/commands.js +3 -0
  11. package/dist/m365/spo/commands/file/file-list.js +15 -4
  12. package/dist/m365/spo/commands/file/file-remove.js +3 -0
  13. package/dist/m365/spo/commands/term/term-get.js +14 -5
  14. package/dist/m365/spo/commands/term/term-group-list.js +39 -4
  15. package/dist/m365/spo/commands/term/term-list.js +18 -9
  16. package/dist/m365/spo/commands/term/term-set-get.js +12 -3
  17. package/dist/m365/spo/commands.js +1 -0
  18. package/docs/docs/cmd/aad/o365group/o365group-get.md +0 -12
  19. package/docs/docs/cmd/docs.md +51 -0
  20. package/docs/docs/cmd/pa/app/app-consent-set.md +47 -0
  21. package/docs/docs/cmd/planner/task/task-get.md +0 -6
  22. package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-get.md +118 -0
  23. package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-list.md +111 -0
  24. package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-policysettings-list.md +97 -0
  25. package/docs/docs/cmd/spo/file/file-list.md +9 -6
  26. package/docs/docs/cmd/spo/file/file-remove.md +12 -0
  27. package/docs/docs/cmd/spo/term/term-get.md +111 -10
  28. package/docs/docs/cmd/spo/term/term-group-list.md +70 -2
  29. package/docs/docs/cmd/spo/term/term-list.md +80 -8
  30. package/docs/docs/cmd/spo/term/term-set-get.md +92 -8
  31. package/package.json +1 -1
@@ -0,0 +1,97 @@
1
+ # purview sensitivitylabel policysettings list
2
+
3
+ Get a list of policy settings for a sensitivity label.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 purview sensitivitylabel policysettings list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--userId [userId]`
14
+ : User's Azure AD ID. Optionally specify this if you want to get a list of policy settings for a sensitivity label that the user has access to. Specify either `userId` or `userName` but not both.
15
+
16
+ `--userName [userName]`
17
+ : User's UPN (user principal name, e.g. johndoe@example.com). Optionally specify this if you want to get a list of policy settings for a sensitivity label that the user has access to. Specify either `userId` or `userName` but not both.
18
+
19
+ --8<-- "docs/cmd/_global.md"
20
+
21
+ ## Remarks
22
+
23
+ !!! attention
24
+ This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
25
+
26
+ !!! attention
27
+ When operating in app-only mode, you have the option to use either the `userName` or `userId` parameters to retrieve the sensitivity policy settings for a specific user. Without specifying either of these parameters, the command will retrieve the sensitivity policy settings for the currently authenticated user when operating in delegated mode.
28
+
29
+ ## Examples
30
+
31
+ Get a list of policy settings for a sensitivity label.
32
+
33
+ ```sh
34
+ m365 purview sensitivitylabel policysettings list
35
+ ```
36
+
37
+ Get a list of policy settings for a sensitivity label that a specific user has access to by its Id.
38
+
39
+ ```sh
40
+ m365 purview sensitivitylabel policysettings list --userId 59f80e08-24b1-41f8-8586-16765fd830d3
41
+ ```
42
+
43
+ Get a list of policy settings for a sensitivity label that a specific user has access to by its UPN.
44
+
45
+ ```sh
46
+ m365 purview sensitivitylabel policysettings list --userName john.doe@contoso.com
47
+ ```
48
+
49
+ ## Response
50
+
51
+ === "JSON"
52
+
53
+ ```json
54
+ {
55
+ "id": "71F139249895C2F6DC861031DAC47E0C2C37C6595582D4248CC77FD7293681B5DE348BC71AEB44068CB397DB021CADB4",
56
+ "moreInfoUrl": "https://docs.microsoft.com/en-us/microsoft-365/compliance/get-started-with-sensitivity-labels?view=o365-worldwide#end-user-documentation-for-sensitivity-labels",
57
+ "isMandatory": true,
58
+ "isDowngradeJustificationRequired": true,
59
+ "defaultLabelId": "022bb90d-0cda-491d-b861-d195b14532dc"
60
+ }
61
+ ```
62
+
63
+ === "Text"
64
+
65
+ ```text
66
+ defaultLabelId : 022bb90d-0cda-491d-b861-d195b14532dc
67
+ id : 71F139249895C2F6DC861031DAC47E0C2C37C6595582D4248CC77FD7293681B5DE348BC71AEB44068CB397
68
+ DB021CADB4
69
+ isDowngradeJustificationRequired: true
70
+ isMandatory : true
71
+ moreInfoUrl : https://docs.microsoft.com/en-us/microsoft-365/compliance/get-started-with-sensitivity-labels?view=o365-worldwide#end-user-documentation-for-sensitivity-labels
72
+ ```
73
+
74
+ === "CSV"
75
+
76
+ ```csv
77
+ id,moreInfoUrl,isMandatory,isDowngradeJustificationRequired,defaultLabelId
78
+ 71F139249895C2F6DC861031DAC47E0C2C37C6595582D4248CC77FD7293681B5DE348BC71AEB44068CB397DB021CADB4,https://docs.microsoft.com/en-us/microsoft-365/compliance/get-started-with-sensitivity-labels?view=o365-worldwide#end-user-documentation-for-sensitivity-labels,1,1,022bb90d-0cda-491d-b861-d195b14532dc
79
+ ```
80
+
81
+ === "Markdown"
82
+
83
+ ```md
84
+ # purview sensitivitylabel policysettings list
85
+
86
+ Date: 4/11/2023
87
+
88
+ ## 71F139249895C2F6DC861031DAC47E0C2C37C6595582D4248CC77FD7293681B5DE348BC71AEB44068CB397DB021CADB4
89
+
90
+ Property | Value
91
+ ---------|-------
92
+ id | 71F139249895C2F6DC861031DAC47E0C2C37C6595582D4248CC77FD7293681B5DE348BC71AEB44068CB397DB021CADB4
93
+ moreInfoUrl | https://docs.microsoft.com/en-us/microsoft-365/compliance/get-started-with-sensitivity-labels?view=o365-worldwide#end-user-documentation-for-sensitivity-labels
94
+ isMandatory | true
95
+ isDowngradeJustificationRequired | true
96
+ defaultLabelId | 022bb90d-0cda-491d-b861-d195b14532dc
97
+ ```
@@ -13,8 +13,11 @@ m365 spo file list [options]
13
13
  `-u, --webUrl <webUrl>`
14
14
  : The URL of the site where the folder from which to retrieve files is located
15
15
 
16
+ `-f, --folderUrl <folderUrl>`
17
+ : The server- or site-relative URL of the parent folder from which to retrieve files
18
+
16
19
  `-f, --folder <folder>`
17
- : The server- or site-relative URL of the folder from which to retrieve files
20
+ : (deprecated. Use `folderUrl` instead) The server- or site-relative URL of the folder from which to retrieve files
18
21
 
19
22
  `--fields [fields]`
20
23
  : Comma-separated list of fields to retrieve. Will retrieve all fields if not specified.
@@ -36,25 +39,25 @@ When the `fields` option includes values with a `/`, for example: `ListItemAllFi
36
39
  Return all files from a folder
37
40
 
38
41
  ```sh
39
- m365 spo file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents'
42
+ m365 spo file list --webUrl https://contoso.sharepoint.com/sites/project-x --folderUrl 'Shared Documents'
40
43
  ```
41
44
 
42
45
  Return all files from a folder and all the sub-folders
43
46
 
44
47
  ```sh
45
- m365 spo file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --recursive
48
+ m365 spo file list --webUrl https://contoso.sharepoint.com/sites/project-x --folderUrl 'Shared Documents' --recursive
46
49
  ```
47
50
 
48
51
  Return the files from a folder with specific fields which will be expanded
49
52
 
50
53
  ```sh
51
- m365 spo file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --fields "Title,Length"
54
+ m365 spo file list --webUrl https://contoso.sharepoint.com/sites/project-x --folderUrl 'Shared Documents' --fields "Title,Length"
52
55
  ```
53
56
 
54
57
  Return the files from a folder that meet the criteria of the filter with specific fields which will be expanded
55
58
 
56
59
  ```sh
57
- m365 spo file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --fields ListItemAllFields/Id --filter "Name eq 'document.docx'"
60
+ m365 spo file list --webUrl https://contoso.sharepoint.com/sites/project-x --folderUrl 'Shared Documents' --fields ListItemAllFields/Id --filter "Name eq 'document.docx'"
58
61
  ```
59
62
 
60
63
  ## Response
@@ -107,7 +110,7 @@ m365 spo file list --webUrl https://contoso.sharepoint.com/sites/project-x --fol
107
110
  === "Markdown"
108
111
 
109
112
  ```md
110
- # spo file list --webUrl "https://contoso.sharepoint.com" --folder "Shared Documents"
113
+ # spo file list --webUrl "https://contoso.sharepoint.com" --folderUrl "Shared Documents"
111
114
 
112
115
  Date: 23/3/2023
113
116
 
@@ -8,6 +8,12 @@ Removes the specified file
8
8
  m365 spo file remove [options]
9
9
  ```
10
10
 
11
+ ## Alias
12
+
13
+ ```sh
14
+ m365 spo page template remove
15
+ ```
16
+
11
17
  ## Options
12
18
 
13
19
  `-w, --webUrl <webUrl>`
@@ -46,3 +52,9 @@ Move the file with server-relative URL _/sites/project-x/SharedDocuments/Test.do
46
52
  ```sh
47
53
  m365 spo file remove --webUrl https://contoso.sharepoint.com/sites/project-x --url /sites/project-x/SharedDocuments/Test.docx --recycle
48
54
  ```
55
+
56
+ Remove the page template with site-relative URL _SharedDocuments/Test.docx_ from located in site _https://contoso.sharepoint.com/sites/project-x_
57
+
58
+ ```sh
59
+ m365 spo page template remove --webUrl https://contoso.sharepoint.com/sites/project-x --url SharedDocuments/Forms/Template.dotx
60
+ ```
@@ -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 Adminstrator 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,17 +10,85 @@ m365 spo term group list [options]
10
10
 
11
11
  ## Options
12
12
 
13
+ `-u, --webUrl [webUrl]`
14
+ : If specified, allows you to list term groups from the tenant term store as well as the sitecollection specific term store. Defaults to the tenant admin site.
15
+
13
16
  --8<-- "docs/cmd/_global.md"
14
17
 
15
18
  ## Remarks
16
19
 
17
20
  !!! important
18
- To use this command you have to have permissions to access the tenant admin site.
21
+ To use this command without the --webUrl option you have to have permissions to access the tenant admin site.
22
+
23
+ When using the `--webUrl` option you can connect to the term store with limited permissions, and do not need the SharePoint Adminstrator role. You need to be a site visitor or more. It allows you to list term groups from the tenant term store as well as term groups from the sitecollection term store.
19
24
 
20
25
  ## Examples
21
26
 
22
- List taxonomy term groups
27
+ List taxonomy term groups.
23
28
 
24
29
  ```sh
25
30
  m365 spo term group list
26
31
  ```
32
+
33
+ List taxonomy term groups from the specified sitecollection.
34
+
35
+ ```sh
36
+ m365 spo term group list --webUrl https://contoso.sharepoint.com/sites/project-x
37
+ ```
38
+
39
+ ## Response
40
+
41
+ === "JSON"
42
+
43
+ ```json
44
+ [
45
+ {
46
+ "_ObjectType_": "SP.Taxonomy.TermGroup",
47
+ "_ObjectIdentity_": "5522b1a0-b01a-2000-4160-d04eee2e977f|fec14c62-7c3b-481b-851b-c80d7802b224:gr:aCf0Cz4D9UOS7+b/OlUY5XrNqUp10tpPhLK4MIXc7g8=",
48
+ "CreatedDate": "2019-09-03T06:41:32.070Z",
49
+ "Id": "4aa9cd7a-d275-4fda-84b2-b83085dcee0f",
50
+ "LastModifiedDate": "2019-09-03T06:41:32.070Z",
51
+ "Name": "People",
52
+ "Description": "",
53
+ "IsSiteCollectionGroup": false,
54
+ "IsSystemGroup": false
55
+ }
56
+ ]
57
+ ```
58
+
59
+ === "Text"
60
+
61
+ ```text
62
+ Id Name
63
+ ------------------------------------ -----------------------------------------------------------
64
+ 4aa9cd7a-d275-4fda-84b2-b83085dcee0f People
65
+ ```
66
+
67
+ === "CSV"
68
+
69
+ ```csv
70
+ _ObjectType_,_ObjectIdentity_,CreatedDate,Id,LastModifiedDate,Name,Description,IsSiteCollectionGroup,IsSystemGroup
71
+ SP.Taxonomy.TermGroup,7522b1a0-804d-2000-41be-bba084eae72f|fec14c62-7c3b-481b-851b-c80d7802b224:gr:aCf0Cz4D9UOS7+b/OlUY5XrNqUp10tpPhLK4MIXc7g8=,2019-09-03T06:41:32.070Z,4aa9cd7a-d275-4fda-84b2-b83085dcee0f,2019-09-03T06:41:32.070Z,People,,,
72
+ ```
73
+
74
+ === "Markdown"
75
+
76
+ ```md
77
+ # spo term group list
78
+
79
+ Date: 5/9/2023
80
+
81
+ ## People (4aa9cd7a-d275-4fda-84b2-b83085dcee0f)
82
+
83
+ Property | Value
84
+ ---------|-------
85
+ \_ObjectType\_ | SP.Taxonomy.TermGroup
86
+ \_ObjectIdentity\_ | 8c22b1a0-200f-2000-3976-694ba2bf8a01\|fec14c62-7c3b-481b-851b-c80d7802b224:gr:aCf0Cz4D9UOS7+b/OlUY5XrNqUp10tpPhLK4MIXc7g8=
87
+ CreatedDate | 2019-09-03T06:41:32.070Z
88
+ Id | 4aa9cd7a-d275-4fda-84b2-b83085dcee0f
89
+ LastModifiedDate | 2019-09-03T06:41:32.070Z
90
+ Name | People
91
+ Description |
92
+ IsSiteCollectionGroup | false
93
+ IsSystemGroup | false
94
+ ```
@@ -10,17 +10,20 @@ m365 spo term list [options]
10
10
 
11
11
  ## Options
12
12
 
13
+ `-u, --webUrl [webUrl]`
14
+ : If specified, allows you to list terms from the tenant term store as well as the sitecollection specific term store. Defaults to the tenant admin site.
15
+
13
16
  `--termGroupId [termGroupId]`
14
- : ID of the term group where the term set is located. Specify `termGroupId` or `termGroupName` but not both
17
+ : ID of the term group where the term set is located. Specify `termGroupId` or `termGroupName` but not both.
15
18
 
16
19
  `--termGroupName [termGroupName]`
17
- : Name of the term group where the term set is located. Specify `termGroupId` or `termGroupName` but not both
20
+ : Name of the term group where the term set is located. Specify `termGroupId` or `termGroupName` but not both.
18
21
 
19
22
  `--termSetId [termSetId]`
20
- : ID of the term set for which to retrieve terms. Specify `termSetId` or `termSetName` but not both
23
+ : ID of the term set for which to retrieve terms. Specify `termSetId` or `termSetName` but not both.
21
24
 
22
25
  `--termSetName [termSetName]`
23
- : Name of the term set for which to retrieve terms. Specify `termSetId` or `termSetName` but not both
26
+ : Name of the term set for which to retrieve terms. Specify `termSetId` or `termSetName` but not both.
24
27
 
25
28
  `--includeChildTerms`
26
29
  : If specified, child terms are loaded as well.
@@ -30,23 +33,31 @@ m365 spo term list [options]
30
33
  ## Remarks
31
34
 
32
35
  !!! important
33
- To use this command you have to have permissions to access the tenant admin site.
36
+ To use this command without the --webUrl option you have to have permissions to access the tenant admin site.
37
+
38
+ When using the `--webUrl` option you can connect to the term store with limited permissions, and do not need the SharePoint Adminstrator role. You need to be a site visitor or more. It allows you to list terms from the tenant term store as well as terms from the sitecollection term store.
34
39
 
35
40
  ## Examples
36
41
 
37
- List taxonomy terms from the term group and term set with the given name
42
+ List taxonomy terms from the specified sitecollection, the term group and term set with the given name
43
+
44
+ ```sh
45
+ m365 spo term list --webUrl https://contoso.sharepoint.com/sites/project-x --termGroupName PnPTermSets --termSetName PnP-Organizations
46
+ ```
47
+
48
+ List taxonomy terms from the term group and term set with the given name.
38
49
 
39
50
  ```sh
40
51
  m365 spo term list --termGroupName PnPTermSets --termSetName PnP-Organizations
41
52
  ```
42
53
 
43
- List taxonomy terms from the term group and term set with the given ID
54
+ List taxonomy terms from the term group and term set with the given ID.
44
55
 
45
56
  ```sh
46
57
  m365 spo term list --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termSetId 0e8f395e-ff58-4d45-9ff7-e331ab728bec
47
58
  ```
48
59
 
49
- List taxonomy terms from the term group and term set with the given ID including child terms if any are found
60
+ List taxonomy terms from the term group and term set with the given ID including child terms if any are found.
50
61
 
51
62
  ```sh
52
63
  m365 spo term list --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termSetId 0e8f395e-ff58-4d45-9ff7-e331ab728bec --includeChildTerms
@@ -104,6 +115,37 @@ m365 spo term list --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termSetI
104
115
  c387e91c-b553-4b92-886b-9af717cd73b0,Financing
105
116
  ```
106
117
 
118
+ === "Markdown"
119
+
120
+ ```md
121
+ # spo term list --termGroupName "PnPTermSets" --termSetName "PnP-Organizations"
122
+
123
+ Date: 5/8/2023
124
+
125
+ ## Financing (c387e91c-b553-4b92-886b-9af717cd73b0)
126
+
127
+ Property | Value
128
+ ---------|-------
129
+ \_ObjectType\_ | SP.Taxonomy.Term
130
+ \_ObjectIdentity\_ | b6d6b0a0-50c8-2000-41be-bd745120140b\|fec14c62-7c3b-481b-851b-c80d7802b224:te:aCf0Cz4D9UOS7+b/OlUY5XrNqUp10tpPhLK4MIXc7g/qydiOUnAdTKTXucEL/+pvpnFcKyvXqEmjv9gGNthbRA==
131
+ CreatedDate | 2021-07-07T09:42:02.283Z
132
+ Id | c387e91c-b553-4b92-886b-9af717cd73b0
133
+ LastModifiedDate | 2021-07-07T09:42:02.283Z
134
+ Name | Financing
135
+ IsAvailableForTagging | true
136
+ Owner | NT Service\SPTimerV4
137
+ Description |
138
+ IsDeprecated | false
139
+ IsKeyword | false
140
+ IsPinned | false
141
+ IsPinnedRoot | false
142
+ IsReused | false
143
+ IsRoot | true
144
+ IsSourceTerm | true
145
+ PathOfTerm | Financing
146
+ TermsCount | 0
147
+ ```
148
+
107
149
  ### `includeChildTerms` response
108
150
 
109
151
  When we make use of the option `includeChildTerms` the response will differ.
@@ -180,3 +222,33 @@ When we make use of the option `includeChildTerms` the response will differ.
180
222
  c387e91c-b553-4b92-886b-9af717cd73b0,Financing,079b9c7f-9f49-421b-b1e9-83b908e0d9d4
181
223
  ```
182
224
 
225
+ === "Markdown"
226
+
227
+ ```md
228
+ # spo term list --termGroupName "PnPTermSets" --termSetName "PnP-Organizations" --includeChildTerms "true"
229
+
230
+ Date: 5/8/2023
231
+
232
+ ## Financing (c387e91c-b553-4b92-886b-9af717cd73b0)
233
+
234
+ Property | Value
235
+ ---------|-------
236
+ \_ObjectType\_ | SP.Taxonomy.Term
237
+ \_ObjectIdentity\_ | b6d6b0a0-50c8-2000-41be-bd745120140b\|fec14c62-7c3b-481b-851b-c80d7802b224:te:aCf0Cz4D9UOS7+b/OlUY5XrNqUp10tpPhLK4MIXc7g/qydiOUnAdTKTXucEL/+pvpnFcKyvXqEmjv9gGNthbRA==
238
+ CreatedDate | 2021-07-07T09:42:02.283Z
239
+ Id | c387e91c-b553-4b92-886b-9af717cd73b0
240
+ LastModifiedDate | 2021-07-07T09:42:02.283Z
241
+ Name | Financing
242
+ IsAvailableForTagging | true
243
+ Owner | NT Service\SPTimerV4
244
+ Description |
245
+ IsDeprecated | false
246
+ IsKeyword | false
247
+ IsPinned | false
248
+ IsPinnedRoot | false
249
+ IsReused | false
250
+ IsRoot | true
251
+ IsSourceTerm | true
252
+ PathOfTerm | Financing
253
+ TermsCount | 0
254
+ ```
@@ -10,35 +10,119 @@ m365 spo term set get [options]
10
10
 
11
11
  ## Options
12
12
 
13
+ `-u, --webUrl [webUrl]`
14
+ : If specified, allows you to get a term set 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 set to retrieve. Specify `name` or `id` but not both
17
+ : ID of the term set to retrieve. Specify `name` or `id` but not both.
15
18
 
16
19
  `-n, --name [name]`
17
- : Name of the term set to retrieve. Specify `name` or `id` but not both
20
+ : Name of the term set 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
  --8<-- "docs/cmd/_global.md"
26
29
 
27
30
  ## Remarks
28
31
 
29
32
  !!! important
30
- To use this command you have to have permissions to access the tenant admin site.
33
+ To use this command without the --webUrl option you have to have permissions to access the tenant admin site.
34
+
35
+ When using the `--webUrl` option you can connect to the term store with limited permissions, and do not need the SharePoint Adminstrator role. You need to be a site visitor or more. It allows you to get a term set from the tenant term store as well as a term set from the sitecollection term store.
31
36
 
32
37
  ## Examples
33
38
 
34
- Get information about a taxonomy term set using its ID
39
+ Get information about a taxonomy term set using its ID.
35
40
 
36
41
  ```sh
37
42
  m365 spo term set get --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termGroupName PnPTermSets
38
43
  ```
39
44
 
40
- Get information about a taxonomy term set using its name
45
+ Get information about a taxonomy term set using its name.
41
46
 
42
47
  ```sh
43
- m365 spo term set get --name PnPTermSets --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb
48
+ m365 spo term set get --name PnP-Organizations --termGroupId 0a099ee9-e231-4ae9-a5b6-d7f94a0d241d
44
49
  ```
50
+
51
+ Get information about a taxonomy term set using its ID from the specified sitecollection.
52
+
53
+ ```sh
54
+ m365 spo term set get --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termGroupName PnPTermSets --webUrl https://contoso.sharepoint.com/sites/project-x
55
+ ```
56
+
57
+ ## Response
58
+
59
+ === "JSON"
60
+
61
+ ```json
62
+ {
63
+ "CreatedDate": "2019-09-03T06:41:32.110Z",
64
+ "Id": "0e8f395e-ff58-4d45-9ff7-e331ab728beb",
65
+ "LastModifiedDate": "2019-09-03T06:41:32.260Z",
66
+ "Name": "PnP-Organizations",
67
+ "CustomProperties": {
68
+ "SearchCenterNavVer": "15"
69
+ },
70
+ "CustomSortOrder": null,
71
+ "IsAvailableForTagging": true,
72
+ "Owner": "",
73
+ "Contact": "",
74
+ "Description": "",
75
+ "IsOpenForTermCreation": true,
76
+ "Names": {
77
+ "1033": "PnP-Organizations"
78
+ },
79
+ "Stakeholders": []
80
+ }
81
+ ```
82
+
83
+ === "Text"
84
+
85
+ ```text
86
+ Contact :
87
+ CreatedDate : 2019-09-03T06:41:32.110Z
88
+ CustomProperties : {"SearchCenterNavVer":"15"}
89
+ CustomSortOrder : null
90
+ Description :
91
+ Id : 0e8f395e-ff58-4d45-9ff7-e331ab728beb
92
+ IsAvailableForTagging: true
93
+ IsOpenForTermCreation: true
94
+ LastModifiedDate : 2019-09-03T06:41:32.260Z
95
+ Name : PnP-Organizations
96
+ Names : {"1033":"PnP-Organizations"}
97
+ Owner :
98
+ Stakeholders : []
99
+ ```
100
+
101
+ === "CSV"
102
+
103
+ ```csv
104
+ CreatedDate,Id,LastModifiedDate,Name,IsAvailableForTagging,Owner,Contact,Description,IsOpenForTermCreation
105
+ 2019-09-03T06:41:32.110Z,0e8f395e-ff58-4d45-9ff7-e331ab728beb,2019-09-03T06:41:32.260Z,PnP-Organizations,1,,,,1
106
+ ```
107
+
108
+ === "Markdown"
109
+
110
+ ```md
111
+ # spo term set get --name "PnP-Organizations" --termGroupName "PnPTermSets"
112
+
113
+ Date: 5/9/2023
114
+
115
+ ## PnP-Organizations (0e8f395e-ff58-4d45-9ff7-e331ab728beb)
116
+
117
+ Property | Value
118
+ ---------|-------
119
+ CreatedDate | 2019-09-03T06:41:32.110Z
120
+ Id | 0e8f395e-ff58-4d45-9ff7-e331ab728beb
121
+ LastModifiedDate | 2019-09-03T06:41:32.260Z
122
+ Name | PnP-Organizations
123
+ IsAvailableForTagging | true
124
+ Owner |
125
+ Contact |
126
+ Description |
127
+ IsOpenForTermCreation | true
128
+ ```