@pnp/cli-microsoft365 12.0.0-beta.bf446c8 → 12.0.0-beta.d0b29c1
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/.devproxy/generate-openapi-spec.json +1 -1
- package/allCommands.json +1 -1
- package/allCommandsFull.json +1 -1
- package/dist/googleAnalytics.js +96 -0
- package/dist/m365/spfx/commands/SpfxCompatibilityMatrix.js +15 -0
- package/dist/m365/spfx/commands/project/project-doctor/doctor-1.24.0-rc.0.js +19 -0
- package/dist/m365/spfx/commands/project/project-doctor.js +2 -1
- package/dist/m365/spfx/commands/project/project-upgrade/rules/FN012021_TSC_excludeDirectories.js +43 -0
- package/dist/m365/spfx/commands/project/project-upgrade/rules/FN027002_OVERRIDES_qs.js +33 -0
- package/dist/m365/spfx/commands/project/project-upgrade/rules/FN027003_OVERRIDES_uuid.js +33 -0
- package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.24.0-rc.0.js +77 -0
- package/dist/m365/spfx/commands/project/project-upgrade.js +12 -11
- package/dist/m365/spo/commands/app/app-add.js +35 -56
- package/dist/m365/spo/commands/app/app-deploy.js +41 -59
- package/dist/m365/spo/commands/app/app-get.js +40 -56
- package/dist/m365/spo/commands/app/app-install.js +20 -41
- package/dist/m365/spo/commands/app/app-instance-list.js +12 -24
- package/dist/m365/spo/commands/app/app-list.js +26 -44
- package/dist/m365/spo/commands/app/app-remove.js +32 -52
- package/dist/m365/spo/commands/app/app-retract.js +32 -51
- package/dist/m365/spo/commands/app/app-teamspackage-download.js +35 -54
- package/dist/m365/spo/commands/app/app-uninstall.js +21 -44
- package/dist/m365/spo/commands/app/app-upgrade.js +20 -41
- package/dist/m365/spo/commands/feature/feature-disable.js +20 -50
- package/dist/m365/spo/commands/feature/feature-enable.js +22 -50
- package/dist/m365/spo/commands/feature/feature-list.js +11 -36
- package/dist/m365/spo/commands/field/field-add.js +33 -62
- package/dist/m365/spo/commands/field/field-get.js +30 -57
- package/dist/m365/spo/commands/field/field-list.js +21 -46
- package/dist/m365/spo/commands/field/field-remove.js +32 -63
- package/dist/m365/spo/commands/field/field-set.js +34 -66
- package/dist/m365/spo/commands/file/file-get.js +4 -3
- package/dist/m365/spo/commands/folder/folder-unarchive.js +90 -0
- package/dist/m365/spo/commands/hubsite/hubsite-connect.js +38 -63
- package/dist/m365/spo/commands/hubsite/hubsite-data-get.js +11 -27
- package/dist/m365/spo/commands/hubsite/hubsite-disconnect.js +25 -47
- package/dist/m365/spo/commands/hubsite/hubsite-get.js +25 -37
- package/dist/m365/spo/commands/hubsite/hubsite-list.js +12 -24
- package/dist/m365/spo/commands/hubsite/hubsite-register.js +10 -18
- package/dist/m365/spo/commands/hubsite/hubsite-rights-grant.js +14 -32
- package/dist/m365/spo/commands/hubsite/hubsite-rights-revoke.js +12 -29
- package/dist/m365/spo/commands/hubsite/hubsite-set.js +19 -46
- package/dist/m365/spo/commands/hubsite/hubsite-unregister.js +11 -27
- package/dist/m365/spo/commands/navigation/navigation-node-add.js +74 -120
- package/dist/m365/spo/commands/navigation/navigation-node-get.js +4 -13
- package/dist/m365/spo/commands/navigation/navigation-node-set.js +53 -114
- package/dist/m365/spo/commands/page/page-unpublish.js +53 -0
- package/dist/m365/spo/commands.js +3 -1
- package/dist/m365/teams/commands/chat/chat-get.js +30 -45
- package/dist/m365/teams/commands/chat/chat-list.js +22 -42
- package/dist/m365/teams/commands/chat/chat-member-add.js +43 -64
- package/dist/m365/teams/commands/chat/chat-member-list.js +10 -23
- package/dist/m365/teams/commands/chat/chat-member-remove.js +28 -50
- package/dist/m365/teams/commands/chat/chat-message-send.js +32 -55
- package/dist/m365/util/commands/accesstoken/accesstoken-get.js +10 -28
- package/dist/telemetry.js +7 -11
- package/dist/utils/spo.js +39 -0
- package/docs/docs/cmd/spo/file/file-archive.mdx +1 -1
- package/docs/docs/cmd/spo/file/file-checkin.mdx +2 -2
- package/docs/docs/cmd/spo/file/file-checkout-undo.mdx +1 -1
- package/docs/docs/cmd/spo/file/file-checkout.mdx +2 -2
- package/docs/docs/cmd/spo/file/file-copy.mdx +2 -2
- package/docs/docs/cmd/spo/file/file-get.mdx +6 -6
- package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.mdx +1 -1
- package/docs/docs/cmd/spo/file/file-retentionlabel-remove.mdx +1 -1
- package/docs/docs/cmd/spo/file/file-roleassignment-add.mdx +1 -1
- package/docs/docs/cmd/spo/file/file-roleassignment-remove.mdx +1 -1
- package/docs/docs/cmd/spo/file/file-roleinheritance-break.mdx +3 -3
- package/docs/docs/cmd/spo/file/file-roleinheritance-reset.mdx +2 -2
- package/docs/docs/cmd/spo/file/file-sharinginfo-get.mdx +2 -2
- package/docs/docs/cmd/spo/file/file-sharinglink-add.mdx +1 -1
- package/docs/docs/cmd/spo/file/file-sharinglink-clear.mdx +1 -1
- package/docs/docs/cmd/spo/file/file-sharinglink-get.mdx +1 -1
- package/docs/docs/cmd/spo/file/file-sharinglink-list.mdx +1 -1
- package/docs/docs/cmd/spo/file/file-sharinglink-remove.mdx +1 -1
- package/docs/docs/cmd/spo/file/file-sharinglink-set.mdx +1 -1
- package/docs/docs/cmd/spo/file/file-unarchive.mdx +1 -1
- package/docs/docs/cmd/spo/file/file-version-clear.mdx +1 -1
- package/docs/docs/cmd/spo/file/file-version-get.mdx +1 -1
- package/docs/docs/cmd/spo/file/file-version-keep.mdx +1 -1
- package/docs/docs/cmd/spo/file/file-version-list.mdx +1 -1
- package/docs/docs/cmd/spo/file/file-version-remove.mdx +1 -1
- package/docs/docs/cmd/spo/file/file-version-restore.mdx +1 -1
- package/docs/docs/cmd/spo/folder/folder-archive.mdx +1 -1
- package/docs/docs/cmd/spo/folder/folder-copy.mdx +1 -1
- package/docs/docs/cmd/spo/folder/folder-get.mdx +2 -2
- package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.mdx +1 -1
- package/docs/docs/cmd/spo/folder/folder-retentionlabel-remove.mdx +1 -1
- package/docs/docs/cmd/spo/folder/folder-sharinglink-add.mdx +1 -1
- package/docs/docs/cmd/spo/folder/folder-sharinglink-list.mdx +1 -1
- package/docs/docs/cmd/spo/folder/folder-sharinglink-remove.mdx +1 -1
- package/docs/docs/cmd/spo/folder/folder-unarchive.mdx +76 -0
- package/docs/docs/cmd/spo/navigation/navigation-node-add.mdx +45 -30
- package/docs/docs/cmd/spo/navigation/navigation-node-get.mdx +64 -42
- package/docs/docs/cmd/spo/navigation/navigation-node-set.mdx +10 -8
- package/docs/docs/cmd/spo/page/page-unpublish.mdx +63 -0
- package/docs/docs/cmd/spp/model/model-get.mdx +1 -1
- package/docs/docs/cmd/spp/model/model-remove.mdx +1 -1
- package/docs/docs/cmd/teams/tab/tab-add.mdx +19 -0
- package/docs/docs/cmd/teams/tab/tab-get.mdx +19 -0
- package/docs/docs/cmd/teams/tab/tab-list.mdx +19 -0
- package/docs/docs/cmd/teams/tab/tab-remove.mdx +21 -0
- package/docs/docs/cmd/viva/engage/engage-message-add.mdx +17 -0
- package/docs/docs/cmd/viva/engage/engage-message-get.mdx +17 -0
- package/docs/docs/cmd/viva/engage/engage-message-list.mdx +17 -0
- package/docs/docs/cmd/viva/engage/engage-message-remove.mdx +19 -0
- package/npm-shrinkwrap.json +324 -3116
- package/package.json +17 -35
- package/dist/appInsights.js +0 -43
|
@@ -1,13 +1,14 @@
|
|
|
1
|
-
|
|
2
|
-
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
|
|
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
|
-
return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
|
|
5
|
-
};
|
|
6
|
-
var _UtilAccessTokenGetCommand_instances, _UtilAccessTokenGetCommand_initTelemetry, _UtilAccessTokenGetCommand_initOptions;
|
|
1
|
+
import { z } from 'zod';
|
|
7
2
|
import auth, { Auth } from '../../../../Auth.js';
|
|
8
|
-
import Command from '../../../../Command.js';
|
|
3
|
+
import Command, { globalOptionsZod } from '../../../../Command.js';
|
|
9
4
|
import commands from '../../commands.js';
|
|
10
5
|
import { accessToken } from '../../../../utils/accessToken.js';
|
|
6
|
+
export const options = z.strictObject({
|
|
7
|
+
...globalOptionsZod.shape,
|
|
8
|
+
resource: z.string().alias('r'),
|
|
9
|
+
new: z.boolean().optional(),
|
|
10
|
+
decoded: z.boolean().optional()
|
|
11
|
+
});
|
|
11
12
|
class UtilAccessTokenGetCommand extends Command {
|
|
12
13
|
get name() {
|
|
13
14
|
return commands.ACCESSTOKEN_GET;
|
|
@@ -15,11 +16,8 @@ class UtilAccessTokenGetCommand extends Command {
|
|
|
15
16
|
get description() {
|
|
16
17
|
return 'Gets access token for the specified resource';
|
|
17
18
|
}
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
_UtilAccessTokenGetCommand_instances.add(this);
|
|
21
|
-
__classPrivateFieldGet(this, _UtilAccessTokenGetCommand_instances, "m", _UtilAccessTokenGetCommand_initTelemetry).call(this);
|
|
22
|
-
__classPrivateFieldGet(this, _UtilAccessTokenGetCommand_instances, "m", _UtilAccessTokenGetCommand_initOptions).call(this);
|
|
19
|
+
get schema() {
|
|
20
|
+
return options;
|
|
23
21
|
}
|
|
24
22
|
async commandAction(logger, args) {
|
|
25
23
|
let resource = args.options.resource;
|
|
@@ -49,21 +47,5 @@ class UtilAccessTokenGetCommand extends Command {
|
|
|
49
47
|
}
|
|
50
48
|
}
|
|
51
49
|
}
|
|
52
|
-
_UtilAccessTokenGetCommand_instances = new WeakSet(), _UtilAccessTokenGetCommand_initTelemetry = function _UtilAccessTokenGetCommand_initTelemetry() {
|
|
53
|
-
this.telemetry.push((args) => {
|
|
54
|
-
Object.assign(this.telemetryProperties, {
|
|
55
|
-
new: args.options.new,
|
|
56
|
-
decoded: args.options.decoded
|
|
57
|
-
});
|
|
58
|
-
});
|
|
59
|
-
}, _UtilAccessTokenGetCommand_initOptions = function _UtilAccessTokenGetCommand_initOptions() {
|
|
60
|
-
this.options.unshift({
|
|
61
|
-
option: '-r, --resource <resource>'
|
|
62
|
-
}, {
|
|
63
|
-
option: '--new'
|
|
64
|
-
}, {
|
|
65
|
-
option: '--decoded'
|
|
66
|
-
});
|
|
67
|
-
};
|
|
68
50
|
export default new UtilAccessTokenGetCommand();
|
|
69
51
|
//# sourceMappingURL=accesstoken-get.js.map
|
package/dist/telemetry.js
CHANGED
|
@@ -1,25 +1,21 @@
|
|
|
1
|
-
import appInsights from './appInsights.js';
|
|
2
1
|
import { cli } from './cli/cli.js';
|
|
2
|
+
import { googleAnalytics } from './googleAnalytics.js';
|
|
3
3
|
import { settingsNames } from './settingsNames.js';
|
|
4
4
|
import { pid } from './utils/pid.js';
|
|
5
5
|
import { session } from './utils/session.js';
|
|
6
6
|
async function trackTelemetry(object) {
|
|
7
7
|
try {
|
|
8
8
|
const { commandName, properties, exception } = object;
|
|
9
|
-
|
|
10
|
-
|
|
9
|
+
const context = {
|
|
10
|
+
shell: pid.getProcessName(process.ppid) || '',
|
|
11
|
+
sessionId: session.getId(process.ppid)
|
|
12
|
+
};
|
|
11
13
|
if (exception) {
|
|
12
|
-
|
|
13
|
-
exception
|
|
14
|
-
});
|
|
14
|
+
await googleAnalytics.trackException(exception, context);
|
|
15
15
|
}
|
|
16
16
|
else {
|
|
17
|
-
|
|
18
|
-
name: commandName,
|
|
19
|
-
properties
|
|
20
|
-
});
|
|
17
|
+
await googleAnalytics.trackEvent(commandName, properties, context);
|
|
21
18
|
}
|
|
22
|
-
await appInsights.flush();
|
|
23
19
|
}
|
|
24
20
|
catch {
|
|
25
21
|
// Do nothing
|
package/dist/utils/spo.js
CHANGED
|
@@ -576,6 +576,45 @@ export const spo = {
|
|
|
576
576
|
return request.post(requestOptions);
|
|
577
577
|
},
|
|
578
578
|
/**
|
|
579
|
+
* Retrieves the navigation node with the specified key.
|
|
580
|
+
* Returns the node along with the menu state that contains it.
|
|
581
|
+
* @param webUrl Web url
|
|
582
|
+
* @param key Key (ID) of the navigation node
|
|
583
|
+
* @param location Navigation to search. When not specified, searches the quick launch first and then the top navigation
|
|
584
|
+
*/
|
|
585
|
+
async getMenuStateNodeByKey(webUrl, key, location) {
|
|
586
|
+
const locations = location ? [location] : ['QuickLaunch', 'TopNavigationBar'];
|
|
587
|
+
for (const navigationLocation of locations) {
|
|
588
|
+
const menuState = navigationLocation === 'TopNavigationBar'
|
|
589
|
+
? await this.getTopNavigationMenuState(webUrl)
|
|
590
|
+
: await this.getQuickLaunchMenuState(webUrl);
|
|
591
|
+
const node = this.findMenuStateNode(menuState.Nodes, key);
|
|
592
|
+
if (node) {
|
|
593
|
+
return { menuState, node };
|
|
594
|
+
}
|
|
595
|
+
}
|
|
596
|
+
throw location
|
|
597
|
+
? `Navigation node with id '${key}' not found in ${location}.`
|
|
598
|
+
: `Navigation node with id '${key}' not found.`;
|
|
599
|
+
},
|
|
600
|
+
/**
|
|
601
|
+
* Recursively searches the specified menu state nodes for the node with the specified key.
|
|
602
|
+
* @param nodes Menu state nodes to search
|
|
603
|
+
* @param key Key (ID) of the navigation node
|
|
604
|
+
*/
|
|
605
|
+
findMenuStateNode(nodes, key) {
|
|
606
|
+
for (const node of nodes) {
|
|
607
|
+
if (node.Key === key) {
|
|
608
|
+
return node;
|
|
609
|
+
}
|
|
610
|
+
const childNode = this.findMenuStateNode(node.Nodes, key);
|
|
611
|
+
if (childNode) {
|
|
612
|
+
return childNode;
|
|
613
|
+
}
|
|
614
|
+
}
|
|
615
|
+
return undefined;
|
|
616
|
+
},
|
|
617
|
+
/**
|
|
579
618
|
* Retrieves the spo group by name.
|
|
580
619
|
* Returns a group object
|
|
581
620
|
* @param webUrl Web url
|
|
@@ -22,7 +22,7 @@ m365 spo file archive [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the file to archive. Specify either `url` or `id`, but not both.
|
|
23
23
|
|
|
24
24
|
`-i, --id [id]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the file to archive. Specify either `url` or `id`, but not both.
|
|
26
26
|
|
|
27
27
|
`-f, --force`
|
|
28
28
|
: Don't prompt for confirmation.
|
|
@@ -22,7 +22,7 @@ m365 spo file checkin [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the file to retrieve. Specify either `url` or `id` but not both.
|
|
23
23
|
|
|
24
24
|
`-i, --id [id]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the file to retrieve. Specify either `url` or `id` but not both.
|
|
26
26
|
|
|
27
27
|
`-t, --type [type]`
|
|
28
28
|
: Type of the check in. Allowed values: `Minor`, `Major`, `Overwrite`. Defaults to `Major`.
|
|
@@ -54,7 +54,7 @@ m365 spo file checkin [options]
|
|
|
54
54
|
|
|
55
55
|
## Examples
|
|
56
56
|
|
|
57
|
-
Checks in file with the specified
|
|
57
|
+
Checks in file with the specified unique ID located in the specified site.
|
|
58
58
|
|
|
59
59
|
```sh
|
|
60
60
|
m365 spo file checkin --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6'
|
|
@@ -22,7 +22,7 @@ m365 spo file checkout undo [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
|
|
23
23
|
|
|
24
24
|
`-i, --fileId [fileId]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
|
|
26
26
|
|
|
27
27
|
`-f, --force`
|
|
28
28
|
: Don't prompt for confirmation.
|
|
@@ -22,7 +22,7 @@ m365 spo file checkout [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the file to retrieve. Specify either `url` or `id` but not both.
|
|
23
23
|
|
|
24
24
|
`-i, --id [id]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the file to retrieve. Specify either `url` or `id` but not both.
|
|
26
26
|
```
|
|
27
27
|
|
|
28
28
|
<Global />
|
|
@@ -48,7 +48,7 @@ m365 spo file checkout [options]
|
|
|
48
48
|
|
|
49
49
|
## Examples
|
|
50
50
|
|
|
51
|
-
Checks out file with the specified
|
|
51
|
+
Checks out file with the specified unique ID located in the specified site.
|
|
52
52
|
|
|
53
53
|
```sh
|
|
54
54
|
m365 spo file checkout --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6'
|
|
@@ -85,13 +85,13 @@ Copy a file by site-relative URL to a document library in another site collectio
|
|
|
85
85
|
m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceUrl "/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents" --ignoreVersionHistory
|
|
86
86
|
```
|
|
87
87
|
|
|
88
|
-
Copy file by sourceId (
|
|
88
|
+
Copy file by sourceId (unique ID) to a document library in another site collection and rename the file (without specifying the file extension).
|
|
89
89
|
|
|
90
90
|
```sh
|
|
91
91
|
m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceId "b2307a39-e878-458b-bc90-03bc578531d6" --targetUrl "/sites/IT/Shared Documents" --newName "Report.pdf"
|
|
92
92
|
```
|
|
93
93
|
|
|
94
|
-
Copy file by sourceId (
|
|
94
|
+
Copy file by sourceId (unique ID) to a document library in another site collection with a new name, rename the file if it already exists.
|
|
95
95
|
|
|
96
96
|
```sh
|
|
97
97
|
m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceId "b2307a39-e878-458b-bc90-03bc578531d6" --targetUrl "/sites/IT/Shared Documents" --newName "Report.pdf" --nameConflictBehavior rename
|
|
@@ -22,7 +22,7 @@ m365 spo file get [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the file to retrieve. Specify either `url` or `id` but not both.
|
|
23
23
|
|
|
24
24
|
`-i, --id [id]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the file to retrieve. Specify either `url` or `id` but not both.
|
|
26
26
|
|
|
27
27
|
`--asString`
|
|
28
28
|
: Set to retrieve the contents of the specified file as string.
|
|
@@ -63,25 +63,25 @@ m365 spo file get [options]
|
|
|
63
63
|
|
|
64
64
|
## Examples
|
|
65
65
|
|
|
66
|
-
Get file properties for a file with id (
|
|
66
|
+
Get file properties for a file with id (unique ID) parameter located in a site.
|
|
67
67
|
|
|
68
68
|
```sh
|
|
69
69
|
m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6'
|
|
70
70
|
```
|
|
71
71
|
|
|
72
|
-
Get contents of the file with id (
|
|
72
|
+
Get contents of the file with id (unique ID) parameter located in a site.
|
|
73
73
|
|
|
74
74
|
```sh
|
|
75
75
|
m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6' --asString
|
|
76
76
|
```
|
|
77
77
|
|
|
78
|
-
Get list item properties for a file with id (
|
|
78
|
+
Get list item properties for a file with id (unique ID) parameter located in a site.
|
|
79
79
|
|
|
80
80
|
```sh
|
|
81
81
|
m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6' --asListItem
|
|
82
82
|
```
|
|
83
83
|
|
|
84
|
-
Saves the file with id (
|
|
84
|
+
Saves the file with id (unique ID) parameter located in a site to a local file.
|
|
85
85
|
|
|
86
86
|
```sh
|
|
87
87
|
m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6' --asFile --path /Users/user/documents/SavedAsTest1.docx
|
|
@@ -111,7 +111,7 @@ Saves a file with the server-relative url located in a site to a local file.
|
|
|
111
111
|
m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx' --asFile --path /Users/user/documents/SavedAsTest1.docx
|
|
112
112
|
```
|
|
113
113
|
|
|
114
|
-
Gets the file properties for a file with id (
|
|
114
|
+
Gets the file properties for a file with id (unique ID) parameter located in a site with permissions.
|
|
115
115
|
|
|
116
116
|
```sh
|
|
117
117
|
m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6' --withPermissions
|
|
@@ -22,7 +22,7 @@ m365 spo file retentionlabel ensure [options]
|
|
|
22
22
|
: The site- or server-relative decoded URL of the file that should be labelled. Specify either `fileUrl` or `fileId` but not both.
|
|
23
23
|
|
|
24
24
|
`-i, --fileId [fileId]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the file that should be labelled. Specify either `fileUrl` or `fileId` but not both.
|
|
26
26
|
|
|
27
27
|
`--name <name>`
|
|
28
28
|
: Name of the retention label to apply to the file.
|
|
@@ -22,7 +22,7 @@ m365 spo file retentionlabel remove [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the file of which the label should be removed. Specify either `fileUrl` or `fileId` but not both.
|
|
23
23
|
|
|
24
24
|
`-i, --fileId [fileId]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the file of which the label should be removed. Specify either `fileUrl` or `fileId` but not both.
|
|
26
26
|
|
|
27
27
|
`-f, --force`
|
|
28
28
|
: Don't prompt for confirming removing the retention label from a file.
|
|
@@ -22,7 +22,7 @@ m365 spo file roleassignment add [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
|
|
23
23
|
|
|
24
24
|
`-i, --fileId [fileId]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
|
|
26
26
|
|
|
27
27
|
`--principalId [principalId]`
|
|
28
28
|
: The SharePoint Id of the principal. It may be either a user id or group id to add a role assignment for. Specify either `upn`, `groupName`, or `principalId` but not multiple.
|
|
@@ -22,7 +22,7 @@ m365 spo file roleassignment remove [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
23
23
|
|
|
24
24
|
`-i, --fileId [fileId]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
26
26
|
|
|
27
27
|
`--principalId [principalId]`
|
|
28
28
|
: The SharePoint Id of the principal. It may be either a user id or group id. Specify either `upn`, `groupName`, `entraGroupId`, `entraGroupName`, or `principalId` but not multiple.
|
|
@@ -22,7 +22,7 @@ m365 spo file roleinheritance break [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
23
23
|
|
|
24
24
|
`-i, --fileId [fileId]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
26
26
|
|
|
27
27
|
`-c, --clearExistingPermissions`
|
|
28
28
|
: Clear all existing permissions from the file.
|
|
@@ -54,13 +54,13 @@ m365 spo file roleinheritance break [options]
|
|
|
54
54
|
|
|
55
55
|
## Examples
|
|
56
56
|
|
|
57
|
-
Break the inheritance of a file with a specific id (
|
|
57
|
+
Break the inheritance of a file with a specific id (unique ID).
|
|
58
58
|
|
|
59
59
|
```sh
|
|
60
60
|
m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6"
|
|
61
61
|
```
|
|
62
62
|
|
|
63
|
-
Break the inheritance of a file with a specific id (
|
|
63
|
+
Break the inheritance of a file with a specific id (unique ID) and clear all existing permissions.
|
|
64
64
|
|
|
65
65
|
```sh
|
|
66
66
|
m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --clearExistingPermissions
|
|
@@ -22,7 +22,7 @@ m365 spo file roleinheritance reset [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
|
|
23
23
|
|
|
24
24
|
`-i, --fileId [fileId]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
|
|
26
26
|
|
|
27
27
|
`-f, --force`
|
|
28
28
|
: Don't prompt for confirmation.
|
|
@@ -51,7 +51,7 @@ m365 spo file roleinheritance reset [options]
|
|
|
51
51
|
|
|
52
52
|
## Examples
|
|
53
53
|
|
|
54
|
-
Reset inheritance of file with the specified id (
|
|
54
|
+
Reset inheritance of file with the specified id (unique ID) located in the specified site.
|
|
55
55
|
|
|
56
56
|
```sh
|
|
57
57
|
m365 spo file roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6"
|
|
@@ -22,7 +22,7 @@ m365 spo file sharinginfo get [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the file for which to build the report. Specify either `fileUrl` or `fileId` but not both.
|
|
23
23
|
|
|
24
24
|
`-i, --fileId [fileId]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the file for which to build the report. Specify either `fileUrl` or `fileId` but not both.
|
|
26
26
|
```
|
|
27
27
|
|
|
28
28
|
<Global />
|
|
@@ -54,7 +54,7 @@ Get file sharing information report for the file with the specified server-relat
|
|
|
54
54
|
m365 spo file sharinginfo get --webUrl https://contoso.sharepoint.com/sites/project-x --fileUrl "/sites/M365CLI/Shared Documents/SharedFile.docx"
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
-
Get file sharing information report for file with the specified id (
|
|
57
|
+
Get file sharing information report for file with the specified id (unique ID) located in the specified site.
|
|
58
58
|
|
|
59
59
|
```sh
|
|
60
60
|
m365 spo file sharinginfo get --webUrl https://contoso.sharepoint.com/sites/project-x --fileId "b2307a39-e878-458b-bc90-03bc578531d6"
|
|
@@ -22,7 +22,7 @@ m365 spo file sharinglink add [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
23
23
|
|
|
24
24
|
`--fileId [fileId]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
26
26
|
|
|
27
27
|
`--type <type>`
|
|
28
28
|
: The type of sharing link to create. Either `view` or `edit`.
|
|
@@ -22,7 +22,7 @@ m365 spo file sharinglink clear [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
23
23
|
|
|
24
24
|
`--fileId [fileId]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
26
26
|
|
|
27
27
|
`-s, --scope [scope]`
|
|
28
28
|
: Scope of the sharing link. Possible options are: `anonymous`, `users` or `organization`. If not specified, all links will be removed.
|
|
@@ -22,7 +22,7 @@ m365 spo file sharinglink get [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
23
23
|
|
|
24
24
|
`--fileId [fileId]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
26
26
|
|
|
27
27
|
`-i, --id <id>`
|
|
28
28
|
: The ID of the sharing link.
|
|
@@ -22,7 +22,7 @@ m365 spo file sharinglink list [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
23
23
|
|
|
24
24
|
`--fileId [fileId]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
26
26
|
|
|
27
27
|
`-s, --scope [scope]`
|
|
28
28
|
: Filter the results to only sharing links of a given scope: `anonymous`, `users` or `organization`. By default all sharing links are listed.
|
|
@@ -22,7 +22,7 @@ m365 spo file sharinglink remove [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
23
23
|
|
|
24
24
|
`--fileId [fileId]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
26
26
|
|
|
27
27
|
`-i, --id <id>`
|
|
28
28
|
: The ID of the sharing link.
|
|
@@ -22,7 +22,7 @@ m365 spo file sharinglink set [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
23
23
|
|
|
24
24
|
`--fileId [fileId]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
26
26
|
|
|
27
27
|
`--id <id>`
|
|
28
28
|
: The ID of the sharing link.
|
|
@@ -22,7 +22,7 @@ m365 spo file unarchive [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the file to unarchive. Specify either `url` or `id`, but not both.
|
|
23
23
|
|
|
24
24
|
`-i, --id [id]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the file to unarchive. Specify either `url` or `id`, but not both.
|
|
26
26
|
|
|
27
27
|
`-f, --force`
|
|
28
28
|
: Don't prompt for confirmation.
|
|
@@ -22,7 +22,7 @@ m365 spo file version clear [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
23
23
|
|
|
24
24
|
`-i, --fileId [fileId]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
26
26
|
|
|
27
27
|
`-f, --force`
|
|
28
28
|
: Don't prompt for confirmation.
|
|
@@ -25,7 +25,7 @@ m365 spo file version get [options]
|
|
|
25
25
|
: The server- or site-relative decoded URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
|
|
26
26
|
|
|
27
27
|
`-i, --fileId [fileId]`
|
|
28
|
-
: The
|
|
28
|
+
: The unique ID (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
|
|
29
29
|
```
|
|
30
30
|
|
|
31
31
|
<Global />
|
|
@@ -22,7 +22,7 @@ m365 spo file version keep [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL. Specify either `fileUrl` or `fileId` but not both.
|
|
23
23
|
|
|
24
24
|
`-i, --fileId [fileId]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
26
26
|
|
|
27
27
|
`--label <label>`
|
|
28
28
|
: Label of the version.
|
|
@@ -22,7 +22,7 @@ m365 spo file version list [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
23
23
|
|
|
24
24
|
`-i, --fileId [fileId]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
26
26
|
```
|
|
27
27
|
|
|
28
28
|
<Global />
|
|
@@ -25,7 +25,7 @@ m365 spo file version remove [options]
|
|
|
25
25
|
: The server- or site-relative decoded URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
|
|
26
26
|
|
|
27
27
|
`-i, --fileId [fileId]`
|
|
28
|
-
: The
|
|
28
|
+
: The unique ID (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
|
|
29
29
|
|
|
30
30
|
`-f, --force`
|
|
31
31
|
: Don't prompt for confirmation.
|
|
@@ -25,7 +25,7 @@ m365 spo file version restore [options]
|
|
|
25
25
|
: The server- or site-relative decoded URL of the file whose version will be restored. Specify either `fileUrl` or `fileId` but not both.
|
|
26
26
|
|
|
27
27
|
`-i, --fileId [fileId]`
|
|
28
|
-
: The
|
|
28
|
+
: The unique ID (GUID) of the file whose version will be restored. Specify either `fileUrl` or `fileId` but not both.
|
|
29
29
|
|
|
30
30
|
`-f, --force`
|
|
31
31
|
: Don't prompt for confirmation.
|
|
@@ -22,7 +22,7 @@ m365 spo folder archive [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the folder to archive. Specify either `url` or `id`, but not both.
|
|
23
23
|
|
|
24
24
|
`-i, --id [id]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the folder to archive. Specify either `url` or `id`, but not both.
|
|
26
26
|
|
|
27
27
|
`-f, --force`
|
|
28
28
|
: Don't prompt for confirmation.
|
|
@@ -22,7 +22,7 @@ m365 spo folder copy [options]
|
|
|
22
22
|
: The server-, site-relative or absolute decoded URL of the folder to copy. Specify either `sourceUrl` or `sourceId` but not both.
|
|
23
23
|
|
|
24
24
|
`-i, --sourceId [sourceId]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the folder. Specify either `sourceUrl` or `sourceId` but not both.
|
|
26
26
|
|
|
27
27
|
`-t, --targetUrl <targetUrl>`
|
|
28
28
|
: Server-relative or absolute decoded URL where to copy the folder.
|
|
@@ -22,7 +22,7 @@ m365 spo folder get [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the folder to retrieve. Specify either `folderUrl` or `id` but not both.
|
|
23
23
|
|
|
24
24
|
`-i, --id [id]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the folder to retrieve. Specify either `url` or `id` but not both.
|
|
26
26
|
|
|
27
27
|
`--withPermissions`
|
|
28
28
|
: Set if you want to return associated roles and permissions of the folder.
|
|
@@ -63,7 +63,7 @@ Get folder properties for a folder with a specific site-relative URL.
|
|
|
63
63
|
m365 spo folder get --webUrl https://contoso.sharepoint.com/sites/project-x --url "/Shared Documents"
|
|
64
64
|
```
|
|
65
65
|
|
|
66
|
-
Get folder properties for a folder with a specific id (
|
|
66
|
+
Get folder properties for a folder with a specific id (unique ID).
|
|
67
67
|
|
|
68
68
|
```sh
|
|
69
69
|
m365 spo folder get --webUrl https://contoso.sharepoint.com/sites/project-x --id "b2307a39-e878-458b-bc90-03bc578531d6"
|
|
@@ -22,7 +22,7 @@ m365 spo folder retentionlabel ensure [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the folder that should be labelled. Specify either `folderUrl` or `folderId` but not both.
|
|
23
23
|
|
|
24
24
|
`-i, --folderId [folderId]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the folder that should be labelled. Specify either `folderUrl` or `folderId` but not both.
|
|
26
26
|
|
|
27
27
|
`--name <name>`
|
|
28
28
|
: Name of the retention label to apply to the folder.
|
|
@@ -22,7 +22,7 @@ m365 spo folder retentionlabel remove [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the folder of which the label should be removed. Specify either `folderUrl` or `folderId` but not both.
|
|
23
23
|
|
|
24
24
|
`-i, --folderId [folderId]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the folder of which the label should be removed. Specify either `folderUrl` or `folderId` but not both.
|
|
26
26
|
|
|
27
27
|
`-f, --force`
|
|
28
28
|
: Don't prompt for confirming to remove the label.
|
|
@@ -22,7 +22,7 @@ m365 spo folder sharinglink add [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the folder. Specify either `folderUrl` or `folderId` but not both.
|
|
23
23
|
|
|
24
24
|
`--folderId [folderId]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the folder. Specify either `folderUrl` or `folderId` but not both.
|
|
26
26
|
|
|
27
27
|
`--type <type>`
|
|
28
28
|
: The type of sharing link to create. Either `view` or `edit`.
|
|
@@ -22,7 +22,7 @@ m365 spo folder sharinglink list [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the folder. Specify either `folderUrl` or `folderId` but not both.
|
|
23
23
|
|
|
24
24
|
`--folderId [folderId]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the folder. Specify either `folderUrl` or `folderId` but not both.
|
|
26
26
|
|
|
27
27
|
`-s, --scope [scope]`
|
|
28
28
|
: Filter the results to only sharing links of a given scope: `anonymous`, `users` or `organization`. By default all sharing links are listed.
|
|
@@ -22,7 +22,7 @@ m365 spo folder sharinglink remove [options]
|
|
|
22
22
|
: The server- or site-relative decoded URL of the folder. Specify either `folderUrl` or `folderId` but not both.
|
|
23
23
|
|
|
24
24
|
`--folderId [folderId]`
|
|
25
|
-
: The
|
|
25
|
+
: The unique ID (GUID) of the folder. Specify either `folderUrl` or `folderId` but not both.
|
|
26
26
|
|
|
27
27
|
`-i, --id <id>`
|
|
28
28
|
: The ID of the sharing link.
|