@pnp/cli-microsoft365 7.1.0-beta.aca68bd → 7.1.0-beta.d53f0d9
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/.devcontainer/Dockerfile +0 -1
- package/.eslintrc.cjs +1 -0
- package/Dockerfile +0 -1
- package/dist/Auth.js +1 -1
- package/dist/appInsights.js +5 -9
- package/dist/cli/Cli.js +6 -2
- package/dist/m365/spo/commands/app/app-deploy.js +1 -1
- package/dist/m365/spo/commands/app/app-get.js +1 -1
- package/dist/m365/spo/commands/app/app-teamspackage-download.js +1 -1
- package/dist/m365/spo/commands/apppage/apppage-add.js +1 -1
- package/dist/m365/spo/commands/feature/feature-disable.js +8 -6
- package/dist/m365/spo/commands/feature/feature-enable.js +6 -5
- package/dist/m365/spo/commands/page/Page.js +1 -1
- package/dist/m365/spo/commands/page/page-add.js +1 -1
- package/dist/m365/spo/commands/page/page-get.js +1 -1
- package/dist/m365/spo/commands/page/page-header-set.js +1 -1
- package/dist/m365/spo/commands/page/page-remove.js +1 -1
- package/dist/m365/spo/commands/page/page-set.js +2 -2
- package/dist/m365/spo/commands/page/page-text-add.js +1 -1
- package/dist/m365/spo/commands/user/user-get.js +7 -1
- package/dist/telemetry.js +30 -14
- package/dist/telemetryRunner.js +26 -0
- package/docs/docs/cmd/aad/license/license-list.mdx +21 -16
- package/docs/docs/cmd/aad/m365group/m365group-add.mdx +1 -1
- package/docs/docs/cmd/aad/user/user-add.mdx +2 -4
- package/docs/docs/cmd/aad/user/user-license-add.mdx +2 -4
- package/docs/docs/cmd/aad/user/user-license-list.mdx +3 -5
- package/docs/docs/cmd/aad/user/user-recyclebinitem-list.mdx +1 -3
- package/docs/docs/cmd/aad/user/user-recyclebinitem-restore.mdx +1 -3
- package/docs/docs/cmd/flow/environment/environment-get.mdx +3 -4
- package/docs/docs/cmd/flow/environment/environment-list.mdx +3 -4
- package/docs/docs/cmd/flow/owner/owner-list.mdx +2 -3
- package/docs/docs/cmd/flow/run/run-list.mdx +6 -8
- package/docs/docs/cmd/graph/schemaextension/schemaextension-list.mdx +2 -3
- package/docs/docs/cmd/onenote/page/page-list.mdx +6 -9
- package/docs/docs/cmd/outlook/message/message-get.mdx +5 -15
- package/docs/docs/cmd/outlook/message/message-list.mdx +5 -14
- package/docs/docs/cmd/outlook/room/room-list.mdx +3 -6
- package/docs/docs/cmd/outlook/roomlist/roomlist-list.mdx +1 -3
- package/docs/docs/cmd/pa/app/app-get.mdx +4 -7
- package/docs/docs/cmd/pa/app/app-list.mdx +4 -7
- package/docs/docs/cmd/pa/connector/connector-list.mdx +2 -4
- package/docs/docs/cmd/pa/environment/environment-get.mdx +2 -4
- package/docs/docs/cmd/pa/environment/environment-list.mdx +1 -3
- package/docs/docs/cmd/planner/plan/plan-add.mdx +4 -11
- package/docs/docs/cmd/planner/plan/plan-get.mdx +4 -9
- package/docs/docs/cmd/planner/plan/plan-list.mdx +3 -6
- package/docs/docs/cmd/planner/plan/plan-set.mdx +3 -9
- package/docs/docs/cmd/planner/roster/roster-member-add.mdx +2 -4
- package/docs/docs/cmd/planner/roster/roster-member-get.mdx +2 -4
- package/docs/docs/cmd/planner/roster/roster-member-list.mdx +1 -3
- package/docs/docs/cmd/planner/task/task-add.mdx +4 -14
- package/docs/docs/cmd/planner/task/task-checklistitem-add.mdx +2 -4
- package/docs/docs/cmd/planner/task/task-checklistitem-list.mdx +1 -3
- package/docs/docs/cmd/planner/task/task-get.mdx +0 -7
- package/docs/docs/cmd/planner/task/task-list.mdx +1 -5
- package/docs/docs/cmd/planner/task/task-reference-add.mdx +0 -2
- package/docs/docs/cmd/planner/task/task-reference-list.mdx +0 -2
- package/docs/docs/cmd/planner/task/task-set.mdx +4 -13
- package/docs/docs/cmd/planner/tenant/tenant-settings-list.mdx +1 -3
- package/docs/docs/cmd/planner/tenant/tenant-settings-set.mdx +3 -5
- package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-get.mdx +6 -8
- package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-list.mdx +4 -7
- package/docs/docs/cmd/pp/card/card-get.mdx +4 -8
- package/docs/docs/cmd/pp/card/card-list.mdx +0 -4
- package/docs/docs/cmd/pp/chatbot/chatbot-get.mdx +4 -6
- package/docs/docs/cmd/pp/dataverse/dataverse-table-get.mdx +3 -14
- package/docs/docs/cmd/pp/dataverse/dataverse-table-list.mdx +3 -14
- package/docs/docs/cmd/pp/environment/environment-get.mdx +3 -5
- package/docs/docs/cmd/pp/environment/environment-list.mdx +2 -4
- package/docs/docs/cmd/pp/gateway/gateway-get.mdx +0 -3
- package/docs/docs/cmd/pp/gateway/gateway-list.mdx +1 -4
- package/docs/docs/cmd/purview/auditlog/auditlog-list.mdx +4 -0
- package/docs/docs/cmd/purview/retentionevent/retentionevent-add.mdx +3 -8
- package/docs/docs/cmd/purview/retentionevent/retentionevent-get.mdx +1 -3
- package/docs/docs/cmd/purview/retentionevent/retentionevent-list.mdx +1 -5
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.mdx +0 -2
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-get.mdx +1 -3
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-list.mdx +1 -3
- package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-get.mdx +3 -6
- package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-list.mdx +3 -5
- package/docs/docs/cmd/purview/threatassessment/threatassessment-get.mdx +4 -8
- package/docs/docs/cmd/spo/app/app-add.mdx +94 -7
- package/docs/docs/cmd/spo/app/app-deploy.mdx +11 -7
- package/docs/docs/cmd/spo/app/app-get.mdx +117 -8
- package/docs/docs/cmd/spo/app/app-install.mdx +9 -5
- package/docs/docs/cmd/spo/app/app-instance-list.mdx +85 -2
- package/docs/docs/cmd/spo/app/app-list.mdx +95 -3
- package/docs/docs/cmd/spo/app/app-remove.mdx +11 -7
- package/docs/docs/cmd/spo/app/app-retract.mdx +9 -5
- package/docs/docs/cmd/spo/app/app-teamspackage-download.mdx +12 -8
- package/docs/docs/cmd/spo/app/app-uninstall.mdx +11 -7
- package/docs/docs/cmd/spo/app/app-upgrade.mdx +9 -5
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-add.mdx +4 -2
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx +9 -7
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-list.mdx +6 -6
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-remove.mdx +12 -6
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-set.mdx +4 -2
- package/docs/docs/cmd/spo/apppage/apppage-add.mdx +54 -5
- package/docs/docs/cmd/spo/apppage/apppage-set.mdx +8 -4
- package/docs/docs/cmd/spo/cdn/cdn-get.mdx +36 -1
- package/docs/docs/cmd/spo/cdn/cdn-origin-add.mdx +7 -3
- package/docs/docs/cmd/spo/cdn/cdn-origin-list.mdx +48 -3
- package/docs/docs/cmd/spo/cdn/cdn-origin-remove.mdx +8 -4
- package/docs/docs/cmd/spo/cdn/cdn-policy-list.mdx +53 -3
- package/docs/docs/cmd/spo/cdn/cdn-policy-set.mdx +7 -3
- package/docs/docs/cmd/spo/cdn/cdn-set.mdx +7 -3
- package/docs/docs/cmd/spo/commandset/commandset-add.mdx +6 -6
- package/docs/docs/cmd/spo/commandset/commandset-get.mdx +3 -5
- package/docs/docs/cmd/spo/commandset/commandset-list.mdx +6 -5
- package/docs/docs/cmd/spo/commandset/commandset-remove.mdx +7 -3
- package/docs/docs/cmd/spo/commandset/commandset-set.mdx +6 -4
- package/docs/docs/cmd/spo/contenttype/contenttype-add.mdx +148 -9
- package/docs/docs/cmd/spo/contenttype/contenttype-field-remove.mdx +19 -15
- package/docs/docs/cmd/spo/contenttype/contenttype-field-set.mdx +12 -8
- package/docs/docs/cmd/spo/contenttype/contenttype-get.mdx +147 -8
- package/docs/docs/cmd/spo/contenttype/contenttype-list.mdx +115 -4
- package/docs/docs/cmd/spo/contenttype/contenttype-remove.mdx +8 -4
- package/docs/docs/cmd/spo/contenttype/contenttype-set.mdx +8 -4
- package/docs/docs/cmd/spo/contenttypehub/contenttypehub-get.mdx +44 -0
- package/docs/docs/cmd/spo/customaction/customaction-add.mdx +12 -8
- package/docs/docs/cmd/spo/customaction/customaction-clear.mdx +10 -7
- package/docs/docs/cmd/spo/customaction/customaction-get.mdx +11 -15
- package/docs/docs/cmd/spo/customaction/customaction-list.mdx +87 -5
- package/docs/docs/cmd/spo/customaction/customaction-remove.mdx +17 -13
- package/docs/docs/cmd/spo/customaction/customaction-set.mdx +27 -23
- package/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.mdx +29 -14
- package/docs/docs/cmd/spo/eventreceiver/eventreceiver-list.mdx +66 -5
- package/docs/docs/cmd/spo/eventreceiver/eventreceiver-remove.mdx +4 -0
- package/docs/docs/cmd/spo/externaluser/externaluser-list.mdx +78 -7
- package/docs/docs/cmd/spo/feature/feature-disable.mdx +10 -6
- package/docs/docs/cmd/spo/feature/feature-enable.mdx +9 -5
- package/docs/docs/cmd/spo/feature/feature-list.mdx +52 -0
- package/docs/docs/cmd/spo/field/field-add.mdx +177 -11
- package/docs/docs/cmd/spo/field/field-get.mdx +175 -9
- package/docs/docs/cmd/spo/field/field-list.mdx +135 -8
- package/docs/docs/cmd/spo/field/field-remove.mdx +16 -12
- package/docs/docs/cmd/spo/field/field-set.mdx +15 -11
- package/docs/docs/cmd/spo/file/file-add.mdx +31 -27
- package/docs/docs/cmd/spo/file/file-checkin.mdx +13 -9
- package/docs/docs/cmd/spo/file/file-checkout.mdx +9 -5
- package/docs/docs/cmd/spo/file/file-copy.mdx +5 -5
- package/docs/docs/cmd/spo/file/file-get.mdx +89 -18
- package/docs/docs/cmd/spo/file/file-list.mdx +5 -5
- package/docs/docs/cmd/spo/file/file-move.mdx +5 -5
- package/docs/docs/cmd/spo/file/file-remove.mdx +13 -9
- package/docs/docs/cmd/spo/file/file-rename.mdx +63 -5
- package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.mdx +3 -3
- package/docs/docs/cmd/spo/file/file-retentionlabel-remove.mdx +2 -2
- package/docs/docs/cmd/spo/file/file-roleassignment-add.mdx +4 -0
- package/docs/docs/cmd/spo/file/file-roleassignment-remove.mdx +7 -3
- package/docs/docs/cmd/spo/file/file-roleinheritance-break.mdx +9 -5
- package/docs/docs/cmd/spo/file/file-roleinheritance-reset.mdx +10 -6
- package/docs/docs/cmd/spo/file/file-sharinginfo-get.mdx +133 -5
- package/docs/docs/cmd/spo/file/file-sharinglink-add.mdx +21 -3
- package/docs/docs/cmd/spo/file/file-sharinglink-clear.mdx +2 -2
- package/docs/docs/cmd/spo/file/file-sharinglink-get.mdx +18 -0
- package/docs/docs/cmd/spo/file/file-sharinglink-list.mdx +20 -3
- package/docs/docs/cmd/spo/file/file-sharinglink-set.mdx +2 -7
- package/docs/docs/cmd/spo/file/file-version-clear.mdx +7 -7
- package/docs/docs/cmd/spo/file/file-version-get.mdx +28 -6
- package/docs/docs/cmd/spo/file/file-version-list.mdx +28 -6
- package/docs/docs/cmd/spo/file/file-version-remove.mdx +8 -8
- package/docs/docs/cmd/spo/file/file-version-restore.mdx +8 -8
- package/docs/docs/cmd/spo/folder/folder-add.mdx +3 -3
- package/docs/docs/cmd/spo/folder/folder-copy.mdx +1 -1
- package/docs/docs/cmd/spo/folder/folder-get.mdx +257 -3
- package/docs/docs/cmd/spo/folder/folder-list.mdx +3 -4
- package/docs/docs/cmd/spo/folder/folder-move.mdx +5 -5
- package/docs/docs/cmd/spo/folder/folder-remove.mdx +6 -2
- package/docs/docs/cmd/spo/folder/folder-rename.mdx +2 -2
- package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.mdx +3 -3
- package/docs/docs/cmd/spo/folder/folder-retentionlabel-remove.mdx +2 -2
- package/docs/docs/cmd/spo/folder/folder-roleassignment-add.mdx +13 -8
- package/docs/docs/cmd/spo/folder/folder-roleassignment-remove.mdx +8 -4
- package/docs/docs/cmd/spo/folder/folder-roleinheritance-break.mdx +4 -0
- package/docs/docs/cmd/spo/folder/folder-roleinheritance-reset.mdx +5 -1
- package/docs/docs/cmd/spo/group/group-add.mdx +78 -0
- package/docs/docs/cmd/spo/group/group-get.mdx +81 -3
- package/docs/docs/cmd/spo/group/group-list.mdx +74 -3
- package/docs/docs/cmd/spo/group/group-member-add.mdx +13 -21
- package/docs/docs/cmd/spo/group/group-member-list.mdx +80 -5
- package/docs/docs/cmd/spo/group/group-member-remove.mdx +4 -4
- package/docs/docs/cmd/spo/group/group-remove.mdx +10 -6
- package/docs/docs/cmd/spo/group/group-set.mdx +9 -5
- package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-get.mdx +36 -1
- package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-set.mdx +6 -2
- package/docs/docs/cmd/spo/hubsite/hubsite-data-get.mdx +0 -2
- package/docs/docs/cmd/spo/list/list-add.mdx +0 -3
- package/docs/docs/cmd/spo/list/list-contenttype-add.mdx +0 -2
- package/docs/docs/cmd/spo/list/list-contenttype-list.mdx +0 -2
- package/docs/docs/cmd/spo/list/list-get.mdx +1 -4
- package/docs/docs/cmd/spo/list/list-list.mdx +0 -4
- package/docs/docs/cmd/spo/list/list-view-add.mdx +0 -3
- package/docs/docs/cmd/spo/list/list-view-get.mdx +9 -12
- package/docs/docs/cmd/spo/list/list-view-list.mdx +4 -7
- package/docs/docs/cmd/spo/listitem/listitem-attachment-list.mdx +8 -11
- package/docs/docs/cmd/spo/listitem/listitem-get.mdx +0 -2
- package/docs/docs/cmd/spo/navigation/navigation-node-add.mdx +4 -6
- package/docs/docs/cmd/spo/navigation/navigation-node-get.mdx +0 -2
- package/docs/docs/cmd/spo/navigation/navigation-node-list.mdx +4 -6
- package/docs/docs/cmd/spo/page/page-copy.mdx +4 -8
- package/docs/docs/cmd/spo/page/page-get.mdx +2 -5
- package/docs/docs/cmd/spo/page/page-list.mdx +1 -5
- package/docs/docs/cmd/spo/sitescript/sitescript-get.mdx +4 -4
- package/docs/docs/cmd/spo/sitescript/sitescript-set.mdx +6 -7
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.mdx +3 -1
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-get.mdx +5 -3
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-list.mdx +4 -2
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-remove.mdx +5 -1
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-set.mdx +2 -0
- package/docs/docs/cmd/spo/tenant/tenant-commandset-add.mdx +2 -1
- package/docs/docs/cmd/spo/tenant/tenant-commandset-get.mdx +5 -2
- package/docs/docs/cmd/spo/tenant/tenant-commandset-list.mdx +4 -1
- package/docs/docs/cmd/spo/tenant/tenant-commandset-remove.mdx +5 -1
- package/docs/docs/cmd/spo/tenant/tenant-commandset-set.mdx +3 -1
- package/docs/docs/cmd/spo/user/user-get.mdx +6 -0
- package/docs/docs/cmd/teams/channel/channel-member-list.mdx +3 -5
- package/docs/docs/cmd/teams/channel/channel-member-set.mdx +0 -2
- package/docs/docs/cmd/teams/chat/chat-get.mdx +2 -4
- package/docs/docs/cmd/teams/chat/chat-list.mdx +1 -3
- package/docs/docs/cmd/teams/chat/chat-member-list.mdx +2 -4
- package/docs/docs/cmd/teams/message/message-get.mdx +0 -7
- package/docs/docs/cmd/teams/message/message-list.mdx +0 -6
- package/docs/docs/cmd/teams/message/message-reply-list.mdx +0 -6
- package/docs/docs/cmd/teams/tab/tab-add.mdx +10 -12
- package/docs/docs/cmd/teams/tab/tab-get.mdx +8 -10
- package/docs/docs/cmd/teams/tab/tab-list.mdx +4 -7
- package/docs/docs/cmd/teams/team/team-add.mdx +0 -7
- package/docs/docs/cmd/teams/team/team-get.mdx +0 -6
- package/docs/docs/cmd/tenant/security/security-alerts-list.mdx +1 -1
- package/docs/docs/cmd/todo/task/task-add.mdx +9 -13
- package/docs/docs/cmd/todo/task/task-set.mdx +10 -14
- package/eslint-rules/lib/index.js +2 -1
- package/eslint-rules/lib/rules/no-by-server-relative-url-usage.js +55 -0
- package/npm-shrinkwrap.json +86 -82
- package/package.json +20 -19
|
@@ -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 field add
|
|
4
6
|
|
|
@@ -14,22 +16,22 @@ m365 spo field add [options]
|
|
|
14
16
|
|
|
15
17
|
```md definition-list
|
|
16
18
|
`-u, --webUrl <webUrl>`
|
|
17
|
-
: Absolute URL of the site where the field should be created
|
|
19
|
+
: Absolute URL of the site where the field should be created.
|
|
18
20
|
|
|
19
21
|
`-l, --listTitle [listTitle]`
|
|
20
|
-
: Title of the list where the field should be created (if it should be created as a list column). Specify either `listTitle`, `listId` or `listUrl
|
|
22
|
+
: Title of the list where the field should be created (if it should be created as a list column). Specify either `listTitle`, `listId` or `listUrl`.
|
|
21
23
|
|
|
22
24
|
`--listId [listId]`
|
|
23
|
-
: ID of the list where the field should be created (if it should be created as a list column). Specify either `listTitle`, `listId` or `listUrl
|
|
25
|
+
: ID of the list where the field should be created (if it should be created as a list column). Specify either `listTitle`, `listId` or `listUrl`.
|
|
24
26
|
|
|
25
27
|
`--listUrl [listUrl]`
|
|
26
|
-
: Server- or site-relative URL of the list where the field should be created (if it should be created as a list column). Specify either `listTitle`, `listId` or `listUrl
|
|
28
|
+
: Server- or site-relative URL of the list where the field should be created (if it should be created as a list column). Specify either `listTitle`, `listId` or `listUrl`.
|
|
27
29
|
|
|
28
30
|
`-x, --xml <xml>`
|
|
29
|
-
: CAML field definition
|
|
31
|
+
: CAML field definition.
|
|
30
32
|
|
|
31
33
|
`--options [options]`
|
|
32
|
-
: The options to use to add to the field. Allowed values: `DefaultValue`,`AddToDefaultContentType`, `AddToNoContentType`, `AddToAllContentTypes`, `AddFieldInternalNameHint`, `AddFieldToDefaultView`, `AddFieldCheckDisplayName
|
|
34
|
+
: The options to use to add to the field. Allowed values: `DefaultValue`,`AddToDefaultContentType`, `AddToNoContentType`, `AddToAllContentTypes`, `AddFieldInternalNameHint`, `AddFieldToDefaultView`, `AddFieldCheckDisplayName`.
|
|
33
35
|
```
|
|
34
36
|
|
|
35
37
|
<Global />
|
|
@@ -40,31 +42,31 @@ If the specified field already exists, you will get a _A duplicate field name "y
|
|
|
40
42
|
|
|
41
43
|
## Examples
|
|
42
44
|
|
|
43
|
-
Create a date time site column
|
|
45
|
+
Create a date time site column.
|
|
44
46
|
|
|
45
47
|
```sh
|
|
46
48
|
m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --xml '`<Field Type="DateTime" DisplayName="Start date-time" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="DateTime" Group="PnP Columns" FriendlyDisplayFormat="Disabled" ID="{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertStartDateTime" Name="PnPAlertStartDateTime"><Default>[today]</Default></Field>`'
|
|
47
49
|
```
|
|
48
50
|
|
|
49
|
-
Create a URL list column to a list retrieved by Title
|
|
51
|
+
Create a URL list column to a list retrieved by Title.
|
|
50
52
|
|
|
51
53
|
```sh
|
|
52
54
|
m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --xml '`<Field Type="URL" DisplayName="More information link" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="Hyperlink" Group="PnP Columns" ID="{6085e32a-339b-4da7-ab6d-c1e013e5ab27}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertMoreInformation" Name="PnPAlertMoreInformation"></Field>`'
|
|
53
55
|
```
|
|
54
56
|
|
|
55
|
-
Create a URL list column and add it to all content types
|
|
57
|
+
Create a URL list column and add it to all content types.
|
|
56
58
|
|
|
57
59
|
```sh
|
|
58
60
|
m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --xml '`<Field Type="URL" DisplayName="More information link" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="Hyperlink" Group="PnP Columns" ID="{6085e32a-339b-4da7-ab6d-c1e013e5ab27}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertMoreInformation" Name="PnPAlertMoreInformation"></Field>`' --options AddToAllContentTypes
|
|
59
61
|
```
|
|
60
62
|
|
|
61
|
-
Create a URL list column to a list retrieved by ID
|
|
63
|
+
Create a URL list column to a list retrieved by ID.
|
|
62
64
|
|
|
63
65
|
```sh
|
|
64
66
|
m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId e785fe80-2ca1-409e-b9d1-19055a85cd38 --xml '`<Field Type="URL" DisplayName="More information link" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="Hyperlink" Group="PnP Columns" ID="{6085e32a-339b-4da7-ab6d-c1e013e5ab27}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertMoreInformation" Name="PnPAlertMoreInformation"></Field>`'
|
|
65
67
|
```
|
|
66
68
|
|
|
67
|
-
Create a date time list column to a list retrieved by URL
|
|
69
|
+
Create a date time list column to a list retrieved by URL.
|
|
68
70
|
|
|
69
71
|
```sh
|
|
70
72
|
m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl /sites/contoso-sales/lists/Events --xml '`<Field Type="DateTime" DisplayName="Start date-time" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="DateTime" Group="PnP Columns" FriendlyDisplayFormat="Disabled" ID="{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertStartDateTime" Name="PnPAlertStartDateTime"><Default>[today]</Default></Field>`'
|
|
@@ -73,3 +75,167 @@ m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales -
|
|
|
73
75
|
## More information
|
|
74
76
|
|
|
75
77
|
- AddFieldOptions enumeration: [https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.addfieldoptions.aspx](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.addfieldoptions.aspx)
|
|
78
|
+
|
|
79
|
+
## Response
|
|
80
|
+
|
|
81
|
+
<Tabs>
|
|
82
|
+
<TabItem value="JSON">
|
|
83
|
+
|
|
84
|
+
```json
|
|
85
|
+
{
|
|
86
|
+
"AutoIndexed": false,
|
|
87
|
+
"CanBeDeleted": true,
|
|
88
|
+
"ClientSideComponentId": "00000000-0000-0000-0000-000000000000",
|
|
89
|
+
"ClientSideComponentProperties": null,
|
|
90
|
+
"ClientValidationFormula": null,
|
|
91
|
+
"ClientValidationMessage": null,
|
|
92
|
+
"CustomFormatter": null,
|
|
93
|
+
"DefaultFormula": null,
|
|
94
|
+
"DefaultValue": "[today]",
|
|
95
|
+
"Description": "",
|
|
96
|
+
"Direction": "none",
|
|
97
|
+
"EnforceUniqueValues": false,
|
|
98
|
+
"EntityPropertyName": "PnPAlertStartDateTime",
|
|
99
|
+
"Filterable": true,
|
|
100
|
+
"FromBaseType": false,
|
|
101
|
+
"Group": "PnP Columns",
|
|
102
|
+
"Hidden": false,
|
|
103
|
+
"Id": "5ee2dd25-d941-455a-9bdb-7f2c54aed11b",
|
|
104
|
+
"Indexed": false,
|
|
105
|
+
"IndexStatus": 0,
|
|
106
|
+
"InternalName": "PnPAlertStartDateTime",
|
|
107
|
+
"IsModern": false,
|
|
108
|
+
"JSLink": "clienttemplates.js",
|
|
109
|
+
"PinnedToFiltersPane": false,
|
|
110
|
+
"ReadOnlyField": false,
|
|
111
|
+
"Required": false,
|
|
112
|
+
"SchemaXml": "<Field Type=\"DateTime\" DisplayName=\"Start date-time\" Required=\"FALSE\" EnforceUniqueValues=\"FALSE\" Indexed=\"FALSE\" Format=\"DateTime\" Group=\"PnP Columns\" FriendlyDisplayFormat=\"Disabled\" ID=\"{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}\" SourceID=\"{4f118c69-66e0-497c-96ff-d7855ce0713d}\" StaticName=\"PnPAlertStartDateTime\" Name=\"PnPAlertStartDateTime\" Version=\"1\"><Default>[today]</Default></Field>",
|
|
113
|
+
"Scope": "/sites/SPDemo",
|
|
114
|
+
"Sealed": false,
|
|
115
|
+
"ShowInFiltersPane": 0,
|
|
116
|
+
"Sortable": true,
|
|
117
|
+
"StaticName": "PnPAlertStartDateTime",
|
|
118
|
+
"Title": "Start date-time",
|
|
119
|
+
"FieldTypeKind": 4,
|
|
120
|
+
"TypeAsString": "DateTime",
|
|
121
|
+
"TypeDisplayName": "Date and Time",
|
|
122
|
+
"TypeShortDescription": "Date and Time",
|
|
123
|
+
"ValidationFormula": null,
|
|
124
|
+
"ValidationMessage": null,
|
|
125
|
+
"DateTimeCalendarType": 0,
|
|
126
|
+
"DateFormat": null,
|
|
127
|
+
"DisplayFormat": 1,
|
|
128
|
+
"FriendlyDisplayFormat": 1,
|
|
129
|
+
"TimeFormat": null
|
|
130
|
+
}
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
</TabItem>
|
|
134
|
+
<TabItem value="Text">
|
|
135
|
+
|
|
136
|
+
```text
|
|
137
|
+
AutoIndexed : false
|
|
138
|
+
CanBeDeleted : true
|
|
139
|
+
ClientSideComponentId : 00000000-0000-0000-0000-000000000000
|
|
140
|
+
ClientSideComponentProperties: null
|
|
141
|
+
ClientValidationFormula : null
|
|
142
|
+
ClientValidationMessage : null
|
|
143
|
+
CustomFormatter : null
|
|
144
|
+
DateFormat : null
|
|
145
|
+
DateTimeCalendarType : 0
|
|
146
|
+
DefaultFormula : null
|
|
147
|
+
DefaultValue : [today]
|
|
148
|
+
Description :
|
|
149
|
+
Direction : none
|
|
150
|
+
DisplayFormat : 1
|
|
151
|
+
EnforceUniqueValues : false
|
|
152
|
+
EntityPropertyName : PnPAlertStartDateTime
|
|
153
|
+
FieldTypeKind : 4
|
|
154
|
+
Filterable : true
|
|
155
|
+
FriendlyDisplayFormat : 1
|
|
156
|
+
FromBaseType : false
|
|
157
|
+
Group : PnP Columns
|
|
158
|
+
Hidden : false
|
|
159
|
+
Id : 5ee2dd25-d941-455a-9bdb-7f2c54aed11b
|
|
160
|
+
IndexStatus : 0
|
|
161
|
+
Indexed : false
|
|
162
|
+
InternalName : PnPAlertStartDateTime
|
|
163
|
+
IsModern : false
|
|
164
|
+
JSLink : clienttemplates.js
|
|
165
|
+
PinnedToFiltersPane : false
|
|
166
|
+
ReadOnlyField : false
|
|
167
|
+
Required : false
|
|
168
|
+
SchemaXml : <Field Type="DateTime" DisplayName="Start date-time" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="DateTime" Group="PnP Columns" FriendlyDisplayFormat="Disabled" ID="{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertStartDateTime" Name="PnPAlertStartDateTime" Version="1"><Default>[today]</Default></Field>
|
|
169
|
+
Scope : /sites/SPDemo
|
|
170
|
+
Sealed : false
|
|
171
|
+
ShowInFiltersPane : 0
|
|
172
|
+
Sortable : true
|
|
173
|
+
StaticName : PnPAlertStartDateTime
|
|
174
|
+
TimeFormat : null
|
|
175
|
+
Title : Start date-time
|
|
176
|
+
TypeAsString : DateTime
|
|
177
|
+
TypeDisplayName : Date and Time
|
|
178
|
+
TypeShortDescription : Date and Time
|
|
179
|
+
ValidationFormula : null
|
|
180
|
+
ValidationMessage : null
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
</TabItem>
|
|
184
|
+
<TabItem value="CSV">
|
|
185
|
+
|
|
186
|
+
```csv
|
|
187
|
+
AutoIndexed,CanBeDeleted,ClientSideComponentId,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,DateTimeCalendarType,DisplayFormat,FriendlyDisplayFormat
|
|
188
|
+
,1,00000000-0000-0000-0000-000000000000,[today],,none,,PnPAlertStartDateTime,1,,PnP Columns,,5ee2dd25-d941-455a-9bdb-7f2c54aed11b,,0,PnPAlertStartDateTime,,clienttemplates.js,,,,"<Field Type=""DateTime"" DisplayName=""Start date-time"" Required=""FALSE"" EnforceUniqueValues=""FALSE"" Indexed=""FALSE"" Format=""DateTime"" Group=""PnP Columns"" FriendlyDisplayFormat=""Disabled"" ID=""{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}"" SourceID=""{4f118c69-66e0-497c-96ff-d7855ce0713d}"" StaticName=""PnPAlertStartDateTime"" Name=""PnPAlertStartDateTime"" Version=""1""><Default>[today]</Default></Field>",/sites/SPDemo,,0,1,PnPAlertStartDateTime,Start date-time,4,DateTime,Date and Time,Date and Time,0,1,1
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
</TabItem>
|
|
192
|
+
<TabItem value="Markdown">
|
|
193
|
+
|
|
194
|
+
```md
|
|
195
|
+
# spo field add --webUrl "https://nachan365.sharepoint.com/sites/SPDemo" --xml "<Field Type='DateTime' DisplayName='Start date-time' Required='FALSE' EnforceUniqueValues='FALSE' Indexed='FALSE' Format='DateTime' Group='PnP Columns' FriendlyDisplayFormat='Disabled' ID='{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}' SourceID='{4f118c69-66e0-497c-96ff-d7855ce0713d}' StaticName='PnPAlertStartDateTime' Name='PnPAlertStartDateTime'><Default>[today]</Default></Field>"
|
|
196
|
+
|
|
197
|
+
Date: 10/3/2023
|
|
198
|
+
|
|
199
|
+
## Start date-time (5ee2dd25-d941-455a-9bdb-7f2c54aed11b)
|
|
200
|
+
|
|
201
|
+
Property | Value
|
|
202
|
+
---------|-------
|
|
203
|
+
AutoIndexed | false
|
|
204
|
+
CanBeDeleted | true
|
|
205
|
+
ClientSideComponentId | 00000000-0000-0000-0000-000000000000
|
|
206
|
+
DefaultValue | [today]
|
|
207
|
+
Description |
|
|
208
|
+
Direction | none
|
|
209
|
+
EnforceUniqueValues | false
|
|
210
|
+
EntityPropertyName | PnPAlertStartDateTime
|
|
211
|
+
Filterable | true
|
|
212
|
+
FromBaseType | false
|
|
213
|
+
Group | PnP Columns
|
|
214
|
+
Hidden | false
|
|
215
|
+
Id | 5ee2dd25-d941-455a-9bdb-7f2c54aed11b
|
|
216
|
+
Indexed | false
|
|
217
|
+
IndexStatus | 0
|
|
218
|
+
InternalName | PnPAlertStartDateTime
|
|
219
|
+
IsModern | false
|
|
220
|
+
JSLink | clienttemplates.js
|
|
221
|
+
PinnedToFiltersPane | false
|
|
222
|
+
ReadOnlyField | false
|
|
223
|
+
Required | false
|
|
224
|
+
SchemaXml | <Field Type="DateTime" DisplayName="Start date-time" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="DateTime" Group="PnP Columns" FriendlyDisplayFormat="Disabled" ID="{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertStartDateTime" Name="PnPAlertStartDateTime" Version="1"><Default>[today]</Default></Field>
|
|
225
|
+
Scope | /sites/SPDemo
|
|
226
|
+
Sealed | false
|
|
227
|
+
ShowInFiltersPane | 0
|
|
228
|
+
Sortable | true
|
|
229
|
+
StaticName | PnPAlertStartDateTime
|
|
230
|
+
Title | Start date-time
|
|
231
|
+
FieldTypeKind | 4
|
|
232
|
+
TypeAsString | DateTime
|
|
233
|
+
TypeDisplayName | Date and Time
|
|
234
|
+
TypeShortDescription | Date and Time
|
|
235
|
+
DateTimeCalendarType | 0
|
|
236
|
+
DisplayFormat | 1
|
|
237
|
+
FriendlyDisplayFormat | 1
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
</TabItem>
|
|
241
|
+
</Tabs>
|
|
@@ -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 field get
|
|
4
6
|
|
|
@@ -14,42 +16,206 @@ m365 spo field get [options]
|
|
|
14
16
|
|
|
15
17
|
```md definition-list
|
|
16
18
|
`-u, --webUrl <webUrl>`
|
|
17
|
-
: Absolute URL of the site where the field is located
|
|
19
|
+
: Absolute URL of the site where the field is located.
|
|
18
20
|
|
|
19
21
|
`-l, --listTitle [listTitle]`
|
|
20
|
-
: Title of the list where the field is located. Specify
|
|
22
|
+
: Title of the list where the field is located. Specify either `listTitle`, `listId` or `listUrl`.
|
|
21
23
|
|
|
22
24
|
`--listId [listId]`
|
|
23
|
-
: ID of the list where the field is located. Specify
|
|
25
|
+
: ID of the list where the field is located. Specify either `listTitle`, `listId` or `listUrl`.
|
|
24
26
|
|
|
25
27
|
`--listUrl [listUrl]`
|
|
26
|
-
: Server- or web-relative URL of the list where the field is located. Specify
|
|
28
|
+
: Server- or web-relative URL of the list where the field is located. Specify either `listTitle`, `listId` or `listUrl`.
|
|
27
29
|
|
|
28
30
|
`-i, --id [id]`
|
|
29
|
-
: The ID of the field to retrieve. Specify id or title but not both
|
|
31
|
+
: The ID of the field to retrieve. Specify `id` or `title` but not both.
|
|
30
32
|
|
|
31
33
|
`-t, --title [title]`
|
|
32
|
-
: The display name (case-sensitive) of the field to remove. Specify id or title
|
|
34
|
+
: The display name (case-sensitive) of the field to remove. Specify `id` or `title` but not both.
|
|
33
35
|
```
|
|
34
36
|
|
|
35
37
|
<Global />
|
|
36
38
|
|
|
37
39
|
## Examples
|
|
38
40
|
|
|
39
|
-
Retrieves site column by id located in site
|
|
41
|
+
Retrieves site column by id located in the specified site.
|
|
40
42
|
|
|
41
43
|
```sh
|
|
42
44
|
m365 spo field get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --id 5ee2dd25-d941-455a-9bdb-7f2c54aed11b
|
|
43
45
|
```
|
|
44
46
|
|
|
45
|
-
Retrieves list column by id located in site
|
|
47
|
+
Retrieves list column by id located in the specified site. Retrieves the list by its title.
|
|
46
48
|
|
|
47
49
|
```sh
|
|
48
50
|
m365 spo field get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --id 5ee2dd25-d941-455a-9bdb-7f2c54aed11b
|
|
49
51
|
```
|
|
50
52
|
|
|
51
|
-
Retrieves list column by display name located in site
|
|
53
|
+
Retrieves list column by display name located in the specified site. Retrieves the list by its url.
|
|
52
54
|
|
|
53
55
|
```sh
|
|
54
56
|
m365 spo field get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl "Lists/Events" --title "Title"
|
|
55
57
|
```
|
|
58
|
+
|
|
59
|
+
## Response
|
|
60
|
+
|
|
61
|
+
<Tabs>
|
|
62
|
+
<TabItem value="JSON">
|
|
63
|
+
|
|
64
|
+
```json
|
|
65
|
+
{
|
|
66
|
+
"AutoIndexed": false,
|
|
67
|
+
"CanBeDeleted": true,
|
|
68
|
+
"ClientSideComponentId": "00000000-0000-0000-0000-000000000000",
|
|
69
|
+
"ClientSideComponentProperties": null,
|
|
70
|
+
"ClientValidationFormula": null,
|
|
71
|
+
"ClientValidationMessage": null,
|
|
72
|
+
"CustomFormatter": null,
|
|
73
|
+
"DefaultFormula": null,
|
|
74
|
+
"DefaultValue": "[today]",
|
|
75
|
+
"Description": "",
|
|
76
|
+
"Direction": "none",
|
|
77
|
+
"EnforceUniqueValues": false,
|
|
78
|
+
"EntityPropertyName": "PnPAlertStartDateTime",
|
|
79
|
+
"Filterable": true,
|
|
80
|
+
"FromBaseType": false,
|
|
81
|
+
"Group": "PnP Columns",
|
|
82
|
+
"Hidden": false,
|
|
83
|
+
"Id": "5ee2dd25-d941-455a-9bdb-7f2c54aed11b",
|
|
84
|
+
"Indexed": false,
|
|
85
|
+
"IndexStatus": 0,
|
|
86
|
+
"InternalName": "PnPAlertStartDateTime",
|
|
87
|
+
"IsModern": false,
|
|
88
|
+
"JSLink": "clienttemplates.js",
|
|
89
|
+
"PinnedToFiltersPane": false,
|
|
90
|
+
"ReadOnlyField": false,
|
|
91
|
+
"Required": false,
|
|
92
|
+
"SchemaXml": "<Field Type=\"DateTime\" DisplayName=\"Start date-time\" Required=\"FALSE\" EnforceUniqueValues=\"FALSE\" Indexed=\"FALSE\" Format=\"DateTime\" Group=\"PnP Columns\" FriendlyDisplayFormat=\"Disabled\" ID=\"{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}\" SourceID=\"{4f118c69-66e0-497c-96ff-d7855ce0713d}\" StaticName=\"PnPAlertStartDateTime\" Name=\"PnPAlertStartDateTime\" Version=\"1\"><Default>[today]</Default></Field>",
|
|
93
|
+
"Scope": "/sites/SPDemo",
|
|
94
|
+
"Sealed": false,
|
|
95
|
+
"ShowInFiltersPane": 0,
|
|
96
|
+
"Sortable": true,
|
|
97
|
+
"StaticName": "PnPAlertStartDateTime",
|
|
98
|
+
"Title": "Start date-time",
|
|
99
|
+
"FieldTypeKind": 4,
|
|
100
|
+
"TypeAsString": "DateTime",
|
|
101
|
+
"TypeDisplayName": "Date and Time",
|
|
102
|
+
"TypeShortDescription": "Date and Time",
|
|
103
|
+
"ValidationFormula": null,
|
|
104
|
+
"ValidationMessage": null,
|
|
105
|
+
"DateTimeCalendarType": 0,
|
|
106
|
+
"DateFormat": null,
|
|
107
|
+
"DisplayFormat": 1,
|
|
108
|
+
"FriendlyDisplayFormat": 1,
|
|
109
|
+
"TimeFormat": null
|
|
110
|
+
}
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
</TabItem>
|
|
114
|
+
<TabItem value="Text">
|
|
115
|
+
|
|
116
|
+
```text
|
|
117
|
+
AutoIndexed : false
|
|
118
|
+
CanBeDeleted : true
|
|
119
|
+
ClientSideComponentId : 00000000-0000-0000-0000-000000000000
|
|
120
|
+
ClientSideComponentProperties: null
|
|
121
|
+
ClientValidationFormula : null
|
|
122
|
+
ClientValidationMessage : null
|
|
123
|
+
CustomFormatter : null
|
|
124
|
+
DateFormat : null
|
|
125
|
+
DateTimeCalendarType : 0
|
|
126
|
+
DefaultFormula : null
|
|
127
|
+
DefaultValue : [today]
|
|
128
|
+
Description :
|
|
129
|
+
Direction : none
|
|
130
|
+
DisplayFormat : 1
|
|
131
|
+
EnforceUniqueValues : false
|
|
132
|
+
EntityPropertyName : PnPAlertStartDateTime
|
|
133
|
+
FieldTypeKind : 4
|
|
134
|
+
Filterable : true
|
|
135
|
+
FriendlyDisplayFormat : 1
|
|
136
|
+
FromBaseType : false
|
|
137
|
+
Group : PnP Columns
|
|
138
|
+
Hidden : false
|
|
139
|
+
Id : 5ee2dd25-d941-455a-9bdb-7f2c54aed11b
|
|
140
|
+
IndexStatus : 0
|
|
141
|
+
Indexed : false
|
|
142
|
+
InternalName : PnPAlertStartDateTime
|
|
143
|
+
IsModern : false
|
|
144
|
+
JSLink : clienttemplates.js
|
|
145
|
+
PinnedToFiltersPane : false
|
|
146
|
+
ReadOnlyField : false
|
|
147
|
+
Required : false
|
|
148
|
+
SchemaXml : <Field Type="DateTime" DisplayName="Start date-time" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="DateTime" Group="PnP Columns" FriendlyDisplayFormat="Disabled" ID="{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertStartDateTime" Name="PnPAlertStartDateTime" Version="1"><Default>[today]</Default></Field>
|
|
149
|
+
Scope : /sites/SPDemo
|
|
150
|
+
Sealed : false
|
|
151
|
+
ShowInFiltersPane : 0
|
|
152
|
+
Sortable : true
|
|
153
|
+
StaticName : PnPAlertStartDateTime
|
|
154
|
+
TimeFormat : null
|
|
155
|
+
Title : Start date-time
|
|
156
|
+
TypeAsString : DateTime
|
|
157
|
+
TypeDisplayName : Date and Time
|
|
158
|
+
TypeShortDescription : Date and Time
|
|
159
|
+
ValidationFormula : null
|
|
160
|
+
ValidationMessage : null
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
</TabItem>
|
|
164
|
+
<TabItem value="CSV">
|
|
165
|
+
|
|
166
|
+
```csv
|
|
167
|
+
AutoIndexed,CanBeDeleted,ClientSideComponentId,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,DateTimeCalendarType,DisplayFormat,FriendlyDisplayFormat
|
|
168
|
+
,1,00000000-0000-0000-0000-000000000000,[today],,none,,PnPAlertStartDateTime,1,,PnP Columns,,5ee2dd25-d941-455a-9bdb-7f2c54aed11b,,0,PnPAlertStartDateTime,,clienttemplates.js,,,,"<Field Type=""DateTime"" DisplayName=""Start date-time"" Required=""FALSE"" EnforceUniqueValues=""FALSE"" Indexed=""FALSE"" Format=""DateTime"" Group=""PnP Columns"" FriendlyDisplayFormat=""Disabled"" ID=""{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}"" SourceID=""{4f118c69-66e0-497c-96ff-d7855ce0713d}"" StaticName=""PnPAlertStartDateTime"" Name=""PnPAlertStartDateTime"" Version=""1""><Default>[today]</Default></Field>",/sites/SPDemo,,0,1,PnPAlertStartDateTime,Start date-time,4,DateTime,Date and Time,Date and Time,0,1,1
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
</TabItem>
|
|
172
|
+
<TabItem value="Markdown">
|
|
173
|
+
|
|
174
|
+
```md
|
|
175
|
+
# spo field get --webUrl "https://nachan365.sharepoint.com/sites/SPDemo" --id "5ee2dd25-d941-455a-9bdb-7f2c54aed11b"
|
|
176
|
+
|
|
177
|
+
Date: 10/3/2023
|
|
178
|
+
|
|
179
|
+
## Start date-time (5ee2dd25-d941-455a-9bdb-7f2c54aed11b)
|
|
180
|
+
|
|
181
|
+
Property | Value
|
|
182
|
+
---------|-------
|
|
183
|
+
AutoIndexed | false
|
|
184
|
+
CanBeDeleted | true
|
|
185
|
+
ClientSideComponentId | 00000000-0000-0000-0000-000000000000
|
|
186
|
+
DefaultValue | [today]
|
|
187
|
+
Description |
|
|
188
|
+
Direction | none
|
|
189
|
+
EnforceUniqueValues | false
|
|
190
|
+
EntityPropertyName | PnPAlertStartDateTime
|
|
191
|
+
Filterable | true
|
|
192
|
+
FromBaseType | false
|
|
193
|
+
Group | PnP Columns
|
|
194
|
+
Hidden | false
|
|
195
|
+
Id | 5ee2dd25-d941-455a-9bdb-7f2c54aed11b
|
|
196
|
+
Indexed | false
|
|
197
|
+
IndexStatus | 0
|
|
198
|
+
InternalName | PnPAlertStartDateTime
|
|
199
|
+
IsModern | false
|
|
200
|
+
JSLink | clienttemplates.js
|
|
201
|
+
PinnedToFiltersPane | false
|
|
202
|
+
ReadOnlyField | false
|
|
203
|
+
Required | false
|
|
204
|
+
SchemaXml | <Field Type="DateTime" DisplayName="Start date-time" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="DateTime" Group="PnP Columns" FriendlyDisplayFormat="Disabled" ID="{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertStartDateTime" Name="PnPAlertStartDateTime" Version="1"><Default>[today]</Default></Field>
|
|
205
|
+
Scope | /sites/SPDemo
|
|
206
|
+
Sealed | false
|
|
207
|
+
ShowInFiltersPane | 0
|
|
208
|
+
Sortable | true
|
|
209
|
+
StaticName | PnPAlertStartDateTime
|
|
210
|
+
Title | Start date-time
|
|
211
|
+
FieldTypeKind | 4
|
|
212
|
+
TypeAsString | DateTime
|
|
213
|
+
TypeDisplayName | Date and Time
|
|
214
|
+
TypeShortDescription | Date and Time
|
|
215
|
+
DateTimeCalendarType | 0
|
|
216
|
+
DisplayFormat | 1
|
|
217
|
+
FriendlyDisplayFormat | 1
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
</TabItem>
|
|
221
|
+
</Tabs>
|
|
@@ -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 field list
|
|
4
6
|
|
|
@@ -14,42 +16,167 @@ m365 spo field list [options]
|
|
|
14
16
|
|
|
15
17
|
```md definition-list
|
|
16
18
|
`-u, --webUrl <webUrl>`
|
|
17
|
-
: Absolute URL of the site where fields are located
|
|
19
|
+
: Absolute URL of the site where fields are located.
|
|
18
20
|
|
|
19
21
|
`-t, --listTitle [listTitle]`
|
|
20
|
-
: Title of the list where fields are located. Specify `listTitle`, `listId` or `listUrl
|
|
22
|
+
: Title of the list where fields are located. Specify either `listTitle`, `listId` or `listUrl`.
|
|
21
23
|
|
|
22
24
|
`-i --listId [listId]`
|
|
23
|
-
: ID of the list where fields are located. Specify `listTitle`, `listId` or `listUrl
|
|
25
|
+
: ID of the list where fields are located. Specify either `listTitle`, `listId` or `listUrl`.
|
|
24
26
|
|
|
25
27
|
`--listUrl [listUrl]`
|
|
26
|
-
: Server- or web-relative URL of the list where fields are located. Specify `listTitle`, `listId` or `listUrl
|
|
28
|
+
: Server- or web-relative URL of the list where fields are located. Specify either `listTitle`, `listId` or `listUrl`.
|
|
27
29
|
```
|
|
28
30
|
|
|
29
31
|
<Global />
|
|
30
32
|
|
|
31
33
|
## Examples
|
|
32
34
|
|
|
33
|
-
Retrieves site columns for site
|
|
35
|
+
Retrieves site columns for the specified site.
|
|
34
36
|
|
|
35
37
|
```sh
|
|
36
38
|
m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales
|
|
37
39
|
```
|
|
38
40
|
|
|
39
|
-
Retrieves list columns for list _Events_ in site
|
|
41
|
+
Retrieves list columns for list _Events_ in the specified site.
|
|
40
42
|
|
|
41
43
|
```sh
|
|
42
44
|
m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events
|
|
43
45
|
```
|
|
44
46
|
|
|
45
|
-
Retrieves list columns for list
|
|
47
|
+
Retrieves list columns for the specified list in the specified site.
|
|
46
48
|
|
|
47
49
|
```sh
|
|
48
50
|
m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991'
|
|
49
51
|
```
|
|
50
52
|
|
|
51
|
-
Retrieves list columns for list
|
|
53
|
+
Retrieves list columns for the specified list in the specified site.
|
|
52
54
|
|
|
53
55
|
```sh
|
|
54
56
|
m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events'
|
|
55
57
|
```
|
|
58
|
+
|
|
59
|
+
## Response
|
|
60
|
+
|
|
61
|
+
<Tabs>
|
|
62
|
+
<TabItem value="JSON">
|
|
63
|
+
|
|
64
|
+
```json
|
|
65
|
+
[
|
|
66
|
+
{
|
|
67
|
+
"AutoIndexed": false,
|
|
68
|
+
"CanBeDeleted": true,
|
|
69
|
+
"ClientSideComponentId": "00000000-0000-0000-0000-000000000000",
|
|
70
|
+
"ClientSideComponentProperties": null,
|
|
71
|
+
"ClientValidationFormula": null,
|
|
72
|
+
"ClientValidationMessage": null,
|
|
73
|
+
"CustomFormatter": null,
|
|
74
|
+
"DefaultFormula": null,
|
|
75
|
+
"DefaultValue": "[today]",
|
|
76
|
+
"Description": "",
|
|
77
|
+
"Direction": "none",
|
|
78
|
+
"EnforceUniqueValues": false,
|
|
79
|
+
"EntityPropertyName": "PnPAlertStartDateTime",
|
|
80
|
+
"Filterable": true,
|
|
81
|
+
"FromBaseType": false,
|
|
82
|
+
"Group": "PnP Columns",
|
|
83
|
+
"Hidden": false,
|
|
84
|
+
"Id": "5ee2dd25-d941-455a-9bdb-7f2c54aed11b",
|
|
85
|
+
"Indexed": false,
|
|
86
|
+
"IndexStatus": 0,
|
|
87
|
+
"InternalName": "PnPAlertStartDateTime",
|
|
88
|
+
"IsModern": false,
|
|
89
|
+
"JSLink": "clienttemplates.js",
|
|
90
|
+
"PinnedToFiltersPane": false,
|
|
91
|
+
"ReadOnlyField": false,
|
|
92
|
+
"Required": false,
|
|
93
|
+
"SchemaXml": "<Field Type=\"DateTime\" DisplayName=\"Start date-time\" Required=\"FALSE\" EnforceUniqueValues=\"FALSE\" Indexed=\"FALSE\" Format=\"DateTime\" Group=\"PnP Columns\" FriendlyDisplayFormat=\"Disabled\" ID=\"{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}\" SourceID=\"{4f118c69-66e0-497c-96ff-d7855ce0713d}\" StaticName=\"PnPAlertStartDateTime\" Name=\"PnPAlertStartDateTime\" Version=\"1\"><Default>[today]</Default></Field>",
|
|
94
|
+
"Scope": "/sites/SPDemo",
|
|
95
|
+
"Sealed": false,
|
|
96
|
+
"ShowInFiltersPane": 0,
|
|
97
|
+
"Sortable": true,
|
|
98
|
+
"StaticName": "PnPAlertStartDateTime",
|
|
99
|
+
"Title": "Start date-time",
|
|
100
|
+
"FieldTypeKind": 4,
|
|
101
|
+
"TypeAsString": "DateTime",
|
|
102
|
+
"TypeDisplayName": "Date and Time",
|
|
103
|
+
"TypeShortDescription": "Date and Time",
|
|
104
|
+
"ValidationFormula": null,
|
|
105
|
+
"ValidationMessage": null,
|
|
106
|
+
"DateTimeCalendarType": 0,
|
|
107
|
+
"DateFormat": null,
|
|
108
|
+
"DisplayFormat": 1,
|
|
109
|
+
"FriendlyDisplayFormat": 1,
|
|
110
|
+
"TimeFormat": null
|
|
111
|
+
}
|
|
112
|
+
]
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
</TabItem>
|
|
116
|
+
<TabItem value="Text">
|
|
117
|
+
|
|
118
|
+
```text
|
|
119
|
+
Id Title Group Hidden
|
|
120
|
+
------------------------------------ --------------------------------------- -------------------------------------- ------
|
|
121
|
+
5ee2dd25-d941-455a-9bdb-7f2c54aed11b Start date-time PnP Columns false
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
</TabItem>
|
|
125
|
+
<TabItem value="CSV">
|
|
126
|
+
|
|
127
|
+
```csv
|
|
128
|
+
AutoIndexed,CanBeDeleted,ClientSideComponentId,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,MaxLength
|
|
129
|
+
,1,00000000-0000-0000-0000-000000000000,,none,,PnPAlertStartDateTime,1,,PnP Columns,,5ee2dd25-d941-455a-9bdb-7f2c54aed11b,,0,PnPAlertStartDateTime,,clienttemplates.js,,,,"<Field Type=""DateTime"" DisplayName=""Start date-time"" Required=""FALSE"" EnforceUniqueValues=""FALSE"" Indexed=""FALSE"" Format=""DateTime"" Group=""PnP Columns"" FriendlyDisplayFormat=""Disabled"" ID=""{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}"" SourceID=""{4f118c69-66e0-497c-96ff-d7855ce0713d}"" StaticName=""PnPAlertStartDateTime"" Name=""PnPAlertStartDateTime"" Version=""1""><Default>[today]</Default></Field>",/sites/SPDemo,,0,1,PnPAlertStartDateTime,Start date-time,4,DateTime,Date and Time,Date and Time,
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
</TabItem>
|
|
133
|
+
<TabItem value="Markdown">
|
|
134
|
+
|
|
135
|
+
```md
|
|
136
|
+
# spo field list --webUrl "https://nachan365.sharepoint.com/sites/SPDemo"
|
|
137
|
+
|
|
138
|
+
Date: 10/3/2023
|
|
139
|
+
|
|
140
|
+
## Start date-time (5ee2dd25-d941-455a-9bdb-7f2c54aed11b)
|
|
141
|
+
|
|
142
|
+
Property | Value
|
|
143
|
+
---------|-------
|
|
144
|
+
AutoIndexed | false
|
|
145
|
+
CanBeDeleted | true
|
|
146
|
+
ClientSideComponentId | 00000000-0000-0000-0000-000000000000
|
|
147
|
+
DefaultValue | [today]
|
|
148
|
+
Description |
|
|
149
|
+
Direction | none
|
|
150
|
+
EnforceUniqueValues | false
|
|
151
|
+
EntityPropertyName | PnPAlertStartDateTime
|
|
152
|
+
Filterable | true
|
|
153
|
+
FromBaseType | false
|
|
154
|
+
Group | PnP Columns
|
|
155
|
+
Hidden | false
|
|
156
|
+
Id | 5ee2dd25-d941-455a-9bdb-7f2c54aed11b
|
|
157
|
+
Indexed | false
|
|
158
|
+
IndexStatus | 0
|
|
159
|
+
InternalName | PnPAlertStartDateTime
|
|
160
|
+
IsModern | false
|
|
161
|
+
JSLink | clienttemplates.js
|
|
162
|
+
PinnedToFiltersPane | false
|
|
163
|
+
ReadOnlyField | false
|
|
164
|
+
Required | false
|
|
165
|
+
SchemaXml | <Field Type="DateTime" DisplayName="Start date-time" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="DateTime" Group="PnP Columns" FriendlyDisplayFormat="Disabled" ID="{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertStartDateTime" Name="PnPAlertStartDateTime" Version="1"><Default>[today]</Default></Field>
|
|
166
|
+
Scope | /sites/SPDemo
|
|
167
|
+
Sealed | false
|
|
168
|
+
ShowInFiltersPane | 0
|
|
169
|
+
Sortable | true
|
|
170
|
+
StaticName | PnPAlertStartDateTime
|
|
171
|
+
Title | Start date-time
|
|
172
|
+
FieldTypeKind | 4
|
|
173
|
+
TypeAsString | DateTime
|
|
174
|
+
TypeDisplayName | Date and Time
|
|
175
|
+
TypeShortDescription | Date and Time
|
|
176
|
+
DateTimeCalendarType | 0
|
|
177
|
+
DisplayFormat | 1
|
|
178
|
+
FriendlyDisplayFormat | 1
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
</TabItem>
|
|
182
|
+
</Tabs>
|