@pnp/cli-microsoft365 6.2.0-beta.e162995 → 6.2.0-beta.edaa477
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.
- package/.eslintrc.js +6 -0
- package/dist/m365/aad/commands/approleassignment/approleassignment-add.js +3 -0
- package/dist/m365/onenote/commands/page/page-list.js +137 -0
- package/dist/m365/onenote/commands.js +2 -1
- package/dist/m365/pp/commands/aibuildermodel/aibuildermodel-list.js +68 -0
- package/dist/m365/pp/commands.js +1 -0
- package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js +143 -0
- package/dist/m365/purview/commands.js +1 -0
- package/dist/m365/spo/commands/file/GraphFileDetails.js +3 -0
- package/dist/m365/spo/commands/file/file-sharinginfo-get.js +12 -12
- package/dist/m365/spo/commands/file/file-sharinglink-get.js +116 -0
- package/dist/m365/spo/commands/file/file-sharinglink-list.js +133 -0
- package/dist/m365/spo/commands/file/file-sharinglink-remove.js +135 -0
- package/dist/m365/spo/commands/group/group-member-add.js +33 -6
- package/dist/m365/spo/commands/group/group-member-remove.js +78 -33
- package/dist/m365/spo/commands/list/list-retentionlabel-ensure.js +10 -2
- package/dist/m365/spo/commands/listitem/ListItemRetentionLabel.js +3 -0
- package/dist/m365/spo/commands/listitem/SiteRetentionLabel.js +3 -0
- package/dist/m365/spo/commands/listitem/listitem-retentionlabel-ensure.js +161 -0
- package/dist/m365/spo/commands/term/term-list.js +99 -29
- package/dist/m365/spo/commands.js +4 -0
- package/dist/m365/teams/commands/chat/chat-list.js +29 -7
- package/docs/docs/cmd/onenote/page/page-list.md +140 -0
- package/docs/docs/cmd/planner/bucket/bucket-add.md +17 -0
- package/docs/docs/cmd/planner/bucket/bucket-get.md +17 -0
- package/docs/docs/cmd/planner/bucket/bucket-list.md +17 -0
- package/docs/docs/cmd/planner/plan/plan-add.md +40 -0
- package/docs/docs/cmd/planner/plan/plan-get.md +21 -0
- package/docs/docs/cmd/planner/plan/plan-list.md +19 -0
- package/docs/docs/cmd/planner/plan/plan-set.md +20 -0
- package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-list.md +95 -0
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +128 -0
- package/docs/docs/cmd/spo/file/file-sharinglink-get.md +107 -0
- package/docs/docs/cmd/spo/file/file-sharinglink-list.md +106 -0
- package/docs/docs/cmd/spo/file/file-sharinglink-remove.md +52 -0
- package/docs/docs/cmd/spo/group/group-member-add.md +22 -4
- package/docs/docs/cmd/spo/group/group-member-remove.md +24 -6
- package/docs/docs/cmd/spo/list/list-retentionlabel-ensure.md +8 -5
- package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-ensure.md +58 -0
- package/docs/docs/cmd/spo/term/term-list.md +138 -0
- package/docs/docs/cmd/teams/chat/chat-list.md +16 -4
- package/npm-shrinkwrap.json +182 -202
- package/package.json +12 -11
|
@@ -97,6 +97,25 @@ m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Gro
|
|
|
97
97
|
xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
|
|
98
98
|
```
|
|
99
99
|
|
|
100
|
+
=== "Markdown"
|
|
101
|
+
|
|
102
|
+
```md
|
|
103
|
+
# planner plan add --title "My Planner Plan" --ownerGroupId "ebf3b108-5234-4e22-b93d-656d7dae5874"
|
|
104
|
+
|
|
105
|
+
Date: 30/03/2015
|
|
106
|
+
|
|
107
|
+
## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
|
|
108
|
+
|
|
109
|
+
Property | Value
|
|
110
|
+
---------|-------
|
|
111
|
+
createdDateTime | 2015-03-30T18:36:49.2407981Z
|
|
112
|
+
owner | ebf3b108-5234-4e22-b93d-656d7dae5874
|
|
113
|
+
title | My Planner Plan
|
|
114
|
+
id | xqQg5FS2LkCp935s-FIFm2QAFkHM
|
|
115
|
+
createdBy | {"user":{"displayName":null,"id":"95e27074-6c4a-447a-aa24-9d718a0b86fa"},"application":{"displayName":null,"id":"ebf3b108-5234-4e22-b93d-656d7dae5874"}}
|
|
116
|
+
container | {"containerId":"ebf3b108-5234-4e22-b93d-656d7dae5874","type":"group","url":"https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"}
|
|
117
|
+
```
|
|
118
|
+
|
|
100
119
|
### `shareWithUserIds`, `shareWithUserNames` response
|
|
101
120
|
|
|
102
121
|
When we make use of the option `shareWithUserIds` or `shareWithUserNames` the response will differ.
|
|
@@ -173,3 +192,24 @@ When we make use of the option `shareWithUserIds` or `shareWithUserNames` the re
|
|
|
173
192
|
id,title,createdDateTime,owner
|
|
174
193
|
xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
|
|
175
194
|
```
|
|
195
|
+
|
|
196
|
+
=== "Markdown"
|
|
197
|
+
|
|
198
|
+
```md
|
|
199
|
+
# planner plan add --title "My Planner Plan" --ownerGroupId "ebf3b108-5234-4e22-b93d-656d7dae5874" --shareWithUserNames "Allan.Carroll@contoso.com,Ida.Stevens@contoso.com"
|
|
200
|
+
|
|
201
|
+
Date: 30/03/2015
|
|
202
|
+
|
|
203
|
+
## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
|
|
204
|
+
|
|
205
|
+
Property | Value
|
|
206
|
+
---------|-------
|
|
207
|
+
createdDateTime | 2015-03-30T18:36:49.2407981Z
|
|
208
|
+
owner | ebf3b108-5234-4e22-b93d-656d7dae5874
|
|
209
|
+
title | My Planner Plan
|
|
210
|
+
id | xqQg5FS2LkCp935s-FIFm2QAFkHM
|
|
211
|
+
createdBy | {"user":{"displayName":null,"id":"dd8b99a7-77c6-4238-a609-396d27844921"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
|
|
212
|
+
container | {"containerId":"ebf3b108-5234-4e22-b93d-656d7dae5874","type":"group","url":"https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"}
|
|
213
|
+
sharedWith | {"ebf3b108-5234-4e22-b93d-656d7dae5874":true,"6463a5ce-2119-4198-9f2a-628761df4a62":true}
|
|
214
|
+
categoryDescriptions | {"category1":null,"category2":null,"category3":null,"category4":null,"category5":null,"category6":null,"category7":null,"category8":null,"category9":null,"category10":null,"category11":null,"category12":null,"category13":null,"category14":null,"category15":null,"category16":null,"category17":null,"category18":null,"category19":null,"category20":null,"category21":null,"category22":null,"category23":null,"category24":null,"category25":null}
|
|
215
|
+
```
|
|
@@ -118,3 +118,24 @@ m365 planner plan get --title "MyPlan" --ownerGroupName "My Planner Group"
|
|
|
118
118
|
id,title,createdDateTime,owner
|
|
119
119
|
xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
|
|
120
120
|
```
|
|
121
|
+
|
|
122
|
+
=== "Markdown"
|
|
123
|
+
|
|
124
|
+
```md
|
|
125
|
+
# planner plan get --id "xqQg5FS2LkCp935s-FIFm2QAFkHM"
|
|
126
|
+
|
|
127
|
+
Date: 27/12/2022
|
|
128
|
+
|
|
129
|
+
## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
|
|
130
|
+
|
|
131
|
+
Property | Value
|
|
132
|
+
---------|-------
|
|
133
|
+
createdDateTime | 2015-03-30T18:36:49.2407981Z
|
|
134
|
+
owner | ebf3b108-5234-4e22-b93d-656d7dae5874
|
|
135
|
+
title | My Planner Plan
|
|
136
|
+
id | xqQg5FS2LkCp935s-FIFm2QAFkHM
|
|
137
|
+
createdBy | {"user":{"displayName":null,"id":"dd8b99a7-77c6-4238-a609-396d27844921"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
|
|
138
|
+
container | {"containerId":"ebf3b108-5234-4e22-b93d-656d7dae5874","type":"group","url":"https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"}
|
|
139
|
+
sharedWith | {"aa089c1a-0ca8-4b36-ae2e-c5d60f054a2c":true,"ebf3b108-5234-4e22-b93d-656d7dae5874":true}
|
|
140
|
+
categoryDescriptions | {"category1":null,"category2":null,"category3":null,"category4":null,"category5":null,"category6":null,"category7":null,"category8":null,"category9":null,"category10":null,"category11":null,"category12":null,"category13":null,"category14":null,"category15":null,"category16":null,"category17":null,"category18":null,"category19":null,"category20":null,"category21":null,"category22":null,"category23":null,"category24":null,"category25":null}
|
|
141
|
+
```
|
|
@@ -76,3 +76,22 @@ m365 planner plan list --ownerGroupName "My Planner Group"
|
|
|
76
76
|
id,title,createdDateTime,owner
|
|
77
77
|
xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
|
|
78
78
|
```
|
|
79
|
+
|
|
80
|
+
=== "Markdown"
|
|
81
|
+
|
|
82
|
+
```md
|
|
83
|
+
# planner plan list --ownerGroupId "ebf3b108-5234-4e22-b93d-656d7dae5874"
|
|
84
|
+
|
|
85
|
+
Date: 27/12/2022
|
|
86
|
+
|
|
87
|
+
## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
|
|
88
|
+
|
|
89
|
+
Property | Value
|
|
90
|
+
---------|-------
|
|
91
|
+
createdDateTime | 2021-12-12T14:00:50.4522129Z
|
|
92
|
+
owner | ebf3b108-5234-4e22-b93d-656d7dae5874
|
|
93
|
+
title | My Planner Plan
|
|
94
|
+
id | xqQg5FS2LkCp935s-FIFm2QAFkHM
|
|
95
|
+
createdBy | {"user":{"displayName":null,"id":"dd8b99a7-77c6-4238-a609-396d27844921"},"application":{"displayName":null,"id":"09abbdfd-ed23-44ee-a2d9-a627aa1c90f3"}}
|
|
96
|
+
container | {"containerId":"ebf3b108-5234-4e22-b93d-656d7dae5874","type":"group","url":"https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"}
|
|
97
|
+
```
|
|
@@ -142,3 +142,23 @@ m365 planner plan set --id 'gndWOTSK60GfPQfiDDj43JgACDCb' --category21 'ToDo' --
|
|
|
142
142
|
xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
|
|
143
143
|
```
|
|
144
144
|
|
|
145
|
+
=== "Markdown"
|
|
146
|
+
|
|
147
|
+
```md
|
|
148
|
+
# planner plan set --id "xqQg5FS2LkCp935s-FIFm2QAFkHM" --newTitle "My Planner Plan"
|
|
149
|
+
|
|
150
|
+
Date: 27/12/2022
|
|
151
|
+
|
|
152
|
+
## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
|
|
153
|
+
|
|
154
|
+
Property | Value
|
|
155
|
+
---------|-------
|
|
156
|
+
createdDateTime | 2015-03-30T18:36:49.2407981Z
|
|
157
|
+
owner | ebf3b108-5234-4e22-b93d-656d7dae5874
|
|
158
|
+
title | My Planner Plan
|
|
159
|
+
id | xqQg5FS2LkCp935s-FIFm2QAFkHM
|
|
160
|
+
createdBy | {"user":{"displayName":null,"id":"dd8b99a7-77c6-4238-a609-396d27844921"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
|
|
161
|
+
container | {"containerId":"ebf3b108-5234-4e22-b93d-656d7dae5874","type":"group","url":"https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"}
|
|
162
|
+
sharedWith | {"ebf3b108-5234-4e22-b93d-656d7dae5874":true,"6463a5ce-2119-4198-9f2a-628761df4a62":true}
|
|
163
|
+
categoryDescriptions | {"category1":null,"category2":null,"category3":null,"category4":null,"category5":null,"category6":null,"category7":null,"category8":null,"category9":null,"category10":null,"category11":null,"category12":null,"category13":null,"category14":null,"category15":null,"category16":null,"category17":null,"category18":null,"category19":null,"category20":null,"category21":null,"category22":null,"category23":null,"category24":null,"category25":null}
|
|
164
|
+
```
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# pp aibuildermodel list
|
|
2
|
+
|
|
3
|
+
List available AI builder models in the specified Power Platform environment
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
pp aibuildermodel list [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-e, --environment <environment>`
|
|
14
|
+
: The name of the environment
|
|
15
|
+
|
|
16
|
+
`--asAdmin`
|
|
17
|
+
: Run the command as admin for environments you do not have explicitly assigned permissions to
|
|
18
|
+
|
|
19
|
+
--8<-- "docs/cmd/_global.md"
|
|
20
|
+
|
|
21
|
+
## Examples
|
|
22
|
+
|
|
23
|
+
List all AI Builder models in a specific environment
|
|
24
|
+
|
|
25
|
+
```sh
|
|
26
|
+
m365 pp aibuildermodel list --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5"
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
List all AI Builder models in a specific environment as admin
|
|
30
|
+
|
|
31
|
+
```sh
|
|
32
|
+
m365 pp aibuildermodel list --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --asAdmin
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Response
|
|
36
|
+
|
|
37
|
+
=== "JSON"
|
|
38
|
+
|
|
39
|
+
```json
|
|
40
|
+
[
|
|
41
|
+
{
|
|
42
|
+
"statecode": 0,
|
|
43
|
+
"_msdyn_templateid_value": "10707e4e-1d56-e911-8194-000d3a6cd5a5",
|
|
44
|
+
"msdyn_modelcreationcontext": "{}",
|
|
45
|
+
"createdon": "2022-11-29T11:58:45Z",
|
|
46
|
+
"_ownerid_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
|
|
47
|
+
"modifiedon": "2022-11-29T11:58:45Z",
|
|
48
|
+
"msdyn_sharewithorganizationoncreate": false,
|
|
49
|
+
"msdyn_aimodelidunique": "b0328b67-47e2-4202-8189-e617ec9a88bd",
|
|
50
|
+
"solutionid": "fd140aae-4df4-11dd-bd17-0019b9312238",
|
|
51
|
+
"ismanaged": false,
|
|
52
|
+
"versionnumber": 1458121,
|
|
53
|
+
"msdyn_name": "Document Processing 11/29/2022, 12:58:43 PM",
|
|
54
|
+
"introducedversion": "1.0",
|
|
55
|
+
"statuscode": 0,
|
|
56
|
+
"_modifiedby_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
|
|
57
|
+
"overwritetime": "1900-01-01T00:00:00Z",
|
|
58
|
+
"componentstate": 0,
|
|
59
|
+
"_createdby_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
|
|
60
|
+
"_owningbusinessunit_value": "6da087c1-1c4d-ed11-bba1-000d3a2caf7f",
|
|
61
|
+
"_owninguser_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
|
|
62
|
+
"msdyn_aimodelid": "08ffffbe-ec1c-4e64-b64b-dd1db926c613",
|
|
63
|
+
"_msdyn_activerunconfigurationid_value": null,
|
|
64
|
+
"overriddencreatedon": null,
|
|
65
|
+
"_msdyn_retrainworkflowid_value": null,
|
|
66
|
+
"importsequencenumber": null,
|
|
67
|
+
"_msdyn_scheduleinferenceworkflowid_value": null,
|
|
68
|
+
"_modifiedonbehalfby_value": null,
|
|
69
|
+
"utcconversiontimezonecode": null,
|
|
70
|
+
"_createdonbehalfby_value": null,
|
|
71
|
+
"_owningteam_value": null,
|
|
72
|
+
"timezoneruleversionnumber": null,
|
|
73
|
+
"iscustomizable": {
|
|
74
|
+
"Value": true,
|
|
75
|
+
"CanBeChanged": true,
|
|
76
|
+
"ManagedPropertyLogicalName": "iscustomizableanddeletable"
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
]
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
=== "Text"
|
|
83
|
+
|
|
84
|
+
```text
|
|
85
|
+
createdon modifiedon msdyn_aimodelid msdyn_name
|
|
86
|
+
-------------------- -------------------- ------------------------------------ -------------------------------------------
|
|
87
|
+
2022-10-25T14:44:48Z 2022-10-25T14:44:48Z 08ffffbe-ec1c-4e64-b64b-dd1db926c613 Document Processing 11/29/2022, 12:58:43 PM
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
=== "CSV"
|
|
91
|
+
|
|
92
|
+
```csv
|
|
93
|
+
msdyn_name,msdyn_aimodelid,createdon,modifiedon
|
|
94
|
+
"Document Processing 11/29/2022, 12:58:43 PM",08ffffbe-ec1c-4e64-b64b-dd1db926c613,2022-11-29T11:58:45Z,2022-11-29T11:58:45Z
|
|
95
|
+
```
|
|
@@ -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
|
+
```
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# spo file sharinglink get
|
|
2
|
+
|
|
3
|
+
Gets details about a specific sharing link of a file
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo file sharinglink get [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-u, --webUrl <webUrl>`
|
|
14
|
+
: The URL of the site where the file is located.
|
|
15
|
+
|
|
16
|
+
`--fileUrl [fileUrl]`
|
|
17
|
+
: The server-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
18
|
+
|
|
19
|
+
`--fileId [fileId]`
|
|
20
|
+
: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
21
|
+
|
|
22
|
+
`-i, --id <id>`
|
|
23
|
+
: The ID of the sharing link.
|
|
24
|
+
|
|
25
|
+
--8<-- "docs/cmd/_global.md"
|
|
26
|
+
|
|
27
|
+
## Examples
|
|
28
|
+
|
|
29
|
+
Gets a specific sharing link of a file by id.
|
|
30
|
+
|
|
31
|
+
```sh
|
|
32
|
+
m365 spo file sharinglink get --webUrl 'https://contoso.sharepoint.com/sites/demo' --fileId daebb04b-a773-4baa-b1d1-3625418e3234 --id 1ba739c5-e693-4c16-9dfa-042e4ec62972
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Gets a specific sharing link of a file by a specified site-relative URL.
|
|
36
|
+
|
|
37
|
+
```sh
|
|
38
|
+
m365 spo file sharinglink get --webUrl 'https://contoso.sharepoint.com/sites/demo' --fileUrl 'Shared Documents/document.docx' --id 1ba739c5-e693-4c16-9dfa-042e4ec62972
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Gets a specific sharing link of a file by a specified server-relative URL.
|
|
42
|
+
|
|
43
|
+
```sh
|
|
44
|
+
m365 spo file sharinglink get --webUrl 'https://contoso.sharepoint.com/sites/demo' --fileUrl '/sites/demo/Shared Documents/document.docx' --id 1ba739c5-e693-4c16-9dfa-042e4ec62972
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Response
|
|
48
|
+
|
|
49
|
+
=== "JSON"
|
|
50
|
+
|
|
51
|
+
```json
|
|
52
|
+
{
|
|
53
|
+
"id": "1ba739c5-e693-4c16-9dfa-042e4ec62972",
|
|
54
|
+
"roles": [
|
|
55
|
+
"write"
|
|
56
|
+
],
|
|
57
|
+
"hasPassword": false,
|
|
58
|
+
"grantedToIdentitiesV2": [
|
|
59
|
+
{
|
|
60
|
+
"user": {
|
|
61
|
+
"displayName": "John Doe",
|
|
62
|
+
"email": "john@contoso.onmicrosoft.com",
|
|
63
|
+
"id": "04355ecd-2124-4097-bc2b-c2295a71d7a3"
|
|
64
|
+
},
|
|
65
|
+
"siteUser": {
|
|
66
|
+
"displayName": "John Doe",
|
|
67
|
+
"email": "john@contoso.onmicrosoft.com",
|
|
68
|
+
"id": "11",
|
|
69
|
+
"loginName": "i:0#.f|membership|john@contoso.onmicrosoft.com"
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
],
|
|
73
|
+
"grantedToIdentities": [
|
|
74
|
+
{
|
|
75
|
+
"user": {
|
|
76
|
+
"displayName": "John Doe",
|
|
77
|
+
"email": "john@contoso.onmicrosoft.com",
|
|
78
|
+
"id": "04355ecd-2124-4097-bc2b-c2295a71d7a3"
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
],
|
|
82
|
+
"link": {
|
|
83
|
+
"scope": "organization",
|
|
84
|
+
"type": "edit",
|
|
85
|
+
"webUrl": "https://contoso.sharepoint.com/:w:/s/demo/EecoJa3lri9Hu9NWp-W0aBQB8ZqmGqA5tdIiaab4o-6BZw",
|
|
86
|
+
"preventsDownload": false
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
=== "Text"
|
|
92
|
+
|
|
93
|
+
```text
|
|
94
|
+
grantedToIdentities : [{"user":{"displayName":"John Doe","email":"john@contoso.onmicrosoft.com","id":"04355ecd-2124-4097-bc2b-c2295a71d7a3"}}]
|
|
95
|
+
grantedToIdentitiesV2: [{"user":{"displayName":"John Doe","email":"john@contoso.onmicrosoft.com","id":"04355ecd-2124-4097-bc2b-c2295a71d7a3"},"siteUser":{"displayName":"John Doe","email":"john@contoso.onmicrosoft.com","id":"11","loginName":"i:0#.f|membership|john@contoso.onmicrosoft.com"}}]
|
|
96
|
+
hasPassword : false
|
|
97
|
+
id : 1ba739c5-e693-4c16-9dfa-042e4ec62972
|
|
98
|
+
link : {"scope":"organization","type":"edit","webUrl":"https://contoso.sharepoint.com/:w:/s/demo/EecoJa3lri9Hu9NWp-W0aBQB8ZqmGqA5tdIiaab4o-6BZw","preventsDownload":false}
|
|
99
|
+
roles : ["write"]
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
=== "CSV"
|
|
103
|
+
|
|
104
|
+
```csv
|
|
105
|
+
id,roles,hasPassword,grantedToIdentitiesV2,grantedToIdentities,link
|
|
106
|
+
1ba739c5-e693-4c16-9dfa-042e4ec62972,"[""write""]",,"[{""user"":{""displayName"":""John Doe"",""email"":""john@contoso.onmicrosoft.com"",""id"":""04355ecd-2124-4097-bc2b-c2295a71d7a3""},""siteUser"":{""displayName"":""John Doe"",""email"":""john@contoso.onmicrosoft.com"",""id"":""11"",""loginName"":""i:0#.f|membership|john@contoso.onmicrosoft.com""}}]","[{""user"":{""displayName"":""John Doe"",""email"":""john@contoso.onmicrosoft.com"",""id"":""04355ecd-2124-4097-bc2b-c2295a71d7a3""}}]","{""scope"":""organization"",""type"":""edit"",""webUrl"":""https://contoso.sharepoint.com/:w:/s/demo/EecoJa3lri9Hu9NWp-W0aBQB8ZqmGqA5tdIiaab4o-6BZw"",""preventsDownload"":false}"
|
|
107
|
+
```
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
# spo file sharinglink list
|
|
2
|
+
|
|
3
|
+
Lists all the sharing links of a specific file
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo file sharinglink list [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-u, --webUrl <webUrl>`
|
|
14
|
+
: The URL of the site where the file is located.
|
|
15
|
+
|
|
16
|
+
`-f, --fileUrl [fileUrl]`
|
|
17
|
+
: The server-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
18
|
+
|
|
19
|
+
`-i, --fileId [fileId]`
|
|
20
|
+
: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
21
|
+
|
|
22
|
+
`--scope [scope]`
|
|
23
|
+
: Filter the results to only sharing links of a given scope: `anonymous`, `users` or `organization`. By default all sharing links are listed.
|
|
24
|
+
|
|
25
|
+
--8<-- "docs/cmd/_global.md"
|
|
26
|
+
|
|
27
|
+
## Examples
|
|
28
|
+
|
|
29
|
+
List sharing links of a file by id
|
|
30
|
+
|
|
31
|
+
```sh
|
|
32
|
+
m365 spo file sharinglink list --webUrl https://contoso.sharepoint.com/sites/demo --fileId daebb04b-a773-4baa-b1d1-3625418e3234
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
List sharing links of a file by url
|
|
36
|
+
|
|
37
|
+
```sh
|
|
38
|
+
m365 spo file sharinglink list --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl "/sites/demo/shared documents/document.docx"
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
List anonymous sharing links of a file by url
|
|
42
|
+
|
|
43
|
+
```sh
|
|
44
|
+
m365 spo file sharinglink list --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl "/sites/demo/shared documents/document.docx" --scope anonymous
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Response
|
|
48
|
+
|
|
49
|
+
=== "JSON"
|
|
50
|
+
|
|
51
|
+
```json
|
|
52
|
+
[
|
|
53
|
+
{
|
|
54
|
+
"id": "2a021f54-90a2-4016-b3b3-5f34d2e7d932",
|
|
55
|
+
"roles": [
|
|
56
|
+
"read"
|
|
57
|
+
],
|
|
58
|
+
"hasPassword": false,
|
|
59
|
+
"grantedToIdentitiesV2": [
|
|
60
|
+
{
|
|
61
|
+
"user": {
|
|
62
|
+
"displayName": "John Doe",
|
|
63
|
+
"email": "john@contoso.onmicrosoft.com",
|
|
64
|
+
"id": "fe36f75e-c103-410b-a18a-2bf6df06ac3a"
|
|
65
|
+
},
|
|
66
|
+
"siteUser": {
|
|
67
|
+
"displayName": "John Doe",
|
|
68
|
+
"email": "john@contoso.onmicrosoft.com",
|
|
69
|
+
"id": "9",
|
|
70
|
+
"loginName": "i:0#.f|membership|john@contoso.onmicrosoft.com"
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
],
|
|
74
|
+
"grantedToIdentities": [
|
|
75
|
+
{
|
|
76
|
+
"user": {
|
|
77
|
+
"displayName": "John Doe",
|
|
78
|
+
"email": "john@contoso.onmicrosoft.com",
|
|
79
|
+
"id": "fe36f75e-c103-410b-a18a-2bf6df06ac3a"
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
],
|
|
83
|
+
"link": {
|
|
84
|
+
"scope": "organization",
|
|
85
|
+
"type": "view",
|
|
86
|
+
"webUrl": "https://contoso.sharepoint.com/:w:/s/demo/EY50lub3559MtRKfj2hrZqoBWnHOpGIcgi4gzw9XiWYJ-A",
|
|
87
|
+
"preventsDownload": false
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
]
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
=== "Text"
|
|
94
|
+
|
|
95
|
+
```text
|
|
96
|
+
id scope roles link
|
|
97
|
+
------------------------------------ ------------ ----- ----------------------------------------------------------------------------------------
|
|
98
|
+
2a021f54-90a2-4016-b3b3-5f34d2e7d932 organization read https://contoso.sharepoint.com/:w:/s/demo/EY50lub3559MtRKfj2hrZqoBWnHOpGIcgi4gzw9XiWYJ-A
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
=== "CSV"
|
|
102
|
+
|
|
103
|
+
```csv
|
|
104
|
+
id,scope,roles,link
|
|
105
|
+
2a021f54-90a2-4016-b3b3-5f34d2e7d932,organization,read,https://contoso.sharepoint.com/:w:/s/demo/EY50lub3559MtRKfj2hrZqoBWnHOpGIcgi4gzw9XiWYJ-A
|
|
106
|
+
```
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# spo file sharinglink remove
|
|
2
|
+
|
|
3
|
+
Removes a specific sharing link of a file
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo file sharinglink remove [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-u, --webUrl <webUrl>`
|
|
14
|
+
: The URL of the site where the file is located.
|
|
15
|
+
|
|
16
|
+
`--fileUrl [fileUrl]`
|
|
17
|
+
: The server-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
18
|
+
|
|
19
|
+
`--fileId [fileId]`
|
|
20
|
+
: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
21
|
+
|
|
22
|
+
`-i, --id <id>`
|
|
23
|
+
: The ID of the sharing link.
|
|
24
|
+
|
|
25
|
+
`--confirm`
|
|
26
|
+
: Don't prompt for confirmation.
|
|
27
|
+
|
|
28
|
+
--8<-- "docs/cmd/_global.md"
|
|
29
|
+
|
|
30
|
+
## Examples
|
|
31
|
+
|
|
32
|
+
Removes a specific sharing link from a file by id without prompting for confirmation.
|
|
33
|
+
|
|
34
|
+
```sh
|
|
35
|
+
m365 spo file sharinglink remove --webUrl https://contoso.sharepoint.com/sites/demo --fileId daebb04b-a773-4baa-b1d1-3625418e3234 --id c391b57d-5783-4c53-9236-cefb5c6ef323 --confirm
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Removes a specific sharing link from a file by a specified site-relative URL.
|
|
39
|
+
|
|
40
|
+
```sh
|
|
41
|
+
m365 spo file sharinglink remove --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl 'Shared Documents/document.docx' --id c391b57d-5783-4c53-9236-cefb5c6ef323
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Removes a specific sharing link from a file by a specified server-relative URL.
|
|
45
|
+
|
|
46
|
+
```sh
|
|
47
|
+
m365 spo file sharinglink remove --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl '/sites/demo/Shared Documents/document.docx' --id c391b57d-5783-4c53-9236-cefb5c6ef323
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Response
|
|
51
|
+
|
|
52
|
+
The command won't return a response on success.
|
|
@@ -20,19 +20,25 @@ m365 spo group member add [options]
|
|
|
20
20
|
: Name of the SharePoint Group to which the user needs to be added, specify either `groupId` or `groupName`
|
|
21
21
|
|
|
22
22
|
`--userName [userName]`
|
|
23
|
-
: User's UPN (user principal name, eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com)
|
|
23
|
+
: User's UPN (user principal name, eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com). Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
|
|
24
24
|
|
|
25
25
|
`--email [email]`
|
|
26
|
-
: User's email (eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com)
|
|
26
|
+
: User's email (eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com). Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
|
|
27
27
|
|
|
28
28
|
`--userId [userId]`
|
|
29
|
-
: The user Id of the user to add as a member. (Id of the site user, for example: 14) If multiple users need to be added, the
|
|
29
|
+
: The user Id of the user to add as a member. (Id of the site user, for example: 14) If multiple users need to be added, the Ids have to be comma separated. Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
|
|
30
|
+
|
|
31
|
+
`--aadGroupId [aadGroupId]`
|
|
32
|
+
: The object Id of the Azure AD group to add as a member. If multiple groups need to be added, the Ids have to be comma separated. Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
|
|
33
|
+
|
|
34
|
+
`--aadGroupName [aadGroupName]`
|
|
35
|
+
: The name of the Azure AD group to add as a member. Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
|
|
30
36
|
|
|
31
37
|
--8<-- "docs/cmd/_global.md"
|
|
32
38
|
|
|
33
39
|
## Remarks
|
|
34
40
|
|
|
35
|
-
For the
|
|
41
|
+
For the `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName` options you can specify multiple values by separating them with a comma. If one of the specified entries is not valid, the command will fail with an error message showing the list of invalid values.
|
|
36
42
|
|
|
37
43
|
## Examples
|
|
38
44
|
|
|
@@ -72,6 +78,18 @@ Add multiple users with the userId parameter to a SharePoint group with the grou
|
|
|
72
78
|
m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userId "5,12"
|
|
73
79
|
```
|
|
74
80
|
|
|
81
|
+
Add multiple users with the aadUserId parameter to a SharePoint group with the groupId parameter
|
|
82
|
+
|
|
83
|
+
```sh
|
|
84
|
+
m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --aadUserId "56ca9023-3449-4e98-a96a-69e81a6f4983,a96c1755-8aec-4f4d-955f-08504510dc56"
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Add multiple users with the aadUserName parameter to a SharePoint group with the groupId parameter
|
|
88
|
+
|
|
89
|
+
```sh
|
|
90
|
+
m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --aadUserName "Azure group one, Azure group two"
|
|
91
|
+
```
|
|
92
|
+
|
|
75
93
|
## Response
|
|
76
94
|
|
|
77
95
|
=== "JSON"
|