-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Move SPO-PS info from sp-dev-docs page to separate reference topics #361
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 9 commits
3617ac5
002297f
a50dc92
d72d0b8
64a4d43
9771f4a
1dd5f73
27bdde3
0c16141
ce3bd6d
4ad264a
2c2525d
ebcb2a9
4a7d875
84249e3
3e0f589
cb83aa5
b6681ae
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| --- | ||
| external help file: | ||
| applicable: SharePoint Online | ||
| title: Add-SPOSiteDesign | ||
| schema: 2.0.0 | ||
| --- | ||
|
|
||
| # Add-SPOSiteDesign | ||
|
|
||
| ## SYNOPSIS | ||
|
|
||
| Creates a new site design available to users when they create a new site from the SharePoint home page. | ||
|
|
||
| ## SYNTAX | ||
|
|
||
| ```powershell | ||
| Add-SPOSiteDesign | ||
| -Title <string> | ||
| -WebTemplate <string> | ||
| -SiteScripts <SPOSiteScriptPipeBind[]> | ||
| [-Description <string>] | ||
| [-PreviewImageUrl <string>] | ||
| [-PreviewImageAltText <string>] | ||
| [-IsDefault] | ||
| [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## PARAMETERS | ||
|
|
||
| ### -Title | ||
| The display name of the site design. | ||
|
|
||
| ```yaml | ||
| Type: String | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
| Applicable: SharePoint Online | ||
| Required: True | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ### -WebTemplate | ||
| Identifies which base template to add the design to. Use the value **64** for the Team site template, and the value **68** for the Communication site template. | ||
|
|
||
| ```yaml | ||
| Type: String | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
| Applicable: SharePoint Online | ||
| Required: True | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ### -SiteScripts | ||
| An array of one or more site scripts. Each is identified by an ID. The scripts run in the order listed. | ||
|
|
||
| ```yaml | ||
| Type: SPOSiteScriptPipeBind | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
| Applicable: SharePoint Online | ||
| Required: True | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ### -Description | ||
| The display description of the site design. | ||
|
|
||
| ```yaml | ||
| Type: String | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
| Applicable: SharePoint Online | ||
| Required: False | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ### -PreviewImageUrl | ||
| The URL of a preview image. If none is specified, SharePoint uses a generic image. | ||
|
|
||
| ```yaml | ||
| Type: String | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
| Applicable: SharePoint Online | ||
| Required: False | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ### -PreviewImageAltText | ||
| The alt text description of the image for accessibility. | ||
|
|
||
| ```yaml | ||
| Type: String | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
| Applicable: SharePoint Online | ||
| Required: False | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ### -IsDefault | ||
| A switch that if provided, applies the site design to the default site template. For more information, see [Customize a default site design](customize-default-site-design.md). | ||
|
|
||
| ```yaml | ||
| Type: CommonParameters | ||
|
||
| Parameter Sets: (All) | ||
| Aliases: | ||
| Applicable: SharePoint Online | ||
| Required: False | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### Example 1 | ||
|
|
||
| This example creates a new site design. | ||
|
|
||
| ```powershell | ||
| C:\> Add-SPOSiteDesign ` | ||
|
||
| -Title "Contoso customer tracking" ` | ||
| -WebTemplate "64" ` | ||
| -SiteScripts "<ID>" ` | ||
| -Description "Tracks key customer data in a list" ` | ||
| -PreviewImageUrl "https://contoso.sharepoint.com/SiteAssets/site-preview.png" ` | ||
| -PreviewImageAltText "site preview" | ||
| ``` | ||
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| --- | ||
| external help file: | ||
| applicable: SharePoint Online | ||
| title: Add-SPOSiteScript | ||
| schema: 2.0.0 | ||
| --- | ||
|
|
||
| # Add-SPOSiteScript | ||
|
|
||
| ## SYNOPSIS | ||
|
|
||
| Uploads a new site script for use either directly or in a site design. | ||
|
|
||
| ## SYNTAX | ||
|
|
||
| ```powershell | ||
| Add-SPOSiteScript | ||
| -Title <string> | ||
| -Content <string> | ||
| [-Description <string>] | ||
| [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## PARAMETERS | ||
|
|
||
| ### -Title | ||
| The display name of the site design. | ||
|
|
||
| ```yaml | ||
| Type: String | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
| Applicable: SharePoint Online | ||
| Required: True | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ### -Content | ||
| The JSON value that describes the script. For more information, see the [JSON reference](site-design-json-schema.md). | ||
|
|
||
| ```yaml | ||
| Type: String | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
| Applicable: SharePoint Online | ||
| Required: True | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ### -Description | ||
| A description of the script. | ||
|
|
||
| ```yaml | ||
| Type: String | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
| Applicable: SharePoint Online | ||
| Required: False | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### Example 1 | ||
|
|
||
| This example adds a new site logo from the following script in a file. | ||
|
|
||
| ```json | ||
| { | ||
| "verb": "setSiteLogo", | ||
| "url": "https://contoso.sharepoint.com/SiteAssets/company-logo.png" | ||
| }, | ||
| ``` | ||
|
|
||
| ```powershell | ||
| C:\> Get-Content 'c:\scripts\site-script.json' -Raw | Add-SPOSiteScript -Title "Customer logo" -Description "Applies customer logo for customer sites" | ||
|
||
| ``` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| --- | ||
| external help file: | ||
| applicable: SharePoint Online | ||
| title: Get-SPOSiteDesign | ||
| schema: 2.0.0 | ||
| --- | ||
|
|
||
| # Get-SPOSiteDesign | ||
|
|
||
| ## SYNOPSIS | ||
|
|
||
| Gets details about site designs that are on the SharePoint tenant. You can specify an ID of a specific site design to retrieve. If there are no parameters listed, details about all site designs are listed. | ||
|
|
||
| ## SYNTAX | ||
|
|
||
| ```powershell | ||
| Get-SPOSiteDesign | ||
| [[-Identity] <SPOSiteDesignPipeBind>] | ||
| [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## PARAMETERS | ||
|
|
||
| ### -Identity | ||
| The ID of the site design to retrieve. | ||
|
|
||
| ```yaml | ||
| Type: SPOSiteDesignPipeBind | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
| Applicable: SharePoint Online | ||
| Required: False | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### Example 1 | ||
|
|
||
| This example and sample response show how to get site design details. | ||
|
|
||
| ```powershell | ||
| PS C:\> Get-SPOSiteDesign 44252d09-62c4-4913-9eb0-a2a8b8d7f863 | ||
|
||
|
|
||
| Id : 44252d09-62c4-4913-9eb0-a2a8b8d7f863 | ||
| Title : Contoso - Team Project | ||
| WebTemplate : 64 | ||
| SiteScriptIds : {1306913c-8463-42ca-bd63-efad0fcdbba4} | ||
| Description : Use this design to apply Contoso theme and create | ||
| custom lists and add to nav | ||
| ``` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| --- | ||
| external help file: | ||
| applicable: SharePoint Online | ||
| title: Get-SPOSiteDesignRights | ||
| schema: 2.0.0 | ||
| --- | ||
|
|
||
| # Get-SPOSiteDesignRights | ||
|
|
||
| ## SYNOPSIS | ||
|
|
||
| Displays a list of principals and their rights for usage of the site design. This can be used to determine the scope that your site design has with users on the tenant. | ||
|
|
||
| ## SYNTAX | ||
|
|
||
| ```powershell | ||
| Get-SPOSiteDesignRights | ||
| [-Identity] <SPOSiteDesignPipeBind> | ||
| [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## PARAMETERS | ||
|
|
||
| ### -Identity | ||
| The ID of the site design to get scoping information. | ||
|
|
||
| ```yaml | ||
| Type: SPOSiteDesignPipeBind | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
| Applicable: SharePoint Online | ||
| Required: False | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### Example 1 | ||
|
|
||
| This example gets the rights for a site design. | ||
|
|
||
| ```powershell | ||
| PS C:\> Get-SPOSiteDesignRights 607aed52-6d61-490a-b692-c0f58a6981a1 | ||
|
|
||
| DisplayName PrincipalName Rights | ||
| ----------- ------------- ------ | ||
| Nestor Wilke i:0#.f|membership|[email protected] View | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be "SPOSiteScriptPipeBind[]" since this is an array
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated.