Skip to main content

spo file checkout

Checks out specified file

Usage

m365 spo file checkout [options]

Options

-u, --webUrl <webUrl>

The URL of the site where the file is located.

--url [url]

The server- or site-relative decoded URL of the file to retrieve. Specify either url or id but not both.

-i, --id [id]

The UniqueId (GUID) of the file to retrieve. Specify either url or id but not both.

-h, --help [help]

Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are options, examples, remarks, 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

Checks out file with the specified UniqueId located in the specified site.

m365 spo file checkout --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6'

Checks out file with the specified server-relative url located in the specified site.

m365 spo file checkout --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx'

Response

The command won't return a response on success.

CTRL + M