Skip to content

folder-copy.mdx

Latest commit

 

History

History
155 lines (114 loc) · 4.61 KB

folder-copy.mdx

File metadata and controls

155 lines (114 loc) · 4.61 KB

import Global from '../../_global.mdx'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

spo folder copy

Copies a folder to another location

Usage

m365 spo folder copy [options]

Options

`-u, --webUrl <webUrl>`
: The URL of the site where the folder is located.

`-s, --sourceUrl [sourceUrl]`
: The server-, site-relative or absolute decoded URL of the folder to copy. Specify either `sourceUrl` or `sourceId` but not both.

`-i, --sourceId [sourceId]`
: The UniqueId (GUID) of the folder. Specify either `sourceUrl` or `sourceId` but not both.

`-t, --targetUrl <targetUrl>`
: Server-relative or absolute decoded URL where to copy the folder.

`--newName [newName]`
: New name of the destination folder.

`--nameConflictBehavior [nameConflictBehavior]`
: Behavior when a file or folder with the same name is already present at the destination. Allowed values: `fail`, `rename`. Defaults to `fail`.

`--skipWait`
: Don't wait for the copy operation to complete.

Remarks

When you specify a value for nameConflictBehavior, consider the following:

  • fail will throw an error when the destination folder already exists.
  • rename will add a suffix (e.g. Folder1) when the destination folder already exists.

Examples

Copy a folder a folder to another location using server-relative URLs

m365 spo folder copy --webUrl https://contoso.sharepoint.com/sites/project-x --sourceUrl "/sites/project-x/Shared Documents/Reports" --targetUrl "/sites/project-y/Shared Documents/Project files"

Copy a folder a folder to another location using site-relative URLs and rename it

m365 spo folder copy --webUrl https://contoso.sharepoint.com/sites/project-x --sourceUrl "/Shared Documents/Reports" --targetUrl "/sites/project-y/Shared Documents" --newName "Reports January"

Copy a folder to another location and use new name on conflict

m365 spo folder copy --webUrl https://contoso.sharepoint.com/sites/project-x --sourceUrl "/sites/project-x/Shared Documents/Reports" --targetUrl "/sites/project-y/Shared Documents/Project files" --nameConflictBehavior rename

Copy a folder referenced by its ID to another document library and don't wait for the copy operation to finish

m365 spo folder copy --webUrl https://contoso.sharepoint.com/sites/project-x --sourceId b8cc341b-9c11-4f2d-aa2b-0ce9c18bcba2 --targetUrl "/sites/project-x/Project files" --skipWait

Response

Standard Response

{
  "Exists": true,
  "ExistsAllowThrowForPolicyFailures": true,
  "ExistsWithException": true,
  "IsWOPIEnabled": false,
  "ItemCount": 6,
  "Name": "Company",
  "ProgID": null,
  "ServerRelativeUrl": "/sites/Sales/Icons/Company",
  "TimeCreated": "2024-09-26T22:08:53Z",
  "TimeLastModified": "2024-09-26T22:09:31Z",
  "UniqueId": "d3a37396-ca16-467b-b968-48f5fc41f2b6",
  "WelcomePage": ""
}
Exists                           : true
ExistsAllowThrowForPolicyFailures: true
ExistsWithException              : true
IsWOPIEnabled                    : false
ItemCount                        : 6
Name                             : Company
ProgID                           : null
ServerRelativeUrl                : /sites/Sales/Icons/Company
TimeCreated                      : 2024-09-26T22:08:53Z
TimeLastModified                 : 2024-09-26T22:09:31Z
UniqueId                         : d3a37396-ca16-467b-b968-48f5fc41f2b6
WelcomePage                      :

Exists,ExistsAllowThrowForPolicyFailures,ExistsWithException,IsWOPIEnabled,ItemCount,Name,ProgID,ServerRelativeUrl,TimeCreated,TimeLastModified,UniqueId,WelcomePage
1,1,1,0,6,Company,,/sites/Sales/Icons/Company,2024-09-26T22:08:53Z,2024-09-26T22:09:31Z,d3a37396-ca16-467b-b968-48f5fc41f2b6,
# spo folder copy --webUrl "https://contoso.sharepoint.com/sites/Marketing" --sourceUrl "/Logos/Contoso" --targetUrl "/sites/Sales/Logos"

Date: 18/10/2024

## Company (d3a37396-ca16-467b-b968-48f5fc41f2b6)

Property | Value
---------|-------
Exists | true
ExistsAllowThrowForPolicyFailures | true
ExistsWithException | true
IsWOPIEnabled | false
ItemCount | 6
Name | Company
ServerRelativeUrl | /sites/Sales/Icons/Company
TimeCreated | 2024-09-26T22:08:53Z
TimeLastModified | 2024-09-26T22:09:31Z
UniqueId | d3a37396-ca16-467b-b968-48f5fc41f2b6
WelcomePage |

skipWait response

The command won't return a response on success.