@pnp/cli-microsoft365 9.0.0-beta.2f8dd1e → 9.0.0-beta.59b026e
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.cjs +1 -0
- package/allCommands.json +1 -1
- package/allCommandsFull.json +1 -1
- package/dist/Auth.js +10 -18
- package/dist/Command.js +49 -2
- package/dist/chili/chili.js +0 -23
- package/dist/cli/cli.js +61 -101
- package/dist/config.js +1 -1
- package/dist/m365/app/commands/permission/permission-add.js +9 -9
- package/dist/m365/commands/login.js +44 -96
- package/dist/m365/commands/setup.js +0 -4
- 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-set.js +66 -29
- 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/MultitenantOrganization.js +2 -0
- package/dist/m365/entra/commands/multitenant/multitenant-add.js +65 -0
- package/dist/m365/entra/commands/multitenant/multitenant-get.js +32 -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 +4 -0
- package/dist/m365/external/commands/connection/connection-doctor.js +10 -24
- package/dist/m365/flow/commands/flow-get.js +1 -1
- package/dist/m365/flow/commands/flow-list.js +23 -24
- package/dist/m365/graph/commands/subscription/subscription-add.js +4 -2
- package/dist/m365/outlook/commands/message/message-get.js +11 -11
- package/dist/m365/spe/ContainerTypeProperties.js +2 -0
- package/dist/m365/spe/commands/containertype/containertype-list.js +49 -0
- package/dist/m365/spe/commands.js +2 -1
- package/dist/m365/spfx/commands/project/DeployWorkflow.js +1 -1
- package/dist/m365/spfx/commands/project/base-project-command.js +36 -126
- package/dist/m365/spfx/commands/project/project-github-workflow-add.js +1 -10
- package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-get.js +16 -21
- package/dist/m365/spo/commands/cdn/cdn-get.js +12 -15
- package/dist/m365/spo/commands/cdn/cdn-set.js +6 -4
- package/dist/m365/spo/commands/commandset/commandset-get.js +31 -17
- package/dist/m365/spo/commands/contenttype/contenttype-field-list.js +124 -0
- package/dist/m365/spo/commands/field/field-list.js +1 -1
- 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/group/group-member-add.js +103 -99
- 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/page/page-clientsidewebpart-add.js +2 -3
- package/dist/m365/spo/commands/page/page-text-add.js +2 -3
- 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/spo-search.js +3 -4
- package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-get.js +19 -5
- package/dist/m365/spo/commands/tenant/tenant-commandset-get.js +20 -6
- package/dist/m365/spo/commands/tenant/tenant-recyclebinitem-restore.js +2 -22
- package/dist/m365/spo/commands.js +3 -1
- package/dist/m365/teams/commands/meeting/meeting-attendancereport-get.js +119 -0
- package/dist/m365/teams/commands/message/message-remove.js +112 -0
- package/dist/m365/teams/commands.js +2 -0
- package/dist/m365/viva/commands/engage/engage-community-add.js +166 -0
- package/dist/m365/viva/commands.js +1 -0
- package/dist/utils/drive.js +61 -0
- package/dist/utils/formatting.js +30 -1
- package/dist/utils/spo.js +143 -6
- package/dist/utils/teams.js +49 -0
- package/dist/utils/validation.js +19 -0
- package/dist/utils/zod.js +124 -0
- 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-set.mdx +37 -7
- 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-get.mdx +94 -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/external/connection/connection-doctor.mdx +9 -9
- package/docs/docs/cmd/flow/flow-get.mdx +149 -283
- package/docs/docs/cmd/flow/flow-list.mdx +114 -56
- package/docs/docs/cmd/graph/subscription/subscription-add.mdx +18 -0
- package/docs/docs/cmd/outlook/message/message-get.mdx +5 -5
- package/docs/docs/cmd/planner/plan/plan-remove.mdx +1 -1
- package/docs/docs/cmd/spe/containertype/containertype-list.mdx +102 -0
- package/docs/docs/cmd/spfx/project/project-github-workflow-add.mdx +11 -12
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx +87 -38
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-list.mdx +22 -28
- package/docs/docs/cmd/spo/cdn/cdn-set.mdx +3 -3
- package/docs/docs/cmd/spo/commandset/commandset-get.mdx +75 -24
- package/docs/docs/cmd/spo/commandset/commandset-list.mdx +26 -32
- package/docs/docs/cmd/spo/contenttype/contenttype-field-list.mdx +172 -0
- package/docs/docs/cmd/spo/contenttype/contenttype-list.mdx +3 -3
- package/docs/docs/cmd/spo/field/field-list.mdx +3 -3
- 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/group/group-member-add.mdx +34 -27
- 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-applicationcustomizer-get.mdx +79 -30
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-list.mdx +20 -19
- package/docs/docs/cmd/spo/tenant/tenant-commandset-get.mdx +84 -38
- package/docs/docs/cmd/spo/tenant/tenant-commandset-list.mdx +20 -19
- 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/docs/docs/cmd/teams/meeting/meeting-attendancereport-get.mdx +138 -0
- package/docs/docs/cmd/teams/meeting/meeting-list.mdx +7 -3
- package/docs/docs/cmd/teams/message/message-remove.mdx +63 -0
- package/docs/docs/cmd/viva/engage/engage-community-add.mdx +168 -0
- package/npm-shrinkwrap.json +588 -1022
- package/package.json +7 -3
|
@@ -0,0 +1,172 @@
|
|
|
1
|
+
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
import Tabs from '@theme/Tabs';
|
|
3
|
+
import TabItem from '@theme/TabItem';
|
|
4
|
+
|
|
5
|
+
# spo contenttype field list
|
|
6
|
+
|
|
7
|
+
Lists fields for a given site or list content type
|
|
8
|
+
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
m365 spo contenttype field list [options]
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Options
|
|
16
|
+
|
|
17
|
+
```md definition-list
|
|
18
|
+
`-u, --webUrl <webUrl>`
|
|
19
|
+
: Absolute URL of the site where the content type is located.
|
|
20
|
+
|
|
21
|
+
`-i, --contentTypeId [contentTypeId]`
|
|
22
|
+
: The ID of the content type for which to list fields. Specify either `contentTypeId` or `contentTypeName`.
|
|
23
|
+
|
|
24
|
+
`-n, --contentTypeName [contentTypeName]`
|
|
25
|
+
: The name of the content type for which to list fields. Specify either `contentTypeId` or `contentTypeName`.
|
|
26
|
+
|
|
27
|
+
`-l, --listTitle [listTitle]`
|
|
28
|
+
: Optional title of the list where the content type is located. Specify either `listTitle`, `listId` or `listUrl`.
|
|
29
|
+
|
|
30
|
+
`--listId [listId]`
|
|
31
|
+
: Optional ID of the list where the content type is located. Specify either `listTitle`, `listId` or `listUrl`.
|
|
32
|
+
|
|
33
|
+
`--listUrl [listUrl]`
|
|
34
|
+
: Optional server- or web-relative URL of the list where the content type is located. Specify either `listTitle`, `listId` or `listUrl`.
|
|
35
|
+
|
|
36
|
+
`-p, --properties [properties]`
|
|
37
|
+
: Comma-separated list of properties to retrieve. Will retrieve all properties if not specified.
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
<Global />
|
|
41
|
+
|
|
42
|
+
## Examples
|
|
43
|
+
|
|
44
|
+
Retrieves fields for the specified site content type.
|
|
45
|
+
|
|
46
|
+
```sh
|
|
47
|
+
m365 spo contenttype field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --contentTypeId "0x01"
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Retrieves fields for the specified list content type in the Documents library.
|
|
51
|
+
|
|
52
|
+
```sh
|
|
53
|
+
m365 spo contenttype field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --contentTypeName "Document" --listTitle "Documents"
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## Response
|
|
57
|
+
|
|
58
|
+
<Tabs>
|
|
59
|
+
<TabItem value="JSON">
|
|
60
|
+
|
|
61
|
+
```json
|
|
62
|
+
[
|
|
63
|
+
{
|
|
64
|
+
"AutoIndexed": false,
|
|
65
|
+
"CanBeDeleted": false,
|
|
66
|
+
"ClientSideComponentId": "00000000-0000-0000-0000-000000000000",
|
|
67
|
+
"ClientSideComponentProperties": null,
|
|
68
|
+
"ClientValidationFormula": null,
|
|
69
|
+
"ClientValidationMessage": null,
|
|
70
|
+
"CustomFormatter": null,
|
|
71
|
+
"DefaultFormula": null,
|
|
72
|
+
"DefaultValue": null,
|
|
73
|
+
"Description": "",
|
|
74
|
+
"Direction": "none",
|
|
75
|
+
"EnforceUniqueValues": false,
|
|
76
|
+
"EntityPropertyName": "Title",
|
|
77
|
+
"Filterable": true,
|
|
78
|
+
"FromBaseType": true,
|
|
79
|
+
"Group": "_Hidden",
|
|
80
|
+
"Hidden": false,
|
|
81
|
+
"Id": "fa564e0f-0c70-4ab9-b863-0177e6ddd247",
|
|
82
|
+
"Indexed": false,
|
|
83
|
+
"IndexStatus": 0,
|
|
84
|
+
"InternalName": "Title",
|
|
85
|
+
"IsModern": false,
|
|
86
|
+
"JSLink": "clienttemplates.js",
|
|
87
|
+
"PinnedToFiltersPane": false,
|
|
88
|
+
"ReadOnlyField": false,
|
|
89
|
+
"Required": true,
|
|
90
|
+
"SchemaXml": "<Field ID=\"{fa564e0f-0c70-4ab9-b863-0177e6ddd247}\" Name=\"Title\" SourceID=\"http://schemas.microsoft.com/sharepoint/v3\" StaticName=\"Title\" Group=\"_Hidden\" Type=\"Text\" DisplayName=\"Title\" Required=\"TRUE\" FromBaseType=\"TRUE\" DelayActivateTemplateBinding=\"GROUP,SPSPERS,SITEPAGEPUBLISHING\" Customization=\"\" ShowInNewForm=\"TRUE\" ShowInEditForm=\"TRUE\"></Field>",
|
|
91
|
+
"Scope": "/",
|
|
92
|
+
"Sealed": false,
|
|
93
|
+
"ShowInFiltersPane": 0,
|
|
94
|
+
"Sortable": true,
|
|
95
|
+
"StaticName": "Title",
|
|
96
|
+
"Title": "Title",
|
|
97
|
+
"FieldTypeKind": 2,
|
|
98
|
+
"TypeAsString": "Text",
|
|
99
|
+
"TypeDisplayName": "Single line of text",
|
|
100
|
+
"TypeShortDescription": "Single line of text",
|
|
101
|
+
"ValidationFormula": null,
|
|
102
|
+
"ValidationMessage": null,
|
|
103
|
+
"MaxLength": 255
|
|
104
|
+
}
|
|
105
|
+
]
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
</TabItem>
|
|
109
|
+
<TabItem value="Text">
|
|
110
|
+
|
|
111
|
+
```text
|
|
112
|
+
Id Title InternalName Hidden
|
|
113
|
+
------------------------------------ ------ ------------ ------
|
|
114
|
+
5ee2dd25-d941-455a-9bdb-7f2c54aed11b Title Title false
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
</TabItem>
|
|
118
|
+
<TabItem value="CSV">
|
|
119
|
+
|
|
120
|
+
```csv
|
|
121
|
+
AutoIndexed,CanBeDeleted,ClientSideComponentId,ClientSideComponentProperties,ClientValidationFormula,ClientValidationMessage,CustomFormatter,DefaultFormula,DefaultValue,Description,Direction,EnforceUniqueValues,EntityPropertyName,Filterable,FromBaseType,Group,Hidden,Id,Indexed,IndexStatus,InternalName,IsModern,JSLink,PinnedToFiltersPane,ReadOnlyField,Required,SchemaXml,Scope,Sealed,ShowInFiltersPane,Sortable,StaticName,Title,FieldTypeKind,TypeAsString,TypeDisplayName,TypeShortDescription,ValidationFormula,ValidationMessage,EnableLookup
|
|
122
|
+
,,00000000-0000-0000-0000-000000000000,,,,,,,,none,,ContentType,1,,_Hidden,,c042a256-787d-4a6f-8a8a-cf6ab767f12d,,0,ContentType,,,,,,"<Field ID=""{c042a256-787d-4a6f-8a8a-cf6ab767f12d}"" Name=""ContentType"" SourceID=""http://schemas.microsoft.com/sharepoint/v3"" StaticName=""ContentType"" Group=""_Hidden"" Type=""Computed"" DisplayName=""Content Type"" Sealed=""TRUE"" Sortable=""FALSE"" RenderXMLUsingPattern=""TRUE"" PITarget=""MicrosoftWindowsSharePointServices"" PIAttribute=""ContentTypeID"" DelayActivateTemplateBinding=""GROUP,SPSPERS,SITEPAGEPUBLISHING"" Customization=""""><FieldRefs><FieldRef ID=""{03e45e84-1992-4d42-9116-26f756012634}"" Name=""ContentTypeId"" /></FieldRefs><DisplayPattern><MapToContentType><Column Name=""ContentTypeId"" /></MapToContentType></DisplayPattern></Field>",/,1,0,,ContentType,Content Type,12,Computed,Computed,Computed,,,
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
</TabItem>
|
|
126
|
+
<TabItem value="Markdown">
|
|
127
|
+
|
|
128
|
+
```md
|
|
129
|
+
# spo contenttype field list --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --contentTypeId "0x01"
|
|
130
|
+
|
|
131
|
+
Date: 10/04/2024
|
|
132
|
+
|
|
133
|
+
## Title (fa564e0f-0c70-4ab9-b863-0177e6ddd247)
|
|
134
|
+
|
|
135
|
+
Property | Value
|
|
136
|
+
---------|-------
|
|
137
|
+
AutoIndexed | false
|
|
138
|
+
CanBeDeleted | false
|
|
139
|
+
ClientSideComponentId | 00000000-0000-0000-0000-000000000000
|
|
140
|
+
Description |
|
|
141
|
+
Direction | none
|
|
142
|
+
EnforceUniqueValues | false
|
|
143
|
+
EntityPropertyName | Title
|
|
144
|
+
Filterable | true
|
|
145
|
+
FromBaseType | true
|
|
146
|
+
Group | \_Hidden
|
|
147
|
+
Hidden | false
|
|
148
|
+
Id | fa564e0f-0c70-4ab9-b863-0177e6ddd247
|
|
149
|
+
Indexed | false
|
|
150
|
+
IndexStatus | 0
|
|
151
|
+
InternalName | Title
|
|
152
|
+
IsModern | false
|
|
153
|
+
JSLink | clienttemplates.js
|
|
154
|
+
PinnedToFiltersPane | false
|
|
155
|
+
ReadOnlyField | false
|
|
156
|
+
Required | true
|
|
157
|
+
SchemaXml | <Field ID="{fa564e0f-0c70-4ab9-b863-0177e6ddd247}" Name="Title" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="Title" Group="\_Hidden" Type="Text" DisplayName="Title" Required="TRUE" FromBaseType="TRUE" DelayActivateTemplateBinding="GROUP,SPSPERS,SITEPAGEPUBLISHING" Customization="" ShowInNewForm="TRUE" ShowInEditForm="TRUE"></Field>
|
|
158
|
+
Scope | /
|
|
159
|
+
Sealed | false
|
|
160
|
+
ShowInFiltersPane | 0
|
|
161
|
+
Sortable | true
|
|
162
|
+
StaticName | Title
|
|
163
|
+
Title | Title
|
|
164
|
+
FieldTypeKind | 2
|
|
165
|
+
TypeAsString | Text
|
|
166
|
+
TypeDisplayName | Single line of text
|
|
167
|
+
TypeShortDescription | Single line of text
|
|
168
|
+
MaxLength | 255
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
</TabItem>
|
|
172
|
+
</Tabs>
|
|
@@ -88,9 +88,9 @@ m365 spo contenttype list --webUrl "https://contoso.sharepoint.com/sites/contoso
|
|
|
88
88
|
<TabItem value="Text">
|
|
89
89
|
|
|
90
90
|
```text
|
|
91
|
-
StringId
|
|
92
|
-
|
|
93
|
-
0x01007926A45D687BA842B947286090B8F67D
|
|
91
|
+
StringId Name Hidden ReadOnly Sealed
|
|
92
|
+
-------------------------------------- --------- ------ -------- ------
|
|
93
|
+
0x01007926A45D687BA842B947286090B8F67D PnP Alert false false false
|
|
94
94
|
```
|
|
95
95
|
|
|
96
96
|
</TabItem>
|
|
@@ -116,9 +116,9 @@ m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales
|
|
|
116
116
|
<TabItem value="Text">
|
|
117
117
|
|
|
118
118
|
```text
|
|
119
|
-
Id Title
|
|
120
|
-
------------------------------------
|
|
121
|
-
5ee2dd25-d941-455a-9bdb-7f2c54aed11b Start date-time
|
|
119
|
+
Id Title InternalName Hidden
|
|
120
|
+
------------------------------------ --------------- --------------------- ------
|
|
121
|
+
5ee2dd25-d941-455a-9bdb-7f2c54aed11b Start date-time PnPAlertStartDateTime false
|
|
122
122
|
```
|
|
123
123
|
|
|
124
124
|
</TabItem>
|
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
import Tabs from '@theme/Tabs';
|
|
3
|
+
import TabItem from '@theme/TabItem';
|
|
2
4
|
|
|
3
5
|
# spo file copy
|
|
4
6
|
|
|
@@ -31,11 +33,14 @@ m365 spo file copy [options]
|
|
|
31
33
|
`--nameConflictBehavior [nameConflictBehavior]`
|
|
32
34
|
: Behavior when a document with the same name is already present at the destination. Allowed values: `fail`, `replace`, `rename`. Defaults to `fail`.
|
|
33
35
|
|
|
34
|
-
`--resetAuthorAndCreated`
|
|
35
|
-
: Use this option to clear the author and created date. When not specified, the values from the source file are used.
|
|
36
|
-
|
|
37
36
|
`--bypassSharedLock`
|
|
38
37
|
: This indicates whether a file with a share lock can still be copied. Use this option to copy a file that is locked.
|
|
38
|
+
|
|
39
|
+
`--ignoreVersionHistory`
|
|
40
|
+
: Only copy the most recent version of the file and ignore the version history.
|
|
41
|
+
|
|
42
|
+
`--skipWait`
|
|
43
|
+
: Don't wait for the copy operation to complete.
|
|
39
44
|
```
|
|
40
45
|
|
|
41
46
|
<Global />
|
|
@@ -43,7 +48,6 @@ m365 spo file copy [options]
|
|
|
43
48
|
## Remarks
|
|
44
49
|
|
|
45
50
|
When you specify a value for `nameConflictBehavior`, consider the following:
|
|
46
|
-
|
|
47
51
|
- `fail` will throw an error when the destination file already exists.
|
|
48
52
|
- `replace` will replace the destination file if it already exists.
|
|
49
53
|
- `rename` will add a suffix (e.g. Document1.pdf) when the destination file already exists.
|
|
@@ -56,16 +60,16 @@ Copy a file by server-relative URL to a document library in another site collect
|
|
|
56
60
|
m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceUrl "/sites/project/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents"
|
|
57
61
|
```
|
|
58
62
|
|
|
59
|
-
Copy a file by site-relative URL to a document library in another site collection and
|
|
63
|
+
Copy a file by site-relative URL to a document library in another site collection and ignore the file history.
|
|
60
64
|
|
|
61
65
|
```sh
|
|
62
|
-
m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceUrl "/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents" --
|
|
66
|
+
m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceUrl "/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents" --ignoreVersionHistory
|
|
63
67
|
```
|
|
64
68
|
|
|
65
|
-
Copy file by sourceId (UniqueId) to a document library in another site collection and rename the file.
|
|
69
|
+
Copy file by sourceId (UniqueId) to a document library in another site collection and rename the file (without specifying the file extension).
|
|
66
70
|
|
|
67
71
|
```sh
|
|
68
|
-
m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceId "b2307a39-e878-458b-bc90-03bc578531d6" --targetUrl "/sites/IT/Shared Documents" --newName "Report
|
|
72
|
+
m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceId "b2307a39-e878-458b-bc90-03bc578531d6" --targetUrl "/sites/IT/Shared Documents" --newName "Report"
|
|
69
73
|
```
|
|
70
74
|
|
|
71
75
|
Copy file by sourceId (UniqueId) to a document library in another site collection with a new name, rename the file if it already exists.
|
|
@@ -76,8 +80,111 @@ m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourc
|
|
|
76
80
|
|
|
77
81
|
## Response
|
|
78
82
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
83
|
+
### Standard Response
|
|
84
|
+
|
|
85
|
+
<Tabs>
|
|
86
|
+
<TabItem value="JSON">
|
|
87
|
+
|
|
88
|
+
```json
|
|
89
|
+
{
|
|
90
|
+
"CheckInComment": "",
|
|
91
|
+
"CheckOutType": 2,
|
|
92
|
+
"ContentTag": "{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1,1",
|
|
93
|
+
"CustomizedPageStatus": 0,
|
|
94
|
+
"ETag": "\"{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1\"",
|
|
95
|
+
"Exists": true,
|
|
96
|
+
"IrmEnabled": false,
|
|
97
|
+
"Length": "5987",
|
|
98
|
+
"Level": 1,
|
|
99
|
+
"LinkingUri": null,
|
|
100
|
+
"LinkingUrl": "",
|
|
101
|
+
"MajorVersion": 1,
|
|
102
|
+
"MinorVersion": 0,
|
|
103
|
+
"Name": "Test1.docx",
|
|
104
|
+
"ServerRelativeUrl": "/sites/project-x/documents/Test1.docx",
|
|
105
|
+
"TimeCreated": "2022-10-30T10:16:18Z",
|
|
106
|
+
"TimeLastModified": "2022-10-30T10:16:18Z",
|
|
107
|
+
"Title": null,
|
|
108
|
+
"UIVersion": 512,
|
|
109
|
+
"UIVersionLabel": "1.0",
|
|
110
|
+
"UniqueId": "b2307a39-e878-458b-bc90-03bc578531d6"
|
|
111
|
+
}
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
</TabItem>
|
|
115
|
+
<TabItem value="Text">
|
|
116
|
+
|
|
117
|
+
```text
|
|
118
|
+
CheckInComment :
|
|
119
|
+
CheckOutType : 2
|
|
120
|
+
ContentTag : {03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1,1
|
|
121
|
+
CustomizedPageStatus: 0
|
|
122
|
+
ETag : "{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1"
|
|
123
|
+
Exists : true
|
|
124
|
+
IrmEnabled : false
|
|
125
|
+
Length : 5987
|
|
126
|
+
Level : 1
|
|
127
|
+
LinkingUri : null
|
|
128
|
+
LinkingUrl :
|
|
129
|
+
MajorVersion : 1
|
|
130
|
+
MinorVersion : 0
|
|
131
|
+
Name : Test1.docx
|
|
132
|
+
ServerRelativeUrl : /sites/project-x/documents/Test1.docx
|
|
133
|
+
TimeCreated : 2022-10-30T10:16:18Z
|
|
134
|
+
TimeLastModified : 2022-10-30T10:16:18Z
|
|
135
|
+
Title : null
|
|
136
|
+
UIVersion : 512
|
|
137
|
+
UIVersionLabel : 1.0
|
|
138
|
+
UniqueId : b2307a39-e878-458b-bc90-03bc578531d6
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
</TabItem>
|
|
142
|
+
<TabItem value="CSV">
|
|
143
|
+
|
|
144
|
+
```csv
|
|
145
|
+
CheckInComment,CheckOutType,ContentTag,CustomizedPageStatus,ETag,Exists,IrmEnabled,Length,Level,LinkingUri,LinkingUrl,MajorVersion,MinorVersion,Name,ServerRelativeUrl,TimeCreated,TimeLastModified,Title,UIVersion,UIVersionLabel,UniqueId
|
|
146
|
+
,2,"{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1,1",0,"""{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1""",1,,5987,1,,,1,0,Test1.docx,/sites/project-x/documents/Test1.docx,2022-10-30T10:16:18Z,2022-10-30T10:16:18Z,,512,1.0,b2307a39-e878-458b-bc90-03bc578531d6
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
</TabItem>
|
|
150
|
+
<TabItem value="Markdown">
|
|
151
|
+
|
|
152
|
+
```md
|
|
153
|
+
# spo file copy --webUrl "https://contoso.sharepoint.com/sites/IT" --sourceUrl "/Shared Documents/Document.docx" --targetUrl "/sites/project-x/Shared Documents"
|
|
154
|
+
|
|
155
|
+
Date: 10/3/2023
|
|
156
|
+
|
|
157
|
+
## b2307a39-e878-458b-bc90-03bc578531d6
|
|
158
|
+
|
|
159
|
+
Property | Value
|
|
160
|
+
---------|-------
|
|
161
|
+
CheckInComment |
|
|
162
|
+
CheckOutType | 2
|
|
163
|
+
ContentTag | {03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1,1
|
|
164
|
+
CustomizedPageStatus | 0
|
|
165
|
+
ETag | "{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1"
|
|
166
|
+
Exists | true
|
|
167
|
+
ExistsAllowThrowForPolicyFailures | true
|
|
168
|
+
IrmEnabled | false
|
|
169
|
+
Length | 5987
|
|
170
|
+
Level | 1
|
|
171
|
+
LinkingUri | https://contoso.sharepoint.com/sites/project-x/shared%20documents/Document.docx?d=w59d4e6fcf6f94ce78bea0273cedb1a19
|
|
172
|
+
LinkingUrl | https://contoso.sharepoint.com/sites/project-x/shared documents/Document.docx?d=w59d4e6fcf6f94ce78bea0273cedb1a19
|
|
173
|
+
MajorVersion | 1
|
|
174
|
+
MinorVersion | 0
|
|
175
|
+
Name | Document.docx
|
|
176
|
+
ServerRelativeUrl | /sites/project-x/shared documents/Document.docx
|
|
177
|
+
TimeCreated | 2023-05-23T09:51:34Z
|
|
178
|
+
TimeLastModified | 2023-05-23T10:13:01Z
|
|
179
|
+
Title |
|
|
180
|
+
UIVersion | 1536
|
|
181
|
+
UIVersionLabel | 1.0
|
|
182
|
+
UniqueId | b2307a39-e878-458b-bc90-03bc578531d6
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
</TabItem>
|
|
186
|
+
</Tabs>
|
|
187
|
+
|
|
188
|
+
### `skipWait` response
|
|
82
189
|
|
|
83
|
-
|
|
190
|
+
The command won't return a response on success.
|
|
@@ -33,7 +33,7 @@ m365 spo file retentionlabel ensure [options]
|
|
|
33
33
|
|
|
34
34
|
## Remarks
|
|
35
35
|
|
|
36
|
-
You can also use [spo listitem retentionlabel remove](./../../../cmd/spo/listitem/listitem-retentionlabel-remove.mdx) for removing the retention label from a
|
|
36
|
+
You can also use [spo listitem retentionlabel remove](./../../../cmd/spo/listitem/listitem-retentionlabel-remove.mdx) for removing the retention label from a list item.
|
|
37
37
|
|
|
38
38
|
The `--assetId` option has to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
|
|
39
39
|
|
|
@@ -19,7 +19,7 @@ m365 spo file roleassignment add [options]
|
|
|
19
19
|
`--fileUrl [fileUrl]`
|
|
20
20
|
: The server- or site-relative decoded URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
`-i, --fileId [fileId]`
|
|
23
23
|
: The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
|
|
24
24
|
|
|
25
25
|
`--principalId [principalId]`
|
|
@@ -29,7 +29,7 @@ m365 spo file roleassignment add [options]
|
|
|
29
29
|
: The upn/email of user to assign role to. Specify either `upn`, `groupName`, or `principalId` but not multiple.
|
|
30
30
|
|
|
31
31
|
`--groupName [groupName]`
|
|
32
|
-
: The group name of
|
|
32
|
+
: The group name of the SharePoint group Specify either `upn`, `groupName`, or `principalId` but not multiple.
|
|
33
33
|
|
|
34
34
|
`--roleDefinitionId [roleDefinitionId]`
|
|
35
35
|
: ID of role definition. Specify either `roleDefinitionId` or `roleDefinitionName` but not both.
|
|
@@ -29,7 +29,7 @@ m365 spo file roleassignment remove [options]
|
|
|
29
29
|
: The upn/email of the user. Specify either `upn`, `groupName`, or `principalId` but not multiple.
|
|
30
30
|
|
|
31
31
|
`--groupName [groupName]`
|
|
32
|
-
: The group name of
|
|
32
|
+
: The group name of the SharePoint group Specify either `upn`, `groupName`, or `principalId` but not multiple.
|
|
33
33
|
|
|
34
34
|
`-f, --force`
|
|
35
35
|
: Don't prompt for confirmation.
|
|
@@ -19,7 +19,7 @@ m365 spo file roleinheritance break [options]
|
|
|
19
19
|
`--fileUrl [fileUrl]`
|
|
20
20
|
: The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
`-i, --fileId [fileId]`
|
|
23
23
|
: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
24
24
|
|
|
25
25
|
`-c, --clearExistingPermissions`
|
|
@@ -19,7 +19,7 @@ m365 spo file roleinheritance reset [options]
|
|
|
19
19
|
`--fileUrl [fileUrl]`
|
|
20
20
|
: The server- or site-relative decoded URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
`-i, --fileId [fileId]`
|
|
23
23
|
: The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
|
|
24
24
|
|
|
25
25
|
`-f, --force`
|
|
@@ -19,7 +19,7 @@ m365 spo folder retentionlabel ensure [options]
|
|
|
19
19
|
`--folderUrl [folderUrl]`
|
|
20
20
|
: The server- or site-relative decoded URL of the folder that should be labelled. Specify either `folderUrl` or `folderId` but not both.
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
`-i, --folderId [folderId]`
|
|
23
23
|
: The UniqueId (GUID) of the folder that should be labelled. Specify either `folderUrl` or `folderId` but not both.
|
|
24
24
|
|
|
25
25
|
`--name <name>`
|
|
@@ -30,7 +30,7 @@ m365 spo folder retentionlabel ensure [options]
|
|
|
30
30
|
|
|
31
31
|
## Remarks
|
|
32
32
|
|
|
33
|
-
You can also use [spo listitem retentionlabel remove](./../../../cmd/spo/listitem/listitem-retentionlabel-remove.mdx) for removing the retention label from a
|
|
33
|
+
You can also use [spo listitem retentionlabel remove](./../../../cmd/spo/listitem/listitem-retentionlabel-remove.mdx) for removing the retention label from a list item.
|
|
34
34
|
|
|
35
35
|
## Examples
|
|
36
36
|
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
import Tabs from '@theme/Tabs';
|
|
3
|
+
import TabItem from '@theme/TabItem';
|
|
4
|
+
|
|
5
|
+
# spo folder sharinglink get
|
|
6
|
+
|
|
7
|
+
Gets details about a specific sharing link on a folder
|
|
8
|
+
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
m365 spo folder sharinglink get [options]
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Options
|
|
16
|
+
|
|
17
|
+
```md definition-list
|
|
18
|
+
`-u, --webUrl <webUrl>`
|
|
19
|
+
: The URL of the site where the folder is located.
|
|
20
|
+
|
|
21
|
+
`--folderUrl [folderUrl]`
|
|
22
|
+
: The server- or site-relative decoded URL of the folder. Specify either `folderUrl` or `folderId` but not both.
|
|
23
|
+
|
|
24
|
+
`--folderId [folderId]`
|
|
25
|
+
: The Unique ID (GUID) of the folder. Specify either `folderUrl` or `folderId` but not both.
|
|
26
|
+
|
|
27
|
+
`-i, --id <id>`
|
|
28
|
+
: The sharing link ID.
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
<Global />
|
|
32
|
+
|
|
33
|
+
## Examples
|
|
34
|
+
|
|
35
|
+
Gets a specific sharing link of a folder by id.
|
|
36
|
+
|
|
37
|
+
```sh
|
|
38
|
+
m365 spo folder sharinglink get --webUrl https://contoso.sharepoint.com/sites/demo --id 45fa6aed-362f-48b1-b04e-6da85a526506 --folderId daebb04b-a773-4baa-b1d1-3625418e3234
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Gets a specific sharing link of a folder by url.
|
|
42
|
+
|
|
43
|
+
```sh
|
|
44
|
+
m365 spo folder sharinglink get --webUrl https://contoso.sharepoint.com/sites/demo --id 45fa6aed-362f-48b1-b04e-6da85a526506 --folderUrl "/sites/demo/shared documents/folder"
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Response
|
|
48
|
+
|
|
49
|
+
<Tabs>
|
|
50
|
+
<TabItem value="JSON">
|
|
51
|
+
|
|
52
|
+
```json
|
|
53
|
+
{
|
|
54
|
+
"id": "d6f6a428-9857-471f-9635-edd68d5aa6c1",
|
|
55
|
+
"roles": [
|
|
56
|
+
"write"
|
|
57
|
+
],
|
|
58
|
+
"shareId": "u!aHR0cHM6Ly9uYWNoYW4zNjUuc2hhcmVwb2ludC5jb20vOmY6L3MvU1BEZW1vL0VxXzlYcXRIdks1RW9wd3NfX1kteko0QlNybFFNUy1qUTBFOWJsazhVLVNTdVE",
|
|
59
|
+
"hasPassword": false,
|
|
60
|
+
"grantedToIdentitiesV2": [],
|
|
61
|
+
"grantedToIdentities": [],
|
|
62
|
+
"link": {
|
|
63
|
+
"scope": "anonymous",
|
|
64
|
+
"type": "edit",
|
|
65
|
+
"webUrl": "https://contoso.sharepoint.com/:f:/s/demo/Eq_9XqtHvK5Eopws__Y-zJ4BSrlQMS-jQ0E9blk8U-SSuQ",
|
|
66
|
+
"preventsDownload": false
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
</TabItem>
|
|
72
|
+
<TabItem value="Text">
|
|
73
|
+
|
|
74
|
+
```text
|
|
75
|
+
grantedToIdentities : []
|
|
76
|
+
grantedToIdentitiesV2 : []
|
|
77
|
+
hasPassword : false
|
|
78
|
+
id : d6f6a428-9857-471f-9635-edd68d5aa6c1
|
|
79
|
+
link : {"scope":"anonymous","type":"edit","webUrl":"https://contoso.sharepoint.com/:f:/s/demo/Eq_9XqtHvK5Eopws__Y-zJ4BSrlQMS-jQ0E9blk8U-SSuQ","preventsDownload":false}
|
|
80
|
+
roles : ["write"]
|
|
81
|
+
shareId : u!aHR0cHM6Ly9uYWNoYW4zNjUuc2hhcmVwb2ludC5jb20vOmY6L3MvU1BEZW1vL0VxXzlYcXRIdks1RW9wd3NfX1kteko0QlNybFFNUy1qUTBFOWJsazhVLVNTdVE
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
</TabItem>
|
|
85
|
+
<TabItem value="CSV">
|
|
86
|
+
|
|
87
|
+
```csv
|
|
88
|
+
id,shareId,hasPassword
|
|
89
|
+
d6f6a428-9857-471f-9635-edd68d5aa6c1,u!aHR0cHM6Ly9uYWNoYW4zNjUuc2hhcmVwb2ludC5jb20vOmY6L3MvU1BEZW1vL0VxXzlYcXRIdks1RW9wd3NfX1kteko0QlNybFFNUy1qUTBFOWJsazhVLVNTdVE,
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
</TabItem>
|
|
93
|
+
<TabItem value="Markdown">
|
|
94
|
+
|
|
95
|
+
```md
|
|
96
|
+
# spo folder sharinglink get --webUrl "https://contoso.sharepoint.com/sites/demo" --id "d6f6a428-9857-471f-9635-edd68d5aa6c1" --folderUrl "/sites/demo/shared documents/Test"
|
|
97
|
+
|
|
98
|
+
Date: 5/2/2024
|
|
99
|
+
|
|
100
|
+
## d6f6a428-9857-471f-9635-edd68d5aa6c1
|
|
101
|
+
|
|
102
|
+
Property | Value
|
|
103
|
+
---------|-------
|
|
104
|
+
id | d6f6a428-9857-471f-9635-edd68d5aa6c1
|
|
105
|
+
shareId | u!aHR0cHM6Ly9uYWNoYW4zNjUuc2hhcmVwb2ludC5jb20vOmY6L3MvU1BEZW1vL0VxXzlYcXRIdks1RW9wd3NfX1kteko0QlNybFFNUy1qUTBFOWJsazhVLVNTdVE
|
|
106
|
+
hasPassword | false
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
</TabItem>
|
|
110
|
+
</Tabs>
|