spo site rename¶
Renames the URL and title of a site collection
Usage¶
m365 spo site rename [options]
Options¶
-u, --url <url>
- The URL of the site to rename
--newUrl <newUrl>
- New URL for the site collection
--newTitle [newTitle]
- New title for the site
--suppressMarketplaceAppCheck
- Suppress marketplace app check
--suppressWorkflow2013Check
- Suppress 2013 workflow check
--wait
- Wait for the job to complete
-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 isfull
. --query [query]
- JMESPath query string. See http://jmespath.org/ for more information and examples
-o, --output [output]
- Output type.
json,text,csv,md
. Defaultjson
--verbose
- Runs command with verbose logging
--debug
- Runs command with debug logging
Remarks¶
Renaming site collections is by default asynchronous and depending on the current state of Microsoft 365, might take up to few minutes. If you're building a script with steps that require the operation to complete fully, you should use the --wait
flag. When using this flag, the spo site rename
command will keep running until it receives confirmation from Microsoft 365 that the site rename operation has completed.
Important
To use this command you must have permissions to access the tenant admin site.
Examples¶
Starts the rename of the site collection with name "samplesite" to "renamed" without modifying the title
m365 spo site rename --url http://contoso.sharepoint.com/samplesite --newUrl http://contoso.sharepoint.com/renamed
Starts the rename of the site collection with name "samplesite" to "renamed" modifying the title of the site to "New Title"
m365 spo site rename --url http://contoso.sharepoint.com/samplesite --newUrl http://contoso.sharepoint.com/renamed --newTitle "New Title"
Renames the specified site collection and waits for the operation to complete
m365 spo site rename --url http://contoso.sharepoint.com/samplesite --newUrl http://contoso.sharepoint.com/renamed --newTitle "New Title" --wait