Skip to main content

spo field remove

Removes the specified list- or site column

Usage​

m365 spo field remove [options]

Options​

-u, --webUrl <webUrl>

Absolute URL of the site where the field to remove is located.

-l, --listTitle [listTitle]

Title of the list where the field is located. Specify either listTitle, listId or listUrl.

--listId [listId]

ID of the list where the field is located. Specify either listTitle, listId or listUrl.

--listUrl [listUrl]

Server- or web-relative URL of the list where the field is located. Specify either listTitle, listId or listUrl.

-i, --id [id]

The ID of the field to remove. Specify either id, title, internalName, or group.

-t, --title [title]

The display name (case-sensitive) of the field to remove. Specify either id, title, internalName, or group.

--internalName [internalName]

The internal name (case-sensitive) of the field to remove. Specify either id, title, internalName, or group.

-g, --group [group]

Delete all fields from this group (case-sensitive). Specify either id, title, internalName, or group.

-f, --force

Don't prompt for confirming removing the field.

-h, --help [help]

Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are options, examples, remarks, permissions, response, full. Default is options.

--query [query]

JMESPath query string. See http://jmespath.org/ for more information and examples.

-o, --output [output]

Output type. json, text, csv, md, none. Default json.

--verbose

Runs command with verbose logging.

--debug

Runs command with debug logging.

Examples​

Remove the site column with the specified ID, located in the specified site.

m365 spo field remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --id 5ee2dd25-d941-455a-9bdb-7f2c54aed11b

Remove the list column with the specified ID, located in the specified site. Retrieves the list by its title.

m365 spo field remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --id 5ee2dd25-d941-455a-9bdb-7f2c54aed11b

Remove the list column with the specified display name, located in the specified site. Retrieves the list by its url.

m365 spo field remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl "Lists/Events" --title "Title"

Remove the list column with the specified display name, located in the specified site. Retrieves the list by its url.

m365 spo field remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl "Lists/Events" --internalName "Title"

Remove all site columns from the specified group.

m365 spo field remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --group "MyGroup"

Response​

The command won't return a response on success.