diff --git a/Cmdlets/Sites/NewSPOWeb.cs b/Cmdlets/Sites/NewSPOWeb.cs index 1f0e83f..39416b7 100644 --- a/Cmdlets/Sites/NewSPOWeb.cs +++ b/Cmdlets/Sites/NewSPOWeb.cs @@ -17,6 +17,8 @@ namespace Lapointe.SharePointOnline.PowerShell.Cmdlets.Sites [RelatedCmdlets(typeof(ConnectSPOSite), typeof(GetSPOWeb))] [Example(Code = "PS C:\\> New-SPOWeb -ParentWeb \"/\" -Url \"childsite\" -WebTemplate \"STS#0\" -Title \"Child Site\" -UseSamePermissionsAsParentSite", Remarks = "This example creates a new child site with the URL name of childsite under the root Site of the current Site Collection.")] + [Example(Code = "PS C:\\> New-SPOWeb -ParentWeb \"/sites/sitecol1\" -Url \"childsite\" -WebTemplate \"STS#0\" -Title \"Child Site\" -UseSamePermissionsAsParentSite", + Remarks = "This example creates a new child site with the URL name of childsite under the sitecol1 Site of the current Site Collection (you must be connected to this site collection).")] public class NewSPOWeb : BaseSPOCmdlet { [ValidateNotNullOrEmpty, diff --git a/Cmdlets/Sites/RemoveSPOWeb.cs b/Cmdlets/Sites/RemoveSPOWeb.cs index f5d5f2a..b3d1cdd 100644 --- a/Cmdlets/Sites/RemoveSPOWeb.cs +++ b/Cmdlets/Sites/RemoveSPOWeb.cs @@ -70,18 +70,27 @@ private void Delete(Web web) } if (web.Webs.Count > 0) { + var toDelete = new List(); + foreach (Web childWeb in web.Webs) + { + toDelete.Add(childWeb); + } + + foreach (Web childWeb in toDelete) { Delete(childWeb); } if (web.Webs.Count == 0) { + try { WriteVerbose("Deleting " + web.Url); } catch { } web.DeleteObject(); web.Context.ExecuteQuery(); } } else { + try { WriteVerbose("Deleting " + web.Url); } catch { } web.DeleteObject(); web.Context.ExecuteQuery(); } diff --git a/Lapointe.SharePointOnline.PowerShell.dll-help.xml b/Lapointe.SharePointOnline.PowerShell.dll-help.xml index 96a5cd1..8ea302b 100644 --- a/Lapointe.SharePointOnline.PowerShell.dll-help.xml +++ b/Lapointe.SharePointOnline.PowerShell.dll-help.xml @@ -15,7 +15,7 @@ Connect SPOSite - 1.3.0.0 + 1.3.1.0 The Connect-SPOSite cmdlet connects a SharePoint Online user to the specified SharePoint Online Site Collection. @@ -147,10 +147,10 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr - Remove-SPOContentType - Content Types + Invoke-SPORestMethod + General - Adds a new content type to an existing List. + Sends an HTTP or HTTPS request to a SharePoint Online REST-compliant web service. Copyright 2016 Falchion Consulting, LLC @@ -159,12 +159,14 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Remove - SPOContentType - 1.3.0.0 + Invoke + SPORestMethod + 1.3.1.0 - Adds a new content type to an existing List. + This function sends an HTTP or HTTPS request to a Representational State Transfer (REST)-compliant ("RESTful") SharePoint Online web service. The Connect-SPOSite cmdlet must be run first in order to set the credentials for the environment. + + Some source code for this cmdlet was referenced from http://blog.vgrem.com/2014/02/27/working-with-the-sharepoint-online-rest-service-via-powershell/. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -174,62 +176,148 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr - Remove-SPOContentType + Invoke-SPORestMethod - Web - SPOWebPipeBind + Url + UrlPipeBind - List - SPOListPipeBind + Method + Default | Get | Head | Post | Put | Delete | Trace | Options | Merge | Patch - - ContentType - SPOContentTypePipeBind + + Body + Object + + + RequestDigest + String + + + ETag + String + + + XHTTPMethod + Default | Get | Head | Post | Put | Delete | Trace | Options | Merge | Patch + + + JSONVerbosity + String + + + OutFile + String - Web + Url - Specifies the identity of the Site containing the Content Type or List containing the Content Type to remove the Content Type from. - - The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. + The REST endpoint URL to call. - SPOWebPipeBind + UrlPipeBind - SPOWebPipeBind + UrlPipeBind - - List + + Method - Specifies the List to remove the Content Type from. - - The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. + Specifies the method used for the web request. The default value is "Get". - SPOListPipeBind + WebRequestMethod - SPOListPipeBind + WebRequestMethod - - ContentType + + Body - Sets a value that specifies the Content Type to remove. The type must be a valid name, Content Type ID, Microsoft.SharePoint.Client.ContentType object or SPOContentType object. + Specifies the body of the request. The body is the content of the request that follows the headers. You can also pipe a body value to Invoke-SPORestMethod. - SPOContentTypePipeBind + Object - SPOContentTypePipeBind + Object + + + + + + + + RequestDigest + + The "X-RequestDigest" header to set. This is most commonly used to provide the form digest variable. Use "(Invoke-SPORestMethod -Url "https://contoso.sharepoint.com/_api/contextinfo" -Method "Post").GetContextWebInformation.FormDigestValue" to get the Form Digest value. + + String + + String + + + + + + + + ETag + + The "If-Match" header to set. Provide this to make sure you are not overwritting an item that has changed since you retrieved it. + + String + + String + + + + + + + + XHTTPMethod + + To work around the fact that many firewalls and other network intermediaries block HTTP verbs other than GET and POST, specify PUT, DELETE, or MERGE requests for -XHTTPMethod with a POST value for -Method. + + WebRequestMethod + + WebRequestMethod + + + + + + + + JSONVerbosity + + The OData verbosity of the data to return. Valid values are "Verbose", "MinimalMetadata", and "NoMetadata". + + String + + String + + + + + + + + OutFile + + If the returned data is a binary data object such as a file from a SharePoint site specify the output file name to save the data to. + + String + + String @@ -264,15 +352,16 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr - For more information, type "Get-Help Remove-SPOContentType -detailed". For technical information, type "Get-Help Remove-SPOContentType -full". + For more information, type "Get-Help Invoke-SPORestMethod -detailed". For technical information, type "Get-Help Invoke-SPORestMethod -full". ------------------EXAMPLE------------------ - PS C:\> Remove-SPOContentType -Web "/" -List "Documents" -ContentType "My Content Type" + PS C:\> Connect-SPOSite -Url "https://contoso.sharepoint.com/" -Credential "admin@contoso.com" +PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - This example removes a content type with the name of My Content Type from the Documents list. + This example invokes the REST call at https://contoso.sharepoint.com/_api/web. @@ -281,14 +370,18 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr Connect-SPOSite + + Disconnect-SPOSite + + - Add-SPOContentType - Content Types + Disconnect-SPOSite + General - Adds a new content type to an existing List. + Disconnects from a SharePoint Online site. Copyright 2016 Falchion Consulting, LLC @@ -297,12 +390,16 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Add - SPOContentType - 1.3.0.0 + Disconnect + SPOSite + 1.3.1.0 - Adds a new content type to an existing List. + The Disconnect-SPOSite cmdlet explicitly disconnects a previously created SharePoint Online site connection. + + You can disconnect the site by running the Disconnect-SPOSite cmdlet or by running the Connect-SPOSite cmdlet to initiate another connection. For more information, see Connect-SPOSite. + + Even after a connection is terminated, operations that were started before the connection is terminated will run to completion. In other words, long-running operations will not be terminated by running the Disconnect-SPOSite cmdlet or the Connect-SPOSite cmdlet. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -310,71 +407,7 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - - - Add-SPOContentType - - Web - SPOWebPipeBind - - - List - SPOListPipeBind - - - ContentType - SPOContentTypePipeBind - - - - - - Web - - Specifies the identity of the Site containing the List to create the new Content Type within. - - The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. - - SPOWebPipeBind - - SPOWebPipeBind - - - - - - - - List - - Specifies the List to add the Content Type to. - - The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. - - SPOListPipeBind - - SPOListPipeBind - - - - - - - - ContentType - - Sets a value that specifies the Content Type that the new Content Type will inherit from. The type must be a valid name, Content Type ID, Microsoft.SharePoint.Client.ContentType object or SPOContentType object. - - SPOContentTypePipeBind - - SPOContentTypePipeBind - - - - - - - + @@ -402,15 +435,15 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr - For more information, type "Get-Help Add-SPOContentType -detailed". For technical information, type "Get-Help Add-SPOContentType -full". + For more information, type "Get-Help Disconnect-SPOSite -detailed". For technical information, type "Get-Help Disconnect-SPOSite -full". ------------------EXAMPLE------------------ - PS C:\> Add-SPOContentType -Web "/" -List "Documents" -ContentType "My Content Type" + PS C:\> Disconnect-SPOSite - This example adds a content type with the name of My Content Type to the Documents list. + This example explicitly disconnects a previously created SharePoint Online service connection. @@ -423,10 +456,10 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr - Get-SPOContentType - Content Types + Add-SPOListViewWebPart + Web Parts - Retrieves the Content Types for the Site or List. + Adds a web part to a web part page or wiki page. Copyright 2016 Falchion Consulting, LLC @@ -435,12 +468,12 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Get - SPOContentType - 1.3.0.0 + Add + SPOListViewWebPart + 1.3.1.0 - Retrieves the Content Types for the Site or List. + Adds a web part to a web part page or wiki page. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -450,41 +483,103 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr - Get-SPOContentType + Add-SPOListViewWebPart + + Zone + String + + + ZoneIndex + Int32 + Web SPOWebPipeBind - - Identity + + File + SPOFilePipeBind + + + List + SPOListPipeBind + + + ViewTitle + String + + + ViewSchema + XmlDocumentPipeBind + + + Title + String + + + JSLink String + + ChromeType + Default | TitleAndBorder | None | TitleOnly | BorderOnly + - Get-SPOContentType + Add-SPOListViewWebPart + + Row + Int32 + + + Column + Int32 + + + AddSpace + SwitchParameter + Web SPOWebPipeBind + + File + SPOFilePipeBind + List SPOListPipeBind - - Identity + + ViewTitle + String + + + ViewSchema + XmlDocumentPipeBind + + + Title + String + + + JSLink String + + ChromeType + Default | TitleAndBorder | None | TitleOnly | BorderOnly + Web - Specifies the identity of the Site whose Content Types will be retrieved. + Specifies the identity of the Site containing the file to add the web part to. The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. - - If not specified then the current Site Collection's Event Receiver Definitions will be retrieved. SPOWebPipeBind @@ -495,10 +590,26 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr - + + File + + Specifies the file to add the web part to. + + The type must be a valid server relative URL, in the form /site_name/list_name/file_name, or an SPOFile or SPOWikiPage object, or Microsoft.SharePoint.Client.File object. + + SPOFilePipeBind + + SPOFilePipeBind + + + + + + + List - Specifies the identity of the List whose Content Types will be retrieved. + The list to whose view will be added to the page. The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. @@ -511,10 +622,122 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr - - Identity + + ViewTitle - The name or ID of the Content Type to retrieve. + The name of the view to use for the list view web part. + + String + + String + + + + + + + + ViewSchema + + The view schema to apply. + + XmlDocumentPipeBind + + XmlDocumentPipeBind + + + + + + + + Title + + The title of the web part to add. + + String + + String + + + + + + + + Zone + + The zone to add the web part to. + + String + + String + + + + + + + + ZoneIndex + + The zone index to add the web part to. + + Int32 + + Int32 + + + + + + + + Row + + The zone to add the web part to. + + Int32 + + Int32 + + + + + + + + Column + + The zone index to add the web part to. + + Int32 + + Int32 + + + + + + + + AddSpace + + Add some space before the web part. + + SwitchParameter + + SwitchParameter + + + + + + + + JSLink + + Set a specific JSLink file. String @@ -525,6 +748,20 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr + + ChromeType + + The chrome settings for the web part. + + PartChromeType + + PartChromeType + + + + + + @@ -553,22 +790,22 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr - For more information, type "Get-Help Get-SPOContentType -detailed". For technical information, type "Get-Help Get-SPOContentType -full". + For more information, type "Get-Help Add-SPOListViewWebPart -detailed". For technical information, type "Get-Help Add-SPOListViewWebPart -full". ------------------EXAMPLE 1----------------------- - PS C:\> Get-SPOContentType -Web "/" + PS C:\> Add-SPOListViewWebPart -Web "/" -File "/default.aspx" -WebPart "c:\announcements.webpart" -Title "Announcements" -Zone "MiddleColumn" -ZoneIndex 1 - Retrieves all the Content Types for the root Site of the current Site Collection. + This example adds an announcements web part to the default.aspx web part page located in the root web of the root site collection. ------------------EXAMPLE 2----------------------- - PS C:\> Get-SPOContentType -Web "/" -Identity "Document" + PS C:\> Add-SPOListViewWebPart -Web "/" -File "/sitepages/home.aspx" -WebPart "c:\announcements.webpart" -Row 1 -Column 1 -AddSpace - Retrieves the Document Content Types from the root Site of the current Site Collection. + This example adds an announcements web part to the home.aspx wiki page located in the root web of the root site collection. @@ -577,14 +814,18 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr Connect-SPOSite + + Get-SPOFile + + - New-SPOContentType - Content Types + Add-SPOWebPart + Web Parts - Creates a new content type within an existing Site or List. + Adds a web part to a web part page or wiki page. Copyright 2016 Falchion Consulting, LLC @@ -593,12 +834,12 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - New - SPOContentType - 1.3.0.0 + Add + SPOWebPart + 1.3.1.0 - Creates a new content type within an existing Site or List. + Adds a web part to a web part page or wiki page. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -608,30 +849,61 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr - New-SPOContentType + Add-SPOWebPart + + Zone + String + + + ZoneIndex + Int32 + Web SPOWebPipeBind - - Name - String + + File + SPOFilePipeBind - - Description - String + + WebPart + XmlDocumentPipeBind - Group + Title String - - ParentContentType - SPOContentTypePipeBind + + + Add-SPOWebPart + + Row + Int32 - - FieldsToAdd - String[] + + Column + Int32 + + + AddSpace + SwitchParameter + + + Web + SPOWebPipeBind + + + File + SPOFilePipeBind + + + WebPart + XmlDocumentPipeBind + + + Title + String @@ -639,7 +911,7 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr Web - Specifies the identity of the Site to create the new Content Type within. + Specifies the identity of the Site containing the file to add the web part to. The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. @@ -652,28 +924,30 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr - - Name + + File - Specifies the name of the new Content Type. + Specifies the file to add the web part to. + + The type must be a valid server relative URL, in the form /site_name/list_name/file_name, or an SPOFile or SPOWikiPage object, or Microsoft.SharePoint.Client.File object. - String + SPOFilePipeBind - String + SPOFilePipeBind - - Description + + WebPart - Describes the new Content Type. If no description is specified, the entry is left blank. + The web part XML file to add to the page. - String + XmlDocumentPipeBind - String + XmlDocumentPipeBind @@ -681,9 +955,9 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr - Group + Title - Describes the new Content Type. If no description is specified, the entry is left blank. + The title of the web part to add. String @@ -695,27 +969,69 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr - ParentContentType + Zone - Sets a value that specifies the Content Type that the new Content Type will inherit from. The type must be a valid name, Content Type ID, Microsoft.SharePoint.Client.ContentType object or SPOContentType object. + The zone to add the web part to. - SPOContentTypePipeBind + String - SPOContentTypePipeBind + String - - FieldsToAdd + + ZoneIndex - An array of internal field names to add to the content type. + The zone index to add the web part to. - String[] + Int32 - String[] + Int32 + + + + + + + + Row + + The zone to add the web part to. + + Int32 + + Int32 + + + + + + + + Column + + The zone index to add the web part to. + + Int32 + + Int32 + + + + + + + + AddSpace + + Add some space before the web part. + + SwitchParameter + + SwitchParameter @@ -750,15 +1066,22 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr - For more information, type "Get-Help New-SPOContentType -detailed". For technical information, type "Get-Help New-SPOContentType -full". + For more information, type "Get-Help Add-SPOWebPart -detailed". For technical information, type "Get-Help Add-SPOWebPart -full". - ------------------EXAMPLE------------------ - PS C:\> New-SPOContentType -Web "/" -Name "My Content Type" -ParentContentType $contentType + ------------------EXAMPLE 1----------------------- + PS C:\> Add-SPOWebPart -Web "/" -File "/default.aspx" -WebPart "c:\announcements.webpart" -Title "Announcements" -Zone "MiddleColumn" -ZoneIndex 1 - This example creates a new content type with the name of My Content Type under the root Site of the current Site Collection. + This example adds an announcements web part to the default.aspx web part page located in the root web of the root site collection. + + + + ------------------EXAMPLE 2----------------------- + PS C:\> Add-SPOWebPart -Web "/" -File "/sitepages/home.aspx" -WebPart "c:\announcements.webpart" -Row 1 -Column 1 -AddSpace + + This example adds an announcements web part to the home.aspx wiki page located in the root web of the root site collection. @@ -767,14 +1090,18 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr Connect-SPOSite + + Get-SPOFile + + - Invoke-SPORestMethod - General + Get-SPOWebPart + Web Parts - Sends an HTTP or HTTPS request to a SharePoint Online REST-compliant web service. + Gets a web part or list of web parts from a web part page or wiki page. Copyright 2016 Falchion Consulting, LLC @@ -783,14 +1110,12 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Invoke - SPORestMethod - 1.3.0.0 + Get + SPOWebPart + 1.3.1.0 - This function sends an HTTP or HTTPS request to a Representational State Transfer (REST)-compliant ("RESTful") SharePoint Online web service. The Connect-SPOSite cmdlet must be run first in order to set the credentials for the environment. - - Some source code for this cmdlet was referenced from http://blog.vgrem.com/2014/02/27/working-with-the-sharepoint-online-rest-service-via-powershell/. + Gets a web part or list of web parts from a web part page or wiki page. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -800,148 +1125,54 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr - Invoke-SPORestMethod - - Url - UrlPipeBind - - - Method - Default | Get | Head | Post | Put | Delete | Trace | Options | Merge | Patch - - - Body - Object - + Get-SPOWebPart - RequestDigest - String - - - ETag - String - - - XHTTPMethod - Default | Get | Head | Post | Put | Delete | Trace | Options | Merge | Patch - - - JSONVerbosity - String - - - OutFile + Title String - Url + Web - The REST endpoint URL to call. + Specifies the identity of the Site containing the file to get the web part from. + + The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. - UrlPipeBind + SPOWebPipeBind - UrlPipeBind + SPOWebPipeBind - - Method + + File - Specifies the method used for the web request. The default value is "Get". + Specifies the file to get the web part from. + + The type must be a valid server relative URL, in the form /site_name/list_name/file_name, or an SPOFile or SPOWikiPage object, or Microsoft.SharePoint.Client.File object. - WebRequestMethod + SPOFilePipeBind - WebRequestMethod + SPOFilePipeBind - - Body + + Title - Specifies the body of the request. The body is the content of the request that follows the headers. You can also pipe a body value to Invoke-SPORestMethod. + The title of the web part to add. - Object + String - Object - - - - - - - - RequestDigest - - The "X-RequestDigest" header to set. This is most commonly used to provide the form digest variable. Use "(Invoke-SPORestMethod -Url "https://contoso.sharepoint.com/_api/contextinfo" -Method "Post").GetContextWebInformation.FormDigestValue" to get the Form Digest value. - - String - - String - - - - - - - - ETag - - The "If-Match" header to set. Provide this to make sure you are not overwritting an item that has changed since you retrieved it. - - String - - String - - - - - - - - XHTTPMethod - - To work around the fact that many firewalls and other network intermediaries block HTTP verbs other than GET and POST, specify PUT, DELETE, or MERGE requests for -XHTTPMethod with a POST value for -Method. - - WebRequestMethod - - WebRequestMethod - - - - - - - - JSONVerbosity - - The OData verbosity of the data to return. Valid values are "Verbose", "MinimalMetadata", and "NoMetadata". - - String - - String - - - - - - - - OutFile - - If the returned data is a binary data object such as a file from a SharePoint site specify the output file name to save the data to. - - String - - String + String @@ -976,16 +1207,22 @@ PS C:\> Connect-SPOSite -Url "http://contoso.sharepoint.com/" -Credential $cr - For more information, type "Get-Help Invoke-SPORestMethod -detailed". For technical information, type "Get-Help Invoke-SPORestMethod -full". + For more information, type "Get-Help Get-SPOWebPart -detailed". For technical information, type "Get-Help Get-SPOWebPart -full". - ------------------EXAMPLE------------------ - PS C:\> Connect-SPOSite -Url "https://contoso.sharepoint.com/" -Credential "admin@contoso.com" -PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" + ------------------EXAMPLE 1----------------------- + PS C:\> Add-SPOWebPart -Web "/" -File "/default.aspx" -WebPart "c:\announcements.webpart" -Title "Announcements" -Zone "MiddleColumn" -ZoneIndex 1 - This example invokes the REST call at https://contoso.sharepoint.com/_api/web. + This example adds an announcements web part to the default.aspx web part page located in the root web of the root site collection. + + + + ------------------EXAMPLE 2----------------------- + PS C:\> Add-SPOWebPart -Web "/" -File "/sitepages/home.aspx" -WebPart "c:\announcements.webpart" -Row 1 -Column 1 -AddSpace + + This example adds an announcements web part to the home.aspx wiki page located in the root web of the root site collection. @@ -995,17 +1232,17 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Disconnect-SPOSite + Get-SPOFile - Disconnect-SPOSite - General + Get-SPOTermStore + Managed Metadata - Disconnects from a SharePoint Online site. + Retrieves a Term Store object. Copyright 2016 Falchion Consulting, LLC @@ -1014,16 +1251,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Disconnect - SPOSite - 1.3.0.0 + Get + SPOTermStore + 1.3.1.0 - The Disconnect-SPOSite cmdlet explicitly disconnects a previously created SharePoint Online site connection. - - You can disconnect the site by running the Disconnect-SPOSite cmdlet or by running the Connect-SPOSite cmdlet to initiate another connection. For more information, see Connect-SPOSite. - - Even after a connection is terminated, operations that were started before the connection is terminated will run to completion. In other words, long-running operations will not be terminated by running the Disconnect-SPOSite cmdlet or the Connect-SPOSite cmdlet. + Retrieves a Term Store object. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -1031,7 +1264,31 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - + + + Get-SPOTermStore + + Identity + SPOTermStorePipeBind + + + + + + Identity + + The taxonomy term store to retrieve. The type must be a valid TermStore object, name, GUID, or index location. + + SPOTermStorePipeBind + + SPOTermStorePipeBind + + + + + + + @@ -1059,31 +1316,31 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help Disconnect-SPOSite -detailed". For technical information, type "Get-Help Disconnect-SPOSite -full". + For more information, type "Get-Help Get-SPOTermStore -detailed". For technical information, type "Get-Help Get-SPOTermStore -full". ------------------EXAMPLE------------------ - PS C:\> Disconnect-SPOSite + PS C:\> Get-SPOTermStore -Identity "My Group" - This example explicitly disconnects a previously created SharePoint Online service connection. + This example retrieves a single term group. - Connect-SPOSite + Export-SPOTaxonomy - Get-SPOEventReceiver - Event Receivers + New-SPOTermSet + Managed Metadata - Retrieves the Event Receivers for the Site Collection or a specific Site. + Creates a Term Set object. Copyright 2016 Falchion Consulting, LLC @@ -1092,12 +1349,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Get - SPOEventReceiver - 1.3.0.0 + New + SPOTermSet + 1.3.1.0 - If the -Web parameter is not provided then the Site Collection scoped Event Receivers are returned; otherwise, the Site scoped Event Receivers for a given Site are returned. + Creates a Term Set object. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -1107,165 +1364,166 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Get-SPOEventReceiver - - Web - SPOWebPipeBind + New-SPOTermSet + + Group + SPOTermGroupPipeBind + + + Name + String + + + Id + Guid + + + Description + String + + + Contact + String + + + CustomSortOrder + String + + + IsAvailableForTagging + SwitchParameter + + + Owner + String + + + IsOpenForTermCreation + SwitchParameter + + + LCID + Int32 - - Web + + Group - Specifies the identity of the Site whose Event Receiver Definitions will be retrieved. - - The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. - - If not specified then the current Site Collection's Event Receiver Definitions will be retrieved. + The Term Group to add the Term Set to. The type must be a valid TermGroup object, SPOTermGroup object, name, or GUID. - SPOWebPipeBind + SPOTermGroupPipeBind - SPOWebPipeBind + SPOTermGroupPipeBind - - - + + Name + + The name of the term set to create. + + String - + String - - - - + + + Id + + The Id of the term set to create. + + Guid - + Guid - - - - - - - - For more information, type "Get-Help Get-SPOEventReceiver -detailed". For technical information, type "Get-Help Get-SPOEventReceiver -full". - - - - - ------------------EXAMPLE 1----------------------- - PS C:\> Get-SPOEventReceiver -Web "/" - - Retrieves all Site scoped Event Receivers for the root Site. - - - - ------------------EXAMPLE 2----------------------- - PS C:\> Get-SPOEventReceiver - - Retrieves all Site Collection scoped Event Receivers. - - - - - - Connect-SPOSite - - - - - - - Disable-SPOFeature - Features - - Disables a Feature within the current Site Collection or a specific Site. - - - Copyright 2016 Falchion Consulting, LLC - > For more information on this cmdlet and others: - > http://blog.falchionconsulting.com/ - > Use of this cmdlet is at your own risk. - > Gary Lapointe assumes no liability. - - Disable - SPOFeature - 1.3.0.0 - - - If the -Web parameter is not provided then a Site Collection scoped Feature will be disabled; otherwise, a Site scoped Feature for a given Site will be disabled. - - Copyright 2016 Falchion Consulting, LLC - > For more information on this cmdlet and others: - > http://blog.falchionconsulting.com/ - > Use of this cmdlet is at your own risk. - > Gary Lapointe assumes no liability. - - - - Disable-SPOFeature - - Web - SPOWebPipeBind - - - Identity - Guid - - - Force - SwitchParameter - - - - - - Web + + + Description - Specifies the identity of the Site where the specified Feature will be deactivated. - - The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. + The description of the term set to create. - SPOWebPipeBind + String - SPOWebPipeBind + String - - Identity + + Contact - + The contact for the Term Set object. - Guid + String - Guid + String - - Force + + CustomSortOrder - + The custom sort order of the Term Set object. + + String + + String + + + + + + + + IsAvailableForTagging + + If specified, the Term Set object should appear in the tagging user interface. + + SwitchParameter + + SwitchParameter + + + + + + + + Owner + + The user who is responsible for the current TermSet. + + String + + String + + + + + + + + IsOpenForTermCreation + + If specified, the Term Set can be updated by all users; otherwise, just by the specified constributors for the Group object. SwitchParameter @@ -1276,6 +1534,20 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" + + LCID + + The language code identifier (LCID). + + Int32 + + Int32 + + + + + + @@ -1304,42 +1576,31 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help Disable-SPOFeature -detailed". For technical information, type "Get-Help Disable-SPOFeature -full". + For more information, type "Get-Help New-SPOTermSet -detailed". For technical information, type "Get-Help New-SPOTermSet -full". - ------------------EXAMPLE 1----------------------- - PS C:\> Disable-SPOFeature -Web "/" -Identity "{7AF6EA6F-2079-4310-B964-210A87F0D5A1}" - - Disables a Site scoped Feature on the root Site. - - - - ------------------EXAMPLE 2----------------------- - PS C:\> Disable-SPOFeature -Identity "{7AF6EA6F-2079-4310-B964-210A87F0D5A1}" + ------------------EXAMPLE------------------ + PS C:\> New-SPOTermSet -Group "My Group" -Name "My Term Set" - Disables a Site Collection scoped Feature. + This example creates a single term set. - Connect-SPOSite - - - - Enable-SPOFeature + Export-SPOTaxonomy - Enable-SPOFeature - Features + Get-SPOTerm + Managed Metadata - Enables a Feature within the current Site Collection or a specific Site. + Retrieves a Term or Terms matching the specified criteria. Copyright 2016 Falchion Consulting, LLC @@ -1348,12 +1609,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Enable - SPOFeature - 1.3.0.0 + Get + SPOTerm + 1.3.1.0 - If the -Web parameter is not provided then a Site Collection scoped Feature will be enabled; otherwise, a Site scoped Feature for a given Site will be enabled. + Retrieves a Term or Terms matching the specified criteria. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -1363,46 +1624,56 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Enable-SPOFeature - - Web - SPOWebPipeBind - - + Get-SPOTerm + Identity - Guid + String + + + StringMatchOption + StartsWith | ExactMatch - Force + DefaultLabelOnly + SwitchParameter + + + TrimUnavailable + SwitchParameter + + + TrimDeprecated SwitchParameter + + ResultCollectionSize + Int32 + - - Web + + Identity - Specifies the identity of the Site where the specified Feature will be activated. - - The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. + The Term to retrieve. - SPOWebPipeBind + String - SPOWebPipeBind + String - - Identity + + StringMatchOption - + Retrieve terms that match the value exactly or just start with the value. The default value is ExactMatch. - Guid + StringMatchOption - Guid + StringMatchOption @@ -1410,9 +1681,9 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Force + DefaultLabelOnly - + If specified,only default labels should be matched against in the search. SwitchParameter @@ -1423,129 +1694,42 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - - + + TrimUnavailable + + If specified, trim Terms that are unavailable. + + SwitchParameter - + SwitchParameter - - - - + + + TrimDeprecated + + If specified, trim out Term objects that have Term.IsDeprecated set to true. + + SwitchParameter - - - - - - - - - - - - - - For more information, type "Get-Help Enable-SPOFeature -detailed". For technical information, type "Get-Help Enable-SPOFeature -full". - - - - - ------------------EXAMPLE 1----------------------- - PS C:\> Enable-SPOFeature -Identity "{7AF6EA6F-2079-4310-B964-210A87F0D5A1}" - - Enables a Site Collection scoped Feature. - - - - ------------------EXAMPLE 2----------------------- - PS C:\> Enable-SPOFeature -Web "/" -Identity "{7AF6EA6F-2079-4310-B964-210A87F0D5A1}" - - Enables a Site scoped Feature on the root Site. - - - - - - Connect-SPOSite - - - - Disable-SPOFeature - - - - - - - Get-SPOFeature - Features - - Retrieves the Feature definition IDs for the Site Collection or a specific Site. - - - Copyright 2016 Falchion Consulting, LLC - > For more information on this cmdlet and others: - > http://blog.falchionconsulting.com/ - > Use of this cmdlet is at your own risk. - > Gary Lapointe assumes no liability. - - Get - SPOFeature - 1.3.0.0 - - - If the -Web parameter is not provided then the Site Collection scoped Feature definition IDs are returned; otherwise, the Site scoped Feature definition IDs for a given Site are returned. - - Copyright 2016 Falchion Consulting, LLC - > For more information on this cmdlet and others: - > http://blog.falchionconsulting.com/ - > Use of this cmdlet is at your own risk. - > Gary Lapointe assumes no liability. - - - - Get-SPOFeature - - Web - SPOWebPipeBind - - - Identity - Guid - - - - - - Web - - Specifies the identity of the Site whose site-scoped Features will be retrieved. - - The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. - - SPOWebPipeBind - - SPOWebPipeBind + SwitchParameter - - Identity + + ResultCollectionSize - + Indicates the maximum number of objects to include in the returned collection. The default value is 1. - Guid + Int32 - Guid + Int32 @@ -1580,38 +1764,31 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help Get-SPOFeature -detailed". For technical information, type "Get-Help Get-SPOFeature -full". + For more information, type "Get-Help Get-SPOTerm -detailed". For technical information, type "Get-Help Get-SPOTerm -full". - ------------------EXAMPLE 1----------------------- - PS C:\> Get-SPOFeature - - Retrieves all Site Collection scoped Feature definition IDs. - - - - ------------------EXAMPLE 2----------------------- - PS C:\> Get-SPOFeature -Web "/" + ------------------EXAMPLE------------------ + PS C:\> Get-SPOTerm -Identity "My Term" -StringMatchOption "ExactMatch" - Retrieves all Site scoped Feature definition IDs for the root Site. + This example retrieves one or more Terms matching the value My Term. - Connect-SPOSite + Export-SPOTaxonomy - Add-SPOField - Fields + Get-SPOTermSet + Managed Metadata - Adds an existing Field to a List. + Retrieves a Term Set object. Copyright 2016 Falchion Consulting, LLC @@ -1620,12 +1797,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Add - SPOField - 1.3.0.0 + Get + SPOTermSet + 1.3.1.0 - Adds an existing Field to a List. + Retrieves a Term Set object. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -1635,54 +1812,22 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Add-SPOField - + Get-SPOTermSet + Identity - SPOFieldPipeBind + SPOTermSetPipeBind - - Web - - Specifies the identity of the Site containing the List to create the new Content Type within. - - The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. - - SPOWebPipeBind - - SPOWebPipeBind - - - - - - - - List - - Specifies the List to add the Content Type to. - - The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. - - SPOListPipeBind - - SPOListPipeBind - - - - - - - + Identity - Specifies the existing field to add to the list. The type must be a valid GUID, internal field name, or field title. + The TermSet to retrieve. The type must be a valid TermSet object, SPOTermSet object, or GUID. - SPOFieldPipeBind + SPOTermSetPipeBind - SPOFieldPipeBind + SPOTermSetPipeBind @@ -1717,31 +1862,31 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help Add-SPOField -detailed". For technical information, type "Get-Help Add-SPOField -full". + For more information, type "Get-Help Get-SPOTermSet -detailed". For technical information, type "Get-Help Get-SPOTermSet -full". ------------------EXAMPLE------------------ - PS C:\> Add-SPOField -Web "/" -List "Documents" -Identity "My Field" + PS C:\> Get-SPOTermSet -Identity ([guid]"6067b6a8-9866-40db-962d-84097f22619a") - This example adds the field "My Field" to the Documents library. + This example retrieves a single term set. - Connect-SPOSite + Export-SPOTaxonomy - New-SPOField - Fields + Export-SPOTaxonomy + Managed Metadata - Creates a new Field within an existing Site or List. + Export the Managed Metadata Terms. Copyright 2016 Falchion Consulting, LLC @@ -1750,12 +1895,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - New - SPOField - 1.3.0.0 + Export + SPOTaxonomy + 1.3.1.0 - Creates a new Field within an existing Site or List. + Export the Managed Metadata Terms. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -1765,113 +1910,140 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - New-SPOField + Export-SPOTaxonomy - Web - SPOWebPipeBind + Tenant + SwitchParameter - - List - SPOListPipeBind + + OutputFile + String - - SchemaXml - XmlDocumentPipeBind + + + Export-SPOTaxonomy + + TermStore + SPOTermStorePipeBind - - AddToDefaultView - SwitchParameter + + OutputFile + String - - Options - DefaultValue | AddToDefaultContentType | AddToNoContentType | AddToAllContentTypes | AddFieldInternalNameHint | AddFieldToDefaultView | AddFieldCheckDisplayName + + + Export-SPOTaxonomy + + Group + SPOTermGroupPipeBind + + + OutputFile + String - New-SPOField + Export-SPOTaxonomy - Web - SPOWebPipeBind + TermSet + SPOTermSetPipeBind - - SchemaXml - XmlDocumentPipeBind + + OutputFile + String - - Options - DefaultValue | AddToDefaultContentType | AddToNoContentType | AddToAllContentTypes | AddFieldInternalNameHint | AddFieldToDefaultView | AddFieldCheckDisplayName + + + Export-SPOTaxonomy + + Term + SPOTermPipeBind + + + OutputFile + String - - Web + + Tenant - Specifies the identity of the Site to create the new Content Type within. - - The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. + Export all terms for the tenant. - SPOWebPipeBind + SwitchParameter - SPOWebPipeBind + SwitchParameter - - List + + TermStore - Specifies the List to add the Content Type to. - - The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. + The TermStore object containing the terms to export. The type must be a valid TermStore object, name, GUID, or index location. - SPOListPipeBind + SPOTermStorePipeBind - SPOListPipeBind + SPOTermStorePipeBind - - SchemaXml + + Group - Specifies the XML schema of the new Field. + The Group object containing the terms to export. The type must be a valid TermGroup object, SPOTermGroup object, name, or GUID. - XmlDocumentPipeBind + SPOTermGroupPipeBind - XmlDocumentPipeBind + SPOTermGroupPipeBind - - AddToDefaultView + + TermSet - If specified, add the field to the default view. + The TermSet object containing the terms to export. The type must be a valid TermSet object, SPOTermSet object, or GUID. - SwitchParameter + SPOTermSetPipeBind - SwitchParameter + SPOTermSetPipeBind - - Options + + Term - Field creation options. + The Term object containing the terms to export. The type must be a valid Term object or GUID. - AddFieldOptions + SPOTermPipeBind - AddFieldOptions + SPOTermPipeBind + + + + + + + + OutputFile + + The path to the file to save the terms to. + + String + + String @@ -1906,31 +2078,59 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help New-SPOField -detailed". For technical information, type "Get-Help New-SPOField -full". + For more information, type "Get-Help Export-SPOTaxonomy -detailed". For technical information, type "Get-Help Export-SPOTaxonomy -full". - ------------------EXAMPLE------------------ - PS C:\> New-SPOField -Web "/" -SchemaXml $schema -Options "AddFieldInternalNameHint" + ------------------EXAMPLE 1----------------------- + PS C:\> Export-SPOTaxonomy -Tenant -OutputFile "c:\terms.xml" -Verbose - This example creates a new site column using the schema definition stored within $schema. + This example exports the terms for all term stores associated with the tenant and saves to c:\terms.xml. + + + + ------------------EXAMPLE 2----------------------- + PS C:\> Export-SPOTaxonomy -TermStore 0 -OutputFile C:\terms.xml -Verbose + + This example exports the term store at index position zero c:\terms.xml. + + + + ------------------EXAMPLE 3----------------------- + PS C:\> Export-SPOTaxonomy -Group "My Group" -OutputFile C:\terms.xml -Verbose + + This example exports a single group and saves to c:\terms.xml. + + + + ------------------EXAMPLE 4----------------------- + PS C:\> Export-SPOTaxonomy -TermSet ([guid]"6067b6a8-9866-40db-962d-84097f22619a") -OutputFile C:\terms.xml -Verbose + + This example exports a single term set and saves to c:\terms.xml. + + + + ------------------EXAMPLE 5----------------------- + PS C:\> Export-SPOTaxonomy -Term ([guid]"6067b6a8-9866-40db-962d-84097f22619a") -OutputFile C:\terms.xml -Verbose + + This example exports a single term and saves to c:\terms.xml. - Connect-SPOSite + Import-SPOTaxonomy - Download-SPOFile - Lists + Get-SPOTermGroup + Managed Metadata - Downloads a specific File from a given Site. + Retrieves a Term Group object. Copyright 2016 Falchion Consulting, LLC @@ -1939,12 +2139,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Download - SPOFile - 1.3.0.0 + Get + SPOTermGroup + 1.3.1.0 - Download and save a specific file from a Site given the server relative URL to the file. The Site provided by the -Web parameter must correspond to the Site where the file is located or else an argument out of range exception will be thrown. + Retrieves a Term Group object. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -1954,129 +2154,22 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Download-SPOFile - - File - SPOFilePipeBind[] - - - Web - SPOWebPipeBind - - - TargetFolder - String - - - Overwrite - SwitchParameter - - - - Download-SPOFile - - Folder - SPOFolderPipeBind - - - Recursive - SwitchParameter - - - Web - SPOWebPipeBind - - - TargetFolder - String - - - Overwrite - SwitchParameter + Get-SPOTermGroup + + Identity + SPOTermGroupPipeBind - - Web - - Specifies the identity of the Site containing the File(s) to retrieve. - - The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. - - SPOWebPipeBind - - SPOWebPipeBind - - - - - - - - File - - The server relative URL(s) to the file(s) to retrieve. - - SPOFilePipeBind[] - - SPOFilePipeBind[] - - - - - - - - Folder - - The path to the folder to save. - - SPOFolderPipeBind - - SPOFolderPipeBind - - - - - - - - Recursive - - Save all child folders and their files. - - SwitchParameter - - SwitchParameter - - - - - - - - TargetFolder - - The path to the folder to save the files to. - - String - - String - - - - - - - - Overwrite + + Identity - Overwrite existing files. + The taxonomy group to retrieve. The type must be a valid TermGroup object, SPOTermGroup object, name, or GUID. - SwitchParameter + SPOTermGroupPipeBind - SwitchParameter + SPOTermGroupPipeBind @@ -2111,31 +2204,31 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help Download-SPOFile -detailed". For technical information, type "Get-Help Download-SPOFile -full". + For more information, type "Get-Help Get-SPOTermGroup -detailed". For technical information, type "Get-Help Get-SPOTermGroup -full". ------------------EXAMPLE------------------ - PS C:\> Download-SPOFile -Web "/" -File "/Shared Documents/MyFile.docx" -TargetFolder "c:\temp" -Overwrite + PS C:\> Get-SPOTermGroup -Identity "My Group" - Downloads the file MyFile.docx from the Documents library within the root Site of the current Site Collection and saves to the c:\temp folder. + This example retrieves a single term group. - Connect-SPOSite + Export-SPOTaxonomy - New-SPOListFolder - Lists + Import-SPOTaxonomy + Managed Metadata - Creates a Folder in a list or library. + Import the Managed Metadata Terms. Copyright 2016 Falchion Consulting, LLC @@ -2144,12 +2237,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - New - SPOListFolder - 1.3.0.0 + Import + SPOTaxonomy + 1.3.1.0 - Creates a folder in the specified list. The Site provided by the -Web parameter must correspond to the Site where the folder and List is located or else an argument out of range exception will be thrown. + Import the Managed Metadata Terms. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -2159,62 +2252,140 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - New-SPOListFolder + Import-SPOTaxonomy - Web - SPOWebPipeBind + Tenant + SwitchParameter - - List - SPOListPipeBind + + InputFile + XmlDocumentPipeBind - - ListRelativeUrlFolderPath - String + + + Import-SPOTaxonomy + + ParentTermStore + SPOTermStorePipeBind + + + InputFile + XmlDocumentPipeBind + + + + Import-SPOTaxonomy + + ParentGroup + SPOTermGroupPipeBind + + + InputFile + XmlDocumentPipeBind + + + + Import-SPOTaxonomy + + ParentTermSet + SPOTermSetPipeBind + + + InputFile + XmlDocumentPipeBind + + + + Import-SPOTaxonomy + + ParentTerm + SPOTermPipeBind + + + InputFile + XmlDocumentPipeBind - - Web + + Tenant - Specifies the identity of the Site containing the List to add the item to. - - The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. + Import all terms for the tenant. - SPOWebPipeBind + SwitchParameter - SPOWebPipeBind + SwitchParameter - - List + + ParentTermStore - Specifies the List to add the item to. - - The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. + The TermStore object to import Groups into. The type must be a valid TermStore object, name, GUID, or index location. - SPOListPipeBind + SPOTermStorePipeBind - SPOListPipeBind + SPOTermStorePipeBind - - ListRelativeUrlFolderPath + + ParentGroup - Create the item within a subfolder inside the list. Only include the path relative to the root of the list. + The Group object to import Term Sets into. The type must be a valid TermGroup object, SPOTermGroup object, name, or GUID. - String + SPOTermGroupPipeBind - String + SPOTermGroupPipeBind + + + + + + + + ParentTermSet + + The TermSet object to import Terms into. The type must be a valid TermSet object or GUID. + + SPOTermSetPipeBind + + SPOTermSetPipeBind + + + + + + + + ParentTerm + + The Term object to import Terms into. The type must be a valid Term object or GUID. + + SPOTermPipeBind + + SPOTermPipeBind + + + + + + + + InputFile + + The path to the file containing the terms to import or an XmlDocument object or XML string. + + XmlDocumentPipeBind + + XmlDocumentPipeBind @@ -2249,31 +2420,59 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help New-SPOListFolder -detailed". For technical information, type "Get-Help New-SPOListFolder -full". + For more information, type "Get-Help Import-SPOTaxonomy -detailed". For technical information, type "Get-Help Import-SPOTaxonomy -full". - ------------------EXAMPLE------------------ - PS C:\> New-SPOListFolder -Web "/" -List "Documents" -ListRelativeUrlFolderPath "My Top Level Folder/My Sub-Folder" + ------------------EXAMPLE 1----------------------- + PS C:\> Import-SPOTaxonomy -Tenant -InputFile "c:\terms.xml" - Creates the folders "My Top Level Folder/My Sub-Folder" in the Documents library within the root Site of the current Site Collection. + This example imports the terms from c:\terms.xml to the Term Store associated with the tenant. + + + + ------------------EXAMPLE 2----------------------- + PS C:\> Import-SPOTaxonomy -ParentTermStore 0 -InputFile C:\terms.xml -Verbose + + This example imports the terms from c:\terms.xml to the Term Store at index position 0. + + + + ------------------EXAMPLE 3----------------------- + PS C:\> Import-SPOTaxonomy -ParentGroup "My Group" -InputFile C:\terms.xml -Verbose + + This example imports the terms from c:\terms.xml to the Group named My Group. + + + + ------------------EXAMPLE 4----------------------- + PS C:\> Import-SPOTaxonomy -ParentTermSet ([guid]"6067b6a8-9866-40db-962d-84097f22619a") -InputFile C:\terms.xml -Verbose + + This example imports the terms from c:\terms.xml to the Term Set with ID "6067b6a8-9866-40db-962d-84097f22619a". + + + + ------------------EXAMPLE 5----------------------- + PS C:\> Import-SPOTaxonomy -ParentTerm ([guid]"6067b6a8-9866-40db-962d-84097f22619a") -InputFile C:\terms.xml -Verbose + + This example imports the terms from c:\terms.xml to the Term with ID "6067b6a8-9866-40db-962d-84097f22619a". - Connect-SPOSite + Export-SPOTaxonomy - Get-SPOFolder - Lists + New-SPOTermGroup + Managed Metadata - Retrieves a specific Folder from a given Site. + Creates a Term Group object. Copyright 2016 Falchion Consulting, LLC @@ -2282,12 +2481,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Get - SPOFolder - 1.3.0.0 + New + SPOTermGroup + 1.3.1.0 - Retrieve a specific SPOFolder object from a Site given the server relative URL to the folder. The Site provided by the -Web parameter must correspond to the Site where the folder is located or else an argument out of range exception will be thrown. + Creates a Term Group object. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -2297,28 +2496,34 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Get-SPOFolder + New-SPOTermGroup - Web - SPOWebPipeBind + TermStore + SPOTermStorePipeBind - Url + Name + String + + + Id + Guid + + + Description String - - Web + + TermStore - Specifies the identity of the Site containing the File to retrieve. - - The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. + The TermStore to add the Term Group to. The type must be a valid TermStore object, name, GUID, or index location. - SPOWebPipeBind + SPOTermStorePipeBind - SPOWebPipeBind + SPOTermStorePipeBind @@ -2326,9 +2531,9 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Url + Name - The server relative URL to the folder to retrieve. + The name of the term group to create. String @@ -2339,6 +2544,34 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" + + Id + + The Id of the term group to create. + + Guid + + Guid + + + + + + + + Description + + The description of the term group to create. + + String + + String + + + + + + @@ -2367,31 +2600,31 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help Get-SPOFolder -detailed". For technical information, type "Get-Help Get-SPOFolder -full". + For more information, type "Get-Help New-SPOTermGroup -detailed". For technical information, type "Get-Help New-SPOTermGroup -full". ------------------EXAMPLE------------------ - PS C:\> Get-SPOFolder -Web "/" -Url "/Shared Documents/My Folder" + PS C:\> New-SPOTermGroup -TermStore 0 -Name "My Group" - Retrieves the folder "My Folder" from the Documents library within the root Site of the current Site Collection. + This example creates a single term group. - Connect-SPOSite + Export-SPOTaxonomy - Get-SPOFile - Lists + Add-SPOSolution + Solutions - Retrieves a specific File from a given Site. + Add a WSP to the Solution Gallery of a Site Collection. Copyright 2016 Falchion Consulting, LLC @@ -2400,12 +2633,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Get - SPOFile - 1.3.0.0 + Add + SPOSolution + 1.3.1.0 - Retrieve a specific SPOFile object from a Site given the server relative URL to the file. The Site provided by the -Web parameter must correspond to the Site where the file is located or else an argument out of range exception will be thrown. + Add a WSP to the Solution Gallery of a Site Collection. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -2415,42 +2648,40 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Get-SPOFile - - Web - SPOWebPipeBind - + Add-SPOSolution - Url + LiteralPath String + + Overwrite + SwitchParameter + - - Web + + LiteralPath - Specifies the identity of the Site containing the File to retrieve. - - The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. + Specify the path to the solution package (WSP) to add to the Solution Gallery. - SPOWebPipeBind + String - SPOWebPipeBind + String - - Url + + Overwrite - The server relative URL to the file to retrieve. + Overwrite an existing file if present. - String + SwitchParameter - String + SwitchParameter @@ -2485,15 +2716,15 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help Get-SPOFile -detailed". For technical information, type "Get-Help Get-SPOFile -full". + For more information, type "Get-Help Add-SPOSolution -detailed". For technical information, type "Get-Help Add-SPOSolution -full". ------------------EXAMPLE------------------ - PS C:\> Get-SPOFile -Web "/" -Url "/Shared Documents/MyFile.docx" + PS C:\> Add-SPOSolution -LiteralPath "c:\customtemplate.wsp" - Retrieves the file MyFile.docx from the Documents library within the root Site of the current Site Collection. + This example uploads a custom Sandbox Solution to the Solution Gallery of the current Site Collection. @@ -2506,10 +2737,10 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - New-SPOFile - Lists + Install-SPOSolution + Solutions - Creates a new list file within an existing List. + Add a WSP to the Solution Gallery of a Site Collection. Copyright 2016 Falchion Consulting, LLC @@ -2518,12 +2749,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - New - SPOFile - 1.3.0.0 + Install + SPOSolution + 1.3.1.0 - Creates a new list file within an existing List. + Add a WSP to the Solution Gallery of a Site Collection. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -2533,105 +2764,26 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - New-SPOFile - - List - SPOListPipeBind - - - Web - SPOWebPipeBind - - - File + Install-SPOSolution + + Identity String - - Overwrite - SwitchParameter - - - FieldValues - PropertiesPipeBind - - - - New-SPOFile - Folder - SPOFolder - - - Web - SPOWebPipeBind - - - File - String - - - Overwrite - SwitchParameter + MajorVersion + Int32 - - FieldValues - PropertiesPipeBind + + MinorVersion + Int32 - - Web - - Specifies the identity of the Site containing the List to add the file to. - - The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. - - SPOWebPipeBind - - SPOWebPipeBind - - - - - - - - List - - Specifies the List to add the file to. - - The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. - - SPOListPipeBind - - SPOListPipeBind - - - - - - - - Folder - - Specifies the Folder to add the file to. - - The type must be a valid SPOFolder object. - - SPOFolder - - SPOFolder - - - - - - - - File + + Identity - Specify the path to the file to add to the list. + Specify the name of the solution package (WSP) to activate. String @@ -2642,28 +2794,28 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - Overwrite + + MajorVersion - Overwrite an existing file if present. + Sets the major version of the WSP. The default value is 1. - SwitchParameter + Int32 - SwitchParameter + Int32 - - FieldValues + + MinorVersion - The collection of field values to set where the key is the internal field name. The type must be a hash table where each key represents the name of a field whose value should be set to the corresponding key value (e.g., @{"Field1"="Value1";"Field2"="Value2"}). Alternatively, provide the path to a file with XML property settings (<Properties><Property Name="Name1">Value1</Property><Property Name="Name2">Value2</Property></Properties>). + Sets the minor version of the WSP. The default value is 0. - PropertiesPipeBind + Int32 - PropertiesPipeBind + Int32 @@ -2698,15 +2850,15 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help New-SPOFile -detailed". For technical information, type "Get-Help New-SPOFile -full". + For more information, type "Get-Help Install-SPOSolution -detailed". For technical information, type "Get-Help Install-SPOSolution -full". ------------------EXAMPLE------------------ - PS C:\> New-SPOFile -Web "/" -List "My List" -File "c:\myfile.txt" -FieldValues @{"Title"="My new file"} + PS C:\> Install-SPOSolution -Identity "customtemplate.wsp" - This example creates a new file within the List My List under the root Site of the current Site Collection. + This example activates a custom Sandbox Solution in the Solution Gallery of the current Site Collection. The WSP will be copied to customtemplate.wsp-v1.0 and this copied version will be activated. @@ -2715,18 +2867,14 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web"Connect-SPOSite - - Get-SPOList - - - Get-SPOList - Lists + Set-SPOWebTheme + Sites - Retrieves the collection of lists or a specific list. + Applies a theme with the specified components to the specified Site. Copyright 2016 Falchion Consulting, LLC @@ -2735,12 +2883,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Get - SPOList - 1.3.0.0 + Set + SPOWebTheme + 1.3.1.0 - If the -List parameter is not provided then all the lists the given Site are returned; otherwise, a single list will be returned matching the identifier provided. + Applies a theme with the specified components to the specified Site. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -2750,26 +2898,34 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Get-SPOList + Set-SPOWebTheme - Web + Identity SPOWebPipeBind - - Identity - SPOListPipeBind + + ColorPaletteUrl + String - Detail - SwitchParameter + FontSchemeUrl + String + + + BackgroundImageUrl + String + + + ShareGenerated + Boolean - Web + Identity - Specifies the identity of the Site containing the List to retrieve. + Specifies the identity of the Site to apply the theme to. The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. @@ -2782,16 +2938,14 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - Identity + + ColorPaletteUrl - Specifies the identity of the List to retrieve. - - The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. + The server relative URL to the color palette file. For example: "/_catalogs/theme/15/palette001.spcolor". - SPOListPipeBind + String - SPOListPipeBind + String @@ -2799,24 +2953,52 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Detail + FontSchemeUrl - Retrieve additional details useful for examining a single object. + The server relative URL to the font file. For example: "/_catalogs/theme/15/fontscheme001.spfont". - SwitchParameter + String - SwitchParameter + String - - - - - + + BackgroundImageUrl + + The server relative URL to the background image file. For example: "/Images/bg.png". + + String + + String + + + + + + + + ShareGenerated + + If specified, store the generated theme files in the root Site, otherwise store them in this Site. + + Boolean + + Boolean + + + + + + + + + + + @@ -2840,22 +3022,15 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help Get-SPOList -detailed". For technical information, type "Get-Help Get-SPOList -full". + For more information, type "Get-Help Set-SPOWebTheme -detailed". For technical information, type "Get-Help Set-SPOWebTheme -full". - ------------------EXAMPLE 1----------------------- - PS C:\> Get-SPOList -Web "/" - - Retrieves all lists for the root Site. - - - - ------------------EXAMPLE 2----------------------- - PS C:\> Get-SPOList -Web "/" -Identity "Shared Documents" + ------------------EXAMPLE------------------ + PS C:\> Set-SPOWebTheme -Web "/" -ColorPaletteUrl "/_catalogs/theme/15/palette001.spcolor" - Retrieves a single list for the given Site. + This example sets the theme of the root Site of the current Site Collection. @@ -2864,14 +3039,18 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web"Connect-SPOSite + + Get-SPOWeb + + - New-SPOList - Lists + Set-SPOWeb + Sites - Creates a new list within an existing Site. + Configures the specified subsite. Copyright 2016 Falchion Consulting, LLC @@ -2880,12 +3059,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - New - SPOList - 1.3.0.0 + Set + SPOWeb + 1.3.1.0 - Creates a new list within an existing Site. + The Set-SPOWeb cmdlet configures the subsite specified by the Identity parameter. Settings for any parameters that are not provided are not changed. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -2895,56 +3074,110 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - New-SPOList - - Web - SPOWebPipeBind - - - Url + Set-SPOWeb + + CustomMasterUrl String - - Title + + MasterUrl String - Description + Title String - CustomSchemaXml + Description String - DocumentTemplateType - Int32 + EnableMinimalDownload + Boolean - QuickLaunchOption - Off | On | DefaultValue + QuickLaunchEnabled + Boolean - TemplateType - Int32 + SaveSiteAsTemplateEnabled + Boolean - TemplateFeatureId - Guid + ServerRelativeUrl + String - DataSourceProperties - Dictionary`2 + SyndicationEnabled + Boolean + + + TreeViewEnabled + Boolean + + + UIVersion + Int32 + + + UIVersionConfigurationEnabled + Boolean + + + AssociatedMemberGroup + SPOGroupPipeBind + + + AssociatedOwnerGroup + SPOGroupPipeBind + + + AssociatedVisitorGroup + SPOGroupPipeBind + + + Identity + SPOWebPipeBind + + + + Set-SPOWeb + + BreakRoleInheritance + SwitchParameter + + + CopyRoleAssignments + SwitchParameter + + + ClearScopes + SwitchParameter + + + Identity + SPOWebPipeBind + + + + Set-SPOWeb + + ResetRoleInheritance + SwitchParameter + + + Identity + SPOWebPipeBind - Web + Identity - Specifies the identity of the Site to create the new List within. + Specifies the identity of the Site to update. - The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. + The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the SIte ID. SPOWebPipeBind @@ -2955,12 +3188,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - Url + + CustomMasterUrl - The URL name of the List to create. If creating a new List at "http://contoso.sharepoint.com/site1/Lists/MyList" then specify a value of "Lists/MyList". + Sets the URL for a custom master page file to apply to the Site. - String + String String @@ -2969,12 +3202,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - Title + + MasterUrl - Specifies the title of the new List. + Sets the URL of the master page that is used for the Site. - String + String String @@ -2984,9 +3217,9 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Description + Title - Describes the new List. If no description is specified, the entry is left blank. + Specifies the new title of the Site. String @@ -2998,9 +3231,9 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - CustomSchemaXml + Description - Sets a value that specifies the List schema of the new List. + Specifies the new description of the Site. String @@ -3012,13 +3245,13 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - DocumentTemplateType + EnableMinimalDownload - Sets a value that specifies the identifier of the document template for the new List. + Sets a Boolean value that specifies whether the Site should use Minimal Download Strategy. - Int32 + Boolean - Int32 + Boolean @@ -3026,13 +3259,13 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - QuickLaunchOption + QuickLaunchEnabled - Sets a value that specifies whether the new List is displayed on the Quick Launch of the Site. + Sets a value that specifies whether the Quick Launch area is enabled on the Site. - QuickLaunchOptions + Boolean - QuickLaunchOptions + Boolean @@ -3040,13 +3273,13 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - TemplateType + SaveSiteAsTemplateEnabled - Sets a value that specifies the List server template of the new List. + Sets a Boolean value that specifies whether the Site can be saved as a Site template. - Int32 + Boolean - Int32 + Boolean @@ -3054,13 +3287,13 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - TemplateFeatureId + ServerRelativeUrl - Sets a value that specifies the Feature identifier of the Feature that contains the List schema for the new List. + Specifies the new relative URL for the Site. This is the URL path after the site collection URL. - Guid + String - Guid + String @@ -3068,145 +3301,111 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - DataSourceProperties + SyndicationEnabled - Sets a value that specifies the properties of the data source of the new List. + Sets a Boolean value that specifies whether the RSS feeds are enabled on the Site. - Dictionary`2 + Boolean - Dictionary`2 + Boolean - - - + + TreeViewEnabled + + Sets a Boolean value that specifies whether the tree view is enabled on the Site. + + Boolean - + Boolean - - - - + + + UIVersion + + Sets the user interface (UI) version of the Site. + + Int32 - + Int32 - - - - - - - - For more information, type "Get-Help New-SPOList -detailed". For technical information, type "Get-Help New-SPOList -full". - - - - - ------------------EXAMPLE------------------ - PS C:\> New-SPOList -Web "/" -Url "Lists/MyNewList" -TemplateType 100 -Title "My New List" - - This example creates a new list with the URL name of Lists/MyNewList under the root Site of the current Site Collection. - - - - - - Connect-SPOSite - - - - Get-SPOList - - - - - - - New-SPOListItem - Lists - - Creates a new list item within an existing List. - - - Copyright 2016 Falchion Consulting, LLC - > For more information on this cmdlet and others: - > http://blog.falchionconsulting.com/ - > Use of this cmdlet is at your own risk. - > Gary Lapointe assumes no liability. - - New - SPOListItem - 1.3.0.0 - - - Creates a new list item within an existing List. - - Copyright 2016 Falchion Consulting, LLC - > For more information on this cmdlet and others: - > http://blog.falchionconsulting.com/ - > Use of this cmdlet is at your own risk. - > Gary Lapointe assumes no liability. - - - - New-SPOListItem - - Web - SPOWebPipeBind - - - List - SPOListPipeBind - - - ListRelativeUrlFolderPath - String - - - FieldValues - PropertiesPipeBind - - - - - - Web + + + UIVersionConfigurationEnabled - Specifies the identity of the Site containing the List to add the item to. - - The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. + Sets a Boolean value that specifies whether the settings UI for visual upgrade is shown or hidden. - SPOWebPipeBind + Boolean - SPOWebPipeBind + Boolean - - List + + AssociatedMemberGroup - Specifies the List to add the item to. - - The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. + Sets the associated member group of the Site. - SPOListPipeBind + SPOGroupPipeBind - SPOListPipeBind + SPOGroupPipeBind + + + + + + + + AssociatedOwnerGroup + + Sets the associated owner group of the Site. + + SPOGroupPipeBind + + SPOGroupPipeBind + + + + + + + + AssociatedVisitorGroup + + Sets the associated visitor group of the Site. + + SPOGroupPipeBind + + SPOGroupPipeBind + + + + + + + + BreakRoleInheritance + + Creates unique role assignments for the Site. + + SwitchParameter + + SwitchParameter @@ -3214,13 +3413,13 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - ListRelativeUrlFolderPath + CopyRoleAssignments - Create the item within a subfolder inside the list. Only include the path relative to the root of the list. + Specifies whether to copy the role assignments from the parent Site. - String + SwitchParameter - String + SwitchParameter @@ -3228,13 +3427,27 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - FieldValues + ClearScopes - The collection of field values to set where the key is the internal field name. The type must be a hash table where each key represents the name of a field whose value should be set to the corresponding key value (e.g., @{"Field1"="Value1";"Field2"="Value2"}). Alternatively, provide the path to a file with XML property settings (<Properties><Property Name="Name1">Value1</Property><Property Name="Name2">Value2</Property></Properties>). + The role assignments for all child Sites in the current Site and in the Sites which inherit role assignments from the current Site must be cleared and those Sites will inherit role assignments from the current Site after this call. - PropertiesPipeBind + SwitchParameter - PropertiesPipeBind + SwitchParameter + + + + + + + + ResetRoleInheritance + + Resets the role inheritance for the Site and inherits role assignments from the parent Site. + + SwitchParameter + + SwitchParameter @@ -3269,15 +3482,22 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help New-SPOListItem -detailed". For technical information, type "Get-Help New-SPOListItem -full". + For more information, type "Get-Help Set-SPOWeb -detailed". For technical information, type "Get-Help Set-SPOWeb -full". - ------------------EXAMPLE------------------ - PS C:\> New-SPOListItem -Web "/" -List "My List" -FieldValues @{"Title"="My new list item"} + ------------------EXAMPLE 1----------------------- + PS C:\> Set-SPOWeb -Identity "/" -CustomMasterUrl "/_catalogs/masterpage/seattle.master" - This example creates a new list item within the List My List under the root Site of the current Site Collection. + This example sets the master page of the root Site of a Site Collection to seattle.master. + + + + ------------------EXAMPLE 2----------------------- + PS C:\> Set-SPOWeb -Identity "/childsite" -BreakRoleInheritance -CopyRoleAssignments + + This example breaks permissions inheritance for /childsite and copies the parents permissions to the Site. @@ -3287,17 +3507,21 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Get-SPOList + Get-SPOWeb + + + + New-SPOWeb - Remove-SPOList - Lists + Remove-SPOWeb + Sites - Removes a List from the specified Site. + Removes a Site from the current Site Collection. Copyright 2016 Falchion Consulting, LLC @@ -3307,11 +3531,11 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Gary Lapointe assumes no liability. Remove - SPOList - 1.3.0.0 + SPOWeb + 1.3.1.0 - Removes a List from the specified Site. + Removes a Site from the current Site Collection. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -3321,26 +3545,22 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Remove-SPOList + Remove-SPOWeb - Web - SPOWebPipeBind - - Identity - SPOListPipeBind + SPOWebPipeBind - - Recycle + + Recurse SwitchParameter - Web + Identity - Specifies the identity of the Site containing the List to delete. + Specifies the identity of the Site to delete. The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. @@ -3353,26 +3573,10 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - Identity - - Specifies the identity of the List to delete. - - The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. - - SPOListPipeBind - - SPOListPipeBind - - - - - - - - Recycle + + Recurse - If specified the List will be recycled instead of deleted. + If the Site contains child Sites then recursively delete all child Sites. SwitchParameter @@ -3411,7 +3615,7 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help Remove-SPOList -detailed". For technical information, type "Get-Help Remove-SPOList -full". + For more information, type "Get-Help Remove-SPOWeb -detailed". For technical information, type "Get-Help Remove-SPOWeb -full". @@ -3429,17 +3633,17 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Get-SPOList + Get-SPOWeb - Set-SPOList - Lists + Get-SPOWeb + Sites - Configures the specified list. + Retrieves one or more Sites within the current Site Collection. Copyright 2016 Falchion Consulting, LLC @@ -3448,12 +3652,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Set - SPOList - 1.3.0.0 + Get + SPOWeb + 1.3.1.0 - The Set-SPOList cmdlet configures the list specified by the Identity parameter. Settings for any parameters that are not provided are not changed. + Retrieves a single Site given the server relative URL, GUID, or existing SPOWeb object. If a Site identifier is not provided then all Sites are provided. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -3463,176 +3667,30 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Set-SPOList - - ContentTypesEnabled - Boolean - - - DefaultContentApprovalWorkflowId - Guid - - - DefaultDisplayFormUrl - String - - - DefaultEditFormUrl - String - - - DefaultNewFormUrl - String - - - Description - String - - - Direction - String - - - DocumentTemplateUrl - String - - - DraftVersionVisibility - Reader | Author | Approver - - - EnableAttachments - Boolean - - - EnableFolderCreation - Boolean - - - EnableMinorVersions - Boolean - - - EnableModeration - Boolean - - - EnableVersioning - Boolean - - - ForceCheckout - Boolean - - - Hidden - Boolean - - - ImageUrl - String - - - IrmEnabled - Boolean - - - IrmExpire - Boolean - - - IrmReject - Boolean - - - IsApplicationList - Boolean - - - LastItemModifiedDate - DateTime - - - MultipleDataList - Boolean - - - NoCrawl - Boolean - - - OnQuickLaunch - Boolean - - - Title - String - - - ValidationFormula - String - - - ValidationMessage - String - - - Web + Get-SPOWeb + + Identity SPOWebPipeBind - Identity - SPOListPipeBind - - - - Set-SPOList - - BreakRoleInheritance + Detail SwitchParameter - CopyRoleAssignments - SwitchParameter - - - ClearScopes - SwitchParameter - - - Web - SPOWebPipeBind - - - Identity - SPOListPipeBind - - - - Set-SPOList - - ResetRoleInheritance + IncludeAppWebs SwitchParameter - - Web - SPOWebPipeBind - - - Identity - SPOListPipeBind - - - Web + + Identity - Specifies the identity of the Site containing the List to update. + Specifies the identity of the Site to retrieve. The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. - SPOWebPipeBind + SPOWebPipeBind SPOWebPipeBind @@ -3641,30 +3699,14 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - Identity - - Specifies the identity of the List to update. - - The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. - - SPOListPipeBind - - SPOListPipeBind - - - - - - - ContentTypesEnabled + Detail - Sets a value that specifies whether Content Types are enabled for the List. + Retrieve additional details useful for examining a single object. - Boolean + SwitchParameter - Boolean + SwitchParameter @@ -3672,391 +3714,752 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - DefaultContentApprovalWorkflowId - - Sets a value that specifies the default workflow identifier for content approval on the List. - - Guid - - Guid - - - - - - - - DefaultDisplayFormUrl - - Sets a value that specifies the location of the default display form for the List. - - String - - String - - - - - - - - DefaultEditFormUrl - - Sets a value that specifies the URL of the edit form to use for List items in the List. - - String - - String - - - - - - - - DefaultNewFormUrl + IncludeAppWebs - Sets a value that specifies the location of the default new form for the List. + When returning multiple items (-Identity is not provided), include app webs in the resultset. - String + SwitchParameter - String + SwitchParameter - - Description - - Sets a value that specifies the description of the List. - - String + + + - String + - - - Direction - - Sets a value that specifies the reading order of the List. Valid values are NONE, LTR, or RTL. - - String + + + + - String + - - - DocumentTemplateUrl + + + + + + + + For more information, type "Get-Help Get-SPOWeb -detailed". For technical information, type "Get-Help Get-SPOWeb -full". + + + + + ------------------EXAMPLE 1----------------------- + PS C:\> Get-SPOWeb "/childsite" + + This example retrieves the core details for the childsite sub-site of the current Site Collection. + + + + ------------------EXAMPLE 2----------------------- + PS C:\> Get-SPOWeb "/" -Detail + + This example retrieves the core details along with additional information for the root site of the current Site Collection. + + + + ------------------EXAMPLE 3----------------------- + PS C:\> Get-SPOWeb -Detail + + This example retrieves the core details along with additional information for all Sites within the current Site Collection. + + + + + + Connect-SPOSite + + + + + + + Get-SPOContextSite + Sites + + Retrieves the details for the currently connected Site Collection. + + + Copyright 2016 Falchion Consulting, LLC + > For more information on this cmdlet and others: + > http://blog.falchionconsulting.com/ + > Use of this cmdlet is at your own risk. + > Gary Lapointe assumes no liability. + + Get + SPOContextSite + 1.3.1.0 + + + Retrieves the details for the currently connected Site Collection. + + Copyright 2016 Falchion Consulting, LLC + > For more information on this cmdlet and others: + > http://blog.falchionconsulting.com/ + > Use of this cmdlet is at your own risk. + > Gary Lapointe assumes no liability. + + + + Get-SPOContextSite + + Detail + SwitchParameter + + + + + + Detail - Sets a value that specifies the server-relative URL of the document template for the List. + Retrieve additional details useful for examining a single object. - String + SwitchParameter - String + SwitchParameter - - DraftVersionVisibility - - Sets a value that specifies the minimum permission required to view minor versions and drafts within the List. - - DraftVisibilityType + + + - DraftVisibilityType + - - - EnableAttachments - - Sets a value that specifies whether List item attachments are enabled for the List. - - Boolean + + + + - Boolean + - - - EnableFolderCreation + + + + + + + + For more information, type "Get-Help Get-SPOContextSite -detailed". For technical information, type "Get-Help Get-SPOContextSite -full". + + + + + ------------------EXAMPLE 1----------------------- + PS C:\> Get-SPOContextSite + + This example retrieves the core details for the currently connected site. + + + + ------------------EXAMPLE 2----------------------- + PS C:\> Get-SPOContextSite -Detail + + This example retrieves the core details along with additional information such as upgrade information, event receivers, owner, etc. + + + + + + Connect-SPOSite + + + + + + + New-SPOWeb + Sites + + Creates a new child Site within an existing Site. + + + Copyright 2016 Falchion Consulting, LLC + > For more information on this cmdlet and others: + > http://blog.falchionconsulting.com/ + > Use of this cmdlet is at your own risk. + > Gary Lapointe assumes no liability. + + New + SPOWeb + 1.3.1.0 + + + Creates a new child Site within an existing Site. + + Copyright 2016 Falchion Consulting, LLC + > For more information on this cmdlet and others: + > http://blog.falchionconsulting.com/ + > Use of this cmdlet is at your own risk. + > Gary Lapointe assumes no liability. + + + + New-SPOWeb + + ParentWeb + SPOWebPipeBind + + + Url + String + + + WebTemplate + String + + + Title + String + + + Description + String + + + Language + Int32 + + + UniquePermissions + SwitchParameter + + + + + + ParentWeb - Sets a value that specifies whether new List folders can be added to the List. + Specifies the identity of the parent Site to create the new Site within. + + The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. - Boolean + SPOWebPipeBind - Boolean + SPOWebPipeBind - - EnableMinorVersions + + Url - Sets a value that specifies whether minor versions are enabled for the List. + The URL name of the Site to create. If creating a new Site at "http://contoso.sharepoint.com/site1/newsite" then specify a value of "newsite". - Boolean + String - Boolean + String - - EnableModeration + + WebTemplate - Sets a value that specifies whether content approval is enabled for the List. + Specifies the Web template for the new Site. The template must already exist. If no template is specified, no template is applied and a template can be selected later. - Boolean + String - Boolean + String - - EnableVersioning + + Title - Sets a value that specifies whether historical versions of List items and documents can be created in the List. + Specifies the title of the new Site. - Boolean + String - Boolean + String - - ForceCheckout + + Description - Sets a value that specifies whether List items must be checked out before they can be edited. + Describes the new Site. If no description is specified, the entry is left blank. - Boolean + String - Boolean + String - - Hidden + + Language - Sets a Boolean value that specifies whether the List is hidden. + Specifies the language template identifier for the new Site. If no language is specified, the Site is created with the same language that was specified when the product was installed. + + The type must be a valid language identifier (LCID). - Boolean + Int32 - Boolean + Int32 - - ImageUrl + + UniquePermissions - Sets a value that specifies the URI for the icon of the List. + Specifies that this Site is to be created with unique permissions. - String + SwitchParameter - String + SwitchParameter - - IrmEnabled - - Sets a value that specifies whether information rights management is enabled for the List. - - Boolean + + + - Boolean + - - - IrmExpire - - - - Boolean + + + + - Boolean + - - - IrmReject + + + + + + + + For more information, type "Get-Help New-SPOWeb -detailed". For technical information, type "Get-Help New-SPOWeb -full". + + + + + ------------------EXAMPLE 1----------------------- + PS C:\> New-SPOWeb -ParentWeb "/" -Url "childsite" -WebTemplate "STS#0" -Title "Child Site" -UseSamePermissionsAsParentSite + + This example creates a new child site with the URL name of childsite under the root Site of the current Site Collection. + + + + ------------------EXAMPLE 2----------------------- + PS C:\> New-SPOWeb -ParentWeb "/sites/sitecol1" -Url "childsite" -WebTemplate "STS#0" -Title "Child Site" -UseSamePermissionsAsParentSite + + This example creates a new child site with the URL name of childsite under the sitecol1 Site of the current Site Collection (you must be connected to this site collection). + + + + + + Connect-SPOSite + + + + Get-SPOWeb + + + + + + + Export-SPOSearchConfiguration + Search + + Exports the search configuration. + + + Copyright 2016 Falchion Consulting, LLC + > For more information on this cmdlet and others: + > http://blog.falchionconsulting.com/ + > Use of this cmdlet is at your own risk. + > Gary Lapointe assumes no liability. + + Export + SPOSearchConfiguration + 1.3.1.0 + + + Exports the search configuration from the current Tenant or Site Collection. + + Copyright 2016 Falchion Consulting, LLC + > For more information on this cmdlet and others: + > http://blog.falchionconsulting.com/ + > Use of this cmdlet is at your own risk. + > Gary Lapointe assumes no liability. + + + + Export-SPOSearchConfiguration + + Path + String + + + ConfigScope + SPWeb | SPSite | SPSiteSubscription | Ssa + + + + + + Path - + The file path where the exported search settings will be saved. - Boolean + String - Boolean + String - - IsApplicationList + + ConfigScope - Sets a value that specifies a flag that a client application can use to determine whether to display the List. + The level at which the search settings will be imported. - Boolean + SearchObjectLevel - Boolean + SearchObjectLevel - - LastItemModifiedDate - - Sets a value that specifies the last time a List item, field, or property of the List was modified. - - DateTime + + + - DateTime + - - - MultipleDataList - - - - Boolean + + + + - Boolean + - - - NoCrawl + + + + + + + + For more information, type "Get-Help Export-SPOSearchConfiguration -detailed". For technical information, type "Get-Help Export-SPOSearchConfiguration -full". + + + + + ------------------EXAMPLE------------------ + PS C:\> Export-SPOSearchConfiguration -Path "c:\search.xml" -ConfigScope SPSite + + This example exports the search configuration for the current Site Collection. + + + + + + Connect-SPOSite + + + + Import-SPOSearchConfiguration + + + + + + + Import-SPOSearchConfiguration + Search + + Retrieves one or more Sites within the current Site Collection. + + + Copyright 2016 Falchion Consulting, LLC + > For more information on this cmdlet and others: + > http://blog.falchionconsulting.com/ + > Use of this cmdlet is at your own risk. + > Gary Lapointe assumes no liability. + + Import + SPOSearchConfiguration + 1.3.1.0 + + + Retrieves a single Site given the server relative URL, GUID, or existing SPOWeb object. If a Site identifier is not provided then all Sites are provided. + + Copyright 2016 Falchion Consulting, LLC + > For more information on this cmdlet and others: + > http://blog.falchionconsulting.com/ + > Use of this cmdlet is at your own risk. + > Gary Lapointe assumes no liability. + + + + Import-SPOSearchConfiguration + + InputObject + XmlDocumentPipeBind + + + ConfigScope + SPWeb | SPSite | SPSiteSubscription | Ssa + + + + + + InputObject - Sets a value that specifies that the crawler must not crawl the List. + The path to the file containing the search settings to import. The value can be the path a file, an XmlDocument object, or an XML string. - Boolean + XmlDocumentPipeBind - Boolean + XmlDocumentPipeBind - - OnQuickLaunch + + ConfigScope - Sets a value that specifies whether the List appears on the Quick Launch of the Site. + The level at which the search settings will be imported. - Boolean + SearchObjectLevel - Boolean + SearchObjectLevel - - Title - - Sets the displayed title for the List. - - String + + + - String + - - - ValidationFormula + + + + + + + + + + + + + + + + + + + For more information, type "Get-Help Import-SPOSearchConfiguration -detailed". For technical information, type "Get-Help Import-SPOSearchConfiguration -full". + + + + + ------------------EXAMPLE------------------ + PS C:\> Import-SPOSearchConfiguration -InputObject "c:\search.xml" -ConfigScope SPSite + + This example imports a search configuration to the current Site Collection. + + + + + + Connect-SPOSite + + + + + + + Download-SPOFile + Lists + + Downloads a specific File from a given Site. + + + Copyright 2016 Falchion Consulting, LLC + > For more information on this cmdlet and others: + > http://blog.falchionconsulting.com/ + > Use of this cmdlet is at your own risk. + > Gary Lapointe assumes no liability. + + Download + SPOFile + 1.3.1.0 + + + Download and save a specific file from a Site given the server relative URL to the file. The Site provided by the -Web parameter must correspond to the Site where the file is located or else an argument out of range exception will be thrown. + + Copyright 2016 Falchion Consulting, LLC + > For more information on this cmdlet and others: + > http://blog.falchionconsulting.com/ + > Use of this cmdlet is at your own risk. + > Gary Lapointe assumes no liability. + + + + Download-SPOFile + + File + SPOFilePipeBind[] + + + Web + SPOWebPipeBind + + + TargetFolder + String + + + Overwrite + SwitchParameter + + + + Download-SPOFile + + Folder + SPOFolderPipeBind + + + Recursive + SwitchParameter + + + Web + SPOWebPipeBind + + + TargetFolder + String + + + Overwrite + SwitchParameter + + + + + + Web - Sets a value that specifies the data validation criteria for a List item. + Specifies the identity of the Site containing the File(s) to retrieve. + + The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. - String + SPOWebPipeBind - String + SPOWebPipeBind - - ValidationMessage + + File - Sets a value that specifies the error message returned when data validation fails for a List item. + The server relative URL(s) to the file(s) to retrieve. - String + SPOFilePipeBind[] - String + SPOFilePipeBind[] - - BreakRoleInheritance + + Folder - Creates unique role assignments for the Site. + The path to the folder to save. - SwitchParameter + SPOFolderPipeBind - SwitchParameter + SPOFolderPipeBind @@ -4064,9 +4467,9 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - CopyRoleAssignments + Recursive - Specifies whether to copy the role assignments from the parent Site. + Save all child folders and their files. SwitchParameter @@ -4077,26 +4480,26 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - ClearScopes + + TargetFolder - The role assignments for all child Sites in the current Site and in the Sites which inherit role assignments from the current Site must be cleared and those Sites will inherit role assignments from the current Site after this call. + The path to the folder to save the files to. - SwitchParameter + String - SwitchParameter + String - - ResetRoleInheritance + + Overwrite - Resets the role inheritance for the Site and inherits role assignments from the parent Site. + Overwrite existing files. - SwitchParameter + SwitchParameter SwitchParameter @@ -4133,22 +4536,15 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help Set-SPOList -detailed". For technical information, type "Get-Help Set-SPOList -full". + For more information, type "Get-Help Download-SPOFile -detailed". For technical information, type "Get-Help Download-SPOFile -full". - ------------------EXAMPLE 1----------------------- - PS C:\> Set-SPOWeb -Identity "/childsite" -BreakRoleInheritance -CopyRoleAssignments - - This example breaks permissions inheritance for /childsite and copies the parents permissions to the Site. - - - - ------------------EXAMPLE 2----------------------- - PS C:\> Set-SPOWeb -Identity "/" -CustomMasterUrl "/_catalogs/masterpage/seattle.master" + ------------------EXAMPLE------------------ + PS C:\> Download-SPOFile -Web "/" -File "/Shared Documents/MyFile.docx" -TargetFolder "c:\temp" -Overwrite - This example sets the master page of the root Site of a Site Collection to seattle.master. + Downloads the file MyFile.docx from the Documents library within the root Site of the current Site Collection and saves to the c:\temp folder. @@ -4157,22 +4553,14 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web"Connect-SPOSite - - Get-SPOList - - - - New-SPOList - - - Export-SPOSearchConfiguration - Search + New-SPOListFolder + Lists - Exports the search configuration. + Creates a Folder in a list or library. Copyright 2016 Falchion Consulting, LLC @@ -4181,12 +4569,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Export - SPOSearchConfiguration - 1.3.0.0 + New + SPOListFolder + 1.3.1.0 - Exports the search configuration from the current Tenant or Site Collection. + Creates a folder in the specified list. The Site provided by the -Web parameter must correspond to the Site where the folder and List is located or else an argument out of range exception will be thrown. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -4196,40 +4584,62 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Export-SPOSearchConfiguration + New-SPOListFolder - Path - String + Web + SPOWebPipeBind - - ConfigScope - SPWeb | SPSite | SPSiteSubscription | Ssa + + List + SPOListPipeBind + + + ListRelativeUrlFolderPath + String - - Path + + Web + + Specifies the identity of the Site containing the List to add the item to. + + The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. + + SPOWebPipeBind + + SPOWebPipeBind + + + + + + + + List - The file path where the exported search settings will be saved. + Specifies the List to add the item to. + + The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. - String + SPOListPipeBind - String + SPOListPipeBind - - ConfigScope + + ListRelativeUrlFolderPath - The level at which the search settings will be imported. + Create the item within a subfolder inside the list. Only include the path relative to the root of the list. - SearchObjectLevel + String - SearchObjectLevel + String @@ -4264,15 +4674,15 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help Export-SPOSearchConfiguration -detailed". For technical information, type "Get-Help Export-SPOSearchConfiguration -full". + For more information, type "Get-Help New-SPOListFolder -detailed". For technical information, type "Get-Help New-SPOListFolder -full". ------------------EXAMPLE------------------ - PS C:\> Export-SPOSearchConfiguration -Path "c:\search.xml" -ConfigScope SPSite + PS C:\> New-SPOListFolder -Web "/" -List "Documents" -ListRelativeUrlFolderPath "My Top Level Folder/My Sub-Folder" - This example exports the search configuration for the current Site Collection. + Creates the folders "My Top Level Folder/My Sub-Folder" in the Documents library within the root Site of the current Site Collection. @@ -4281,18 +4691,14 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web"Connect-SPOSite - - Import-SPOSearchConfiguration - - - Import-SPOSearchConfiguration - Search + Get-SPOFolder + Lists - Retrieves one or more Sites within the current Site Collection. + Retrieves a specific Folder from a given Site. Copyright 2016 Falchion Consulting, LLC @@ -4301,12 +4707,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Import - SPOSearchConfiguration - 1.3.0.0 + Get + SPOFolder + 1.3.1.0 - Retrieves a single Site given the server relative URL, GUID, or existing SPOWeb object. If a Site identifier is not provided then all Sites are provided. + Retrieve a specific SPOFolder object from a Site given the server relative URL to the folder. The Site provided by the -Web parameter must correspond to the Site where the folder is located or else an argument out of range exception will be thrown. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -4316,26 +4722,28 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Import-SPOSearchConfiguration + Get-SPOFolder - InputObject - XmlDocumentPipeBind + Web + SPOWebPipeBind - ConfigScope - SPWeb | SPSite | SPSiteSubscription | Ssa + Url + String - InputObject + Web - The path to the file containing the search settings to import. The value can be the path a file, an XmlDocument object, or an XML string. + Specifies the identity of the Site containing the File to retrieve. + + The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. - XmlDocumentPipeBind + SPOWebPipeBind - XmlDocumentPipeBind + SPOWebPipeBind @@ -4343,13 +4751,13 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - ConfigScope + Url - The level at which the search settings will be imported. + The server relative URL to the folder to retrieve. - SearchObjectLevel + String - SearchObjectLevel + String @@ -4384,15 +4792,15 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help Import-SPOSearchConfiguration -detailed". For technical information, type "Get-Help Import-SPOSearchConfiguration -full". + For more information, type "Get-Help Get-SPOFolder -detailed". For technical information, type "Get-Help Get-SPOFolder -full". ------------------EXAMPLE------------------ - PS C:\> Import-SPOSearchConfiguration -InputObject "c:\search.xml" -ConfigScope SPSite + PS C:\> Get-SPOFolder -Web "/" -Url "/Shared Documents/My Folder" - This example imports a search configuration to the current Site Collection. + Retrieves the folder "My Folder" from the Documents library within the root Site of the current Site Collection. @@ -4405,10 +4813,10 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Set-SPOWebTheme - Sites + Get-SPOFile + Lists - Applies a theme with the specified components to the specified Site. + Retrieves a specific File from a given Site. Copyright 2016 Falchion Consulting, LLC @@ -4417,12 +4825,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Set - SPOWebTheme - 1.3.0.0 + Get + SPOFile + 1.3.1.0 - Applies a theme with the specified components to the specified Site. + Retrieve a specific SPOFile object from a Site given the server relative URL to the file. The Site provided by the -Web parameter must correspond to the Site where the file is located or else an argument out of range exception will be thrown. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -4432,34 +4840,22 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Set-SPOWebTheme + Get-SPOFile - Identity + Web SPOWebPipeBind - ColorPaletteUrl - String - - - FontSchemeUrl - String - - - BackgroundImageUrl + Url String - - ShareGenerated - Boolean - - Identity + Web - Specifies the identity of the Site to apply the theme to. + Specifies the identity of the Site containing the File to retrieve. The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. @@ -4473,9 +4869,9 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - ColorPaletteUrl + Url - The server relative URL to the color palette file. For example: "/_catalogs/theme/15/palette001.spcolor". + The server relative URL to the file to retrieve. String @@ -4486,48 +4882,6 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - FontSchemeUrl - - The server relative URL to the font file. For example: "/_catalogs/theme/15/fontscheme001.spfont". - - String - - String - - - - - - - - BackgroundImageUrl - - The server relative URL to the background image file. For example: "/Images/bg.png". - - String - - String - - - - - - - - ShareGenerated - - If specified, store the generated theme files in the root Site, otherwise store them in this Site. - - Boolean - - Boolean - - - - - - @@ -4556,15 +4910,15 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help Set-SPOWebTheme -detailed". For technical information, type "Get-Help Set-SPOWebTheme -full". + For more information, type "Get-Help Get-SPOFile -detailed". For technical information, type "Get-Help Get-SPOFile -full". ------------------EXAMPLE------------------ - PS C:\> Set-SPOWebTheme -Web "/" -ColorPaletteUrl "/_catalogs/theme/15/palette001.spcolor" + PS C:\> Get-SPOFile -Web "/" -Url "/Shared Documents/MyFile.docx" - This example sets the theme of the root Site of the current Site Collection. + Retrieves the file MyFile.docx from the Documents library within the root Site of the current Site Collection. @@ -4573,18 +4927,14 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web"Connect-SPOSite - - Get-SPOWeb - - - Set-SPOWeb - Sites + New-SPOFile + Lists - Configures the specified subsite. + Creates a new list file within an existing List. Copyright 2016 Falchion Consulting, LLC @@ -4593,12 +4943,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Set - SPOWeb - 1.3.0.0 + New + SPOFile + 1.3.1.0 - The Set-SPOWeb cmdlet configures the subsite specified by the Identity parameter. Settings for any parameters that are not provided are not changed. + Creates a new list file within an existing List. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -4608,110 +4958,59 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Set-SPOWeb + New-SPOFile - CustomMasterUrl - String - - - MasterUrl - String - - - Title - String - - - Description - String - - - EnableMinimalDownload - Boolean - - - QuickLaunchEnabled - Boolean - - - SaveSiteAsTemplateEnabled - Boolean - - - ServerRelativeUrl - String - - - SyndicationEnabled - Boolean - - - TreeViewEnabled - Boolean - - - UIVersion - Int32 - - - UIVersionConfigurationEnabled - Boolean - - - AssociatedMemberGroup - SPOGroupPipeBind - - - AssociatedOwnerGroup - SPOGroupPipeBind - - - AssociatedVisitorGroup - SPOGroupPipeBind + List + SPOListPipeBind - Identity + Web SPOWebPipeBind - - - Set-SPOWeb - - BreakRoleInheritance - SwitchParameter - - - CopyRoleAssignments - SwitchParameter - - - ClearScopes + + File + String + + + Overwrite SwitchParameter - - Identity - SPOWebPipeBind + + FieldValues + PropertiesPipeBind - Set-SPOWeb - - ResetRoleInheritance - SwitchParameter + New-SPOFile + + Folder + SPOFolder - Identity + Web SPOWebPipeBind + + File + String + + + Overwrite + SwitchParameter + + + FieldValues + PropertiesPipeBind + - Identity + Web - Specifies the identity of the Site to update. + Specifies the identity of the Site containing the List to add the file to. - The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the SIte ID. + The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. SPOWebPipeBind @@ -4722,40 +5021,44 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - CustomMasterUrl + + List - Sets the URL for a custom master page file to apply to the Site. + Specifies the List to add the file to. + + The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. - String + SPOListPipeBind - String + SPOListPipeBind - - MasterUrl + + Folder - Sets the URL of the master page that is used for the Site. + Specifies the Folder to add the file to. + + The type must be a valid SPOFolder object. - String + SPOFolder - String + SPOFolder - - Title + + File - Specifies the new title of the Site. + Specify the path to the file to add to the list. - String + String String @@ -4765,13 +5068,13 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Description + Overwrite - Specifies the new description of the Site. + Overwrite an existing file if present. - String + SwitchParameter - String + SwitchParameter @@ -4779,167 +5082,141 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - EnableMinimalDownload - - Sets a Boolean value that specifies whether the Site should use Minimal Download Strategy. - - Boolean - - Boolean - - - - - - - - QuickLaunchEnabled - - Sets a value that specifies whether the Quick Launch area is enabled on the Site. - - Boolean - - Boolean - - - - - - - - SaveSiteAsTemplateEnabled - - Sets a Boolean value that specifies whether the Site can be saved as a Site template. - - Boolean - - Boolean - - - - - - - - ServerRelativeUrl - - Specifies the new relative URL for the Site. This is the URL path after the site collection URL. - - String - - String - - - - - - - - SyndicationEnabled - - Sets a Boolean value that specifies whether the RSS feeds are enabled on the Site. - - Boolean - - Boolean - - - - - - - - TreeViewEnabled - - Sets a Boolean value that specifies whether the tree view is enabled on the Site. - - Boolean - - Boolean - - - - - - - - UIVersion - - Sets the user interface (UI) version of the Site. - - Int32 - - Int32 - - - - - - - - UIVersionConfigurationEnabled + FieldValues - Sets a Boolean value that specifies whether the settings UI for visual upgrade is shown or hidden. + The collection of field values to set where the key is the internal field name. The type must be a hash table where each key represents the name of a field whose value should be set to the corresponding key value (e.g., @{"Field1"="Value1";"Field2"="Value2"}). Alternatively, provide the path to a file with XML property settings (<Properties><Property Name="Name1">Value1</Property><Property Name="Name2">Value2</Property></Properties>). - Boolean + PropertiesPipeBind - Boolean + PropertiesPipeBind - - AssociatedMemberGroup - - Sets the associated member group of the Site. - - SPOGroupPipeBind + + + - SPOGroupPipeBind + - - - AssociatedOwnerGroup - - Sets the associated owner group of the Site. - - SPOGroupPipeBind + + + + - SPOGroupPipeBind + - - - AssociatedVisitorGroup + + + + + + + + For more information, type "Get-Help New-SPOFile -detailed". For technical information, type "Get-Help New-SPOFile -full". + + + + + ------------------EXAMPLE------------------ + PS C:\> New-SPOFile -Web "/" -List "My List" -File "c:\myfile.txt" -FieldValues @{"Title"="My new file"} + + This example creates a new file within the List My List under the root Site of the current Site Collection. + + + + + + Connect-SPOSite + + + + Get-SPOList + + + + + + + Get-SPOList + Lists + + Retrieves the collection of lists or a specific list. + + + Copyright 2016 Falchion Consulting, LLC + > For more information on this cmdlet and others: + > http://blog.falchionconsulting.com/ + > Use of this cmdlet is at your own risk. + > Gary Lapointe assumes no liability. + + Get + SPOList + 1.3.1.0 + + + If the -List parameter is not provided then all the lists the given Site are returned; otherwise, a single list will be returned matching the identifier provided. + + Copyright 2016 Falchion Consulting, LLC + > For more information on this cmdlet and others: + > http://blog.falchionconsulting.com/ + > Use of this cmdlet is at your own risk. + > Gary Lapointe assumes no liability. + + + + Get-SPOList + + Web + SPOWebPipeBind + + + Identity + SPOListPipeBind + + + Detail + SwitchParameter + + + + + + Web - Sets the associated visitor group of the Site. + Specifies the identity of the Site containing the List to retrieve. + + The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. - SPOGroupPipeBind + SPOWebPipeBind - SPOGroupPipeBind + SPOWebPipeBind - - BreakRoleInheritance + + Identity - Creates unique role assignments for the Site. + Specifies the identity of the List to retrieve. + + The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. - SwitchParameter + SPOListPipeBind - SwitchParameter + SPOListPipeBind @@ -4947,23 +5224,9 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - CopyRoleAssignments - - Specifies whether to copy the role assignments from the parent Site. - - SwitchParameter - - SwitchParameter - - - - - - - - ClearScopes + Detail - The role assignments for all child Sites in the current Site and in the Sites which inherit role assignments from the current Site must be cleared and those Sites will inherit role assignments from the current Site after this call. + Retrieve additional details useful for examining a single object. SwitchParameter @@ -4974,20 +5237,6 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - ResetRoleInheritance - - Resets the role inheritance for the Site and inherits role assignments from the parent Site. - - SwitchParameter - - SwitchParameter - - - - - - @@ -5016,22 +5265,22 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help Set-SPOWeb -detailed". For technical information, type "Get-Help Set-SPOWeb -full". + For more information, type "Get-Help Get-SPOList -detailed". For technical information, type "Get-Help Get-SPOList -full". ------------------EXAMPLE 1----------------------- - PS C:\> Set-SPOWeb -Identity "/childsite" -BreakRoleInheritance -CopyRoleAssignments + PS C:\> Get-SPOList -Web "/" - This example breaks permissions inheritance for /childsite and copies the parents permissions to the Site. + Retrieves all lists for the root Site. ------------------EXAMPLE 2----------------------- - PS C:\> Set-SPOWeb -Identity "/" -CustomMasterUrl "/_catalogs/masterpage/seattle.master" + PS C:\> Get-SPOList -Web "/" -Identity "Shared Documents" - This example sets the master page of the root Site of a Site Collection to seattle.master. + Retrieves a single list for the given Site. @@ -5040,22 +5289,14 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web"Connect-SPOSite - - Get-SPOWeb - - - - New-SPOWeb - - - Remove-SPOWeb - Sites + New-SPOList + Lists - Removes a Site from the current Site Collection. + Creates a new list within an existing Site. Copyright 2016 Falchion Consulting, LLC @@ -5064,12 +5305,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Remove - SPOWeb - 1.3.0.0 + New + SPOList + 1.3.1.0 - Removes a Site from the current Site Collection. + Creates a new list within an existing Site. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -5079,42 +5320,186 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Remove-SPOWeb + New-SPOList - Identity + Web SPOWebPipeBind - - Recurse - SwitchParameter + + Url + String + + + Title + String + + + Description + String + + + CustomSchemaXml + String + + + DocumentTemplateType + Int32 + + + QuickLaunchOption + Off | On | DefaultValue + + + TemplateType + Int32 + + + TemplateFeatureId + Guid + + + DataSourceProperties + Dictionary`2 - Identity + Web + + Specifies the identity of the Site to create the new List within. + + The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. + + SPOWebPipeBind + + SPOWebPipeBind + + + + + + + + Url + + The URL name of the List to create. If creating a new List at "http://contoso.sharepoint.com/site1/Lists/MyList" then specify a value of "Lists/MyList". + + String + + String + + + + + + + + Title + + Specifies the title of the new List. + + String + + String + + + + + + + + Description + + Describes the new List. If no description is specified, the entry is left blank. + + String + + String + + + + + + + + CustomSchemaXml + + Sets a value that specifies the List schema of the new List. + + String + + String + + + + + + + + DocumentTemplateType + + Sets a value that specifies the identifier of the document template for the new List. + + Int32 + + Int32 + + + + + + + + QuickLaunchOption + + Sets a value that specifies whether the new List is displayed on the Quick Launch of the Site. + + QuickLaunchOptions + + QuickLaunchOptions + + + + + + + + TemplateType - Specifies the identity of the Site to delete. - - The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. + Sets a value that specifies the List server template of the new List. - SPOWebPipeBind + Int32 - SPOWebPipeBind + Int32 - - Recurse + + TemplateFeatureId - If the Site contains child Sites then recursively delete all child Sites. + Sets a value that specifies the Feature identifier of the Feature that contains the List schema for the new List. - SwitchParameter + Guid - SwitchParameter + Guid + + + + + + + + DataSourceProperties + + Sets a value that specifies the properties of the data source of the new List. + + Dictionary`2 + + Dictionary`2 @@ -5149,15 +5534,15 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help Remove-SPOWeb -detailed". For technical information, type "Get-Help Remove-SPOWeb -full". + For more information, type "Get-Help New-SPOList -detailed". For technical information, type "Get-Help New-SPOList -full". ------------------EXAMPLE------------------ - PS C:\> Remove-SPOWeb -Web "/childsite" + PS C:\> New-SPOList -Web "/" -Url "Lists/MyNewList" -TemplateType 100 -Title "My New List" - This example removes the childsite Site from the Site Collection. + This example creates a new list with the URL name of Lists/MyNewList under the root Site of the current Site Collection. @@ -5167,17 +5552,17 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Get-SPOWeb + Get-SPOList - Get-SPOWeb - Sites + New-SPOListItem + Lists - Retrieves one or more Sites within the current Site Collection. + Creates a new list item within an existing List. Copyright 2016 Falchion Consulting, LLC @@ -5186,12 +5571,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Get - SPOWeb - 1.3.0.0 + New + SPOListItem + 1.3.1.0 - Retrieves a single Site given the server relative URL, GUID, or existing SPOWeb object. If a Site identifier is not provided then all Sites are provided. + Creates a new list item within an existing List. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -5201,30 +5586,34 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Get-SPOWeb - - Identity + New-SPOListItem + + Web SPOWebPipeBind - Detail - SwitchParameter + List + SPOListPipeBind - IncludeAppWebs - SwitchParameter + ListRelativeUrlFolderPath + String + + + FieldValues + PropertiesPipeBind - - Identity + + Web - Specifies the identity of the Site to retrieve. + Specifies the identity of the Site containing the List to add the item to. The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. - SPOWebPipeBind + SPOWebPipeBind SPOWebPipeBind @@ -5233,14 +5622,16 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - Detail + + List - Retrieve additional details useful for examining a single object. + Specifies the List to add the item to. + + The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. - SwitchParameter + SPOListPipeBind - SwitchParameter + SPOListPipeBind @@ -5248,125 +5639,27 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - IncludeAppWebs + ListRelativeUrlFolderPath - When returning multiple items (-Identity is not provided), include app webs in the resultset. + Create the item within a subfolder inside the list. Only include the path relative to the root of the list. - SwitchParameter + String - SwitchParameter + String - - - - - - - - - - - - - - - - - - - - - - - - - - - - - For more information, type "Get-Help Get-SPOWeb -detailed". For technical information, type "Get-Help Get-SPOWeb -full". - - - - - ------------------EXAMPLE 1----------------------- - PS C:\> Get-SPOWeb -Detail - - This example retrieves the core details along with additional information for all Sites within the current Site Collection. - - - - ------------------EXAMPLE 2----------------------- - PS C:\> Get-SPOWeb "/childsite" - - This example retrieves the core details for the childsite sub-site of the current Site Collection. - - - - ------------------EXAMPLE 3----------------------- - PS C:\> Get-SPOWeb "/" -Detail - - This example retrieves the core details along with additional information for the root site of the current Site Collection. - - - - - - Connect-SPOSite - - - - - - - Get-SPOContextSite - Sites - - Retrieves the details for the currently connected Site Collection. - - - Copyright 2016 Falchion Consulting, LLC - > For more information on this cmdlet and others: - > http://blog.falchionconsulting.com/ - > Use of this cmdlet is at your own risk. - > Gary Lapointe assumes no liability. - - Get - SPOContextSite - 1.3.0.0 - - - Retrieves the details for the currently connected Site Collection. - - Copyright 2016 Falchion Consulting, LLC - > For more information on this cmdlet and others: - > http://blog.falchionconsulting.com/ - > Use of this cmdlet is at your own risk. - > Gary Lapointe assumes no liability. - - - - Get-SPOContextSite - - Detail - SwitchParameter - - - - - - Detail + + FieldValues - Retrieve additional details useful for examining a single object. + The collection of field values to set where the key is the internal field name. The type must be a hash table where each key represents the name of a field whose value should be set to the corresponding key value (e.g., @{"Field1"="Value1";"Field2"="Value2"}). Alternatively, provide the path to a file with XML property settings (<Properties><Property Name="Name1">Value1</Property><Property Name="Name2">Value2</Property></Properties>). - SwitchParameter + PropertiesPipeBind - SwitchParameter + PropertiesPipeBind @@ -5401,22 +5694,15 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help Get-SPOContextSite -detailed". For technical information, type "Get-Help Get-SPOContextSite -full". + For more information, type "Get-Help New-SPOListItem -detailed". For technical information, type "Get-Help New-SPOListItem -full". - ------------------EXAMPLE 1----------------------- - PS C:\> Get-SPOContextSite - - This example retrieves the core details for the currently connected site. - - - - ------------------EXAMPLE 2----------------------- - PS C:\> Get-SPOContextSite -Detail + ------------------EXAMPLE------------------ + PS C:\> New-SPOListItem -Web "/" -List "My List" -FieldValues @{"Title"="My new list item"} - This example retrieves the core details along with additional information such as upgrade information, event receivers, owner, etc. + This example creates a new list item within the List My List under the root Site of the current Site Collection. @@ -5425,14 +5711,18 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web"Connect-SPOSite + + Get-SPOList + + - New-SPOWeb - Sites + Remove-SPOList + Lists - Creates a new child Site within an existing Site. + Removes a List from the specified Site. Copyright 2016 Falchion Consulting, LLC @@ -5441,12 +5731,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - New - SPOWeb - 1.3.0.0 + Remove + SPOList + 1.3.1.0 - Creates a new child Site within an existing Site. + Removes a List from the specified Site. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -5456,42 +5746,26 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - New-SPOWeb + Remove-SPOList - ParentWeb - SPOWebPipeBind - - - Url - String - - - WebTemplate - String - - - Title - String - - - Description - String + Web + SPOWebPipeBind - - Language - Int32 + + Identity + SPOListPipeBind - - UniquePermissions + + Recycle SwitchParameter - ParentWeb + Web - Specifies the identity of the parent Site to create the new Site within. + Specifies the identity of the Site containing the List to delete. The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. @@ -5504,82 +5778,26 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - Url - - The URL name of the Site to create. If creating a new Site at "http://contoso.sharepoint.com/site1/newsite" then specify a value of "newsite". - - String - - String - - - - - - - - WebTemplate - - Specifies the Web template for the new Site. The template must already exist. If no template is specified, no template is applied and a template can be selected later. - - String - - String - - - - - - - - Title - - Specifies the title of the new Site. - - String - - String - - - - - - - - Description - - Describes the new Site. If no description is specified, the entry is left blank. - - String - - String - - - - - - - - Language + + Identity - Specifies the language template identifier for the new Site. If no language is specified, the Site is created with the same language that was specified when the product was installed. + Specifies the identity of the List to delete. - The type must be a valid language identifier (LCID). + The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. - Int32 + SPOListPipeBind - Int32 + SPOListPipeBind - - UniquePermissions + + Recycle - Specifies that this Site is to be created with unique permissions. + If specified the List will be recycled instead of deleted. SwitchParameter @@ -5618,15 +5836,15 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help New-SPOWeb -detailed". For technical information, type "Get-Help New-SPOWeb -full". + For more information, type "Get-Help Remove-SPOList -detailed". For technical information, type "Get-Help Remove-SPOList -full". ------------------EXAMPLE------------------ - PS C:\> New-SPOWeb -ParentWeb "/" -Url "childsite" -WebTemplate "STS#0" -Title "Child Site" -UseSamePermissionsAsParentSite + PS C:\> Remove-SPOWeb -Web "/childsite" - This example creates a new child site with the URL name of childsite under the root Site of the current Site Collection. + This example removes the childsite Site from the Site Collection. @@ -5636,17 +5854,17 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Get-SPOWeb + Get-SPOList - Add-SPOSolution - Solutions + Set-SPOList + Lists - Add a WSP to the Solution Gallery of a Site Collection. + Configures the specified list. Copyright 2016 Falchion Consulting, LLC @@ -5655,12 +5873,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Add - SPOSolution - 1.3.0.0 + Set + SPOList + 1.3.1.0 - Add a WSP to the Solution Gallery of a Site Collection. + The Set-SPOList cmdlet configures the list specified by the Identity parameter. Settings for any parameters that are not provided are not changed. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -5670,144 +5888,234 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Add-SPOSolution - - LiteralPath + Set-SPOList + + ContentTypesEnabled + Boolean + + + DefaultContentApprovalWorkflowId + Guid + + + DefaultDisplayFormUrl + String + + + DefaultEditFormUrl String + + DefaultNewFormUrl + String + + + Description + String + + + Direction + String + + + DocumentTemplateUrl + String + + + DraftVersionVisibility + Reader | Author | Approver + + + EnableAttachments + Boolean + + + EnableFolderCreation + Boolean + + + EnableMinorVersions + Boolean + + + EnableModeration + Boolean + + + EnableVersioning + Boolean + + + ForceCheckout + Boolean + + + Hidden + Boolean + + + ImageUrl + String + + + IrmEnabled + Boolean + + + IrmExpire + Boolean + + + IrmReject + Boolean + + + IsApplicationList + Boolean + + + LastItemModifiedDate + DateTime + + + MultipleDataList + Boolean + + + NoCrawl + Boolean + + + OnQuickLaunch + Boolean + + + Title + String + + + ValidationFormula + String + + + ValidationMessage + String + + + Web + SPOWebPipeBind + + + Identity + SPOListPipeBind + + + + Set-SPOList + + BreakRoleInheritance + SwitchParameter + - Overwrite + CopyRoleAssignments + SwitchParameter + + + ClearScopes + SwitchParameter + + + Web + SPOWebPipeBind + + + Identity + SPOListPipeBind + + + + Set-SPOList + + ResetRoleInheritance SwitchParameter + + Web + SPOWebPipeBind + + + Identity + SPOListPipeBind + - - LiteralPath + + Web - Specify the path to the solution package (WSP) to add to the Solution Gallery. + Specifies the identity of the Site containing the List to update. + + The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. - String + SPOWebPipeBind - String + SPOWebPipeBind - - Overwrite + + Identity - Overwrite an existing file if present. + Specifies the identity of the List to update. + + The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. - SwitchParameter + SPOListPipeBind - SwitchParameter + SPOListPipeBind - - - + + ContentTypesEnabled + + Sets a value that specifies whether Content Types are enabled for the List. + + Boolean - + Boolean - - - - + + + DefaultContentApprovalWorkflowId + + Sets a value that specifies the default workflow identifier for content approval on the List. + + Guid - + Guid - - - - - - - - For more information, type "Get-Help Add-SPOSolution -detailed". For technical information, type "Get-Help Add-SPOSolution -full". - - - - - ------------------EXAMPLE------------------ - PS C:\> Add-SPOSolution -LiteralPath "c:\customtemplate.wsp" - - This example uploads a custom Sandbox Solution to the Solution Gallery of the current Site Collection. - - - - - - Connect-SPOSite - - - - - - - Install-SPOSolution - Solutions - - Add a WSP to the Solution Gallery of a Site Collection. - - - Copyright 2016 Falchion Consulting, LLC - > For more information on this cmdlet and others: - > http://blog.falchionconsulting.com/ - > Use of this cmdlet is at your own risk. - > Gary Lapointe assumes no liability. - - Install - SPOSolution - 1.3.0.0 - - - Add a WSP to the Solution Gallery of a Site Collection. - - Copyright 2016 Falchion Consulting, LLC - > For more information on this cmdlet and others: - > http://blog.falchionconsulting.com/ - > Use of this cmdlet is at your own risk. - > Gary Lapointe assumes no liability. - - - - Install-SPOSolution - - Identity - String - - - MajorVersion - Int32 - - - MinorVersion - Int32 - - - - - - Identity + + + DefaultDisplayFormUrl - Specify the name of the solution package (WSP) to activate. + Sets a value that specifies the location of the default display form for the List. - String + String String @@ -5816,326 +6124,192 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - MajorVersion + + DefaultEditFormUrl - Sets the major version of the WSP. The default value is 1. + Sets a value that specifies the URL of the edit form to use for List items in the List. - Int32 + String - Int32 + String - - MinorVersion + + DefaultNewFormUrl - Sets the minor version of the WSP. The default value is 0. + Sets a value that specifies the location of the default new form for the List. - Int32 + String - Int32 + String - - - + + Description + + Sets a value that specifies the description of the List. + + String - + String - - - - + + + Direction + + Sets a value that specifies the reading order of the List. Valid values are NONE, LTR, or RTL. + + String - + String - - - - - - - - For more information, type "Get-Help Install-SPOSolution -detailed". For technical information, type "Get-Help Install-SPOSolution -full". - - - - - ------------------EXAMPLE------------------ - PS C:\> Install-SPOSolution -Identity "customtemplate.wsp" - - This example activates a custom Sandbox Solution in the Solution Gallery of the current Site Collection. The WSP will be copied to customtemplate.wsp-v1.0 and this copied version will be activated. - - - - - - Connect-SPOSite - - - - - - - Get-SPOTermStore - Managed Metadata - - Retrieves a Term Store object. - - - Copyright 2016 Falchion Consulting, LLC - > For more information on this cmdlet and others: - > http://blog.falchionconsulting.com/ - > Use of this cmdlet is at your own risk. - > Gary Lapointe assumes no liability. - - Get - SPOTermStore - 1.3.0.0 - - - Retrieves a Term Store object. - - Copyright 2016 Falchion Consulting, LLC - > For more information on this cmdlet and others: - > http://blog.falchionconsulting.com/ - > Use of this cmdlet is at your own risk. - > Gary Lapointe assumes no liability. - - - - Get-SPOTermStore - - Identity - SPOTermStorePipeBind - - - - - - Identity + + + DocumentTemplateUrl + + Sets a value that specifies the server-relative URL of the document template for the List. + + String + + String + + + + + + + + DraftVersionVisibility - The taxonomy term store to retrieve. The type must be a valid TermStore object, name, GUID, or index location. + Sets a value that specifies the minimum permission required to view minor versions and drafts within the List. - SPOTermStorePipeBind + DraftVisibilityType - SPOTermStorePipeBind + DraftVisibilityType - - - + + EnableAttachments + + Sets a value that specifies whether List item attachments are enabled for the List. + + Boolean - + Boolean - - - - + + + EnableFolderCreation + + Sets a value that specifies whether new List folders can be added to the List. + + Boolean - + Boolean - - - - - - - - For more information, type "Get-Help Get-SPOTermStore -detailed". For technical information, type "Get-Help Get-SPOTermStore -full". - - - - - ------------------EXAMPLE------------------ - PS C:\> Get-SPOTermStore -Identity "My Group" - - This example retrieves a single term group. - - - - - - Export-SPOTaxonomy - - - - - - - New-SPOTermSet - Managed Metadata - - Creates a Term Set object. - - - Copyright 2016 Falchion Consulting, LLC - > For more information on this cmdlet and others: - > http://blog.falchionconsulting.com/ - > Use of this cmdlet is at your own risk. - > Gary Lapointe assumes no liability. - - New - SPOTermSet - 1.3.0.0 - - - Creates a Term Set object. - - Copyright 2016 Falchion Consulting, LLC - > For more information on this cmdlet and others: - > http://blog.falchionconsulting.com/ - > Use of this cmdlet is at your own risk. - > Gary Lapointe assumes no liability. - - - - New-SPOTermSet - - Group - SPOTermGroupPipeBind - - - Name - String - - - Id - Guid - - - Description - String - - - Contact - String - - - CustomSortOrder - String - - - IsAvailableForTagging - SwitchParameter - - - Owner - String - - - IsOpenForTermCreation - SwitchParameter - - - LCID - Int32 - - - - - - Group + + + EnableMinorVersions - The Term Group to add the Term Set to. The type must be a valid TermGroup object, SPOTermGroup object, name, or GUID. + Sets a value that specifies whether minor versions are enabled for the List. - SPOTermGroupPipeBind + Boolean - SPOTermGroupPipeBind + Boolean - - Name + + EnableModeration - The name of the term set to create. + Sets a value that specifies whether content approval is enabled for the List. - String + Boolean - String + Boolean - - Id + + EnableVersioning - The Id of the term set to create. + Sets a value that specifies whether historical versions of List items and documents can be created in the List. - Guid + Boolean - Guid + Boolean - - Description + + ForceCheckout - The description of the term set to create. + Sets a value that specifies whether List items must be checked out before they can be edited. - String + Boolean - String + Boolean - - Contact + + Hidden - The contact for the Term Set object. + Sets a Boolean value that specifies whether the List is hidden. - String + Boolean - String + Boolean - - CustomSortOrder + + ImageUrl - The custom sort order of the Term Set object. + Sets a value that specifies the URI for the icon of the List. String @@ -6146,172 +6320,138 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - IsAvailableForTagging + + IrmEnabled - If specified, the Term Set object should appear in the tagging user interface. + Sets a value that specifies whether information rights management is enabled for the List. - SwitchParameter + Boolean - SwitchParameter + Boolean - - Owner + + IrmExpire - The user who is responsible for the current TermSet. + - String + Boolean - String + Boolean - - IsOpenForTermCreation + + IrmReject + + + + Boolean + + Boolean + + + + + + + + IsApplicationList + + Sets a value that specifies a flag that a client application can use to determine whether to display the List. + + Boolean + + Boolean + + + + + + + + LastItemModifiedDate + + Sets a value that specifies the last time a List item, field, or property of the List was modified. + + DateTime + + DateTime + + + + + + + + MultipleDataList - If specified, the Term Set can be updated by all users; otherwise, just by the specified constributors for the Group object. + - SwitchParameter + Boolean - SwitchParameter + Boolean - - LCID + + NoCrawl - The language code identifier (LCID). + Sets a value that specifies that the crawler must not crawl the List. - Int32 + Boolean - Int32 + Boolean - - - + + OnQuickLaunch + + Sets a value that specifies whether the List appears on the Quick Launch of the Site. + + Boolean - + Boolean - - - - + + + Title + + Sets the displayed title for the List. + + String - + String - - - - - - - - For more information, type "Get-Help New-SPOTermSet -detailed". For technical information, type "Get-Help New-SPOTermSet -full". - - - - - ------------------EXAMPLE------------------ - PS C:\> New-SPOTermSet -Group "My Group" -Name "My Term Set" - - This example creates a single term set. - - - - - - Export-SPOTaxonomy - - - - - - - Get-SPOTerm - Managed Metadata - - Retrieves a Term or Terms matching the specified criteria. - - - Copyright 2016 Falchion Consulting, LLC - > For more information on this cmdlet and others: - > http://blog.falchionconsulting.com/ - > Use of this cmdlet is at your own risk. - > Gary Lapointe assumes no liability. - - Get - SPOTerm - 1.3.0.0 - - - Retrieves a Term or Terms matching the specified criteria. - - Copyright 2016 Falchion Consulting, LLC - > For more information on this cmdlet and others: - > http://blog.falchionconsulting.com/ - > Use of this cmdlet is at your own risk. - > Gary Lapointe assumes no liability. - - - - Get-SPOTerm - - Identity - String - - - StringMatchOption - StartsWith | ExactMatch - - - DefaultLabelOnly - SwitchParameter - - - TrimUnavailable - SwitchParameter - - - TrimDeprecated - SwitchParameter - - - ResultCollectionSize - Int32 - - - - - - Identity + + + ValidationFormula - The Term to retrieve. + Sets a value that specifies the data validation criteria for a List item. - String + String String @@ -6320,26 +6460,26 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - StringMatchOption + + ValidationMessage - Retrieve terms that match the value exactly or just start with the value. The default value is ExactMatch. + Sets a value that specifies the error message returned when data validation fails for a List item. - StringMatchOption + String - StringMatchOption + String - - DefaultLabelOnly + + BreakRoleInheritance - If specified,only default labels should be matched against in the search. + Creates unique role assignments for the Site. - SwitchParameter + SwitchParameter SwitchParameter @@ -6348,10 +6488,10 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - TrimUnavailable + + CopyRoleAssignments - If specified, trim Terms that are unavailable. + Specifies whether to copy the role assignments from the parent Site. SwitchParameter @@ -6362,10 +6502,10 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - TrimDeprecated + + ClearScopes - If specified, trim out Term objects that have Term.IsDeprecated set to true. + The role assignments for all child Sites in the current Site and in the Sites which inherit role assignments from the current Site must be cleared and those Sites will inherit role assignments from the current Site after this call. SwitchParameter @@ -6376,14 +6516,14 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - ResultCollectionSize + + ResetRoleInheritance - Indicates the maximum number of objects to include in the returned collection. The default value is 1. + Resets the role inheritance for the Site and inherits role assignments from the parent Site. - Int32 + SwitchParameter - Int32 + SwitchParameter @@ -6418,31 +6558,46 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help Get-SPOTerm -detailed". For technical information, type "Get-Help Get-SPOTerm -full". + For more information, type "Get-Help Set-SPOList -detailed". For technical information, type "Get-Help Set-SPOList -full". - ------------------EXAMPLE------------------ - PS C:\> Get-SPOTerm -Identity "My Term" -StringMatchOption "ExactMatch" + ------------------EXAMPLE 1----------------------- + PS C:\> Set-SPOWeb -Identity "/" -CustomMasterUrl "/_catalogs/masterpage/seattle.master" - This example retrieves one or more Terms matching the value My Term. + This example sets the master page of the root Site of a Site Collection to seattle.master. + + + + ------------------EXAMPLE 2----------------------- + PS C:\> Set-SPOWeb -Identity "/childsite" -BreakRoleInheritance -CopyRoleAssignments + + This example breaks permissions inheritance for /childsite and copies the parents permissions to the Site. - Export-SPOTaxonomy + Connect-SPOSite + + + + Get-SPOList + + + + New-SPOList - Get-SPOTermSet - Managed Metadata + Set-SPOWikiPageLayout + Wiki Pages - Retrieves a Term Set object. + Sets the layout for a wiki page within an existing List. Copyright 2016 Falchion Consulting, LLC @@ -6451,12 +6606,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Get - SPOTermSet - 1.3.0.0 + Set + SPOWikiPageLayout + 1.3.1.0 - Retrieves a Term Set object. + Sets the layout for a wiki page within an existing List. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -6466,22 +6621,115 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Get-SPOTermSet - - Identity - SPOTermSetPipeBind + Set-SPOWikiPageLayout + + List + SPOListPipeBind + + + Web + SPOWebPipeBind + + + WikiPageName + String + + + WikiPageLayout + OneColumn | OneColumnSideBar | TwoColumns | TwoColumnsHeader | TwoColumnsHeaderFooter | ThreeColumns | ThreeColumnsHeader | ThreeColumnsHeaderFooter + + + + Set-SPOWikiPageLayout + + Folder + SPOFolder + + + Web + SPOWebPipeBind + + + WikiPageName + String + + + WikiPageLayout + OneColumn | OneColumnSideBar | TwoColumns | TwoColumnsHeader | TwoColumnsHeaderFooter | ThreeColumns | ThreeColumnsHeader | ThreeColumnsHeaderFooter - - Identity + + Web + + Specifies the identity of the Site containing the file to update. + + The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. + + SPOWebPipeBind + + SPOWebPipeBind + + + + + + + + List - The TermSet to retrieve. The type must be a valid TermSet object, SPOTermSet object, or GUID. + Specifies the List containing the file to update. + + The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. - SPOTermSetPipeBind + SPOListPipeBind - SPOTermSetPipeBind + SPOListPipeBind + + + + + + + + Folder + + Specifies the Folder containing the file to update. + + The type must be a valid SPOFolder object. + + SPOFolder + + SPOFolder + + + + + + + + WikiPageName + + The name of the wiki page to update. + + String + + String + + + + + + + + WikiPageLayout + + The page layout to set the wiki page to. + + WikiPageLayout + + WikiPageLayout @@ -6516,31 +6764,35 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help Get-SPOTermSet -detailed". For technical information, type "Get-Help Get-SPOTermSet -full". + For more information, type "Get-Help Set-SPOWikiPageLayout -detailed". For technical information, type "Get-Help Set-SPOWikiPageLayout -full". ------------------EXAMPLE------------------ - PS C:\> Get-SPOTermSet -Identity ([guid]"6067b6a8-9866-40db-962d-84097f22619a") + PS C:\> Set-SPOWikiPageLayout -Web "/" -List "Site Pages" -WikiPageName "MyWikiPage.aspx" -WikiPageLayout "OneColumnSideBar" - This example retrieves a single term set. + This example sets the layout of an existing wiki page within the Site Pages list under the root Site of the root Site Collection. - Export-SPOTaxonomy + Connect-SPOSite + + + + Get-SPOList - Export-SPOTaxonomy - Managed Metadata + New-SPOWikiPage + Wiki Pages - Export the Managed Metadata Terms. + Creates a new wiki page within an existing List. Copyright 2016 Falchion Consulting, LLC @@ -6549,12 +6801,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Export - SPOTaxonomy - 1.3.0.0 + New + SPOWikiPage + 1.3.1.0 - Export the Managed Metadata Terms. + Creates a new wiki page within an existing List. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -6564,140 +6816,115 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Export-SPOTaxonomy - - Tenant - SwitchParameter - + New-SPOWikiPage - OutputFile - String + List + SPOListPipeBind - - - Export-SPOTaxonomy - TermStore - SPOTermStorePipeBind + Web + SPOWebPipeBind - - OutputFile + + WikiPageName String - - - Export-SPOTaxonomy - - Group - SPOTermGroupPipeBind - - - OutputFile - String + + WikiPageLayout + OneColumn | OneColumnSideBar | TwoColumns | TwoColumnsHeader | TwoColumnsHeaderFooter | ThreeColumns | ThreeColumnsHeader | ThreeColumnsHeaderFooter - Export-SPOTaxonomy - - TermSet - SPOTermSetPipeBind - - - OutputFile - String + New-SPOWikiPage + + Folder + SPOFolder - - - Export-SPOTaxonomy - Term - SPOTermPipeBind + Web + SPOWebPipeBind - - OutputFile + + WikiPageName String + + WikiPageLayout + OneColumn | OneColumnSideBar | TwoColumns | TwoColumnsHeader | TwoColumnsHeaderFooter | ThreeColumns | ThreeColumnsHeader | ThreeColumnsHeaderFooter + - - Tenant - - Export all terms for the tenant. - - SwitchParameter - - SwitchParameter - - - - - - - - TermStore + + Web - The TermStore object containing the terms to export. The type must be a valid TermStore object, name, GUID, or index location. + Specifies the identity of the Site containing the List to add the file to. + + The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. - SPOTermStorePipeBind + SPOWebPipeBind - SPOTermStorePipeBind + SPOWebPipeBind - - Group + + List - The Group object containing the terms to export. The type must be a valid TermGroup object, SPOTermGroup object, name, or GUID. + Specifies the List to add the file to. + + The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. - SPOTermGroupPipeBind + SPOListPipeBind - SPOTermGroupPipeBind + SPOListPipeBind - - TermSet + + Folder - The TermSet object containing the terms to export. The type must be a valid TermSet object, SPOTermSet object, or GUID. + Specifies the Folder to add the file to. + + The type must be a valid SPOFolder object. - SPOTermSetPipeBind + SPOFolder - SPOTermSetPipeBind + SPOFolder - - Term + + WikiPageName - The Term object containing the terms to export. The type must be a valid Term object or GUID. + The name of the wiki page to create. - SPOTermPipeBind + String - SPOTermPipeBind + String - - OutputFile + + WikiPageLayout - The path to the file to save the terms to. + The page layout to set the wiki page to. The default value is "ThreeColumnsHeaderFooter". - String + WikiPageLayout - String + WikiPageLayout @@ -6729,62 +6956,38 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - - - For more information, type "Get-Help Export-SPOTaxonomy -detailed". For technical information, type "Get-Help Export-SPOTaxonomy -full". - - - - - ------------------EXAMPLE 1----------------------- - PS C:\> Export-SPOTaxonomy -TermStore 0 -OutputFile C:\terms.xml -Verbose - - This example exports the term store at index position zero c:\terms.xml. - - - - ------------------EXAMPLE 2----------------------- - PS C:\> Export-SPOTaxonomy -Group "My Group" -OutputFile C:\terms.xml -Verbose - - This example exports a single group and saves to c:\terms.xml. - - - - ------------------EXAMPLE 3----------------------- - PS C:\> Export-SPOTaxonomy -TermSet ([guid]"6067b6a8-9866-40db-962d-84097f22619a") -OutputFile C:\terms.xml -Verbose - - This example exports a single term set and saves to c:\terms.xml. - - - - ------------------EXAMPLE 4----------------------- - PS C:\> Export-SPOTaxonomy -Tenant -OutputFile "c:\terms.xml" -Verbose - - This example exports the terms for all term stores associated with the tenant and saves to c:\terms.xml. - - + + + + For more information, type "Get-Help New-SPOWikiPage -detailed". For technical information, type "Get-Help New-SPOWikiPage -full". + + + - ------------------EXAMPLE 5----------------------- - PS C:\> Export-SPOTaxonomy -Term ([guid]"6067b6a8-9866-40db-962d-84097f22619a") -OutputFile C:\terms.xml -Verbose + ------------------EXAMPLE------------------ + PS C:\> New-SPOWikiPage -Web "/" -List "Site Pages" -WikiPageName "MyWikiPage.aspx" - This example exports a single term and saves to c:\terms.xml. + This example creates a new wiki page within the Site Pages list under the root Site of the root Site Collection. - Import-SPOTaxonomy + Connect-SPOSite + + + + Get-SPOList - Get-SPOTermGroup - Managed Metadata + Add-SPOField + Fields - Retrieves a Term Group object. + Adds an existing Field to a List. Copyright 2016 Falchion Consulting, LLC @@ -6793,12 +6996,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Get - SPOTermGroup - 1.3.0.0 + Add + SPOField + 1.3.1.0 - Retrieves a Term Group object. + Adds an existing Field to a List. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -6808,22 +7011,54 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Get-SPOTermGroup - + Add-SPOField + Identity - SPOTermGroupPipeBind + SPOFieldPipeBind - + + Web + + Specifies the identity of the Site containing the List to create the new Content Type within. + + The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. + + SPOWebPipeBind + + SPOWebPipeBind + + + + + + + + List + + Specifies the List to add the Content Type to. + + The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. + + SPOListPipeBind + + SPOListPipeBind + + + + + + + Identity - The taxonomy group to retrieve. The type must be a valid TermGroup object, SPOTermGroup object, name, or GUID. + Specifies the existing field to add to the list. The type must be a valid GUID, internal field name, or field title. - SPOTermGroupPipeBind + SPOFieldPipeBind - SPOTermGroupPipeBind + SPOFieldPipeBind @@ -6858,31 +7093,31 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help Get-SPOTermGroup -detailed". For technical information, type "Get-Help Get-SPOTermGroup -full". + For more information, type "Get-Help Add-SPOField -detailed". For technical information, type "Get-Help Add-SPOField -full". ------------------EXAMPLE------------------ - PS C:\> Get-SPOTermGroup -Identity "My Group" + PS C:\> Add-SPOField -Web "/" -List "Documents" -Identity "My Field" - This example retrieves a single term group. + This example adds the field "My Field" to the Documents library. - Export-SPOTaxonomy + Connect-SPOSite - Import-SPOTaxonomy - Managed Metadata + New-SPOField + Fields - Import the Managed Metadata Terms. + Creates a new Field within an existing Site or List. Copyright 2016 Falchion Consulting, LLC @@ -6891,12 +7126,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Import - SPOTaxonomy - 1.3.0.0 + New + SPOField + 1.3.1.0 - Import the Managed Metadata Terms. + Creates a new Field within an existing Site or List. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -6906,140 +7141,113 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Import-SPOTaxonomy + New-SPOField - Tenant - SwitchParameter + Web + SPOWebPipeBind - InputFile - XmlDocumentPipeBind - - - - Import-SPOTaxonomy - - ParentTermStore - SPOTermStorePipeBind + List + SPOListPipeBind - - InputFile + + SchemaXml XmlDocumentPipeBind - - - Import-SPOTaxonomy - - ParentGroup - SPOTermGroupPipeBind + + AddToDefaultView + SwitchParameter - - InputFile - XmlDocumentPipeBind + + Options + DefaultValue | AddToDefaultContentType | AddToNoContentType | AddToAllContentTypes | AddFieldInternalNameHint | AddFieldToDefaultView | AddFieldCheckDisplayName - Import-SPOTaxonomy + New-SPOField - ParentTermSet - SPOTermSetPipeBind + Web + SPOWebPipeBind - - InputFile + + SchemaXml XmlDocumentPipeBind - - - Import-SPOTaxonomy - - ParentTerm - SPOTermPipeBind - - - InputFile - XmlDocumentPipeBind + + Options + DefaultValue | AddToDefaultContentType | AddToNoContentType | AddToAllContentTypes | AddFieldInternalNameHint | AddFieldToDefaultView | AddFieldCheckDisplayName - - Tenant - - Import all terms for the tenant. - - SwitchParameter - - SwitchParameter - - - - - - - - ParentTermStore + + Web - The TermStore object to import Groups into. The type must be a valid TermStore object, name, GUID, or index location. + Specifies the identity of the Site to create the new Content Type within. + + The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. - SPOTermStorePipeBind + SPOWebPipeBind - SPOTermStorePipeBind + SPOWebPipeBind - - ParentGroup + + List - The Group object to import Term Sets into. The type must be a valid TermGroup object, SPOTermGroup object, name, or GUID. + Specifies the List to add the Content Type to. + + The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. - SPOTermGroupPipeBind + SPOListPipeBind - SPOTermGroupPipeBind + SPOListPipeBind - - ParentTermSet + + SchemaXml - The TermSet object to import Terms into. The type must be a valid TermSet object or GUID. + Specifies the XML schema of the new Field. - SPOTermSetPipeBind + XmlDocumentPipeBind - SPOTermSetPipeBind + XmlDocumentPipeBind - - ParentTerm + + AddToDefaultView - The Term object to import Terms into. The type must be a valid Term object or GUID. + If specified, add the field to the default view. - SPOTermPipeBind + SwitchParameter - SPOTermPipeBind + SwitchParameter - - InputFile + + Options - The path to the file containing the terms to import or an XmlDocument object or XML string. + Field creation options. - XmlDocumentPipeBind + AddFieldOptions - XmlDocumentPipeBind + AddFieldOptions @@ -7074,59 +7282,31 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help Import-SPOTaxonomy -detailed". For technical information, type "Get-Help Import-SPOTaxonomy -full". + For more information, type "Get-Help New-SPOField -detailed". For technical information, type "Get-Help New-SPOField -full". - ------------------EXAMPLE 1----------------------- - PS C:\> Import-SPOTaxonomy -Tenant -InputFile "c:\terms.xml" - - This example imports the terms from c:\terms.xml to the Term Store associated with the tenant. - - - - ------------------EXAMPLE 2----------------------- - PS C:\> Import-SPOTaxonomy -ParentTermSet ([guid]"6067b6a8-9866-40db-962d-84097f22619a") -InputFile C:\terms.xml -Verbose - - This example imports the terms from c:\terms.xml to the Term Set with ID "6067b6a8-9866-40db-962d-84097f22619a". - - - - ------------------EXAMPLE 3----------------------- - PS C:\> Import-SPOTaxonomy -ParentTerm ([guid]"6067b6a8-9866-40db-962d-84097f22619a") -InputFile C:\terms.xml -Verbose - - This example imports the terms from c:\terms.xml to the Term with ID "6067b6a8-9866-40db-962d-84097f22619a". - - - - ------------------EXAMPLE 4----------------------- - PS C:\> Import-SPOTaxonomy -ParentGroup "My Group" -InputFile C:\terms.xml -Verbose - - This example imports the terms from c:\terms.xml to the Group named My Group. - - - - ------------------EXAMPLE 5----------------------- - PS C:\> Import-SPOTaxonomy -ParentTermStore 0 -InputFile C:\terms.xml -Verbose + ------------------EXAMPLE------------------ + PS C:\> New-SPOField -Web "/" -SchemaXml $schema -Options "AddFieldInternalNameHint" - This example imports the terms from c:\terms.xml to the Term Store at index position 0. + This example creates a new site column using the schema definition stored within $schema. - Export-SPOTaxonomy + Connect-SPOSite - New-SPOTermGroup - Managed Metadata + Disable-SPOFeature + Features - Creates a Term Group object. + Disables a Feature within the current Site Collection or a specific Site. Copyright 2016 Falchion Consulting, LLC @@ -7135,12 +7315,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - New - SPOTermGroup - 1.3.0.0 + Disable + SPOFeature + 1.3.1.0 - Creates a Term Group object. + If the -Web parameter is not provided then a Site Collection scoped Feature will be disabled; otherwise, a Site scoped Feature for a given Site will be disabled. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -7150,60 +7330,44 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - New-SPOTermGroup - - TermStore - SPOTermStorePipeBind + Disable-SPOFeature + + Web + SPOWebPipeBind - Name - String - - - Id + Identity Guid - - Description - String + + Force + SwitchParameter - - TermStore - - The TermStore to add the Term Group to. The type must be a valid TermStore object, name, GUID, or index location. - - SPOTermStorePipeBind - - SPOTermStorePipeBind - - - - - - - - Name + + Web - The name of the term group to create. + Specifies the identity of the Site where the specified Feature will be deactivated. + + The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. - String + SPOWebPipeBind - String + SPOWebPipeBind - - Id + + Identity - The Id of the term group to create. + - Guid + Guid Guid @@ -7212,14 +7376,14 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - Description + + Force - The description of the term group to create. + - String + SwitchParameter - String + SwitchParameter @@ -7254,31 +7418,42 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help New-SPOTermGroup -detailed". For technical information, type "Get-Help New-SPOTermGroup -full". + For more information, type "Get-Help Disable-SPOFeature -detailed". For technical information, type "Get-Help Disable-SPOFeature -full". - ------------------EXAMPLE------------------ - PS C:\> New-SPOTermGroup -TermStore 0 -Name "My Group" + ------------------EXAMPLE 1----------------------- + PS C:\> Disable-SPOFeature -Identity "{7AF6EA6F-2079-4310-B964-210A87F0D5A1}" - This example creates a single term group. + Disables a Site Collection scoped Feature. + + + + ------------------EXAMPLE 2----------------------- + PS C:\> Disable-SPOFeature -Web "/" -Identity "{7AF6EA6F-2079-4310-B964-210A87F0D5A1}" + + Disables a Site scoped Feature on the root Site. - Export-SPOTaxonomy + Connect-SPOSite + + + + Enable-SPOFeature - Add-SPOListViewWebPart - Web Parts + Enable-SPOFeature + Features - Adds a web part to a web part page or wiki page. + Enables a Feature within the current Site Collection or a specific Site. Copyright 2016 Falchion Consulting, LLC @@ -7287,12 +7462,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Add - SPOListViewWebPart - 1.3.0.0 + Enable + SPOFeature + 1.3.1.0 - Adds a web part to a web part page or wiki page. + If the -Web parameter is not provided then a Site Collection scoped Feature will be enabled; otherwise, a Site scoped Feature for a given Site will be enabled. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -7302,279 +7477,298 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Add-SPOListViewWebPart - - Zone - String - - - ZoneIndex - Int32 - - - Web - SPOWebPipeBind - - - File - SPOFilePipeBind - - - List - SPOListPipeBind - - - ViewTitle - String - - - ViewSchema - XmlDocumentPipeBind - - - Title - String - - - JSLink - String - - - ChromeType - Default | TitleAndBorder | None | TitleOnly | BorderOnly - - - - Add-SPOListViewWebPart - - Row - Int32 - - - Column - Int32 - - - AddSpace - SwitchParameter - - + Enable-SPOFeature + Web SPOWebPipeBind - - File - SPOFilePipeBind - - List - SPOListPipeBind - - - ViewTitle - String - - - ViewSchema - XmlDocumentPipeBind - - - Title - String - - - JSLink - String - - - ChromeType - Default | TitleAndBorder | None | TitleOnly | BorderOnly + Identity + Guid - - - - - Web - - Specifies the identity of the Site containing the file to add the web part to. - - The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. - - SPOWebPipeBind - - SPOWebPipeBind - - - - - - - - File - - Specifies the file to add the web part to. - - The type must be a valid server relative URL, in the form /site_name/list_name/file_name, or an SPOFile or SPOWikiPage object, or Microsoft.SharePoint.Client.File object. - - SPOFilePipeBind - - SPOFilePipeBind - - - - - - - - List - - The list to whose view will be added to the page. - - The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. - - SPOListPipeBind - - SPOListPipeBind - - - - - - - - ViewTitle + + Force + SwitchParameter + + + + + + Web - The name of the view to use for the list view web part. + Specifies the identity of the Site where the specified Feature will be activated. + + The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. - String + SPOWebPipeBind - String + SPOWebPipeBind - - ViewSchema + + Identity - The view schema to apply. + - XmlDocumentPipeBind + Guid - XmlDocumentPipeBind + Guid - - Title + + Force - The title of the web part to add. + - String + SwitchParameter - String + SwitchParameter - - Zone - - The zone to add the web part to. - - String + + + - String + - - - ZoneIndex - - The zone index to add the web part to. - - Int32 + + + + - Int32 + - - - Row + + + + + + + + For more information, type "Get-Help Enable-SPOFeature -detailed". For technical information, type "Get-Help Enable-SPOFeature -full". + + + + + ------------------EXAMPLE 1----------------------- + PS C:\> Enable-SPOFeature -Identity "{7AF6EA6F-2079-4310-B964-210A87F0D5A1}" + + Enables a Site Collection scoped Feature. + + + + ------------------EXAMPLE 2----------------------- + PS C:\> Enable-SPOFeature -Web "/" -Identity "{7AF6EA6F-2079-4310-B964-210A87F0D5A1}" + + Enables a Site scoped Feature on the root Site. + + + + + + Connect-SPOSite + + + + Disable-SPOFeature + + + + + + + Get-SPOFeature + Features + + Retrieves the Feature definition IDs for the Site Collection or a specific Site. + + + Copyright 2016 Falchion Consulting, LLC + > For more information on this cmdlet and others: + > http://blog.falchionconsulting.com/ + > Use of this cmdlet is at your own risk. + > Gary Lapointe assumes no liability. + + Get + SPOFeature + 1.3.1.0 + + + If the -Web parameter is not provided then the Site Collection scoped Feature definition IDs are returned; otherwise, the Site scoped Feature definition IDs for a given Site are returned. + + Copyright 2016 Falchion Consulting, LLC + > For more information on this cmdlet and others: + > http://blog.falchionconsulting.com/ + > Use of this cmdlet is at your own risk. + > Gary Lapointe assumes no liability. + + + + Get-SPOFeature + + Web + SPOWebPipeBind + + + Identity + Guid + + + + + + Web - The zone to add the web part to. + Specifies the identity of the Site whose site-scoped Features will be retrieved. + + The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. - Int32 + SPOWebPipeBind - Int32 + SPOWebPipeBind - - Column + + Identity - The zone index to add the web part to. + - Int32 + Guid - Int32 + Guid - - AddSpace - - Add some space before the web part. - - SwitchParameter + + + - SwitchParameter + - - - JSLink - - Set a specific JSLink file. - - String + + + + - String + - - - ChromeType + + + + + + + + For more information, type "Get-Help Get-SPOFeature -detailed". For technical information, type "Get-Help Get-SPOFeature -full". + + + + + ------------------EXAMPLE 1----------------------- + PS C:\> Get-SPOFeature + + Retrieves all Site Collection scoped Feature definition IDs. + + + + ------------------EXAMPLE 2----------------------- + PS C:\> Get-SPOFeature -Web "/" + + Retrieves all Site scoped Feature definition IDs for the root Site. + + + + + + Connect-SPOSite + + + + + + + Get-SPOEventReceiver + Event Receivers + + Retrieves the Event Receivers for the Site Collection or a specific Site. + + + Copyright 2016 Falchion Consulting, LLC + > For more information on this cmdlet and others: + > http://blog.falchionconsulting.com/ + > Use of this cmdlet is at your own risk. + > Gary Lapointe assumes no liability. + + Get + SPOEventReceiver + 1.3.1.0 + + + If the -Web parameter is not provided then the Site Collection scoped Event Receivers are returned; otherwise, the Site scoped Event Receivers for a given Site are returned. + + Copyright 2016 Falchion Consulting, LLC + > For more information on this cmdlet and others: + > http://blog.falchionconsulting.com/ + > Use of this cmdlet is at your own risk. + > Gary Lapointe assumes no liability. + + + + Get-SPOEventReceiver + + Web + SPOWebPipeBind + + + + + + Web - The chrome settings for the web part. + Specifies the identity of the Site whose Event Receiver Definitions will be retrieved. + + The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. + + If not specified then the current Site Collection's Event Receiver Definitions will be retrieved. - PartChromeType + SPOWebPipeBind - PartChromeType + SPOWebPipeBind @@ -7609,22 +7803,22 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help Add-SPOListViewWebPart -detailed". For technical information, type "Get-Help Add-SPOListViewWebPart -full". + For more information, type "Get-Help Get-SPOEventReceiver -detailed". For technical information, type "Get-Help Get-SPOEventReceiver -full". ------------------EXAMPLE 1----------------------- - PS C:\> Add-SPOListViewWebPart -Web "/" -File "/sitepages/home.aspx" -WebPart "c:\announcements.webpart" -Row 1 -Column 1 -AddSpace + PS C:\> Get-SPOEventReceiver - This example adds an announcements web part to the home.aspx wiki page located in the root web of the root site collection. + Retrieves all Site Collection scoped Event Receivers. ------------------EXAMPLE 2----------------------- - PS C:\> Add-SPOListViewWebPart -Web "/" -File "/default.aspx" -WebPart "c:\announcements.webpart" -Title "Announcements" -Zone "MiddleColumn" -ZoneIndex 1 + PS C:\> Get-SPOEventReceiver -Web "/" - This example adds an announcements web part to the default.aspx web part page located in the root web of the root site collection. + Retrieves all Site scoped Event Receivers for the root Site. @@ -7633,18 +7827,14 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web"Connect-SPOSite - - Get-SPOFile - - - Add-SPOWebPart - Web Parts + Remove-SPOContentType + Content Types - Adds a web part to a web part page or wiki page. + Adds a new content type to an existing List. Copyright 2016 Falchion Consulting, LLC @@ -7653,12 +7843,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Add - SPOWebPart - 1.3.0.0 + Remove + SPOContentType + 1.3.1.0 - Adds a web part to a web part page or wiki page. + Adds a new content type to an existing List. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -7668,61 +7858,18 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Add-SPOWebPart - - Zone - String - - - ZoneIndex - Int32 - - - Web - SPOWebPipeBind - - - File - SPOFilePipeBind - - - WebPart - XmlDocumentPipeBind - - - Title - String - - - - Add-SPOWebPart - - Row - Int32 - - - Column - Int32 - - - AddSpace - SwitchParameter - + Remove-SPOContentType Web SPOWebPipeBind - File - SPOFilePipeBind + List + SPOListPipeBind - WebPart - XmlDocumentPipeBind - - - Title - String + ContentType + SPOContentTypePipeBind @@ -7730,7 +7877,7 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" Web - Specifies the identity of the Site containing the file to add the web part to. + Specifies the identity of the Site containing the Content Type or List containing the Content Type to remove the Content Type from. The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. @@ -7744,15 +7891,15 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - File + List - Specifies the file to add the web part to. + Specifies the List to remove the Content Type from. - The type must be a valid server relative URL, in the form /site_name/list_name/file_name, or an SPOFile or SPOWikiPage object, or Microsoft.SharePoint.Client.File object. + The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. - SPOFilePipeBind + SPOListPipeBind - SPOFilePipeBind + SPOListPipeBind @@ -7760,97 +7907,13 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - WebPart - - The web part XML file to add to the page. - - XmlDocumentPipeBind - - XmlDocumentPipeBind - - - - - - - - Title - - The title of the web part to add. - - String - - String - - - - - - - - Zone - - The zone to add the web part to. - - String - - String - - - - - - - - ZoneIndex - - The zone index to add the web part to. - - Int32 - - Int32 - - - - - - - - Row - - The zone to add the web part to. - - Int32 - - Int32 - - - - - - - - Column - - The zone index to add the web part to. - - Int32 - - Int32 - - - - - - - - AddSpace + ContentType - Add some space before the web part. + Sets a value that specifies the Content Type to remove. The type must be a valid name, Content Type ID, Microsoft.SharePoint.Client.ContentType object or SPOContentType object. - SwitchParameter + SPOContentTypePipeBind - SwitchParameter + SPOContentTypePipeBind @@ -7885,22 +7948,15 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help Add-SPOWebPart -detailed". For technical information, type "Get-Help Add-SPOWebPart -full". + For more information, type "Get-Help Remove-SPOContentType -detailed". For technical information, type "Get-Help Remove-SPOContentType -full". - ------------------EXAMPLE 1----------------------- - PS C:\> Add-SPOWebPart -Web "/" -File "/default.aspx" -WebPart "c:\announcements.webpart" -Title "Announcements" -Zone "MiddleColumn" -ZoneIndex 1 - - This example adds an announcements web part to the default.aspx web part page located in the root web of the root site collection. - - - - ------------------EXAMPLE 2----------------------- - PS C:\> Add-SPOWebPart -Web "/" -File "/sitepages/home.aspx" -WebPart "c:\announcements.webpart" -Row 1 -Column 1 -AddSpace + ------------------EXAMPLE------------------ + PS C:\> Remove-SPOContentType -Web "/" -List "Documents" -ContentType "My Content Type" - This example adds an announcements web part to the home.aspx wiki page located in the root web of the root site collection. + This example removes a content type with the name of My Content Type from the Documents list. @@ -7909,18 +7965,14 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web"Connect-SPOSite - - Get-SPOFile - - - Get-SPOWebPart - Web Parts + Add-SPOContentType + Content Types - Gets a web part or list of web parts from a web part page or wiki page. + Adds a new content type to an existing List. Copyright 2016 Falchion Consulting, LLC @@ -7929,12 +7981,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Get - SPOWebPart - 1.3.0.0 + Add + SPOContentType + 1.3.1.0 - Gets a web part or list of web parts from a web part page or wiki page. + Adds a new content type to an existing List. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -7944,10 +7996,18 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Get-SPOWebPart - - Title - String + Add-SPOContentType + + Web + SPOWebPipeBind + + + List + SPOListPipeBind + + + ContentType + SPOContentTypePipeBind @@ -7955,7 +8015,7 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" Web - Specifies the identity of the Site containing the file to get the web part from. + Specifies the identity of the Site containing the List to create the new Content Type within. The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. @@ -7968,30 +8028,30 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - File + + List - Specifies the file to get the web part from. + Specifies the List to add the Content Type to. - The type must be a valid server relative URL, in the form /site_name/list_name/file_name, or an SPOFile or SPOWikiPage object, or Microsoft.SharePoint.Client.File object. + The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. - SPOFilePipeBind + SPOListPipeBind - SPOFilePipeBind + SPOListPipeBind - - Title + + ContentType - The title of the web part to add. + Sets a value that specifies the Content Type that the new Content Type will inherit from. The type must be a valid name, Content Type ID, Microsoft.SharePoint.Client.ContentType object or SPOContentType object. - String + SPOContentTypePipeBind - String + SPOContentTypePipeBind @@ -8026,22 +8086,15 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help Get-SPOWebPart -detailed". For technical information, type "Get-Help Get-SPOWebPart -full". + For more information, type "Get-Help Add-SPOContentType -detailed". For technical information, type "Get-Help Add-SPOContentType -full". - ------------------EXAMPLE 1----------------------- - PS C:\> Add-SPOWebPart -Web "/" -File "/sitepages/home.aspx" -WebPart "c:\announcements.webpart" -Row 1 -Column 1 -AddSpace - - This example adds an announcements web part to the home.aspx wiki page located in the root web of the root site collection. - - - - ------------------EXAMPLE 2----------------------- - PS C:\> Add-SPOWebPart -Web "/" -File "/default.aspx" -WebPart "c:\announcements.webpart" -Title "Announcements" -Zone "MiddleColumn" -ZoneIndex 1 + ------------------EXAMPLE------------------ + PS C:\> Add-SPOContentType -Web "/" -List "Documents" -ContentType "My Content Type" - This example adds an announcements web part to the default.aspx web part page located in the root web of the root site collection. + This example adds a content type with the name of My Content Type to the Documents list. @@ -8050,18 +8103,14 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web"Connect-SPOSite - - Get-SPOFile - - - Set-SPOWikiPageLayout - Wiki Pages + Get-SPOContentType + Content Types - Sets the layout for a wiki page within an existing List. + Retrieves the Content Types for the Site or List. Copyright 2016 Falchion Consulting, LLC @@ -8070,12 +8119,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Use of this cmdlet is at your own risk. > Gary Lapointe assumes no liability. - Set - SPOWikiPageLayout - 1.3.0.0 + Get + SPOContentType + 1.3.1.0 - Sets the layout for a wiki page within an existing List. + Retrieves the Content Types for the Site or List. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -8085,51 +8134,41 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - Set-SPOWikiPageLayout - - List - SPOListPipeBind - + Get-SPOContentType Web SPOWebPipeBind - - WikiPageName - String + + List + SPOListPipeBind - - WikiPageLayout - OneColumn | OneColumnSideBar | TwoColumns | TwoColumnsHeader | TwoColumnsHeaderFooter | ThreeColumns | ThreeColumnsHeader | ThreeColumnsHeaderFooter + + Identity + String - Set-SPOWikiPageLayout - - Folder - SPOFolder - + Get-SPOContentType Web SPOWebPipeBind - - WikiPageName + + Identity String - - WikiPageLayout - OneColumn | OneColumnSideBar | TwoColumns | TwoColumnsHeader | TwoColumnsHeaderFooter | ThreeColumns | ThreeColumnsHeader | ThreeColumnsHeaderFooter - Web - Specifies the identity of the Site containing the file to update. + Specifies the identity of the Site containing the List whose Content Types will be retrieved. The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. + + If not specified then the current Site Collection's Event Receiver Definitions will be retrieved. SPOWebPipeBind @@ -8140,14 +8179,14 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - + List - Specifies the List containing the file to update. + Specifies the identity of the List whose Content Types will be retrieved. The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. - SPOListPipeBind + SPOListPipeBind SPOListPipeBind @@ -8156,28 +8195,12 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - Folder - - Specifies the Folder containing the file to update. - - The type must be a valid SPOFolder object. - - SPOFolder - - SPOFolder - - - - - - - - WikiPageName + + Identity - The name of the wiki page to update. + The name or ID of the Content Type to retrieve. - String + String String @@ -8186,20 +8209,6 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - WikiPageLayout - - The page layout to set the wiki page to. - - WikiPageLayout - - WikiPageLayout - - - - - - @@ -8228,15 +8237,22 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help Set-SPOWikiPageLayout -detailed". For technical information, type "Get-Help Set-SPOWikiPageLayout -full". + For more information, type "Get-Help Get-SPOContentType -detailed". For technical information, type "Get-Help Get-SPOContentType -full". - ------------------EXAMPLE------------------ - PS C:\> Set-SPOWikiPageLayout -Web "/" -List "Site Pages" -WikiPageName "MyWikiPage.aspx" -WikiPageLayout "OneColumnSideBar" + ------------------EXAMPLE 1----------------------- + PS C:\> Get-SPOContentType -Web "/" - This example sets the layout of an existing wiki page within the Site Pages list under the root Site of the root Site Collection. + Retrieves all the Content Types for the root Site of the current Site Collection. + + + + ------------------EXAMPLE 2----------------------- + PS C:\> Get-SPOContentType -Web "/" -Identity "Document" + + Retrieves the Document Content Types from the root Site of the current Site Collection. @@ -8245,18 +8261,14 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web"Connect-SPOSite - - Get-SPOList - - - New-SPOWikiPage - Wiki Pages + New-SPOContentType + Content Types - Creates a new wiki page within an existing List. + Creates a new content type within an existing Site or List. Copyright 2016 Falchion Consulting, LLC @@ -8266,11 +8278,11 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" > Gary Lapointe assumes no liability. New - SPOWikiPage - 1.3.0.0 + SPOContentType + 1.3.1.0 - Creates a new wiki page within an existing List. + Creates a new content type within an existing Site or List. Copyright 2016 Falchion Consulting, LLC > For more information on this cmdlet and others: @@ -8280,41 +8292,30 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - New-SPOWikiPage - - List - SPOListPipeBind - + New-SPOContentType Web SPOWebPipeBind - - WikiPageName + + Name String - - WikiPageLayout - OneColumn | OneColumnSideBar | TwoColumns | TwoColumnsHeader | TwoColumnsHeaderFooter | ThreeColumns | ThreeColumnsHeader | ThreeColumnsHeaderFooter - - - - New-SPOWikiPage - Folder - SPOFolder - - - Web - SPOWebPipeBind + Description + String - - WikiPageName + + Group String - - WikiPageLayout - OneColumn | OneColumnSideBar | TwoColumns | TwoColumnsHeader | TwoColumnsHeaderFooter | ThreeColumns | ThreeColumnsHeader | ThreeColumnsHeaderFooter + + ParentContentType + SPOContentTypePipeBind + + + FieldsToAdd + String[] @@ -8322,7 +8323,7 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" Web - Specifies the identity of the Site containing the List to add the file to. + Specifies the identity of the Site to create the new Content Type within. The type must be a valid server relative URL, in the form /site_name, or an SPOWeb object, Microsoft.SharePoint.Client.Web object, or GUID representing the Site ID. @@ -8335,44 +8336,40 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - List + + Name - Specifies the List to add the file to. - - The type must be a valid absolute URL, in the form http://contoso.sharepoint.com/site_name/lists/list_name, or an SPOList object, Microsoft.SharePoint.Client.List object, List title, or GUID representing the List ID. + Specifies the name of the new Content Type. - SPOListPipeBind + String - SPOListPipeBind + String - - Folder + + Description - Specifies the Folder to add the file to. - - The type must be a valid SPOFolder object. + Describes the new Content Type. If no description is specified, the entry is left blank. - SPOFolder + String - SPOFolder + String - - WikiPageName + + Group - The name of the wiki page to create. + Describes the new Content Type. If no description is specified, the entry is left blank. - String + String String @@ -8381,14 +8378,28 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - - WikiPageLayout + + ParentContentType - The page layout to set the wiki page to. The default value is "ThreeColumnsHeaderFooter". + Sets a value that specifies the Content Type that the new Content Type will inherit from. The type must be a valid name, Content Type ID, Microsoft.SharePoint.Client.ContentType object or SPOContentType object. - WikiPageLayout + SPOContentTypePipeBind - WikiPageLayout + SPOContentTypePipeBind + + + + + + + + FieldsToAdd + + An array of internal field names to add to the content type. + + String[] + + String[] @@ -8423,15 +8434,15 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web" - For more information, type "Get-Help New-SPOWikiPage -detailed". For technical information, type "Get-Help New-SPOWikiPage -full". + For more information, type "Get-Help New-SPOContentType -detailed". For technical information, type "Get-Help New-SPOContentType -full". ------------------EXAMPLE------------------ - PS C:\> New-SPOWikiPage -Web "/" -List "Site Pages" -WikiPageName "MyWikiPage.aspx" + PS C:\> New-SPOContentType -Web "/" -Name "My Content Type" -ParentContentType $contentType - This example creates a new wiki page within the Site Pages list under the root Site of the root Site Collection. + This example creates a new content type with the name of My Content Type under the root Site of the current Site Collection. @@ -8440,10 +8451,6 @@ PS C:\> Invoke-SPORestMethod "https://contoso.sharepoint.com/_api/web"Connect-SPOSite - - Get-SPOList - - \ No newline at end of file diff --git a/Properties/AssemblyInfo.cs b/Properties/AssemblyInfo.cs index f8e4776..fcb6b44 100644 --- a/Properties/AssemblyInfo.cs +++ b/Properties/AssemblyInfo.cs @@ -32,5 +32,5 @@ // You can specify all the values or you can default the Build and Revision Numbers // by using the '*' as shown below: // [assembly: AssemblyVersion("1.0.*")] -[assembly: AssemblyVersion("1.3.0.0")] -[assembly: AssemblyFileVersion("1.3.0.0")] +[assembly: AssemblyVersion("1.3.1.0")] +[assembly: AssemblyFileVersion("1.3.1.0")]