@pnp/cli-microsoft365 9.0.0-beta.d6b190a → 9.0.0-beta.e69e8d0
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/allCommands.json +1 -1
- package/allCommandsFull.json +1 -1
- package/dist/Auth.js +1 -1
- package/dist/config.js +1 -1
- package/dist/m365/app/commands/permission/permission-add.js +9 -9
- package/dist/m365/commands/status.js +2 -2
- package/dist/m365/connection/commands/connection-remove.js +6 -2
- package/dist/m365/connection/commands/connection-set.js +4 -1
- package/dist/m365/connection/commands/connection-use.js +25 -4
- package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-add.js +13 -13
- package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-get.js +18 -18
- package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-list.js +1 -1
- package/dist/m365/entra/commands/group/group-user-list.js +4 -4
- package/dist/m365/entra/commands/m365group/m365group-conversation-post-list.js +4 -4
- package/dist/m365/entra/commands/m365group/m365group-recyclebinitem-list.js +3 -3
- package/dist/m365/entra/commands/m365group/m365group-user-add.js +109 -32
- package/dist/m365/entra/commands/m365group/m365group-user-list.js +6 -9
- package/dist/m365/entra/commands/m365group/m365group-user-set.js +159 -84
- package/dist/m365/entra/commands/multitenant/multitenant-add.js +65 -0
- package/dist/m365/entra/commands/multitenant/multitenant-remove.js +118 -0
- package/dist/m365/entra/commands/multitenant/multitenant-set.js +72 -0
- package/dist/m365/entra/commands.js +3 -0
- package/dist/m365/flow/commands/flow-get.js +1 -1
- package/dist/m365/outlook/commands/message/message-get.js +11 -11
- package/dist/m365/pa/commands/app/app-export.js +13 -7
- package/dist/m365/spfx/commands/project/DeployWorkflow.js +1 -1
- package/dist/m365/spfx/commands/project/project-github-workflow-add.js +1 -10
- package/dist/m365/spo/commands/file/file-copy.js +55 -34
- package/dist/m365/spo/commands/file/file-roleassignment-add.js +1 -1
- package/dist/m365/spo/commands/file/file-roleinheritance-break.js +1 -1
- package/dist/m365/spo/commands/file/file-roleinheritance-reset.js +1 -1
- package/dist/m365/spo/commands/folder/folder-retentionlabel-ensure.js +1 -1
- package/dist/m365/spo/commands/folder/folder-set.js +0 -4
- package/dist/m365/spo/commands/folder/folder-sharinglink-get.js +86 -0
- package/dist/m365/spo/commands/folder/folder-sharinglink-list.js +110 -0
- package/dist/m365/spo/commands/list/ListInstance.js +6 -1
- package/dist/m365/spo/commands/list/list-get.js +9 -3
- package/dist/m365/spo/commands/list/list-list.js +1 -4
- package/dist/m365/spo/commands/list/list-roleassignment-add.js +46 -21
- package/dist/m365/spo/commands/list/list-roleassignment-remove.js +48 -46
- package/dist/m365/spo/commands/site/site-appcatalog-remove.js +48 -24
- package/dist/m365/spo/commands/site/site-remove.js +1 -7
- package/dist/m365/spo/commands/tenant/tenant-recyclebinitem-restore.js +2 -22
- package/dist/m365/spo/commands.js +2 -1
- package/dist/utils/drive.js +61 -0
- package/dist/utils/spo.js +143 -6
- package/docs/docs/cmd/app/permission/permission-add.mdx +5 -5
- package/docs/docs/cmd/connection/connection-use.mdx +8 -2
- package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-add.mdx +12 -12
- package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-get.mdx +14 -14
- package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-list.mdx +5 -5
- package/docs/docs/cmd/entra/group/group-user-list.mdx +7 -7
- package/docs/docs/cmd/entra/m365group/m365group-conversation-post-list.mdx +5 -5
- package/docs/docs/cmd/entra/m365group/m365group-recyclebinitem-list.mdx +3 -3
- package/docs/docs/cmd/entra/m365group/m365group-user-add.mdx +28 -10
- package/docs/docs/cmd/entra/m365group/m365group-user-list.mdx +1 -1
- package/docs/docs/cmd/entra/m365group/m365group-user-set.mdx +35 -11
- package/docs/docs/cmd/entra/multitenant/multitenant-add.mdx +107 -0
- package/docs/docs/cmd/entra/multitenant/multitenant-remove.mdx +58 -0
- package/docs/docs/cmd/entra/multitenant/multitenant-set.mdx +53 -0
- package/docs/docs/cmd/flow/flow-get.mdx +149 -283
- package/docs/docs/cmd/outlook/message/message-get.mdx +5 -5
- package/docs/docs/cmd/pa/app/app-export.mdx +15 -9
- package/docs/docs/cmd/planner/plan/plan-remove.mdx +1 -1
- package/docs/docs/cmd/spe/containertype/containertype-list.mdx +24 -53
- package/docs/docs/cmd/spfx/project/project-github-workflow-add.mdx +11 -12
- package/docs/docs/cmd/spo/app/app-uninstall.mdx +1 -1
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx +4 -4
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-list.mdx +4 -4
- package/docs/docs/cmd/spo/file/file-copy.mdx +119 -12
- package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.mdx +1 -1
- package/docs/docs/cmd/spo/file/file-roleassignment-add.mdx +2 -2
- package/docs/docs/cmd/spo/file/file-roleassignment-remove.mdx +1 -1
- package/docs/docs/cmd/spo/file/file-roleinheritance-break.mdx +1 -1
- package/docs/docs/cmd/spo/file/file-roleinheritance-reset.mdx +1 -1
- package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.mdx +2 -2
- package/docs/docs/cmd/spo/folder/folder-set.mdx +0 -6
- package/docs/docs/cmd/spo/folder/folder-sharinglink-get.mdx +110 -0
- package/docs/docs/cmd/spo/folder/folder-sharinglink-list.mdx +114 -0
- package/docs/docs/cmd/spo/list/list-get.mdx +6 -0
- package/docs/docs/cmd/spo/list/list-list.mdx +5 -7
- package/docs/docs/cmd/spo/list/list-roleassignment-add.mdx +15 -3
- package/docs/docs/cmd/spo/list/list-roleassignment-remove.mdx +15 -3
- package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-ensure.mdx +4 -4
- package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-remove.mdx +1 -1
- package/docs/docs/cmd/spo/listitem/listitem-roleassignment-add.mdx +9 -9
- package/docs/docs/cmd/spo/listitem/listitem-roleassignment-remove.mdx +7 -7
- package/docs/docs/cmd/spo/site/site-appcatalog-remove.mdx +11 -2
- package/docs/docs/cmd/spo/site/site-recyclebinitem-list.mdx +1 -1
- package/docs/docs/cmd/spo/site/site-remove.mdx +0 -3
- package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-restore.mdx +2 -49
- package/docs/docs/cmd/spo/web/web-roleassignment-add.mdx +1 -1
- package/docs/docs/cmd/spo/web/web-roleassignment-remove.mdx +1 -1
- package/npm-shrinkwrap.json +572 -477
- package/package.json +22 -22
|
@@ -3,7 +3,8 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
|
|
|
3
3
|
if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
|
|
4
4
|
return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
|
|
5
5
|
};
|
|
6
|
-
var _SpoSiteAppCatalogRemoveCommand_instances, _SpoSiteAppCatalogRemoveCommand_initOptions, _SpoSiteAppCatalogRemoveCommand_initValidators;
|
|
6
|
+
var _SpoSiteAppCatalogRemoveCommand_instances, _SpoSiteAppCatalogRemoveCommand_initTelemetry, _SpoSiteAppCatalogRemoveCommand_initOptions, _SpoSiteAppCatalogRemoveCommand_initValidators, _SpoSiteAppCatalogRemoveCommand_initTypes;
|
|
7
|
+
import { cli } from '../../../../cli/cli.js';
|
|
7
8
|
import config from '../../../../config.js';
|
|
8
9
|
import request from '../../../../request.js';
|
|
9
10
|
import { formatting } from '../../../../utils/formatting.js';
|
|
@@ -21,47 +22,70 @@ class SpoSiteAppCatalogRemoveCommand extends SpoCommand {
|
|
|
21
22
|
constructor() {
|
|
22
23
|
super();
|
|
23
24
|
_SpoSiteAppCatalogRemoveCommand_instances.add(this);
|
|
25
|
+
__classPrivateFieldGet(this, _SpoSiteAppCatalogRemoveCommand_instances, "m", _SpoSiteAppCatalogRemoveCommand_initTelemetry).call(this);
|
|
24
26
|
__classPrivateFieldGet(this, _SpoSiteAppCatalogRemoveCommand_instances, "m", _SpoSiteAppCatalogRemoveCommand_initOptions).call(this);
|
|
25
27
|
__classPrivateFieldGet(this, _SpoSiteAppCatalogRemoveCommand_instances, "m", _SpoSiteAppCatalogRemoveCommand_initValidators).call(this);
|
|
28
|
+
__classPrivateFieldGet(this, _SpoSiteAppCatalogRemoveCommand_instances, "m", _SpoSiteAppCatalogRemoveCommand_initTypes).call(this);
|
|
26
29
|
}
|
|
27
30
|
async commandAction(logger, args) {
|
|
28
|
-
const
|
|
29
|
-
|
|
30
|
-
const spoAdminUrl = await spo.getSpoAdminUrl(logger, this.debug);
|
|
31
|
-
const requestDigest = await spo.getRequestDigest(spoAdminUrl);
|
|
31
|
+
const removeSiteAppcatalog = async () => {
|
|
32
|
+
const url = args.options.siteUrl;
|
|
32
33
|
if (this.verbose) {
|
|
33
34
|
await logger.logToStderr(`Disabling site collection app catalog...`);
|
|
34
35
|
}
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
36
|
+
try {
|
|
37
|
+
const spoAdminUrl = await spo.getSpoAdminUrl(logger, this.debug);
|
|
38
|
+
const requestDigest = await spo.getRequestDigest(spoAdminUrl);
|
|
39
|
+
const requestOptions = {
|
|
40
|
+
url: `${spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
|
|
41
|
+
headers: {
|
|
42
|
+
'X-RequestDigest': requestDigest.FormDigestValue
|
|
43
|
+
},
|
|
44
|
+
data: `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="50" ObjectPathId="49" /><ObjectPath Id="52" ObjectPathId="51" /><ObjectPath Id="54" ObjectPathId="53" /><ObjectPath Id="56" ObjectPathId="55" /><ObjectPath Id="58" ObjectPathId="57" /><Method Name="Remove" Id="59" ObjectPathId="57"><Parameters><Parameter Type="String">${formatting.escapeXml(url)}</Parameter></Parameters></Method></Actions><ObjectPaths><Constructor Id="49" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /><Method Id="51" ParentId="49" Name="GetSiteByUrl"><Parameters><Parameter Type="String">${formatting.escapeXml(url)}</Parameter></Parameters></Method><Property Id="53" ParentId="51" Name="RootWeb" /><Property Id="55" ParentId="53" Name="TenantAppCatalog" /><Property Id="57" ParentId="55" Name="SiteCollectionAppCatalogsSites" /></ObjectPaths></Request>`
|
|
45
|
+
};
|
|
46
|
+
const res = await request.post(requestOptions);
|
|
47
|
+
const json = JSON.parse(res);
|
|
48
|
+
const response = json[0];
|
|
49
|
+
if (response.ErrorInfo) {
|
|
50
|
+
throw response.ErrorInfo.ErrorMessage;
|
|
51
|
+
}
|
|
52
|
+
else {
|
|
53
|
+
if (this.verbose) {
|
|
54
|
+
await logger.logToStderr('Site collection app catalog disabled');
|
|
55
|
+
}
|
|
51
56
|
}
|
|
52
57
|
}
|
|
58
|
+
catch (err) {
|
|
59
|
+
this.handleRejectedPromise(err);
|
|
60
|
+
}
|
|
61
|
+
};
|
|
62
|
+
if (args.options.force) {
|
|
63
|
+
await removeSiteAppcatalog();
|
|
53
64
|
}
|
|
54
|
-
|
|
55
|
-
|
|
65
|
+
else {
|
|
66
|
+
const result = await cli.promptForConfirmation({ message: `Are you sure you want to remove the app catalog from ${args.options.siteUrl}?` });
|
|
67
|
+
if (result) {
|
|
68
|
+
await removeSiteAppcatalog();
|
|
69
|
+
}
|
|
56
70
|
}
|
|
57
71
|
}
|
|
58
72
|
}
|
|
59
|
-
_SpoSiteAppCatalogRemoveCommand_instances = new WeakSet(),
|
|
73
|
+
_SpoSiteAppCatalogRemoveCommand_instances = new WeakSet(), _SpoSiteAppCatalogRemoveCommand_initTelemetry = function _SpoSiteAppCatalogRemoveCommand_initTelemetry() {
|
|
74
|
+
this.telemetry.push((args) => {
|
|
75
|
+
Object.assign(this.telemetryProperties, {
|
|
76
|
+
force: !!args.options.force
|
|
77
|
+
});
|
|
78
|
+
});
|
|
79
|
+
}, _SpoSiteAppCatalogRemoveCommand_initOptions = function _SpoSiteAppCatalogRemoveCommand_initOptions() {
|
|
60
80
|
this.options.unshift({
|
|
61
81
|
option: '-u, --siteUrl <siteUrl>'
|
|
82
|
+
}, {
|
|
83
|
+
option: '-f, --force'
|
|
62
84
|
});
|
|
63
85
|
}, _SpoSiteAppCatalogRemoveCommand_initValidators = function _SpoSiteAppCatalogRemoveCommand_initValidators() {
|
|
64
86
|
this.validators.push(async (args) => validation.isValidSharePointUrl(args.options.siteUrl));
|
|
87
|
+
}, _SpoSiteAppCatalogRemoveCommand_initTypes = function _SpoSiteAppCatalogRemoveCommand_initTypes() {
|
|
88
|
+
this.types.string.push('siteUrl');
|
|
65
89
|
};
|
|
66
90
|
export default new SpoSiteAppCatalogRemoveCommand();
|
|
67
91
|
//# sourceMappingURL=site-appcatalog-remove.js.map
|
|
@@ -31,9 +31,6 @@ class SpoSiteRemoveCommand extends SpoCommand {
|
|
|
31
31
|
__classPrivateFieldGet(this, _SpoSiteRemoveCommand_instances, "m", _SpoSiteRemoveCommand_initTypes).call(this);
|
|
32
32
|
}
|
|
33
33
|
async commandAction(logger, args) {
|
|
34
|
-
if (args.options.wait) {
|
|
35
|
-
await this.warn(logger, `Option 'wait' is deprecated and will be removed in the next major release.`);
|
|
36
|
-
}
|
|
37
34
|
if (args.options.force) {
|
|
38
35
|
await this.removeSite(logger, args.options);
|
|
39
36
|
}
|
|
@@ -196,7 +193,6 @@ _SpoSiteRemoveCommand_instances = new WeakSet(), _SpoSiteRemoveCommand_initTelem
|
|
|
196
193
|
Object.assign(this.telemetryProperties, {
|
|
197
194
|
skipRecycleBin: !!args.options.skipRecycleBin,
|
|
198
195
|
fromRecycleBin: !!args.options.fromRecycleBin,
|
|
199
|
-
wait: !!args.options.wait,
|
|
200
196
|
force: !!args.options.force
|
|
201
197
|
});
|
|
202
198
|
});
|
|
@@ -207,8 +203,6 @@ _SpoSiteRemoveCommand_instances = new WeakSet(), _SpoSiteRemoveCommand_initTelem
|
|
|
207
203
|
option: '--skipRecycleBin'
|
|
208
204
|
}, {
|
|
209
205
|
option: '--fromRecycleBin'
|
|
210
|
-
}, {
|
|
211
|
-
option: '--wait'
|
|
212
206
|
}, {
|
|
213
207
|
option: '-f, --force'
|
|
214
208
|
});
|
|
@@ -230,7 +224,7 @@ _SpoSiteRemoveCommand_instances = new WeakSet(), _SpoSiteRemoveCommand_initTelem
|
|
|
230
224
|
});
|
|
231
225
|
}, _SpoSiteRemoveCommand_initTypes = function _SpoSiteRemoveCommand_initTypes() {
|
|
232
226
|
this.types.string.push('url');
|
|
233
|
-
this.types.boolean.push('skipRecycleBin', 'fromRecycleBin', '
|
|
227
|
+
this.types.boolean.push('skipRecycleBin', 'fromRecycleBin', 'force');
|
|
234
228
|
};
|
|
235
229
|
export default new SpoSiteRemoveCommand();
|
|
236
230
|
//# sourceMappingURL=site-remove.js.map
|
|
@@ -3,7 +3,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
|
|
|
3
3
|
if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
|
|
4
4
|
return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
|
|
5
5
|
};
|
|
6
|
-
var _SpoTenantRecycleBinItemRestoreCommand_instances,
|
|
6
|
+
var _SpoTenantRecycleBinItemRestoreCommand_instances, _SpoTenantRecycleBinItemRestoreCommand_initOptions, _SpoTenantRecycleBinItemRestoreCommand_initValidators, _SpoTenantRecycleBinItemRestoreCommand_initTypes;
|
|
7
7
|
import request from '../../../../request.js';
|
|
8
8
|
import { formatting } from '../../../../utils/formatting.js';
|
|
9
9
|
import { odata } from '../../../../utils/odata.js';
|
|
@@ -22,15 +22,11 @@ class SpoTenantRecycleBinItemRestoreCommand extends SpoCommand {
|
|
|
22
22
|
constructor() {
|
|
23
23
|
super();
|
|
24
24
|
_SpoTenantRecycleBinItemRestoreCommand_instances.add(this);
|
|
25
|
-
__classPrivateFieldGet(this, _SpoTenantRecycleBinItemRestoreCommand_instances, "m", _SpoTenantRecycleBinItemRestoreCommand_initTelemetry).call(this);
|
|
26
25
|
__classPrivateFieldGet(this, _SpoTenantRecycleBinItemRestoreCommand_instances, "m", _SpoTenantRecycleBinItemRestoreCommand_initOptions).call(this);
|
|
27
26
|
__classPrivateFieldGet(this, _SpoTenantRecycleBinItemRestoreCommand_instances, "m", _SpoTenantRecycleBinItemRestoreCommand_initValidators).call(this);
|
|
28
27
|
__classPrivateFieldGet(this, _SpoTenantRecycleBinItemRestoreCommand_instances, "m", _SpoTenantRecycleBinItemRestoreCommand_initTypes).call(this);
|
|
29
28
|
}
|
|
30
29
|
async commandAction(logger, args) {
|
|
31
|
-
if (args.options.wait) {
|
|
32
|
-
await this.warn(logger, `Option 'wait' is deprecated and will be removed in the next major release.`);
|
|
33
|
-
}
|
|
34
30
|
try {
|
|
35
31
|
if (this.verbose) {
|
|
36
32
|
await logger.logToStderr(`Restoring site collection '${args.options.siteUrl}' from recycle bin.`);
|
|
@@ -62,13 +58,6 @@ class SpoTenantRecycleBinItemRestoreCommand extends SpoCommand {
|
|
|
62
58
|
};
|
|
63
59
|
await request.post(restoreOptions);
|
|
64
60
|
}
|
|
65
|
-
// Here, we return a fixed response because this new API endpoint doesn't return a response while the previous API did.
|
|
66
|
-
// This has to be removed in the next major release.
|
|
67
|
-
await logger.log({
|
|
68
|
-
HasTimedout: false,
|
|
69
|
-
IsComplete: !!args.options.wait,
|
|
70
|
-
PollingInterval: 15000
|
|
71
|
-
});
|
|
72
61
|
}
|
|
73
62
|
catch (err) {
|
|
74
63
|
this.handleRejectedODataJsonPromise(err);
|
|
@@ -79,23 +68,14 @@ class SpoTenantRecycleBinItemRestoreCommand extends SpoCommand {
|
|
|
79
68
|
return sites[0].GroupId;
|
|
80
69
|
}
|
|
81
70
|
}
|
|
82
|
-
_SpoTenantRecycleBinItemRestoreCommand_instances = new WeakSet(),
|
|
83
|
-
this.telemetry.push((args) => {
|
|
84
|
-
Object.assign(this.telemetryProperties, {
|
|
85
|
-
wait: !!args.options.wait
|
|
86
|
-
});
|
|
87
|
-
});
|
|
88
|
-
}, _SpoTenantRecycleBinItemRestoreCommand_initOptions = function _SpoTenantRecycleBinItemRestoreCommand_initOptions() {
|
|
71
|
+
_SpoTenantRecycleBinItemRestoreCommand_instances = new WeakSet(), _SpoTenantRecycleBinItemRestoreCommand_initOptions = function _SpoTenantRecycleBinItemRestoreCommand_initOptions() {
|
|
89
72
|
this.options.unshift({
|
|
90
73
|
option: '-u, --siteUrl <siteUrl>'
|
|
91
|
-
}, {
|
|
92
|
-
option: '--wait'
|
|
93
74
|
});
|
|
94
75
|
}, _SpoTenantRecycleBinItemRestoreCommand_initValidators = function _SpoTenantRecycleBinItemRestoreCommand_initValidators() {
|
|
95
76
|
this.validators.push(async (args) => validation.isValidSharePointUrl(args.options.siteUrl));
|
|
96
77
|
}, _SpoTenantRecycleBinItemRestoreCommand_initTypes = function _SpoTenantRecycleBinItemRestoreCommand_initTypes() {
|
|
97
78
|
this.types.string.push('siteUrl');
|
|
98
|
-
this.types.boolean.push('wait');
|
|
99
79
|
};
|
|
100
80
|
export default new SpoTenantRecycleBinItemRestoreCommand();
|
|
101
81
|
//# sourceMappingURL=tenant-recyclebinitem-restore.js.map
|
|
@@ -92,7 +92,6 @@ export default {
|
|
|
92
92
|
FOLDER_LIST: `${prefix} folder list`,
|
|
93
93
|
FOLDER_MOVE: `${prefix} folder move`,
|
|
94
94
|
FOLDER_REMOVE: `${prefix} folder remove`,
|
|
95
|
-
FOLDER_RENAME: `${prefix} folder rename`,
|
|
96
95
|
FOLDER_SET: `${prefix} folder set`,
|
|
97
96
|
FOLDER_RETENTIONLABEL_ENSURE: `${prefix} folder retentionlabel ensure`,
|
|
98
97
|
FOLDER_RETENTIONLABEL_REMOVE: `${prefix} folder retentionlabel remove`,
|
|
@@ -100,6 +99,8 @@ export default {
|
|
|
100
99
|
FOLDER_ROLEASSIGNMENT_ADD: `${prefix} folder roleassignment add`,
|
|
101
100
|
FOLDER_ROLEINHERITANCE_BREAK: `${prefix} folder roleinheritance break`,
|
|
102
101
|
FOLDER_ROLEINHERITANCE_RESET: `${prefix} folder roleinheritance reset`,
|
|
102
|
+
FOLDER_SHARINGLINK_GET: `${prefix} folder sharinglink get`,
|
|
103
|
+
FOLDER_SHARINGLINK_LIST: `${prefix} folder sharinglink list`,
|
|
103
104
|
GET: `${prefix} get`,
|
|
104
105
|
GROUP_ADD: `${prefix} group add`,
|
|
105
106
|
GROUP_GET: `${prefix} group get`,
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
import request from "../request.js";
|
|
2
|
+
export const drive = {
|
|
3
|
+
/**
|
|
4
|
+
* Retrieves the Drive associated with the specified site and URL.
|
|
5
|
+
* @param siteId Site ID
|
|
6
|
+
* @param url Drive URL
|
|
7
|
+
* @param logger The logger object
|
|
8
|
+
* @param verbose Set for verbose logging
|
|
9
|
+
* @returns The Drive associated with the drive URL.
|
|
10
|
+
*/
|
|
11
|
+
async getDriveByUrl(siteId, url, logger, verbose) {
|
|
12
|
+
if (verbose && logger) {
|
|
13
|
+
await logger.logToStderr(`Retrieving drive information for URL: ${url.href}`);
|
|
14
|
+
}
|
|
15
|
+
const requestOptions = {
|
|
16
|
+
url: `https://graph.microsoft.com/v1.0/sites/${siteId}/drives?$select=webUrl,id`,
|
|
17
|
+
headers: {
|
|
18
|
+
accept: 'application/json;odata.metadata=none'
|
|
19
|
+
},
|
|
20
|
+
responseType: 'json'
|
|
21
|
+
};
|
|
22
|
+
const drives = await request.get(requestOptions);
|
|
23
|
+
const lowerCaseFolderUrl = url.href.toLowerCase();
|
|
24
|
+
const drive = drives.value
|
|
25
|
+
.sort((a, b) => b.webUrl.localeCompare(a.webUrl))
|
|
26
|
+
.find((d) => {
|
|
27
|
+
const driveUrl = d.webUrl.toLowerCase();
|
|
28
|
+
return lowerCaseFolderUrl.startsWith(driveUrl) &&
|
|
29
|
+
(driveUrl.length === lowerCaseFolderUrl.length ||
|
|
30
|
+
lowerCaseFolderUrl[driveUrl.length] === '/');
|
|
31
|
+
});
|
|
32
|
+
if (!drive) {
|
|
33
|
+
throw new Error(`Drive '${url.href}' not found`);
|
|
34
|
+
}
|
|
35
|
+
return drive;
|
|
36
|
+
},
|
|
37
|
+
/**
|
|
38
|
+
* Retrieves the ID of a drive item (file, folder, etc.) associated with the given drive and item URL.
|
|
39
|
+
* @param drive The Drive object containing the item
|
|
40
|
+
* @param itemUrl Item URL
|
|
41
|
+
* @param logger The logger object
|
|
42
|
+
* @param verbose Set for verbose logging
|
|
43
|
+
* @returns Drive item ID
|
|
44
|
+
*/
|
|
45
|
+
async getDriveItemId(drive, itemUrl, logger, verbose) {
|
|
46
|
+
const relativeItemUrl = itemUrl.href.replace(new RegExp(`${drive.webUrl}`, 'i'), '').replace(/\/+$/, '');
|
|
47
|
+
if (verbose && logger) {
|
|
48
|
+
await logger.logToStderr(`Retrieving drive item ID for URL: ${relativeItemUrl}`);
|
|
49
|
+
}
|
|
50
|
+
const requestOptions = {
|
|
51
|
+
url: `https://graph.microsoft.com/v1.0/drives/${drive.id}/root${relativeItemUrl ? `:${relativeItemUrl}` : ''}?$select=id`,
|
|
52
|
+
headers: {
|
|
53
|
+
accept: 'application/json;odata.metadata=none'
|
|
54
|
+
},
|
|
55
|
+
responseType: 'json'
|
|
56
|
+
};
|
|
57
|
+
const driveItem = await request.get(requestOptions);
|
|
58
|
+
return driveItem?.id;
|
|
59
|
+
}
|
|
60
|
+
};
|
|
61
|
+
//# sourceMappingURL=drive.js.map
|
package/dist/utils/spo.js
CHANGED
|
@@ -12,6 +12,16 @@ import { RoleType } from '../m365/spo/commands/roledefinition/RoleType.js';
|
|
|
12
12
|
import { entraGroup } from './entraGroup.js';
|
|
13
13
|
import { SharingCapabilities } from '../m365/spo/commands/site/SharingCapabilities.js';
|
|
14
14
|
import { setTimeout } from 'timers/promises';
|
|
15
|
+
export var CreateCopyJobsNameConflictBehavior;
|
|
16
|
+
(function (CreateCopyJobsNameConflictBehavior) {
|
|
17
|
+
CreateCopyJobsNameConflictBehavior[CreateCopyJobsNameConflictBehavior["Fail"] = 0] = "Fail";
|
|
18
|
+
CreateCopyJobsNameConflictBehavior[CreateCopyJobsNameConflictBehavior["Replace"] = 1] = "Replace";
|
|
19
|
+
CreateCopyJobsNameConflictBehavior[CreateCopyJobsNameConflictBehavior["Rename"] = 2] = "Rename";
|
|
20
|
+
})(CreateCopyJobsNameConflictBehavior || (CreateCopyJobsNameConflictBehavior = {}));
|
|
21
|
+
// Wrapping this into a settings object so we can alter the values in tests
|
|
22
|
+
export const settings = {
|
|
23
|
+
pollingInterval: 3000
|
|
24
|
+
};
|
|
15
25
|
export const spo = {
|
|
16
26
|
async getRequestDigest(siteUrl) {
|
|
17
27
|
const requestOptions = {
|
|
@@ -454,15 +464,46 @@ export const spo = {
|
|
|
454
464
|
const res = await request.get(requestOptions);
|
|
455
465
|
return res.AadObjectId.NameId;
|
|
456
466
|
},
|
|
467
|
+
/**
|
|
468
|
+
* Ensure a user exists on a specific SharePoint site.
|
|
469
|
+
* @param webUrl URL of the SharePoint site.
|
|
470
|
+
* @param logonName Logon name of the user to ensure on the SharePoint site.
|
|
471
|
+
* @returns SharePoint user object.
|
|
472
|
+
*/
|
|
473
|
+
async ensureUser(webUrl, logonName) {
|
|
474
|
+
const requestOptions = {
|
|
475
|
+
url: `${webUrl}/_api/web/EnsureUser`,
|
|
476
|
+
headers: {
|
|
477
|
+
accept: 'application/json;odata=nometadata'
|
|
478
|
+
},
|
|
479
|
+
responseType: 'json',
|
|
480
|
+
data: {
|
|
481
|
+
logonName: logonName
|
|
482
|
+
}
|
|
483
|
+
};
|
|
484
|
+
return request.post(requestOptions);
|
|
485
|
+
},
|
|
486
|
+
/**
|
|
487
|
+
* Ensure a Microsoft Entra ID group exists on a specific SharePoint site.
|
|
488
|
+
* @param webUrl URL of the SharePoint site.
|
|
489
|
+
* @param group Microsoft Entra ID group.
|
|
490
|
+
* @returns SharePoint user object.
|
|
491
|
+
*/
|
|
492
|
+
async ensureEntraGroup(webUrl, group) {
|
|
493
|
+
if (!group.securityEnabled) {
|
|
494
|
+
throw new Error('Cannot ensure a Microsoft Entra ID group that is not security enabled.');
|
|
495
|
+
}
|
|
496
|
+
return this.ensureUser(webUrl, group.mailEnabled ? `c:0o.c|federateddirectoryclaimprovider|${group.id}` : `c:0t.c|tenant|${group.id}`);
|
|
497
|
+
},
|
|
457
498
|
/**
|
|
458
499
|
* Retrieves the spo user by email.
|
|
459
500
|
* @param webUrl Web url
|
|
460
501
|
* @param email The email of the user
|
|
461
502
|
* @param logger the Logger object
|
|
462
|
-
* @param
|
|
503
|
+
* @param verbose set if verbose logging should be logged
|
|
463
504
|
*/
|
|
464
|
-
async getUserByEmail(webUrl, email, logger,
|
|
465
|
-
if (
|
|
505
|
+
async getUserByEmail(webUrl, email, logger, verbose) {
|
|
506
|
+
if (verbose) {
|
|
466
507
|
await logger.logToStderr(`Retrieving the spo user by email ${email}`);
|
|
467
508
|
}
|
|
468
509
|
const requestUrl = `${webUrl}/_api/web/siteusers/GetByEmail('${formatting.encodeQueryParameter(email)}')`;
|
|
@@ -533,10 +574,10 @@ export const spo = {
|
|
|
533
574
|
* @param webUrl Web url
|
|
534
575
|
* @param name The name of the group
|
|
535
576
|
* @param logger the Logger object
|
|
536
|
-
* @param
|
|
577
|
+
* @param verbose set if verbose logging should be logged
|
|
537
578
|
*/
|
|
538
|
-
async getGroupByName(webUrl, name, logger,
|
|
539
|
-
if (
|
|
579
|
+
async getGroupByName(webUrl, name, logger, verbose) {
|
|
580
|
+
if (verbose) {
|
|
540
581
|
await logger.logToStderr(`Retrieving the group by name ${name}`);
|
|
541
582
|
}
|
|
542
583
|
const requestUrl = `${webUrl}/_api/web/sitegroups/GetByName('${formatting.encodeQueryParameter(name)}')`;
|
|
@@ -1374,6 +1415,38 @@ export const spo = {
|
|
|
1374
1415
|
const site = await request.get(requestOptions);
|
|
1375
1416
|
return site.id;
|
|
1376
1417
|
},
|
|
1418
|
+
/**
|
|
1419
|
+
* Retrieves the server-relative URL of a folder.
|
|
1420
|
+
* @param webUrl Web URL
|
|
1421
|
+
* @param folderUrl Folder URL
|
|
1422
|
+
* @param folderId Folder ID
|
|
1423
|
+
* @param logger The logger object
|
|
1424
|
+
* @param verbose Set for verbose logging
|
|
1425
|
+
* @returns The server-relative URL of the folder
|
|
1426
|
+
*/
|
|
1427
|
+
async getFolderServerRelativeUrl(webUrl, folderUrl, folderId, logger, verbose) {
|
|
1428
|
+
if (verbose && logger) {
|
|
1429
|
+
await logger.logToStderr(`Retrieving server-relative URL for folder ${folderUrl ? `URL: ${folderUrl}` : `ID: ${folderId}`}`);
|
|
1430
|
+
}
|
|
1431
|
+
let requestUrl = `${webUrl}/_api/web/`;
|
|
1432
|
+
if (folderUrl) {
|
|
1433
|
+
const folderServerRelativeUrl = urlUtil.getServerRelativePath(webUrl, folderUrl);
|
|
1434
|
+
requestUrl += `GetFolderByServerRelativePath(decodedUrl='${formatting.encodeQueryParameter(folderServerRelativeUrl)}')`;
|
|
1435
|
+
}
|
|
1436
|
+
else {
|
|
1437
|
+
requestUrl += `GetFolderById('${folderId}')`;
|
|
1438
|
+
}
|
|
1439
|
+
requestUrl += '?$select=ServerRelativeUrl';
|
|
1440
|
+
const requestOptions = {
|
|
1441
|
+
url: requestUrl,
|
|
1442
|
+
headers: {
|
|
1443
|
+
accept: 'application/json;odata=nometadata'
|
|
1444
|
+
},
|
|
1445
|
+
responseType: 'json'
|
|
1446
|
+
};
|
|
1447
|
+
const res = await request.get(requestOptions);
|
|
1448
|
+
return res.ServerRelativeUrl;
|
|
1449
|
+
},
|
|
1377
1450
|
/**
|
|
1378
1451
|
* Retrieves the ObjectIdentity from a SharePoint site
|
|
1379
1452
|
* @param webUrl web url
|
|
@@ -1453,6 +1526,70 @@ export const spo = {
|
|
|
1453
1526
|
};
|
|
1454
1527
|
const itemsResponse = await request.get(requestOptionsItems);
|
|
1455
1528
|
return (itemsResponse);
|
|
1529
|
+
},
|
|
1530
|
+
/**
|
|
1531
|
+
* Create a SharePoint copy job to copy a file/folder to another location.
|
|
1532
|
+
* @param webUrl Absolute web URL where the source file/folder is located.
|
|
1533
|
+
* @param sourceUrl Absolute URL of the source file/folder.
|
|
1534
|
+
* @param destinationUrl Absolute URL of the destination folder.
|
|
1535
|
+
* @param options Options for the copy job.
|
|
1536
|
+
* @returns Copy job information. Use {@link spo.getCopyJobResult} to get the result of the copy job.
|
|
1537
|
+
*/
|
|
1538
|
+
async createCopyJob(webUrl, sourceUrl, destinationUrl, options) {
|
|
1539
|
+
const requestOptions = {
|
|
1540
|
+
url: `${webUrl}/_api/Site/CreateCopyJobs`,
|
|
1541
|
+
headers: {
|
|
1542
|
+
accept: 'application/json;odata=nometadata'
|
|
1543
|
+
},
|
|
1544
|
+
responseType: 'json',
|
|
1545
|
+
data: {
|
|
1546
|
+
destinationUri: destinationUrl,
|
|
1547
|
+
exportObjectUris: [sourceUrl],
|
|
1548
|
+
options: {
|
|
1549
|
+
NameConflictBehavior: options?.nameConflictBehavior ?? CreateCopyJobsNameConflictBehavior.Fail,
|
|
1550
|
+
AllowSchemaMismatch: true,
|
|
1551
|
+
BypassSharedLock: !!options?.bypassSharedLock,
|
|
1552
|
+
IgnoreVersionHistory: !!options?.ignoreVersionHistory,
|
|
1553
|
+
CustomizedItemName: options?.newName ? [options.newName] : undefined,
|
|
1554
|
+
SameWebCopyMoveOptimization: true
|
|
1555
|
+
}
|
|
1556
|
+
}
|
|
1557
|
+
};
|
|
1558
|
+
const response = await request.post(requestOptions);
|
|
1559
|
+
return response.value[0];
|
|
1560
|
+
},
|
|
1561
|
+
/**
|
|
1562
|
+
* Poll until the copy job is finished and return the result.
|
|
1563
|
+
* @param webUrl Absolute web URL where the copy job was created.
|
|
1564
|
+
* @param copyJobInfo Information about the copy job.
|
|
1565
|
+
* @throws Error if the copy job has failed.
|
|
1566
|
+
* @returns Information about the destination object.
|
|
1567
|
+
*/
|
|
1568
|
+
async getCopyJobResult(webUrl, copyJobInfo) {
|
|
1569
|
+
const requestOptions = {
|
|
1570
|
+
url: `${webUrl}/_api/Site/GetCopyJobProgress`,
|
|
1571
|
+
headers: {
|
|
1572
|
+
accept: 'application/json;odata=nometadata'
|
|
1573
|
+
},
|
|
1574
|
+
responseType: 'json',
|
|
1575
|
+
data: {
|
|
1576
|
+
copyJobInfo: copyJobInfo
|
|
1577
|
+
}
|
|
1578
|
+
};
|
|
1579
|
+
let progress = await request.post(requestOptions);
|
|
1580
|
+
while (progress.JobState !== 0) {
|
|
1581
|
+
await setTimeout(settings.pollingInterval);
|
|
1582
|
+
progress = await request.post(requestOptions);
|
|
1583
|
+
}
|
|
1584
|
+
const logs = progress.Logs.map(l => JSON.parse(l));
|
|
1585
|
+
// Check if the job has failed
|
|
1586
|
+
const errorLog = logs.find(l => l.Event === 'JobError');
|
|
1587
|
+
if (errorLog) {
|
|
1588
|
+
throw new Error(errorLog.Message);
|
|
1589
|
+
}
|
|
1590
|
+
// Get the destination object information
|
|
1591
|
+
const objectInfo = logs.find(l => l.Event === 'JobFinishedObjectInfo');
|
|
1592
|
+
return objectInfo;
|
|
1456
1593
|
}
|
|
1457
1594
|
};
|
|
1458
1595
|
//# sourceMappingURL=spo.js.map
|
|
@@ -16,10 +16,10 @@ m365 app permission add [options]
|
|
|
16
16
|
`--appId [appId]`
|
|
17
17
|
: Client ID of the Microsoft Entra app registered in the .m365rc.json file to retrieve API permissions for.
|
|
18
18
|
|
|
19
|
-
`--
|
|
19
|
+
`--applicationPermissions [applicationPermissions]`
|
|
20
20
|
: Space-separated list of application permissions to add.
|
|
21
21
|
|
|
22
|
-
`--
|
|
22
|
+
`--delegatedPermissions [delegatedPermissions]`
|
|
23
23
|
: Space-separated list of delegated permissions to add.
|
|
24
24
|
|
|
25
25
|
`--grantAdminConsent`
|
|
@@ -37,19 +37,19 @@ If you have multiple apps registered in your .m365rc.json file, you can specify
|
|
|
37
37
|
Adds the specified application permissions to the default app registered in the _.m365rc.json_ file while granting admin consent.
|
|
38
38
|
|
|
39
39
|
```sh
|
|
40
|
-
m365 app permission add --
|
|
40
|
+
m365 app permission add --applicationPermissions 'https://graph.microsoft.com/User.ReadWrite.All https://graph.microsoft.com/User.Read.All' --grantAdminConsent
|
|
41
41
|
```
|
|
42
42
|
|
|
43
43
|
Adds the specified delegated permissions to the default app registered in the _.m365rc.json_ file without granting admin consent.
|
|
44
44
|
|
|
45
45
|
```sh
|
|
46
|
-
m365 app permission add --
|
|
46
|
+
m365 app permission add --delegatedPermissions 'https://graph.microsoft.com/offline_access'
|
|
47
47
|
```
|
|
48
48
|
|
|
49
49
|
Adds the specified application and delegated permissions to a specific app registered in the _.m365rc.json_ file while granting admin consent.
|
|
50
50
|
|
|
51
51
|
```sh
|
|
52
|
-
m365 app permission add --appId '1663767b-4172-4519-bfd1-28e6ff19055b' --
|
|
52
|
+
m365 app permission add --appId '1663767b-4172-4519-bfd1-28e6ff19055b' --applicationPermissions 'https://graph.microsoft.com/User.ReadWrite.All https://graph.microsoft.com/User.Read.All' --delegatedPermissions 'https://graph.microsoft.com/offline_access' --grantAdminConsent
|
|
53
53
|
```
|
|
54
54
|
|
|
55
55
|
## Response
|
|
@@ -15,7 +15,7 @@ m365 connection use [options]
|
|
|
15
15
|
## Options
|
|
16
16
|
|
|
17
17
|
```md definition-list
|
|
18
|
-
`-n, --name
|
|
18
|
+
`-n, --name [name]`
|
|
19
19
|
: The name of the connection to switch to.
|
|
20
20
|
```
|
|
21
21
|
|
|
@@ -23,7 +23,13 @@ m365 connection use [options]
|
|
|
23
23
|
|
|
24
24
|
## Remarks
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
:::tip
|
|
27
|
+
|
|
28
|
+
If you haven't disabled the "prompt" setting, running this command without options will show a list of available connections. You can then select the connection to activate it.
|
|
29
|
+
|
|
30
|
+
:::
|
|
31
|
+
|
|
32
|
+
You can update the name of a connection by running [m365 connection set](connection-set.mdx).
|
|
27
33
|
|
|
28
34
|
## Examples
|
|
29
35
|
|
|
@@ -22,39 +22,39 @@ m365 entra sp add [options]
|
|
|
22
22
|
## Options
|
|
23
23
|
|
|
24
24
|
```md definition-list
|
|
25
|
-
|
|
26
|
-
: ID of the app for which the enterprise application should be created
|
|
25
|
+
`-i, --id [id]`
|
|
26
|
+
: ID of the app for which the enterprise application should be created.
|
|
27
27
|
|
|
28
|
-
|
|
29
|
-
: Display name of the app for which the enterprise application should be created
|
|
28
|
+
`-n, --displayName [displayName]`
|
|
29
|
+
: Display name of the app for which the enterprise application should be created.
|
|
30
30
|
|
|
31
31
|
`--objectId [objectId]`
|
|
32
|
-
: ObjectId of the app for which the enterprise application should be created
|
|
32
|
+
: ObjectId of the app for which the enterprise application should be created.
|
|
33
33
|
```
|
|
34
34
|
|
|
35
35
|
<Global />
|
|
36
36
|
|
|
37
37
|
## Remarks
|
|
38
38
|
|
|
39
|
-
Specify either the `
|
|
39
|
+
Specify either the `id`, `displayName` or `objectId`. If you specify more than one option value, the command will fail with an error.
|
|
40
40
|
|
|
41
41
|
If you register an application in the portal, an application object as well as an enterprise application object are automatically created in your home tenant. If you register an application using CLI for Microsoft 365 or the Microsoft Graph, you'll need to create the enterprise application separately. To register/create an application using the CLI for Microsoft 365, use the [m365 entra app add](../app/app-add.mdx) command.
|
|
42
42
|
|
|
43
43
|
## Examples
|
|
44
44
|
|
|
45
|
-
Creates an enterprise application for a registered Entra app with
|
|
45
|
+
Creates an enterprise application for a registered Entra app with the specified id.
|
|
46
46
|
|
|
47
47
|
```sh
|
|
48
|
-
m365 entra enterpriseapp add --
|
|
48
|
+
m365 entra enterpriseapp add --id b2307a39-e878-458b-bc90-03bc578531d6
|
|
49
49
|
```
|
|
50
50
|
|
|
51
|
-
Creates an enterprise application for a registered Entra app with
|
|
51
|
+
Creates an enterprise application for a registered Entra app with the specified displayName.
|
|
52
52
|
|
|
53
53
|
```sh
|
|
54
|
-
m365 entra enterpriseapp add --
|
|
54
|
+
m365 entra enterpriseapp add --displayName "Microsoft Graph"
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
-
Creates an enterprise application for a registered Entra app with objectId
|
|
57
|
+
Creates an enterprise application for a registered Entra app with the specified objectId.
|
|
58
58
|
|
|
59
59
|
```sh
|
|
60
60
|
m365 entra enterpriseapp add --objectId b2307a39-e878-458b-bc90-03bc578531d6
|
|
@@ -172,7 +172,7 @@ m365 entra enterpriseapp add --objectId b2307a39-e878-458b-bc90-03bc578531d6
|
|
|
172
172
|
<TabItem value="Markdown">
|
|
173
173
|
|
|
174
174
|
```md
|
|
175
|
-
# entra enterpriseapp add --
|
|
175
|
+
# entra enterpriseapp add --id "8da75b6a-4272-4b17-8ee1-20ba66e2b06f"
|
|
176
176
|
|
|
177
177
|
Date: 2023-06-02
|
|
178
178
|
|