Skip to main content

spo sitedesign apply

Applies a site design to an existing site collection

Usage​

m365 spo sitedesign apply [options]

Options​

-i, --id <id>

The ID of the site design to apply

-u, --webUrl <webUrl>

The URL of the site to apply the site design to

--asTask

Apply site design as task. Required for large site designs

-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​

Apply the site design with ID 9b142c22-037f-4a7f-9017-e9d8c0e34b98 to the site collection https://contoso.sharepoint.com/sites/project-x

m365 spo sitedesign apply --id 9b142c22-037f-4a7f-9017-e9d8c0e34b98 --webUrl https://contoso.sharepoint.com/sites/project-x

Apply large site design to the specified site

m365 spo sitedesign apply --id 9b142c22-037f-4a7f-9017-e9d8c0e34b98 --webUrl https://contoso.sharepoint.com/sites/project-x --asTask

Response​

Standard response​

[
  {
    "ErrorCode": 0,
    "Outcome": "0",
    "OutcomeText": null,
    "Target": null,
    "TargetId": null,
    "Title": "Activate feature f151bb39-7c3b-414f-bb36-6bf18872052f"
  }
]

asTask response​

When we make use of the option asTask, the response will differ.

Response​

{
  "ID": "781e7556-4489-42bc-aa94-1decf6a395d6",
  "LogonName": "i:0#.f|membership|john@contoso.onmicrosoft.com",
  "SiteDesignID": "00281728-3bc1-41d3-92b6-8fc493dcf4cc",
  "SiteDesignStore": 0,
  "SiteID": "5fc2ea61-7204-41be-9d05-d44f017f958b",
  "WebID": "1c6a5768-89b1-4a68-8c85-9f8db4609bcf"
}

More information​

CTRL + M