@pnp/cli-microsoft365 6.2.0-beta.725ebd5 → 6.2.0-beta.97d58e0

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 (79) hide show
  1. package/dist/m365/context/commands/option/option-remove.js +105 -0
  2. package/dist/m365/context/commands/option/option-set.js +84 -0
  3. package/dist/m365/context/commands.js +2 -0
  4. package/dist/m365/onenote/commands/page/page-list.js +137 -0
  5. package/dist/m365/onenote/commands.js +2 -1
  6. package/dist/m365/planner/commands/bucket/bucket-add.js +0 -6
  7. package/dist/m365/planner/commands/bucket/bucket-get.js +0 -6
  8. package/dist/m365/planner/commands/bucket/bucket-list.js +0 -6
  9. package/dist/m365/planner/commands/bucket/bucket-remove.js +0 -6
  10. package/dist/m365/planner/commands/bucket/bucket-set.js +0 -6
  11. package/dist/m365/planner/commands/plan/plan-add.js +0 -6
  12. package/dist/m365/planner/commands/plan/plan-get.js +0 -6
  13. package/dist/m365/planner/commands/plan/plan-list.js +0 -6
  14. package/dist/m365/planner/commands/plan/plan-remove.js +0 -6
  15. package/dist/m365/planner/commands/plan/plan-set.js +0 -6
  16. package/dist/m365/planner/commands/task/task-add.js +0 -6
  17. package/dist/m365/planner/commands/task/task-checklistitem-add.js +0 -6
  18. package/dist/m365/planner/commands/task/task-checklistitem-list.js +0 -6
  19. package/dist/m365/planner/commands/task/task-get.js +0 -6
  20. package/dist/m365/planner/commands/task/task-list.js +0 -6
  21. package/dist/m365/planner/commands/task/task-reference-list.js +0 -6
  22. package/dist/m365/planner/commands/task/task-set.js +0 -6
  23. package/dist/m365/pp/commands/aibuildermodel/aibuildermodel-get.js +110 -0
  24. package/dist/m365/pp/commands/aibuildermodel/aibuildermodel-remove.js +130 -0
  25. package/dist/m365/pp/commands/solution/solution-publish.js +156 -0
  26. package/dist/m365/pp/commands.js +3 -0
  27. package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js +143 -0
  28. package/dist/m365/purview/commands.js +1 -0
  29. package/dist/m365/spo/commands/file/file-retentionlabel-ensure.js +121 -0
  30. package/dist/m365/spo/commands/file/file-retentionlabel-remove.js +141 -0
  31. package/dist/m365/spo/commands/file/file-sharinglink-add.js +141 -0
  32. package/dist/m365/spo/commands/file/file-sharinglink-get.js +116 -0
  33. package/dist/m365/spo/commands/file/file-sharinglink-list.js +19 -6
  34. package/dist/m365/spo/commands/file/file-sharinglink-remove.js +135 -0
  35. package/dist/m365/spo/commands/folder/folder-retentionlabel-ensure.js +138 -0
  36. package/dist/m365/spo/commands/folder/folder-retentionlabel-remove.js +157 -0
  37. package/dist/m365/spo/commands/group/group-member-add.js +33 -6
  38. package/dist/m365/spo/commands/list/list-add.js +3 -0
  39. package/dist/m365/spo/commands/list/list-retentionlabel-remove.js +146 -0
  40. package/dist/m365/spo/commands/list/list-set.js +3 -0
  41. package/dist/m365/spo/commands/listitem/listitem-list.js +1 -1
  42. package/dist/m365/spo/commands/listitem/listitem-retentionlabel-remove.js +2 -2
  43. package/dist/m365/spo/commands/term/term-list.js +99 -29
  44. package/dist/m365/spo/commands.js +8 -0
  45. package/dist/m365/teams/commands/message/message-send.js +81 -0
  46. package/dist/m365/teams/commands.js +1 -0
  47. package/dist/utils/formatting.js +22 -0
  48. package/docs/docs/cmd/aad/app/app-remove.md +11 -7
  49. package/docs/docs/cmd/context/option/option-remove.md +37 -0
  50. package/docs/docs/cmd/context/option/option-set.md +31 -0
  51. package/docs/docs/cmd/onenote/page/page-list.md +140 -0
  52. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-get.md +99 -0
  53. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-remove.md +53 -0
  54. package/docs/docs/cmd/pp/solution/solution-publish.md +52 -0
  55. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +128 -0
  56. package/docs/docs/cmd/spo/cdn/cdn-get.md +1 -1
  57. package/docs/docs/cmd/spo/cdn/cdn-origin-add.md +1 -1
  58. package/docs/docs/cmd/spo/cdn/cdn-origin-list.md +1 -1
  59. package/docs/docs/cmd/spo/cdn/cdn-origin-remove.md +1 -1
  60. package/docs/docs/cmd/spo/cdn/cdn-policy-list.md +1 -1
  61. package/docs/docs/cmd/spo/cdn/cdn-policy-set.md +1 -1
  62. package/docs/docs/cmd/spo/cdn/cdn-set.md +1 -1
  63. package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.md +47 -0
  64. package/docs/docs/cmd/spo/file/file-retentionlabel-remove.md +43 -0
  65. package/docs/docs/cmd/spo/file/file-sharinglink-add.md +89 -0
  66. package/docs/docs/cmd/spo/file/file-sharinglink-get.md +107 -0
  67. package/docs/docs/cmd/spo/file/file-sharinglink-list.md +16 -7
  68. package/docs/docs/cmd/spo/file/file-sharinglink-remove.md +52 -0
  69. package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.md +47 -0
  70. package/docs/docs/cmd/spo/folder/folder-retentionlabel-remove.md +43 -0
  71. package/docs/docs/cmd/spo/group/group-member-add.md +22 -4
  72. package/docs/docs/cmd/spo/list/list-add.md +3 -9
  73. package/docs/docs/cmd/spo/list/list-retentionlabel-remove.md +52 -0
  74. package/docs/docs/cmd/spo/list/list-set.md +3 -3
  75. package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -12
  76. package/docs/docs/cmd/spo/listitem/listitem-list.md +5 -5
  77. package/docs/docs/cmd/spo/term/term-list.md +138 -0
  78. package/docs/docs/cmd/teams/message/message-send.md +119 -0
  79. package/package.json +1 -1
@@ -0,0 +1,140 @@
1
+ # onenote page list
2
+
3
+ Retrieve a list of OneNote pages.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 onenote page list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--userId [userId]`
14
+ : Id of the user. Use either `userId`, `userName`, `groupId`, `groupName` or `webUrl` but not multiple.
15
+
16
+ `--userName [userName]`
17
+ : Name of the user. Use either `userId`, `userName`, `groupId`, `groupName` or `webUrl` but not multiple.
18
+
19
+ `--groupId [groupId]`
20
+ : Id of the SharePoint group. Use either `userId`, `userName`, `groupId`, `groupName` or `webUrl` but not multiple.
21
+
22
+ `--groupName [groupName]`
23
+ : Name of the SharePoint group. Use either `userId`, `userName`, `groupId`, `groupName` or `webUrl` but not multiple.
24
+
25
+ `-u, --webUrl [webUrl]`
26
+ : URL of the SharePoint site. Use either `userId`, `userName`, `groupId`, `groupName` or `webUrl` but not multiple.
27
+
28
+ --8<-- "docs/cmd/_global.md"
29
+
30
+ ## Remarks
31
+
32
+ When we don't specify either `userId`, `userName`, `groupId`, `groupName` or `webUrl`, the OneNote pages will be retrieved of the currently logged in user.
33
+
34
+ ## Examples
35
+
36
+ List Microsoft OneNote pages for the currently logged in user
37
+
38
+ ```sh
39
+ m365 onenote page list
40
+ ```
41
+
42
+ List Microsoft OneNote pages in a specific group specified by id
43
+
44
+ ```sh
45
+ m365 onenote page list --groupId 233e43d0-dc6a-482e-9b4e-0de7a7bce9b4
46
+ ```
47
+
48
+ List Microsoft OneNote pages in a specific group specified by name
49
+
50
+ ```sh
51
+ m365 onenote page list --groupName "MyGroup"
52
+ ```
53
+
54
+ List Microsoft OneNote pages for a specific user specified by name
55
+
56
+ ```sh
57
+ m365 onenote page list --userName user1@contoso.onmicrosoft.com
58
+ ```
59
+
60
+ List Microsoft OneNote pages for a specific user specified by id
61
+
62
+ ```sh
63
+ m365 onenote page list --userId 2609af39-7775-4f94-a3dc-0dd67657e900
64
+ ```
65
+
66
+ List Microsoft OneNote pages for a specific site
67
+
68
+ ```sh
69
+ m365 onenote page list --webUrl https://contoso.sharepoint.com/sites/testsite
70
+ ```
71
+
72
+ ## Response
73
+
74
+ === "JSON"
75
+
76
+ ```json
77
+ [
78
+ {
79
+ "id": "1-a26aaec43ed348bd82edf4eb44e73d6c!68-3eb21088-b613-4698-98df-92a7d34e0678",
80
+ "self": "https://graph.microsoft.com/v1.0/users/john@contoso.com/onenote/pages/1-a26aaec43ed348bd82edf4eb44e73d6c!68-3eb21088-b613-4698-98df-92a7d34e0678",
81
+ "createdDateTime": "2023-01-07T10:57:15Z",
82
+ "title": "Page B",
83
+ "createdByAppId": "",
84
+ "contentUrl": "https://graph.microsoft.com/v1.0/users/john@contoso.com/onenote/pages/1-a26aaec43ed348bd82edf4eb44e73d6c!68-3eb21088-b613-4698-98df-92a7d34e0678/content",
85
+ "lastModifiedDateTime": "2023-01-07T10:57:17Z",
86
+ "links": {
87
+ "oneNoteClientUrl": {
88
+ "href": "onenote:https://contoso-my.sharepoint.com/personal/john_contoso_com/Documents/Notitieblokken/My%20OneNote/Test.one#Page%20B&section-id=94cacaca-d6b5-428d-b967-d3cf01b95c28&page-id=46a1b220-7ffd-4512-a571-55322097c08d&end"
89
+ },
90
+ "oneNoteWebUrl": {
91
+ "href": "https://contoso-my.sharepoint.com/personal/john_contoso_com/Documents/Notitieblokken/My%20OneNote?wd=target%28Test.one%7C94cacaca-d6b5-428d-b967-d3cf01b95c28%2FPage%20B%7C46a1b220-7ffd-4512-a571-55322097c08d%2F%29"
92
+ }
93
+ },
94
+ "parentSection": {
95
+ "id": "1-3eb21088-b613-4698-98df-92a7d34e0678",
96
+ "displayName": "Test",
97
+ "self": "https://graph.microsoft.com/v1.0/users/john@contoso.com/onenote/sections/1-3eb21088-b613-4698-98df-92a7d34e0678"
98
+ }
99
+ }
100
+ ]
101
+ ```
102
+
103
+ === "Text"
104
+
105
+ ```text
106
+ createdDateTime title id
107
+ -------------------- ------ --------------------------------------------------------------------------
108
+ 2023-01-07T10:57:15Z Page B 1-a26aaec43ed348bd82edf4eb44e73d6c!68-3eb21088-b613-4698-98df-92a7d34e0678
109
+ ```
110
+
111
+ === "CSV"
112
+
113
+ ```csv
114
+ createdDateTime,title,id
115
+ 2023-01-07T10:57:15Z,Page B,1-a26aaec43ed348bd82edf4eb44e73d6c!68-3eb21088-b613-4698-98df-92a7d34e0678
116
+ ```
117
+
118
+ === "Markdown"
119
+
120
+ ```md
121
+ # onenote page list --userName "mathijs@mathijsdev2.onmicrosoft.com"
122
+
123
+ Date: 07/01/2023
124
+
125
+ ## Page A (1-a26aaec43ed348bd82edf4eb44e73d6c!14-3eb21088-b613-4698-98df-92a7d34e0678)
126
+
127
+ ## Page B (1-a26aaec43ed348bd82edf4eb44e73d6c!68-3eb21088-b613-4698-98df-92a7d34e0678)
128
+
129
+ Property | Value
130
+ ---------|-------
131
+ id | 1-a26aaec43ed348bd82edf4eb44e73d6c!68-3eb21088-b613-4698-98df-92a7d34e0678
132
+ self | https://graph.microsoft.com/v1.0/users/john@contoso.com/onenote/pages/1-a26aaec43ed348bd82edf4eb44e73d6c!68-3eb21088-b613-4698-98df-92a7d34e0678
133
+ createdDateTime | 2023-01-07T10:57:15Z
134
+ title | Page B
135
+ createdByAppId |
136
+ contentUrl | https://graph.microsoft.com/v1.0/users/john@contoso.com/onenote/pages/1-a26aaec43ed348bd82edf4eb44e73d6c!68-3eb21088-b613-4698-98df-92a7d34e0678/content
137
+ lastModifiedDateTime | 2023-01-07T10:57:17Z
138
+ links | { "oneNoteClientUrl": { "href": "onenote:https://contoso-my.sharepoint.com/personal/john_contoso_com/Documents/Notitieblokken/My%20OneNote/Test.one#Page%20B& -id=94cacaca-d6b5-428d-b967-d3cf01b95c28&page-id=46a1b220-7ffd-4512-a571-55322097c08d&end" }, "oneNoteWebUrl": { "href": "https://contoso-my.sharepoint.com/personal/john_contoso_com/Documents/Notitieblokken/My%20OneNote?wd=target%28Test.one%7C94cacaca-d6b5-428d-b967-d3cf01b95c28%2FPage%20B%7C46a1b220-7ffd-4512-a571-55322097c08d%2F%29"}}
139
+ parentSection | {"id":"1-3eb21088-b613-4698-98df-92a7d34e0678","displayName":"Test","self":"https://graph.microsoft.com/v1.0/users/john@contoso.com/onenote/sections/1-3eb21088-b613-4698-98df-92a7d34e0678"}
140
+ ```
@@ -0,0 +1,99 @@
1
+ # pp aibuildermodel get
2
+
3
+ Gets a specific AI builder models in the specified Power Platform environment
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ pp aibuildermodel get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-e, --environment <environment>`
14
+ : The name of the environment
15
+
16
+ `-i, --id [id]`
17
+ : The id of the AI Builder model. Specify either `id` or `name` but not both
18
+
19
+ `-n, --name [name]`
20
+ : The name of the AI Builder model. Specify either `id` or `name` but not both
21
+
22
+ `--asAdmin`
23
+ : Run the command as admin for environments you do not have explicitly assigned permissions to
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Examples
28
+
29
+ Get an AI Builder model in a specific environment
30
+
31
+ ```sh
32
+ m365 pp aibuildermodel get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --name "Document Processing 11/29/2022, 12:58:43 PM"
33
+ ```
34
+
35
+ Get an AI Builder models in a specific environment by id as admin
36
+
37
+ ```sh
38
+ m365 pp aibuildermodel get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "08ffffbe-ec1c-4e64-b64b-dd1db926c613" --asAdmin
39
+ ```
40
+
41
+ ## Response
42
+
43
+ === "JSON"
44
+
45
+ ```json
46
+ {
47
+ "statecode": 0,
48
+ "_msdyn_templateid_value": "10707e4e-1d56-e911-8194-000d3a6cd5a5",
49
+ "msdyn_modelcreationcontext": "{}",
50
+ "createdon": "2022-11-29T11:58:45Z",
51
+ "_ownerid_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
52
+ "modifiedon": "2022-11-29T11:58:45Z",
53
+ "msdyn_sharewithorganizationoncreate": false,
54
+ "msdyn_aimodelidunique": "b0328b67-47e2-4202-8189-e617ec9a88bd",
55
+ "solutionid": "fd140aae-4df4-11dd-bd17-0019b9312238",
56
+ "ismanaged": false,
57
+ "versionnumber": 1458121,
58
+ "msdyn_name": "Document Processing 11/29/2022, 12:58:43 PM",
59
+ "introducedversion": "1.0",
60
+ "statuscode": 0,
61
+ "_modifiedby_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
62
+ "overwritetime": "1900-01-01T00:00:00Z",
63
+ "componentstate": 0,
64
+ "_createdby_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
65
+ "_owningbusinessunit_value": "6da087c1-1c4d-ed11-bba1-000d3a2caf7f",
66
+ "_owninguser_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
67
+ "msdyn_aimodelid": "08ffffbe-ec1c-4e64-b64b-dd1db926c613",
68
+ "_msdyn_activerunconfigurationid_value": null,
69
+ "overriddencreatedon": null,
70
+ "_msdyn_retrainworkflowid_value": null,
71
+ "importsequencenumber": null,
72
+ "_msdyn_scheduleinferenceworkflowid_value": null,
73
+ "_modifiedonbehalfby_value": null,
74
+ "utcconversiontimezonecode": null,
75
+ "_createdonbehalfby_value": null,
76
+ "_owningteam_value": null,
77
+ "timezoneruleversionnumber": null,
78
+ "iscustomizable": {
79
+ "Value": true,
80
+ "CanBeChanged": true,
81
+ "ManagedPropertyLogicalName": "iscustomizableanddeletable"
82
+ }
83
+ }
84
+ ```
85
+
86
+ === "Text"
87
+
88
+ ```text
89
+ createdon modifiedon msdyn_aimodelid msdyn_name
90
+ -------------------- -------------------- ------------------------------------ -------------------------------------------
91
+ 2022-10-25T14:44:48Z 2022-10-25T14:44:48Z 08ffffbe-ec1c-4e64-b64b-dd1db926c613 Document Processing 11/29/2022, 12:58:43 PM
92
+ ```
93
+
94
+ === "CSV"
95
+
96
+ ```csv
97
+ msdyn_name,msdyn_aimodelid,createdon,modifiedon
98
+ "Document Processing 11/29/2022, 12:58:43 PM",08ffffbe-ec1c-4e64-b64b-dd1db926c613,2022-11-29T11:58:45Z,2022-11-29T11:58:45Z
99
+ ```
@@ -0,0 +1,53 @@
1
+ # pp aibuildermodel remove
2
+
3
+ Removes the specified Microsoft Power Platform aibuildermodel in the specified Power Platform environment
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 pp aibuildermodel remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-e, --environment <environment>`
14
+ : The name of the environment.
15
+
16
+ `-i, --id [id]`
17
+ : The id of the AI builder model. Specify either `id` or `name` but not both.
18
+
19
+ `-n, --name [name]`
20
+ : The name of the AI builder model. Specify either `id` or `name` but not both.
21
+
22
+ `--asAdmin`
23
+ : Run the command as admin for environments you do not have explicitly assigned permissions to.
24
+
25
+ `--confirm`
26
+ : Don't prompt for confirmation.
27
+
28
+ --8<-- "docs/cmd/_global.md"
29
+
30
+ ## Examples
31
+
32
+ Removes the AI builder model owned by the currently signed-in user based on the name parameter
33
+
34
+ ```sh
35
+ m365 pp aibuildermodel remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "AI Builder Model Name"
36
+ ```
37
+
38
+ Removes the AI builder model owned by the currently signed-in user based on the name parameter without confirmation
39
+
40
+ ```sh
41
+ m365 pp aibuildermodel remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "AI Builder Model Name" --confirm
42
+ ```
43
+
44
+ Removes the AI builder model owned by another user based on the id parameter
45
+
46
+ ```sh
47
+ m365 pp aibuildermodel remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 9d9a13d0-6255-ed11-bba2-000d3adf774e --asAdmin
48
+ ```
49
+
50
+
51
+ ## Response
52
+
53
+ The command won't return a response on success.
@@ -0,0 +1,52 @@
1
+ # pp solution publish
2
+
3
+ Publishes the components of a solution in a given Power Platform environment
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 pp solution publish [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-e, --environment <environment>`
14
+ : The name of the environment.
15
+
16
+ `-i, --id [id]`
17
+ : The id of the solution. Specify either `id` or `name` but not both.
18
+
19
+ `-n, --name [name]`
20
+ : The unique name (not the display name) of the solution. Specify either `id` or `name` but not both.
21
+
22
+ `--asAdmin`
23
+ : Run the command as admin for environments you do not have explicitly assigned permissions to.
24
+
25
+ `--wait`
26
+ : Wait for the job to complete
27
+
28
+ --8<-- "docs/cmd/_global.md"
29
+
30
+ ## Examples
31
+
32
+ Publishes the components of a specified solution with a specific name, owned by the currently signed-in user
33
+
34
+ ```sh
35
+ m365 pp solution publish --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "Solution Name"
36
+ ```
37
+
38
+ Publishes the components of a specified solution owned by the currently signed-in user based on the id parameter and waits for completion
39
+
40
+ ```sh
41
+ m365 pp solution publish --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 00000001-0000-0000-0001-00000000009b --wait
42
+ ```
43
+
44
+ Publishes the components of a specified solution owned by another user based on the name parameter
45
+
46
+ ```sh
47
+ m365 pp solution publish --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "Solution Name" --asAdmin
48
+ ```
49
+
50
+ ## Response
51
+
52
+ The command won't return a response on success.
@@ -0,0 +1,128 @@
1
+ # purview retentionlabel add
2
+
3
+ Create a retention label
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 purview retentionlabel add [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-n, --displayName <displayName>`
14
+ : The display name of the label.
15
+
16
+ `--behaviorDuringRetentionPeriod <behaviorDuringRetentionPeriod>`
17
+ : Specifies how the behavior of a document with this label should be during the retention period. Allowed values: `doNotRetain`, `retain`, `retainAsRecord`, `retainAsRegulatoryRecord`.
18
+
19
+ `--actionAfterRetentionPeriod <actionAfterRetentionPeriod>`
20
+ : Specifies the action to take on a document with this label applied after the retention period. Allowed values: `none`, `delete`, `startDispositionReview`.
21
+
22
+ `--retentionDuration <retentionDuration>`
23
+ : The number of days to retain the content.
24
+
25
+ `-t, --retentionTrigger [retentionTrigger]`
26
+ : Specifies whether the retention duration is calculated from the content creation date, labeled date, or last modification date. Allowed values: `dateLabeled`, `dateCreated`, `dateModified`, `dateOfEvent`. Defaults to `dateLabeled`.
27
+
28
+ `--defaultRecordBehavior [defaultRecordBehavior]`
29
+ : Specifies the locked or unlocked state of a record label when it is created. Allowed values: `startLocked`, `startUnlocked`, Defaults to `startLocked`.
30
+
31
+ `--descriptionForUsers [descriptionForUsers]`
32
+ : The label information for the user.
33
+
34
+ `--descriptionForAdmins [descriptionForAdmins]`
35
+ : The label information for the admin.
36
+
37
+ `--labelToBeApplied [labelToBeApplied]`
38
+ : Specifies the replacement label to be applied automatically after the retention period of the current label ends.
39
+
40
+ --8<-- "docs/cmd/_global.md"
41
+
42
+ ## Examples
43
+
44
+ Create a retention label that retains documents and deletes them after one year.
45
+
46
+ ```sh
47
+ m365 purview retentionlabel add --displayName 'some label' --behaviorDuringRetentionPeriod retain --actionAfterRetentionPeriod delete --retentionDuration 365
48
+ ```
49
+
50
+ Create a retention label that retains documents as records and does not take any action one year after the last modification date.
51
+
52
+ ```sh
53
+ m365 purview retentionlabel add --displayName 'some label' --behaviorDuringRetentionPeriod retainAsRecord --actionAfterRetentionPeriod none --retentionDuration 365 --retentionTrigger dateModified
54
+ ```
55
+
56
+ ## Remarks
57
+
58
+ !!! attention
59
+ 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.
60
+
61
+ ## More information
62
+
63
+ - Create retentionLabel: [https://learn.microsoft.com/en-us/graph/api/security-retentionlabel-post?view=graph-rest-beta&tabs=http](https://learn.microsoft.com/en-us/graph/api/security-retentionlabel-post?view=graph-rest-beta&tabs=http)
64
+
65
+ ## Response
66
+
67
+ === "JSON"
68
+
69
+ ```json
70
+ {
71
+ "displayName": "some label",
72
+ "descriptionForAdmins": "Description for admins",
73
+ "descriptionForUsers": "Description for users",
74
+ "isInUse": false,
75
+ "retentionTrigger": "dateLabeled",
76
+ "behaviorDuringRetentionPeriod": "retain",
77
+ "actionAfterRetentionPeriod": "delete",
78
+ "createdDateTime": "2022-12-21T09:28:37Z",
79
+ "lastModifiedDateTime": "2022-12-21T09:28:37Z",
80
+ "labelToBeApplied": "another label",
81
+ "defaultRecordBehavior": "startLocked",
82
+ "id": "f7e05955-210b-4a8e-a5de-3c64cfa6d9be",
83
+ "retentionDuration": {
84
+ "days": 365
85
+ },
86
+ "createdBy": {
87
+ "user": {
88
+ "id": null,
89
+ "displayName": "John Doe"
90
+ }
91
+ },
92
+ "lastModifiedBy": {
93
+ "user": {
94
+ "id": null,
95
+ "displayName": "John Doe"
96
+ }
97
+ },
98
+ "dispositionReviewStages": []
99
+ }
100
+ ```
101
+
102
+ === "Text"
103
+
104
+ ```text
105
+ actionAfterRetentionPeriod : delete
106
+ behaviorDuringRetentionPeriod: retain
107
+ createdBy : {"user":{"id":null,"displayName":"John Doe"}}
108
+ createdDateTime : 2022-12-21T09:32:38Z
109
+ defaultRecordBehavior : startLocked
110
+ descriptionForAdmins : Description for admins
111
+ descriptionForUsers : Description for users
112
+ displayName : some label
113
+ dispositionReviewStages : []
114
+ id : 3b388f3c-541b-4696-ad0e-83f960695d89
115
+ isInUse : false
116
+ labelToBeApplied : another label
117
+ lastModifiedBy : {"user":{"id":null,"displayName":"John Doe"}}
118
+ lastModifiedDateTime : 2022-12-21T09:32:38Z
119
+ retentionDuration : {"days":365}
120
+ retentionTrigger : dateLabeled
121
+ ```
122
+
123
+ === "CSV"
124
+
125
+ ```csv
126
+ displayName,descriptionForAdmins,descriptionForUsers,isInUse,retentionTrigger,behaviorDuringRetentionPeriod,actionAfterRetentionPeriod,createdDateTime,lastModifiedDateTime,labelToBeApplied,defaultRecordBehavior,id,retentionDuration,createdBy,lastModifiedBy,dispositionReviewStages
127
+ some label,Description for admins,Description for users,,dateLabeled,retain,delete,2022-12-21T09:33:32Z,2022-12-21T09:33:32Z,another label,startLocked,cfc8b132-7aef-45f4-9fcf-3c199090ba2a,"{""days"":365}","{""user"":{""id"":null,""displayName"":""John Doe""}}","{""user"":{""id"":null,""displayName"":""John Doe""}}",[]
128
+ ```
@@ -38,4 +38,4 @@ m365 spo cdn get --type Private
38
38
 
39
39
  ## More information
40
40
 
41
- - General availability of Microsoft 365 CDN: [https://dev.office.com/blogs/general-availability-of-office-365-cdn](https://dev.office.com/blogs/general-availability-of-office-365-cdn)
41
+ - Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide)
@@ -35,4 +35,4 @@ m365 spo cdn origin add --type Public --origin */CDN
35
35
 
36
36
  ## More information
37
37
 
38
- - General availability of Microsoft 365 CDN: [https://dev.office.com/blogs/general-availability-of-office-365-cdn](https://dev.office.com/blogs/general-availability-of-office-365-cdn)
38
+ - Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide)
@@ -38,4 +38,4 @@ m365 spo cdn origin list --type Private
38
38
 
39
39
  ## More information
40
40
 
41
- - General availability of Microsoft 365 CDN: [https://dev.office.com/blogs/general-availability-of-office-365-cdn](https://dev.office.com/blogs/general-availability-of-office-365-cdn)
41
+ - Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide)
@@ -38,4 +38,4 @@ m365 spo cdn origin remove --type Public --origin */CDN
38
38
 
39
39
  ## More information
40
40
 
41
- - General availability of Microsoft 365 CDN: [https://dev.office.com/blogs/general-availability-of-office-365-cdn](https://dev.office.com/blogs/general-availability-of-office-365-cdn)
41
+ - Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide)
@@ -38,4 +38,4 @@ m365 spo cdn policy list --cdnType Private
38
38
 
39
39
  ## More information
40
40
 
41
- - General availability of Microsoft 365 CDN: [https://dev.office.com/blogs/general-availability-of-office-365-cdn](https://dev.office.com/blogs/general-availability-of-office-365-cdn)
41
+ - Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide)
@@ -38,4 +38,4 @@ m365 spo cdn policy set --cdnType Public --policy IncludeFileExtensions --value
38
38
 
39
39
  ## More information
40
40
 
41
- - General availability of Microsoft 365 CDN: [https://dev.office.com/blogs/general-availability-of-office-365-cdn](https://dev.office.com/blogs/general-availability-of-office-365-cdn)
41
+ - Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide)
@@ -66,4 +66,4 @@ m365 spo cdn set --type Both --enabled true --noDefaultOrigins
66
66
 
67
67
  ## More information
68
68
 
69
- - General availability of Microsoft 365 CDN: [https://dev.office.com/blogs/general-availability-of-office-365-cdn](https://dev.office.com/blogs/general-availability-of-office-365-cdn)
69
+ - Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide)
@@ -0,0 +1,47 @@
1
+ # spo file retentionlabel ensure
2
+
3
+ Apply a retention label to a file
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo file retentionlabel ensure [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : URL of the site where the retentionlabel from a file to apply is located
15
+
16
+ `--fileUrl [fileUrl]`
17
+ : The site- or server relative URL of the file that should be labelled. Specify either `fileUrl` or `fileId` but not both.
18
+
19
+ `i, --fileId [fileId]`
20
+ : The UniqueId (GUID) of the file that should be labelled. Specify either `fileUrl` or `fileId` but not both.
21
+
22
+ `--name <name>`
23
+ : Name of the retention label to apply to the file.
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Remarks
28
+
29
+ You can also use [spo listitem retentionlabel remove](./../../../cmd/spo//listitem/listitem-retentionlabel-remove.md) for removing the retentionlabel from a listitem.
30
+
31
+ ## Examples
32
+
33
+ Applies a retention label to a file based on the label name and the fileUrl
34
+
35
+ ```sh
36
+ m365 spo file retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --fileUrl '/Shared Documents/Document.docx' --name 'Some label'
37
+ ```
38
+
39
+ Applies a retention label to a file based on the label name and the fileId
40
+
41
+ ```sh
42
+ m365 spo file retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --fileId '26541f96-017c-4189-a604-599e083533b8' --name 'Some label'
43
+ ```
44
+
45
+ ## Response
46
+
47
+ The command won't return a response on success.
@@ -0,0 +1,43 @@
1
+ # spo file retentionlabel remove
2
+
3
+ Clears the retention label from a file
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo file retentionlabel remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : URL of the site where the retentionlabel from a file to remove is located
15
+
16
+ `--fileUrl [fileUrl]`
17
+ : The site- or server relative URL of the file of which the label should be removed. Specify either `fileUrl` or `fileId` but not both.
18
+
19
+ `-i, --fileId [fileId]`
20
+ : The UniqueId (GUID) of the file of which the label should be removed. Specify either `fileUrl` or `fileId` but not both.
21
+
22
+ `--confirm`
23
+ : Don't prompt for confirming removing the retention label from a file
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Examples
28
+
29
+ Removes the retention label from a file in a given site based on the file id
30
+
31
+ ```sh
32
+ m365 spo file retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --fileId 0cd891ef-afce-4e55-b836-fce03286cccf
33
+ ```
34
+
35
+ Removes the retention label from a file in a given site based on the file url
36
+
37
+ ```sh
38
+ m365 spo file retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --fileUrl /sites/project-x/Shared Documents/Document.docx --id 1
39
+ ```
40
+
41
+ ## Response
42
+
43
+ The command won't return a response on success.