SharePointPnP.PowerShell.2016.Commands.dll-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOFolderItem</command:name> <maml:description> <maml:para>List content in folder</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOFolderItem</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOFolderItem</maml:name> <command:parameter required="false" position="named"> <maml:name>FolderSiteRelativeUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ItemType</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ItemName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>FolderSiteRelativeUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ItemType</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ItemName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOTimeZoneId</command:name> <maml:description> <maml:para>Returns a time zone ID</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOTimeZoneId</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOTimeZoneId</maml:name> <command:parameter required="false" position="named"> <maml:name>Match</maml:name> <maml:description> <maml:para>A string to search for like 'Stockholm'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Match</maml:name> <maml:description> <maml:para>A string to search for like 'Stockholm'</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOTimeZoneId</dev:code> <maml:remarks> <maml:para>This will return all time zone IDs in use by Office 365.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOTimeZoneId -Match Stockholm</dev:code> <maml:remarks> <maml:para>This will return the time zone IDs for Stockholm</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Uninstall-SPOAppInstance</command:name> <maml:description> <maml:para>Removes an app from a site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Uninstall</command:verb> <command:noun>SPOAppInstance</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Uninstall-SPOAppInstance</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Appinstance or Id of the addin to remove.</maml:para> </maml:description> <command:parameterValue required="true">AppPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not ask for confirmation.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Appinstance or Id of the addin to remove.</maml:para> </maml:description> <command:parameterValue required="true">AppPipeBind</command:parameterValue> <dev:type> <maml:name>AppPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not ask for confirmation.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Uninstall-SPOAppInstance -Identity $appinstance</dev:code> <maml:remarks> <maml:para>Uninstalls the app instance which was retrieved with the command Get-SPOAppInstance</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Uninstall-SPOAppInstance -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe</dev:code> <maml:remarks> <maml:para>Uninstalls the app instance with the ID '99a00f6e-fb81-4dc7-8eac-e09c6f9132fe'</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Uninstall-SPOAppInstance -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -force</dev:code> <maml:remarks> <maml:para>Uninstalls the app instance with the ID '99a00f6e-fb81-4dc7-8eac-e09c6f9132fe' and do not ask for confirmation</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOAuthenticationRealm</command:name> <maml:description> <maml:para>Gets the authentication realm for the current web</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOAuthenticationRealm</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOAuthenticationRealm</maml:name> <command:parameter required="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the site</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the site</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOAuthenticationRealm</dev:code> <maml:remarks> <maml:para>This will get the authentication realm for the current connected site</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOAuthenticationRealm -Url https://contoso.sharepoint.com</dev:code> <maml:remarks> <maml:para>This will get the authentication realm for https://contoso.sharepoint.com</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-SPOResponsiveUI</command:name> <maml:description> <maml:para>Disables the PnP Responsive UI implementation on a classic SharePoint Web</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>SPOResponsiveUI</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Disable-SPOResponsiveUI</maml:name> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Disable-SPOResponsiveUI</dev:code> <maml:remarks> <maml:para>If previous enabled, will remove the PnP Responsive UI from a site.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-SPOResponsiveUI</command:name> <maml:description> <maml:para>Enables the PnP Responsive UI implementation on a classic SharePoint Web</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>SPOResponsiveUI</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Enable-SPOResponsiveUI</maml:name> <command:parameter required="false" position="named"> <maml:name>InfrastructureSiteUrl</maml:name> <maml:description> <maml:para>A full URL pointing to an infrastructure site. If specified, it will add a custom action pointing to the responsive UI JS code in that site.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>InfrastructureSiteUrl</maml:name> <maml:description> <maml:para>A full URL pointing to an infrastructure site. If specified, it will add a custom action pointing to the responsive UI JS code in that site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Enable-SPOResponsiveUI</dev:code> <maml:remarks> <maml:para>Will upload a CSS file, a JavaScript file and adds a custom action to the current web, enabling the responsive UI on that web. The CSS and JavaScript files are located in the style library, in a folder called SP.Responsive.UI.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOJavaScriptLink</command:name> <maml:description> <maml:para>Returns all or a specific custom action(s) with location type ScriptLink</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOJavaScriptLink</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOJavaScriptLink</maml:name> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Javascript link. Omit this parameter to retrieve all script links</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Scope of the action, either Web, Site or All to return both</maml:para> </maml:description> <command:parameterValue required="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Javascript link. Omit this parameter to retrieve all script links</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Scope of the action, either Web, Site or All to return both</maml:para> </maml:description> <command:parameterValue required="false">CustomActionScope</command:parameterValue> <dev:type> <maml:name>CustomActionScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOJavaScriptLink</dev:code> <maml:remarks> <maml:para>Returns all web and site scoped JavaScriptLinks</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOJavaScriptLink -Scope Web</dev:code> <maml:remarks> <maml:para>Returns all site scoped JavaScriptLinks</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOJavaScriptLink -Scope Site</dev:code> <maml:remarks> <maml:para>Returns all web scoped JavaScriptLinks</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOJavaScriptLink -Name Test</dev:code> <maml:remarks> <maml:para>Returns the JavaScriptLink named Test</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOTheme</command:name> <maml:description> <maml:para>Returns the current theme/composed look of the current web.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOTheme</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOTheme</maml:name> <command:parameter required="false" position="named"> <maml:name>DetectCurrentComposedLook</maml:name> <maml:description> <maml:para>Specify this switch to not use the PnP Provisioning engine based composed look information but try to detect the current composed look as is.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>DetectCurrentComposedLook</maml:name> <maml:description> <maml:para>Specify this switch to not use the PnP Provisioning engine based composed look information but try to detect the current composed look as is.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOTheme</dev:code> <maml:remarks> <maml:para>Returns the current composed look of the current web.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOTheme -DetectCurrentComposedLook</dev:code> <maml:remarks> <maml:para>Returns the current composed look of the current web, and will try to detect the currently applied composed look based upon the actual site. Without this switch the cmdlet will first check for the presence of a property bag variable called _PnP_ProvisioningTemplateComposedLookInfo that contains composed look information when applied through the provisioning engine or the Set-SPOTheme cmdlet.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SPOFieldFromContentType</command:name> <maml:description> <maml:para>Removes a site column from a content type</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPOFieldFromContentType</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-SPOFieldFromContentType</maml:name> <command:parameter required="true" position="named"> <maml:name>Field</maml:name> <maml:description> <maml:para>The field to remove.</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The content type where the field is to be removed from.</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DoNotUpdateChildren</maml:name> <maml:description> <maml:para>If specified, inherited content types will not be updated.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Field</maml:name> <maml:description> <maml:para>The field to remove.</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> <dev:type> <maml:name>FieldPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The content type where the field is to be removed from.</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DoNotUpdateChildren</maml:name> <maml:description> <maml:para>If specified, inherited content types will not be updated.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOFieldFromContentType -Field "Project_Name" -ContentType "Project Document"</dev:code> <maml:remarks> <maml:para>This will remove the site column with an internal name of "Project_Name" from a content type called "Project Document"</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOFieldFromContentType -Field "Project_Name" -ContentType "Project Document" -DoNotUpdateChildren</dev:code> <maml:remarks> <maml:para>This will remove the site column with an internal name of "Project_Name" from a content type called "Project Document". It will not update content types that inherit from the "Project Document" content type.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SPOContentTypeFromList</command:name> <maml:description> <maml:para>Removes a content type from a list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPOContentTypeFromList</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-SPOContentTypeFromList</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOContentTypeFromList -List "Documents" -ContentType "Project Document"</dev:code> <maml:remarks> <maml:para>This will remove a content type called "Project Document" from the "Documents" list</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPODefaultContentTypeToList</command:name> <maml:description> <maml:para>Sets the default content type for a list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPODefaultContentTypeToList</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPODefaultContentTypeToList</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPODefaultContentTypeToList -List "Project Documents" -ContentType "Project"</dev:code> <maml:remarks> <maml:para>This will set the Project content type (which has already been added to a list) as the default content type</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOContentTypeToList</command:name> <maml:description> <maml:para>Adds a new content type to a list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOContentTypeToList</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOContentTypeToList</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>Specifies the list the content type needs to be added to</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Specifies the content type that needs to be added to the list</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DefaultContentType</maml:name> <maml:description> <maml:para>Specify if the content type needs to be the default content type or not</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>Specifies the list the content type needs to be added to</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Specifies the content type that needs to be added to the list</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DefaultContentType</maml:name> <maml:description> <maml:para>Specify if the content type needs to be the default content type or not</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPOContentTypeToList -List "Documents" -ContentType "Project Document" -DefaultContentType</dev:code> <maml:remarks> <maml:para>This will add an existing content type to a list and sets it as the default content type</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOFieldToContentType</command:name> <maml:description> <maml:para>Adds an existing site column to a content type</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOFieldToContentType</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOFieldToContentType</maml:name> <command:parameter required="true" position="named"> <maml:name>Field</maml:name> <maml:description> <maml:para>Specifies the field that needs to be added to the content type</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Specifies which content type a field needs to be added to</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Required</maml:name> <maml:description> <maml:para>Specifies whether the field is required or not</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Hidden</maml:name> <maml:description> <maml:para>Specifies whether the field should be hidden or not</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Field</maml:name> <maml:description> <maml:para>Specifies the field that needs to be added to the content type</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> <dev:type> <maml:name>FieldPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Specifies which content type a field needs to be added to</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Required</maml:name> <maml:description> <maml:para>Specifies whether the field is required or not</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Hidden</maml:name> <maml:description> <maml:para>Specifies whether the field should be hidden or not</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPOFieldToContentType -Field "Project_Name" -ContentType "Project Document"</dev:code> <maml:remarks> <maml:para>This will add an existing site column with an internal name of "Project_Name" to a content type called "Project Document"</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SPOContentType</command:name> <maml:description> <maml:para>Removes a content type</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPOContentType</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-SPOContentType</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name or ID of the content type to remove</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name or ID of the content type to remove</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOContentType -Identity "Project Document"</dev:code> <maml:remarks> <maml:para>This will remove a content type called "Project Document" from the current web</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOContentType -Identity "Project Document" -Force</dev:code> <maml:remarks> <maml:para>This will remove a content type called "Project Document" from the current web with force</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOContentType</command:name> <maml:description> <maml:para>Retrieves a content type</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOContentType</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOContentType</maml:name> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Name or ID of the content type to retrieve</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>List</maml:name> <maml:description> <maml:para>List to query</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>InSiteHierarchy</maml:name> <maml:description> <maml:para>Search site hierarchy for content types</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Name or ID of the content type to retrieve</maml:para> </maml:description> <command:parameterValue required="false">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>List</maml:name> <maml:description> <maml:para>List to query</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>InSiteHierarchy</maml:name> <maml:description> <maml:para>Search site hierarchy for content types</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOContentType </dev:code> <maml:remarks> <maml:para>This will get a listing of all available content types within the current web</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOContentType -InSiteHierarchy</dev:code> <maml:remarks> <maml:para>This will get a listing of all available content types within the site collection</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOContentType -Identity "Project Document"</dev:code> <maml:remarks> <maml:para>This will get a listing of content types within the current context</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOContentType -List "Documents"</dev:code> <maml:remarks> <maml:para>This will get a listing of all available content types within the list "Documents"</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOContentType</command:name> <maml:description> <maml:para>Adds a new content type</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOContentType</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOContentType</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify the name of the new content type</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentTypeId</maml:name> <maml:description> <maml:para>If specified, in the format of 0x0100233af432334r434343f32f3, will create a content type with the specific ID</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the new content type</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>Specifies the group of the new content type</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ParentContentType</maml:name> <maml:description> <maml:para>Specifies the parent of the new content type</maml:para> </maml:description> <command:parameterValue required="true">ContentType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify the name of the new content type</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentTypeId</maml:name> <maml:description> <maml:para>If specified, in the format of 0x0100233af432334r434343f32f3, will create a content type with the specific ID</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the new content type</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>Specifies the group of the new content type</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ParentContentType</maml:name> <maml:description> <maml:para>Specifies the parent of the new content type</maml:para> </maml:description> <command:parameterValue required="false">ContentType</command:parameterValue> <dev:type> <maml:name>ContentType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPOContentType -Name "Project Document" -Description "Use for Contoso projects" -Group "Contoso Content Types" -ParentContentType $ct</dev:code> <maml:remarks> <maml:para>This will add a new content type based on the parent content type stored in the $ct variable.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOEventReceiver</command:name> <maml:description> <maml:para>Adds a new event receiver</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOEventReceiver</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOEventReceiver</maml:name> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EventReceiverType</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">EventReceiverType</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Synchronization</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">EventReceiverSynchronization</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SequenceNumber</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EventReceiverType</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">EventReceiverType</command:parameterValue> <dev:type> <maml:name>EventReceiverType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Synchronization</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">EventReceiverSynchronization</command:parameterValue> <dev:type> <maml:name>EventReceiverSynchronization</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SequenceNumber</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPOEventReceiver -List "ProjectList" -Name "TestEventReceiver" -Url https://yourserver.azurewebsites.net/eventreceiver.svc -EventReceiverType ItemAdded -Synchronization Asynchronous</dev:code> <maml:remarks> <maml:para>This will add a new event receiver that is executed after an item has been added to the ProjectList list</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOEventReceiver</command:name> <maml:description> <maml:para>Returns all or a specific event receiver</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOEventReceiver</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOEventReceiver</maml:name> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOEventReceiver</dev:code> <maml:remarks> <maml:para>This will return all registered event receivers on the current web</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOEventReceiver -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22</dev:code> <maml:remarks> <maml:para>This will return a specific registered event receivers from the current web</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOEventReceiver -List "ProjectList"</dev:code> <maml:remarks> <maml:para>This will return all registered event receivers in the list with the name ProjectList</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOEventReceiver -List "ProjectList" -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22</dev:code> <maml:remarks> <maml:para>This will return a specific registered event receiver in the list with the name ProjectList</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SPOEventReceiver</command:name> <maml:description> <maml:para>Removes/unregisters a specific event receiver</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPOEventReceiver</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-SPOEventReceiver</maml:name> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOEventReceiver -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22</dev:code> <maml:remarks> <maml:para>This will remove an event receiver with id fb689d0e-eb99-4f13-beb3-86692fd39f22 from the current web</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOEventReceiver -List ProjectList -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22</dev:code> <maml:remarks> <maml:para>This will remove an event receiver with id fb689d0e-eb99-4f13-beb3-86692fd39f22 from the list with name "ProjectList"</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOFieldFromXml</command:name> <maml:description> <maml:para>Adds a field to a list or as a site column based upon a CAML/XML field definition</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOFieldFromXml</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOFieldFromXml</maml:name> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>FieldXml</maml:name> <maml:description> <maml:para>CAML snippet containing the field definition. See http://msdn.microsoft.com/en-us/library/office/ms437580(v=office.15).aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>FieldXml</maml:name> <maml:description> <maml:para>CAML snippet containing the field definition. See http://msdn.microsoft.com/en-us/library/office/ms437580(v=office.15).aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $xml = '<Field Type="Text" Name="PSCmdletTest" DisplayName="PSCmdletTest" ID="{27d81055-f208-41c9-a976-61c5473eed4a}" Group="Test" Required="FALSE" StaticName="PSCmdletTest" />' PS:> Add-SPOFieldFromXml -FieldXml $xml</dev:code> <maml:remarks> <maml:para>Adds a field with the specified field CAML code to the site.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $xml = '<Field Type="Text" Name="PSCmdletTest" DisplayName="PSCmdletTest" ID="{27d81055-f208-41c9-a976-61c5473eed4a}" Group="Test" Required="FALSE" StaticName="PSCmdletTest" />' PS:> Add-SPOFieldFromXml -List "Demo List" -FieldXml $xml</dev:code> <maml:remarks> <maml:para>Adds a field with the specified field CAML code to the site.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Field CAML:</maml:linkText> <maml:uri>http://msdn.microsoft.com/en-us/library/office/ms437580(v=office.15).aspx</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOTaxonomyField</command:name> <maml:description> <maml:para>Adds a taxonomy field to a list or as a site column.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOTaxonomyField</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOTaxonomyField</maml:name> <command:parameter required="true" position="named"> <maml:name>TermSetPath</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermPathDelimiter</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InternalName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MultiValue</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Required</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FieldOptions</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">AddFieldOptions</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-SPOTaxonomyField</maml:name> <command:parameter required="false" position="named"> <maml:name>TaxonomyItemId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InternalName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MultiValue</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Required</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FieldOptions</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">AddFieldOptions</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InternalName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TermSetPath</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TaxonomyItemId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermPathDelimiter</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MultiValue</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Required</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FieldOptions</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">AddFieldOptions</command:parameterValue> <dev:type> <maml:name>AddFieldOptions</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPOTaxonomyField -DisplayName "Test" -InternalName "Test" -TermSetPath "TestTermGroup|TestTermSet"</dev:code> <maml:remarks> <maml:para>Adds a new taxonomy field called "Test" that points to the TestTermSet which is located in the TestTermGroup</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SPOField</command:name> <maml:description> <maml:para>Removes a field from a list or a site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPOField</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-SPOField</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> <dev:type> <maml:name>FieldPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOField</command:name> <maml:description> <maml:para>Returns a field from a list or site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOField</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOField</maml:name> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">FieldPipeBind</command:parameterValue> <dev:type> <maml:name>FieldPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOField</command:name> <maml:description> <maml:para>Adds a field to a list or as a site column</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOField</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOField</maml:name> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InternalName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">FieldType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Required</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-SPOField</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Field</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-SPOField</maml:name> <command:parameter required="true" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InternalName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">FieldType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-SPOField</maml:name> <command:parameter required="false" position="named"> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Required</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Field</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> <dev:type> <maml:name>FieldPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InternalName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">FieldType</command:parameterValue> <dev:type> <maml:name>FieldType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Required</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPOField -List "Demo list" -DisplayName "Location" -InternalName "SPSLocation" -Type Choice -Group "Demo Group" -AddToDefaultView -Choices "Stockholm","Helsinki","Oslo"</dev:code> <maml:remarks> <maml:para>This will add field of type Choice to a the list "Demo List".</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Add-SPOField -List "Demo list" -DisplayName "Speakers" -InternalName "SPSSpeakers" -Type MultiChoice -Group "Demo Group" -AddToDefaultView -Choices "Obiwan Kenobi","Darth Vader", "Anakin Skywalker"</dev:code> <maml:remarks> <maml:para>This will add field of type Multiple Choice to a the list "Demo List". (you can pick several choices for the same item)</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOSitePolicy</command:name> <maml:description> <maml:para>Retrieves all or a specific site policy</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOSitePolicy</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOSitePolicy</maml:name> <command:parameter required="false" position="named"> <maml:name>AllAvailable</maml:name> <maml:description> <maml:para>Retrieve all available site policies</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Retrieves a site policy with a specific name</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AllAvailable</maml:name> <maml:description> <maml:para>Retrieve all available site policies</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Retrieves a site policy with a specific name</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOSitePolicy</dev:code> <maml:remarks> <maml:para>Retrieves the current applied site policy.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOSitePolicy -AllAvailable</dev:code> <maml:remarks> <maml:para>Retrieves all available site policies.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOSitePolicy -Name "Contoso HBI"</dev:code> <maml:remarks> <maml:para>Retrieves an available site policy with the name "Contoso HBI".</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPOSitePolicy</command:name> <maml:description> <maml:para>Sets a site policy</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPOSitePolicy</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPOSitePolicy</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the site policy to apply</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the site policy to apply</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOSitePolicy -Name "Contoso HBI"</dev:code> <maml:remarks> <maml:para>This applies a site policy with the name "Contoso HBI" to the current site. The policy needs to be available in the site.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOListItem</command:name> <maml:description> <maml:para>Adds an item to a list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOListItem</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOListItem</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Specify either the name, ID or an actual content type.</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Use the internal names of the fields when specifying field names</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Specify either the name, ID or an actual content type.</maml:para> </maml:description> <command:parameterValue required="false">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Use the internal names of the fields when specifying field names</maml:para> </maml:description> <command:parameterValue required="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Add-SPOListItem -List "Demo List" -Values @{"Title" = "Test Title"; "Category"="Test Category"}</dev:code> <maml:remarks> <maml:para>Adds a new list item to the "Demo List", and sets both the Title and Category fields with the specified values. Notice, use the internal names of fields.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Add-SPOListItem -List "Demo List" -ContentType "Company" -Values @{"Title" = "Test Title"; "Category"="Test Category"}</dev:code> <maml:remarks> <maml:para>Adds a new list item to the "Demo List", sets the content type to "Company" and sets both the Title and Category fields with the specified values. Notice, use the internal names of fields.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOView</command:name> <maml:description> <maml:para>Adds a view to a list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOView</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOView</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the view.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Query</maml:name> <maml:description> <maml:para>A valid CAML Query.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>A list of fields to add.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ViewType</maml:name> <maml:description> <maml:para>The type of view to add.</maml:para> </maml:description> <command:parameterValue required="true">ViewType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RowLimit</maml:name> <maml:description> <maml:para>The row limit for the view. Defaults to 30.</maml:para> </maml:description> <command:parameterValue required="true">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Personal</maml:name> <maml:description> <maml:para>If specified, a personal view will be created.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetAsDefault</maml:name> <maml:description> <maml:para>If specified, the view will be set as the default view for the list.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Paged</maml:name> <maml:description> <maml:para>If specified, the view will have paging.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the view.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Query</maml:name> <maml:description> <maml:para>A valid CAML Query.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>A list of fields to add.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ViewType</maml:name> <maml:description> <maml:para>The type of view to add.</maml:para> </maml:description> <command:parameterValue required="false">ViewType</command:parameterValue> <dev:type> <maml:name>ViewType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RowLimit</maml:name> <maml:description> <maml:para>The row limit for the view. Defaults to 30.</maml:para> </maml:description> <command:parameterValue required="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Personal</maml:name> <maml:description> <maml:para>If specified, a personal view will be created.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetAsDefault</maml:name> <maml:description> <maml:para>If specified, the view will be set as the default view for the list.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Paged</maml:name> <maml:description> <maml:para>If specified, the view will have paging.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Add-SPOView -List "Demo List" -Title "Demo View" -Fields "Title","Address"</dev:code> <maml:remarks> <maml:para>Adds a view named "Demo view" to the "Demo List" list.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Add-SPOView -List "Demo List" -Title "Demo View" -Fields "Title","Address" -Paged</dev:code> <maml:remarks> <maml:para>Adds a view named "Demo view" to the "Demo List" list and makes sure there's paging on this view.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPODefaultColumnValues</command:name> <maml:description> <maml:para>Sets default column values for a document library</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPODefaultColumnValues</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets default column values for a document library, per folder, or for the root folder if the folder parameter has not been specified. Supports both text and taxonomy fields.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-SPODefaultColumnValues</maml:name> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Name or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Field</maml:name> <maml:description> <maml:para>The internal name, id or a reference to a field</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>A list of values. In case of a text field the values will be concatenated, separated by a semi-column. In case of a taxonomy field multiple values will added</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>A library relative folder path, if not specified it will set the default column values on the root folder of the library ('/')</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Name or Url of the list.</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Field</maml:name> <maml:description> <maml:para>The internal name, id or a reference to a field</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> <dev:type> <maml:name>FieldPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>A list of values. In case of a text field the values will be concatenated, separated by a semi-column. In case of a taxonomy field multiple values will added</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>A library relative folder path, if not specified it will set the default column values on the root folder of the library ('/')</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPODefaultColumnValues -List Documents -Field TaxKeyword -Value "Company|Locations|Stockholm"</dev:code> <maml:remarks> <maml:para>Sets a default value for the enterprise keywords field on a library to a term called "Stockholm", located in the "Locations" term set, which is part of the "Company" term group</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPODefaultColumnValues -List Documents -Field MyTextField -Value "DefaultValue"</dev:code> <maml:remarks> <maml:para>Sets a default value for the MyTextField text field on a library to a value of "DefaultValue"</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOView</command:name> <maml:description> <maml:para>Returns one or all views from a list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOView</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOView</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ViewPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">ViewPipeBind</command:parameterValue> <dev:type> <maml:name>ViewPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-SPOView -List "Demo List"</dev:code> <maml:remarks> <maml:para>Returns all views associated from the specified list</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-SPOView -List "Demo List" -Identity "Demo View"</dev:code> <maml:remarks> <maml:para>Returns the view called "Demo View" from the specified list</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-SPOView -List "Demo List" -Identity "5275148a-6c6c-43d8-999a-d2186989a661"</dev:code> <maml:remarks> <maml:para>Returns the view with the specified ID from the specified list</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SPOView</command:name> <maml:description> <maml:para>Deletes a view from a list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPOView</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-SPOView</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID or Title of the list.</maml:para> </maml:description> <command:parameterValue required="true">ViewPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID or Title of the list.</maml:para> </maml:description> <command:parameterValue required="true">ViewPipeBind</command:parameterValue> <dev:type> <maml:name>ViewPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SPOList</command:name> <maml:description> <maml:para>Deletes a list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPOList</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-SPOList</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID or Title of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID or Title of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOMasterPage</command:name> <maml:description> <maml:para>Adds a Masterpage</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOMasterPage</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOMasterPage</maml:name> <command:parameter required="true" position="named"> <maml:name>SourceFilePath</maml:name> <maml:description> <maml:para>Path to the file which will be uploaded</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title for the page layout</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description for the page layout</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DestinationFolderHierarchy</maml:name> <maml:description> <maml:para>Folder hierarchy where the MasterPage layouts will be deployed</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UiVersion</maml:name> <maml:description> <maml:para>UiVersion Masterpage. Default = 15</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DefaultCssFile</maml:name> <maml:description> <maml:para>Default CSS file for MasterPage, this Url is SiteRelative</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>SourceFilePath</maml:name> <maml:description> <maml:para>Path to the file which will be uploaded</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title for the page layout</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description for the page layout</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DestinationFolderHierarchy</maml:name> <maml:description> <maml:para>Folder hierarchy where the MasterPage layouts will be deployed</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UiVersion</maml:name> <maml:description> <maml:para>UiVersion Masterpage. Default = 15</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DefaultCssFile</maml:name> <maml:description> <maml:para>Default CSS file for MasterPage, this Url is SiteRelative</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPOMasterPage -SourceFilePath "page.master" -Title "MasterPage" -Description "MasterPage for Web" -DestinationFolderHierarchy "SubFolder"</dev:code> <maml:remarks> <maml:para>Adds a MasterPage to the web</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOAuditing</command:name> <maml:description> <maml:para>Get the Auditing setting of a site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOAuditing</command:noun> <dev:version /> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOAuditing</dev:code> <maml:remarks> <maml:para>Gets the auditing settings of the current site</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPOAuditing</command:name> <maml:description> <maml:para>Set Auditing setting for a site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPOAuditing</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPOAuditing</maml:name> <command:parameter required="false" position="named"> <maml:name>EnableAll</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetentionTime</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TrimAuditLog</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SPOAuditing</maml:name> <command:parameter required="false" position="named"> <maml:name>DisableAll</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SPOAuditing</maml:name> <command:parameter required="false" position="named"> <maml:name>RetentionTime</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TrimAuditLog</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EditItems</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckOutCheckInItems</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MoveCopyItems</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DeleteRestoreItems</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EditContentTypesColumns</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SearchContent</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EditUsersPermissions</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>EnableAll</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisableAll</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetentionTime</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TrimAuditLog</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EditItems</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckOutCheckInItems</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MoveCopyItems</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DeleteRestoreItems</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EditContentTypesColumns</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SearchContent</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EditUsersPermissions</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOAuditing -EnableAll</dev:code> <maml:remarks> <maml:para>Enables all auditing settings for the current site</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOAuditing -DisableAll</dev:code> <maml:remarks> <maml:para>Disables all auditing settings for the current site This also disables the automatic trimming of the audit log</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOAuditing -RetentionTime 7</dev:code> <maml:remarks> <maml:para>Sets the audit log trimming to 7 days, this also enables the automatic trimming of the audit log</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOAuditing -TrimAuditLog</dev:code> <maml:remarks> <maml:para>Enables the automatic trimming of the audit log</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOAuditing -RetentionTime 7 -CheckOutCheckInItems -MoveCopyItems -SearchContent</dev:code> <maml:remarks> <maml:para>Sets the audit log trimming to 7 days, this also enables the automatic trimming of the audit log. Do auditing for: - Checking out or checking in items - Moving or copying items to another location in the site - Searching site content</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Import-SPOTermGroupFromXml</command:name> <maml:description> <maml:para>Imports a taxonomy TermGroup from either the input or from an XML file.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>SPOTermGroupFromXml</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Import-SPOTermGroupFromXml</maml:name> <command:parameter required="false" position="named"> <maml:name>Xml</maml:name> <maml:description> <maml:para>The XML to process</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Import-SPOTermGroupFromXml</maml:name> <command:parameter required="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>The XML File to import the data from</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Xml</maml:name> <maml:description> <maml:para>The XML to process</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>The XML File to import the data from</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Import-SPOTermGroupFromXml -Xml $xml</dev:code> <maml:remarks> <maml:para>Imports the XML based termgroup information located in the $xml variable</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Import-SPOTermGroupFromXml -Path input.xml</dev:code> <maml:remarks> <maml:para>Imports the XML file specified by the path.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Export-SPOTermGroupToXml</command:name> <maml:description> <maml:para>Exports a taxonomy TermGroup to either the output or to an XML file.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Export</command:verb> <command:noun>SPOTermGroupToXml</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Export-SPOTermGroupToXml</maml:name> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID or name of the termgroup</maml:para> </maml:description> <command:parameterValue required="true">TermGroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>File to export the data to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FullTemplate</maml:name> <maml:description> <maml:para>If specified, a full provisioning template structure will be returned</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Encoding</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID or name of the termgroup</maml:para> </maml:description> <command:parameterValue required="false">TermGroupPipeBind</command:parameterValue> <dev:type> <maml:name>TermGroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>File to export the data to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FullTemplate</maml:name> <maml:description> <maml:para>If specified, a full provisioning template structure will be returned</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Encoding</command:parameterValue> <dev:type> <maml:name>Encoding</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Export-SPOTermGroupToXml</dev:code> <maml:remarks> <maml:para>Exports all term groups in the default site collection term store to the standard output</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Export-SPOTermGroupToXml -Out output.xml</dev:code> <maml:remarks> <maml:para>Exports all term groups in the default site collection term store to the file 'output.xml' in the current folder</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Export-SPOTermGroupToXml -Out c:\output.xml -Identity "Test Group"</dev:code> <maml:remarks> <maml:para>Exports the term group with the specified name to the file 'output.xml' located in the root folder of the C: drive.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SPOTermGroup</command:name> <maml:description> <maml:para>Creates a taxonomy term group</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>SPOTermGroup</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-SPOTermGroup</maml:name> <command:parameter required="true" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Name of the taxonomy term group to create.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>GUID to use for the term group; if not specified, or the empty GUID, a random GUID is generated and used.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description to use for the term group.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStoreName</maml:name> <maml:description> <maml:para>Term store to check; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Name of the taxonomy term group to create.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>GUID to use for the term group; if not specified, or the empty GUID, a random GUID is generated and used.</maml:para> </maml:description> <command:parameterValue required="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description to use for the term group.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStoreName</maml:name> <maml:description> <maml:para>Term store to check; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOTermGroup</command:name> <maml:description> <maml:para>Returns a taxonomy term group</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOTermGroup</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOTermGroup</maml:name> <command:parameter required="true" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Name of the taxonomy term group to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStoreName</maml:name> <maml:description> <maml:para>Term store to check; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Name of the taxonomy term group to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStoreName</maml:name> <maml:description> <maml:para>Term store to check; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Import-SPOTermSet</command:name> <maml:description> <maml:para>Imports a taxonomy term set from a file in the standard format.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>SPOTermSet</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The format of the file is the same as that used by the import function in the web interface. A sample file can be obtained from the web interface. This is a CSV file, with the following headings: Term Set Name,Term Set Description,LCID,Available for Tagging,Term Description,Level 1 Term,Level 2 Term,Level 3 Term,Level 4 Term,Level 5 Term,Level 6 Term,Level 7 Term The first data row must contain the Term Set Name, Term Set Description, and LCID, and should also contain the first term. It is recommended that a fixed GUID be used as the termSetId, to allow the term set to be easily updated (so do not pass Guid.Empty). In contrast to the web interface import, this is not a one-off import but runs synchronisation logic allowing updating of an existing Term Set. When synchronising, any existing terms are matched (with Term Description and Available for Tagging updated as necessary), any new terms are added in the correct place in the hierarchy, and (if synchroniseDeletions is set) any terms not in the imported file are removed. The import file also supports an expanded syntax for the Term Set Name and term names (Level 1 Term, Level 2 Term, etc). These columns support values with the format 'Name | GUID', with the name and GUID separated by a pipe character (note that the pipe character is invalid to use within a taxomony item name). This expanded syntax is not required, but can be used to ensure all terms have fixed IDs.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-SPOTermSet</maml:name> <command:parameter required="true" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Group to import the term set to; an error is returned if the group does not exist.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Local path to the file containing the term set to import, in the standard format (as the 'sample import file' available in the Term Store Administration).</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermSetId</maml:name> <maml:description> <maml:para>GUID to use for the term set; if not specified, or the empty GUID, a random GUID is generated and used.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SynchronizeDeletions</maml:name> <maml:description> <maml:para>If specified, the import will remove any terms (and children) previously in the term set but not in the import file; default is to leave them.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsOpen</maml:name> <maml:description> <maml:para>Whether the term set should be marked open; if not specified, then the existing setting is not changed.</maml:para> </maml:description> <command:parameterValue required="true">Nullable`1</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Contact</maml:name> <maml:description> <maml:para>Contact for the term set; if not specified, the existing setting is retained.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>Owner for the term set; if not specified, the existing setting is retained.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStoreName</maml:name> <maml:description> <maml:para>Term store to import into; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Group to import the term set to; an error is returned if the group does not exist.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Local path to the file containing the term set to import, in the standard format (as the 'sample import file' available in the Term Store Administration).</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermSetId</maml:name> <maml:description> <maml:para>GUID to use for the term set; if not specified, or the empty GUID, a random GUID is generated and used.</maml:para> </maml:description> <command:parameterValue required="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SynchronizeDeletions</maml:name> <maml:description> <maml:para>If specified, the import will remove any terms (and children) previously in the term set but not in the import file; default is to leave them.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsOpen</maml:name> <maml:description> <maml:para>Whether the term set should be marked open; if not specified, then the existing setting is not changed.</maml:para> </maml:description> <command:parameterValue required="false">Nullable`1</command:parameterValue> <dev:type> <maml:name>Nullable`1</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Contact</maml:name> <maml:description> <maml:para>Contact for the term set; if not specified, the existing setting is retained.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>Owner for the term set; if not specified, the existing setting is retained.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStoreName</maml:name> <maml:description> <maml:para>Term store to import into; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Import-SPOTermSet -GroupName 'Standard Terms' -Path 'C:\\Temp\\ImportTermSet.csv' -SynchronizeDeletions</dev:code> <maml:remarks> <maml:para>Creates (or updates) the term set specified in the import file, in the group specified, removing any existing terms not in the file.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Import-SPOTermSet -TermStoreName 'My Term Store' -GroupName 'Standard Terms' -Path 'C:\\Temp\\ImportTermSet.csv' -TermSetId '{15A98DB6-D8E2-43E6-8771-066C1EC2B8D8}' </dev:code> <maml:remarks> <maml:para>Creates (or updates) the term set specified in the import file, in the term store and group specified, using the specified ID.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Import-SPOTermSet -GroupName 'Standard Terms' -Path 'C:\\Temp\\ImportTermSet.csv' -IsOpen $true -Contact 'user@example.org' -Owner 'user@example.org'</dev:code> <maml:remarks> <maml:para>Creates (or updates) the term set specified in the import file, setting the IsOpen, Contact, and Owner properties as specified.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOWebPartProperty</command:name> <maml:description> <maml:para>Returns a web part property</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOWebPartProperty</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOWebPartProperty</maml:name> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOWebPartProperty -ServerRelativePageUrl /sites/demo/sitepages/home.aspx -Identity ccd2c98a-c9ae-483b-ae72-19992d583914</dev:code> <maml:remarks> <maml:para>Returns all properties of the webpart.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOWebPartProperty -ServerRelativePageUrl /sites/demo/sitepages/home.aspx -Identity ccd2c98a-c9ae-483b-ae72-19992d583914 -Key "Title"</dev:code> <maml:remarks> <maml:para>Returns the title property of the webpart.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SPOJavaScriptLink</command:name> <maml:description> <maml:para>Removes a JavaScript link or block from a web or sitecollection</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPOJavaScriptLink</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-SPOJavaScriptLink</maml:name> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the JavaScriptLink to remove. Omit if you want to remove all JavaScript Links.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Use the -Force flag to bypass the confirmation question</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Define if the JavaScriptLink is to be found at the web or site collection scope. Specify All to allow deletion from either web or site collection.</maml:para> </maml:description> <command:parameterValue required="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the JavaScriptLink to remove. Omit if you want to remove all JavaScript Links.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Use the -Force flag to bypass the confirmation question</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Define if the JavaScriptLink is to be found at the web or site collection scope. Specify All to allow deletion from either web or site collection.</maml:para> </maml:description> <command:parameterValue required="false">CustomActionScope</command:parameterValue> <dev:type> <maml:name>CustomActionScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOJavaScriptLink -Name jQuery</dev:code> <maml:remarks> <maml:para>Removes the injected JavaScript file with the name jQuery from the current web after confirmation</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOJavaScriptLink -Name jQuery -Scope Site</dev:code> <maml:remarks> <maml:para>Removes the injected JavaScript file with the name jQuery from the current site collection after confirmation</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOJavaScriptLink -Name jQuery -Scope Site -Force</dev:code> <maml:remarks> <maml:para>Removes the injected JavaScript file with the name jQuery from the current site collection and will not ask for confirmation</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOJavaScriptLink -Scope Site</dev:code> <maml:remarks> <maml:para>Removes all the injected JavaScript files with from the current site collection after confirmation for each of them</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOJavaScriptLink</command:name> <maml:description> <maml:para>Adds a link to a JavaScript file to a web or sitecollection</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOJavaScriptLink</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOJavaScriptLink</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name under which to register the JavaScriptLink</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>URL to the JavaScript file to inject</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>Sequence of this JavaScript being injected. Use when you have a specific sequence with which to have JavaScript files being added to the page. I.e. jQuery library first and then jQueryUI.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines if this JavaScript file will be injected to every page within the current site collection or web. All is not allowed in for this command. Default is web.</maml:para> </maml:description> <command:parameterValue required="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name under which to register the JavaScriptLink</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>URL to the JavaScript file to inject</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>Sequence of this JavaScript being injected. Use when you have a specific sequence with which to have JavaScript files being added to the page. I.e. jQuery library first and then jQueryUI.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines if this JavaScript file will be injected to every page within the current site collection or web. All is not allowed in for this command. Default is web.</maml:para> </maml:description> <command:parameterValue required="false">CustomActionScope</command:parameterValue> <dev:type> <maml:name>CustomActionScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPOJavaScriptLink -Name jQuery -Url https://code.jquery.com/jquery.min.js -Sequence 9999 -Scope Site</dev:code> <maml:remarks> <maml:para>Injects a reference to the latest v1 series jQuery library to all pages within the current site collection under the name jQuery and at order 9999</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPOJavaScriptLink -Name jQuery -Url https://code.jquery.com/jquery.min.js</dev:code> <maml:remarks> <maml:para>Injects a reference to the latest v1 series jQuery library to all pages within the current web under the name jQuery</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOJavaScriptBlock</command:name> <maml:description> <maml:para>Adds a link to a JavaScript snippet/block to a web or site collection</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOJavaScriptBlock</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Specify a scope as 'Site' to add the custom action to all sites in a site collection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOJavaScriptBlock</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the script block. Can be used to identiy the script with other cmdlets or coded solutions</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Script</maml:name> <maml:description> <maml:para>The javascript block to add</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Sequence</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The scope of the script to add to. Either Web or Site, defaults to Web. All is not valid for this command.</maml:para> </maml:description> <command:parameterValue required="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the script block. Can be used to identiy the script with other cmdlets or coded solutions</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Script</maml:name> <maml:description> <maml:para>The javascript block to add</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Sequence</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The scope of the script to add to. Either Web or Site, defaults to Web. All is not valid for this command.</maml:para> </maml:description> <command:parameterValue required="false">CustomActionScope</command:parameterValue> <dev:type> <maml:name>CustomActionScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-SPOWebAction</command:name> <maml:description> <maml:para>Executes operations on web, lists, list items.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>SPOWebAction</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Invoke-SPOWebAction</maml:name> <command:parameter required="false" position="named"> <maml:name>Webs</maml:name> <maml:description> <maml:para>Webs you want to process (for example diffrent site collections), will use Web parameter if not specified</maml:para> </maml:description> <command:parameterValue required="true">Web[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebAction</maml:name> <maml:description> <maml:para>Function to be exectued on the web. There is one input parameter of type Web</maml:para> </maml:description> <command:parameterValue required="true">Action`1</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShouldProcessWebAction</maml:name> <maml:description> <maml:para>Function to be executed on the web that would decide if WebAction should be invoked, There is one input parameter of type Web and the function should return a bool value</maml:para> </maml:description> <command:parameterValue required="true">Func`2</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PostWebAction</maml:name> <maml:description> <maml:para>Function to be exectued on the web, this will trigger after lists and list items have been proccessed. There is one input parameter of type Web</maml:para> </maml:description> <command:parameterValue required="true">Action`1</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShouldProcessPostWebAction</maml:name> <maml:description> <maml:para>Function to be executed on the web that would decide if PostWebAction should be invoked, There is one input parameter of type Web and the function should return a bool value</maml:para> </maml:description> <command:parameterValue required="true">Func`2</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebProperties</maml:name> <maml:description> <maml:para>The properties to load for web.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ListAction</maml:name> <maml:description> <maml:para>Function to be exectued on the list. There is one input parameter of type List</maml:para> </maml:description> <command:parameterValue required="true">Action`1</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShouldProcessListAction</maml:name> <maml:description> <maml:para>Function to be executed on the web that would decide if ListAction should be invoked, There is one input parameter of type List and the function should return a bool value</maml:para> </maml:description> <command:parameterValue required="true">Func`2</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PostListAction</maml:name> <maml:description> <maml:para>Function to be exectued on the list, this will trigger after list items have been proccesse. There is one input parameter of type List</maml:para> </maml:description> <command:parameterValue required="true">Action`1</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShouldProcessPostListAction</maml:name> <maml:description> <maml:para>Function to be executed on the web that would decide if PostListAction should be invoked, There is one input parameter of type List and the function should return a bool value</maml:para> </maml:description> <command:parameterValue required="true">Func`2</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ListProperties</maml:name> <maml:description> <maml:para>The properties to load for list.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ListItemAction</maml:name> <maml:description> <maml:para>Function to be exectued on the list item. There is one input parameter of type ListItem</maml:para> </maml:description> <command:parameterValue required="true">Action`1</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShouldProcessListItemAction</maml:name> <maml:description> <maml:para>Function to be executed on the web that would decide if ListItemAction should be invoked, There is one input parameter of type ListItem and the function should return a bool value</maml:para> </maml:description> <command:parameterValue required="true">Func`2</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ListItemProperties</maml:name> <maml:description> <maml:para>The properties to load for list items.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SubWebs</maml:name> <maml:description> <maml:para>Specify if sub webs will be processed</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisableStatisticsOutput</maml:name> <maml:description> <maml:para>Will not output statistics after the operation</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipCounting</maml:name> <maml:description> <maml:para>Will skip the counting process, by doing this you will not get an estimated time remaining</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Webs</maml:name> <maml:description> <maml:para>Webs you want to process (for example diffrent site collections), will use Web parameter if not specified</maml:para> </maml:description> <command:parameterValue required="false">Web[]</command:parameterValue> <dev:type> <maml:name>Web[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebAction</maml:name> <maml:description> <maml:para>Function to be exectued on the web. There is one input parameter of type Web</maml:para> </maml:description> <command:parameterValue required="false">Action`1</command:parameterValue> <dev:type> <maml:name>Action`1</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShouldProcessWebAction</maml:name> <maml:description> <maml:para>Function to be executed on the web that would decide if WebAction should be invoked, There is one input parameter of type Web and the function should return a bool value</maml:para> </maml:description> <command:parameterValue required="false">Func`2</command:parameterValue> <dev:type> <maml:name>Func`2</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PostWebAction</maml:name> <maml:description> <maml:para>Function to be exectued on the web, this will trigger after lists and list items have been proccessed. There is one input parameter of type Web</maml:para> </maml:description> <command:parameterValue required="false">Action`1</command:parameterValue> <dev:type> <maml:name>Action`1</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShouldProcessPostWebAction</maml:name> <maml:description> <maml:para>Function to be executed on the web that would decide if PostWebAction should be invoked, There is one input parameter of type Web and the function should return a bool value</maml:para> </maml:description> <command:parameterValue required="false">Func`2</command:parameterValue> <dev:type> <maml:name>Func`2</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebProperties</maml:name> <maml:description> <maml:para>The properties to load for web.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ListAction</maml:name> <maml:description> <maml:para>Function to be exectued on the list. There is one input parameter of type List</maml:para> </maml:description> <command:parameterValue required="false">Action`1</command:parameterValue> <dev:type> <maml:name>Action`1</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShouldProcessListAction</maml:name> <maml:description> <maml:para>Function to be executed on the web that would decide if ListAction should be invoked, There is one input parameter of type List and the function should return a bool value</maml:para> </maml:description> <command:parameterValue required="false">Func`2</command:parameterValue> <dev:type> <maml:name>Func`2</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PostListAction</maml:name> <maml:description> <maml:para>Function to be exectued on the list, this will trigger after list items have been proccesse. There is one input parameter of type List</maml:para> </maml:description> <command:parameterValue required="false">Action`1</command:parameterValue> <dev:type> <maml:name>Action`1</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShouldProcessPostListAction</maml:name> <maml:description> <maml:para>Function to be executed on the web that would decide if PostListAction should be invoked, There is one input parameter of type List and the function should return a bool value</maml:para> </maml:description> <command:parameterValue required="false">Func`2</command:parameterValue> <dev:type> <maml:name>Func`2</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ListProperties</maml:name> <maml:description> <maml:para>The properties to load for list.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ListItemAction</maml:name> <maml:description> <maml:para>Function to be exectued on the list item. There is one input parameter of type ListItem</maml:para> </maml:description> <command:parameterValue required="false">Action`1</command:parameterValue> <dev:type> <maml:name>Action`1</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShouldProcessListItemAction</maml:name> <maml:description> <maml:para>Function to be executed on the web that would decide if ListItemAction should be invoked, There is one input parameter of type ListItem and the function should return a bool value</maml:para> </maml:description> <command:parameterValue required="false">Func`2</command:parameterValue> <dev:type> <maml:name>Func`2</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ListItemProperties</maml:name> <maml:description> <maml:para>The properties to load for list items.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SubWebs</maml:name> <maml:description> <maml:para>Specify if sub webs will be processed</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisableStatisticsOutput</maml:name> <maml:description> <maml:para>Will not output statistics after the operation</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipCounting</maml:name> <maml:description> <maml:para>Will skip the counting process, by doing this you will not get an estimated time remaining</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Invoke-SPOWebAction -ListAction ${function:ListAction}</dev:code> <maml:remarks> <maml:para>This will call the function ListAction on all the lists located on the current web.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Invoke-SPOWebAction -ShouldProcessListAction ${function:ShouldProcessList} -ListAction ${function:ListAction}</dev:code> <maml:remarks> <maml:para>This will call the function ShouldProcessList, if it returns true the function ListAction will then be called. This will occur on all lists located on the current web</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Ensure-SPOFolder</command:name> <maml:description> <maml:para>Returns a folder given a site relative path, and will create it if it not exists.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Ensure</command:verb> <command:noun>SPOFolder</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Ensure-SPOFolder</maml:name> <command:parameter required="true" position="named"> <maml:name>SiteRelativePath</maml:name> <maml:description> <maml:para>Site Relative Folder Path</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>SiteRelativePath</maml:name> <maml:description> <maml:para>Site Relative Folder Path</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Ensure-SPOFolder -SiteRelativePath "demofolder/subfolder"</dev:code> <maml:remarks> <maml:para>Creates a folder called subfolder in a folder called demofolder with located in the root folder of the site. If the folder hierarchy does not exist, it will be created.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOFolder</command:name> <maml:description> <maml:para>Creates a folder within a parent folder</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOFolder</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOFolder</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The folder name</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The parent folder in the site</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The folder name</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The parent folder in the site</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPOFolder -Name NewFolder -Folder _catalogs/masterpage/newfolder</dev:code> <maml:remarks> <maml:para /> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SPOIndexedProperty</command:name> <maml:description> <maml:para>Removes a key from propertybag to be indexed by search. The key and it's value retain in the propertybag, however it will not be indexed anymore.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPOIndexedProperty</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-SPOIndexedProperty</maml:name> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SPOFile</command:name> <maml:description> <maml:para>Removes a file.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPOFile</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-SPOFile</maml:name> <command:parameter required="true" position="named"> <maml:name>ServerRelativeUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SPOFile</maml:name> <command:parameter required="true" position="named"> <maml:name>SiteRelativeUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ServerRelativeUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SiteRelativeUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Remove-SPOFile -ServerRelativeUrl /sites/project/_catalogs/themes/15/company.spcolor</dev:code> <maml:remarks> <maml:para /> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Remove-SPOFile -SiteRelativeUrl _catalogs/themes/15/company.spcolor</dev:code> <maml:remarks> <maml:para /> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOIndexedPropertyKeys</command:name> <maml:description> <maml:para>Returns the keys of the property bag values that have been marked for indexing by search</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOIndexedPropertyKeys</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOIndexedPropertyKeys</maml:name> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOIndexedProperty</command:name> <maml:description> <maml:para>Marks the value of the propertybag key to be indexed by search.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOIndexedProperty</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOIndexedProperty</maml:name> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SPOFolder</command:name> <maml:description> <maml:para>Deletes a folder within a parent folder</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPOFolder</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-SPOFolder</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The folder name</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The parent folder in the site</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The folder name</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The parent folder in the site</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOFolder -Name NewFolder -Folder _catalogs/masterpage/newfolder</dev:code> <maml:remarks> <maml:para /> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SPOWeb</command:name> <maml:description> <maml:para>Removes a subweb in the current web</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPOWeb</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-SPOWeb</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The site relative url of the web, e.g. 'Subweb1'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not ask for confirmation to delete the subweb</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SPOWeb</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity/Id/Web object to delete</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not ask for confirmation to delete the subweb</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The site relative url of the web, e.g. 'Subweb1'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity/Id/Web object to delete</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not ask for confirmation to delete the subweb</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOWeb -Url projectA</dev:code> <maml:remarks> <maml:para>Remove a web</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOWeb -Identity 5fecaf67-6b9e-4691-a0ff-518fc9839aa0</dev:code> <maml:remarks> <maml:para>Remove a web specified by its ID</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOSubWebs | Remove-SPOWeb -Force</dev:code> <maml:remarks> <maml:para>Remove all subwebs and do not ask for confirmation</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOPublishingPage</command:name> <maml:description> <maml:para>Adds a publishing page</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOPublishingPage</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOPublishingPage</maml:name> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PageName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PageTemplateName</maml:name> <maml:description> <maml:para>The name of the page layout you want to use. Specify without the .aspx extension. So 'ArticleLeft' or 'BlankWebPartPage'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Publish</maml:name> <maml:description> <maml:para>Publishes the page. Also Approves it if moderation is enabled on the Pages library.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>PageName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PageTemplateName</maml:name> <maml:description> <maml:para>The name of the page layout you want to use. Specify without the .aspx extension. So 'ArticleLeft' or 'BlankWebPartPage'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Publish</maml:name> <maml:description> <maml:para>Publishes the page. Also Approves it if moderation is enabled on the Pages library.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Uninstall-SPOSolution</command:name> <maml:description> <maml:para>Uninstalls a sandboxed solution from a site collection</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Uninstall</command:verb> <command:noun>SPOSolution</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Uninstall-SPOSolution</maml:name> <command:parameter required="true" position="named"> <maml:name>PackageId</maml:name> <maml:description> <maml:para>ID of the solution, from the solution manifest</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PackageName</maml:name> <maml:description> <maml:para>Filename of the WSP file to uninstall</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MajorVersion</maml:name> <maml:description> <maml:para>Optional major version of the solution, defaults to 1</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinorVersion</maml:name> <maml:description> <maml:para>Optional minor version of the solution, defaults to 0</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>PackageId</maml:name> <maml:description> <maml:para>ID of the solution, from the solution manifest</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PackageName</maml:name> <maml:description> <maml:para>Filename of the WSP file to uninstall</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MajorVersion</maml:name> <maml:description> <maml:para>Optional major version of the solution, defaults to 1</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinorVersion</maml:name> <maml:description> <maml:para>Optional minor version of the solution, defaults to 0</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Install-SPOSolution</command:name> <maml:description> <maml:para>Installs a sandboxed solution to a site collection. WARNING! This method can delete your composed look gallery due to the method used to activate the solution. We recommend you to only to use this cmdlet if you are okay with that.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Install</command:verb> <command:noun>SPOSolution</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Install-SPOSolution</maml:name> <command:parameter required="true" position="named"> <maml:name>PackageId</maml:name> <maml:description> <maml:para>ID of the solution, from the solution manifest</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SourceFilePath</maml:name> <maml:description> <maml:para>Path to the sandbox solution package (.WSP) file</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MajorVersion</maml:name> <maml:description> <maml:para>Optional major version of the solution, defaults to 1</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinorVersion</maml:name> <maml:description> <maml:para>Optional minor version of the solution, defaults to 0</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>PackageId</maml:name> <maml:description> <maml:para>ID of the solution, from the solution manifest</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SourceFilePath</maml:name> <maml:description> <maml:para>Path to the sandbox solution package (.WSP) file</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MajorVersion</maml:name> <maml:description> <maml:para>Optional major version of the solution, defaults to 1</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinorVersion</maml:name> <maml:description> <maml:para>Optional minor version of the solution, defaults to 0</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOTaxonomyItem</command:name> <maml:description> <maml:para>Returns a taxonomy item</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOTaxonomyItem</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOTaxonomyItem</maml:name> <command:parameter required="true" position="named"> <maml:name>Term</maml:name> <maml:description> <maml:para>The path, delimited by | of the taxonomy item to retrieve, alike GROUPLABEL|TERMSETLABEL|TERMLABEL</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Term</maml:name> <maml:description> <maml:para>The path, delimited by | of the taxonomy item to retrieve, alike GROUPLABEL|TERMSETLABEL|TERMLABEL</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPOTaxonomyFieldValue</command:name> <maml:description> <maml:para>Sets a taxonomy term value in a listitem field</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPOTaxonomyFieldValue</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPOTaxonomyFieldValue</maml:name> <command:parameter required="true" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The Label value of the term</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TermId</maml:name> <maml:description> <maml:para>The Id of the Term</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ListItem</maml:name> <maml:description> <maml:para>The list item to set the field value to</maml:para> </maml:description> <command:parameterValue required="true">ListItem</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InternalFieldName</maml:name> <maml:description> <maml:para>The internal name of the field</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SPOTaxonomyFieldValue</maml:name> <command:parameter required="true" position="named"> <maml:name>TermPath</maml:name> <maml:description> <maml:para>A path in the form of GROUPLABEL|TERMSETLABEL|TERMLABEL</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ListItem</maml:name> <maml:description> <maml:para>The list item to set the field value to</maml:para> </maml:description> <command:parameterValue required="true">ListItem</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InternalFieldName</maml:name> <maml:description> <maml:para>The internal name of the field</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ListItem</maml:name> <maml:description> <maml:para>The list item to set the field value to</maml:para> </maml:description> <command:parameterValue required="true">ListItem</command:parameterValue> <dev:type> <maml:name>ListItem</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InternalFieldName</maml:name> <maml:description> <maml:para>The internal name of the field</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The Label value of the term</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TermId</maml:name> <maml:description> <maml:para>The Id of the Term</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TermPath</maml:name> <maml:description> <maml:para>A path in the form of GROUPLABEL|TERMSETLABEL|TERMLABEL</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOTaxonomyFieldValue -ListItem $item -InternalFieldName 'Department' -Label 'HR'</dev:code> <maml:remarks> <maml:para /> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOTaxonomyFieldValue -ListItem $item -InternalFieldName 'Department' -TermPath 'CORPORATE|DEPARTMENTS|HR'</dev:code> <maml:remarks> <maml:para /> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOList</command:name> <maml:description> <maml:para>Returns a List object</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOList</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOList</maml:name> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID or Url of the list.</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOList</dev:code> <maml:remarks> <maml:para>Returns all lists in the current web</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOList -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe</dev:code> <maml:remarks> <maml:para>Returns a list with the given id.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOList -Identity /Lists/Announcements</dev:code> <maml:remarks> <maml:para>Returns a list with the given url.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SPOList</command:name> <maml:description> <maml:para>Creates a new list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>SPOList</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-SPOList</maml:name> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>The type of list to create.</maml:para> </maml:description> <command:parameterValue required="true">ListTemplateType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>If set, will override the url of the list.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableVersioning</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableContentTypes</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OnQuickLaunch</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>The type of list to create.</maml:para> </maml:description> <command:parameterValue required="true">ListTemplateType</command:parameterValue> <dev:type> <maml:name>ListTemplateType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>If set, will override the url of the list.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableVersioning</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableContentTypes</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OnQuickLaunch</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-SPOList -Title Announcements -Template Announcements</dev:code> <maml:remarks> <maml:para /> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-SPOList -Title "Demo List" -Url "DemoList" -Template Announcements</dev:code> <maml:remarks> <maml:para>Create a list with a title that is different from the url</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPOAppSideLoading</command:name> <maml:description> <maml:para>Enables the App Side Loading Feature on a site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPOAppSideLoading</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPOAppSideLoading</maml:name> <command:parameter required="true" position="named"> <maml:name>On</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SPOAppSideLoading</maml:name> <command:parameter required="true" position="named"> <maml:name>Off</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>On</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Off</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOSite</command:name> <maml:description> <maml:para>Returns the current site collection from the context.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOSite</command:noun> <dev:version /> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SPOTenantSite</command:name> <maml:description> <maml:para>Creates a new site collection for the current tenant</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>SPOTenantSite</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-SPOTenantSite cmdlet creates a new site collection for the current company. However, creating a new SharePoint Online site collection fails if a deleted site with the same URL exists in the Recycle Bin. If you want to use this command for an on-premises farm, please refer to http://blogs.msdn.com/b/vesku/archive/2014/06/09/provisioning-site-collections-using-sp-app-model-in-on-premises-with-just-csom.aspx </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-SPOTenantSite</maml:name> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Specifies the title of the new site collection</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the full URL of the new site collection. It must be in a valid managed path in the company's site. For example, for company contoso, valid managed paths are https://contoso.sharepoint.com/sites and https://contoso.sharepoint.com/teams.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the new site collection</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>Specifies the user name of the site collection's primary owner. The owner must be a user instead of a security group or an email-enabled security group.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lcid</maml:name> <maml:description> <maml:para>Specifies the language of this site collection. For more information, see Locale IDs Assigned by Microsoft: http://go.microsoft.com/fwlink/p/?LinkId=242911Id=242911.</maml:para> </maml:description> <command:parameterValue required="true">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>Specifies the site collection template type. Use the Get-SPOWebTemplate cmdlet to get the list of valid templates. If no template is specified, one can be added later. The Template and LocaleId parameters must be a valid combination as returned from the Get-SPOnlineWebTemplate cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>Use Get-SPOTimeZoneId to retrieve possible timezone values</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResourceQuota</maml:name> <maml:description> <maml:para>Specifies the quota for this site collection in Sandboxed Solutions units. This value must not exceed the company's aggregate available Sandboxed Solutions quota. The default value is 0. For more information, see Resource Usage Limits on Sandboxed Solutions in SharePoint 2010 : http://msdn.microsoft.com/en-us/library/gg615462.aspx.</maml:para> </maml:description> <command:parameterValue required="true">Double</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResourceQuotaWarningLevel</maml:name> <maml:description> <maml:para>Specifies the warning level for the resource quota. This value must not exceed the value set for the ResourceQuota parameter</maml:para> </maml:description> <command:parameterValue required="true">Double</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StorageQuota</maml:name> <maml:description> <maml:para>Specifies the storage quota for this site collection in megabytes. This value must not exceed the company's available quota.</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StorageQuotaWarningLevel</maml:name> <maml:description> <maml:para>Specifies the warning level for the storage quota in megabytes. This value must not exceed the values set for the StorageQuota parameter</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Specifies the title of the new site collection</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the full URL of the new site collection. It must be in a valid managed path in the company's site. For example, for company contoso, valid managed paths are https://contoso.sharepoint.com/sites and https://contoso.sharepoint.com/teams.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the new site collection</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>Specifies the user name of the site collection's primary owner. The owner must be a user instead of a security group or an email-enabled security group.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lcid</maml:name> <maml:description> <maml:para>Specifies the language of this site collection. For more information, see Locale IDs Assigned by Microsoft: http://go.microsoft.com/fwlink/p/?LinkId=242911Id=242911.</maml:para> </maml:description> <command:parameterValue required="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>Specifies the site collection template type. Use the Get-SPOWebTemplate cmdlet to get the list of valid templates. If no template is specified, one can be added later. The Template and LocaleId parameters must be a valid combination as returned from the Get-SPOnlineWebTemplate cmdlet.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>Use Get-SPOTimeZoneId to retrieve possible timezone values</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResourceQuota</maml:name> <maml:description> <maml:para>Specifies the quota for this site collection in Sandboxed Solutions units. This value must not exceed the company's aggregate available Sandboxed Solutions quota. The default value is 0. For more information, see Resource Usage Limits on Sandboxed Solutions in SharePoint 2010 : http://msdn.microsoft.com/en-us/library/gg615462.aspx.</maml:para> </maml:description> <command:parameterValue required="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResourceQuotaWarningLevel</maml:name> <maml:description> <maml:para>Specifies the warning level for the resource quota. This value must not exceed the value set for the ResourceQuota parameter</maml:para> </maml:description> <command:parameterValue required="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StorageQuota</maml:name> <maml:description> <maml:para>Specifies the storage quota for this site collection in megabytes. This value must not exceed the company's available quota.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StorageQuotaWarningLevel</maml:name> <maml:description> <maml:para>Specifies the warning level for the storage quota in megabytes. This value must not exceed the values set for the StorageQuota parameter</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-SPOTenantSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso -Owner user@example.org -TimeZone 4</dev:code> <maml:remarks> <maml:para>This will add a site collection with the title 'Contoso', the url 'https://tenant.sharepoint.com/sites/contoso', the timezone 'UTC+01:00' and the owner 'user@example.org'</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Locale IDs:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/p/?LinkId=242911Id=242911</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resource Usage Limits on Sandboxed Solutions in SharePoint 2010:</maml:linkText> <maml:uri>http://msdn.microsoft.com/en-us/library/gg615462.aspx.</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Creating on-premises site collections using CSOM:</maml:linkText> <maml:uri>http://blogs.msdn.com/b/vesku/archive/2014/06/09/provisioning-site-collections-using-sp-app-model-in-on-premises-with-just-csom.aspx</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Import-SPOTaxonomy</command:name> <maml:description> <maml:para>Imports a taxonomy from either a string array or a file</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>SPOTaxonomy</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Import-SPOTaxonomy</maml:name> <command:parameter required="false" position="named"> <maml:name>Terms</maml:name> <maml:description> <maml:para>An array of strings describing termgroup, termset, term, subterms using a default delimiter of '|'.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lcid</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStoreName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Delimiter</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SynchronizeDeletions</maml:name> <maml:description> <maml:para>If specified, terms that exist in the termset, but are not in the imported data will be removed.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Import-SPOTaxonomy</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies a file containing terms per line, in the format as required by the Terms parameter.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lcid</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStoreName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Delimiter</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SynchronizeDeletions</maml:name> <maml:description> <maml:para>If specified, terms that exist in the termset, but are not in the imported data will be removed.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Terms</maml:name> <maml:description> <maml:para>An array of strings describing termgroup, termset, term, subterms using a default delimiter of '|'.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies a file containing terms per line, in the format as required by the Terms parameter.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lcid</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStoreName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Delimiter</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SynchronizeDeletions</maml:name> <maml:description> <maml:para>If specified, terms that exist in the termset, but are not in the imported data will be removed.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Import-SPOTaxonomy -Terms 'Company|Locations|Stockholm'</dev:code> <maml:remarks> <maml:para>Creates a new termgroup, 'Company', a termset 'Locations' and a term 'Stockholm'</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Import-SPOTaxonomy -Terms 'Company|Locations|Stockholm|Central','Company|Locations|Stockholm|North'</dev:code> <maml:remarks> <maml:para>Creates a new termgroup, 'Company', a termset 'Locations', a term 'Stockholm' and two subterms: 'Central', and 'North'</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Export-SPOTaxonomy</command:name> <maml:description> <maml:para>Exports a taxonomy to either the output or to a file.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Export</command:verb> <command:noun>SPOTaxonomy</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Export-SPOTaxonomy</maml:name> <command:parameter required="false" position="named"> <maml:name>TermSetId</maml:name> <maml:description> <maml:para>If specified, will export the specified termset only</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStoreName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeID</maml:name> <maml:description> <maml:para>If specified will include the ids of the taxonomy items in the output. Format: <label>;#<guid></maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>File to export the data to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Delimiter</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Encoding</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>TermSetId</maml:name> <maml:description> <maml:para>If specified, will export the specified termset only</maml:para> </maml:description> <command:parameterValue required="false">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeID</maml:name> <maml:description> <maml:para>If specified will include the ids of the taxonomy items in the output. Format: <label>;#<guid></maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>File to export the data to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStoreName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Delimiter</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Encoding</command:parameterValue> <dev:type> <maml:name>Encoding</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Export-SPOTaxonomy</dev:code> <maml:remarks> <maml:para>Exports the full taxonomy to the standard output</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Export-SPOTaxonomy -Path c:\output.txt</dev:code> <maml:remarks> <maml:para>Exports the full taxonomy the file output.txt</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Export-SPOTaxonomy -Path c:\output.txt -TermSet f6f43025-7242-4f7a-b739-41fa32847254 </dev:code> <maml:remarks> <maml:para>Exports the term set with the specified id</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOTaxonomySession</command:name> <maml:description> <maml:para>Returns a taxonomy session</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOTaxonomySession</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOTaxonomySession</maml:name> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Send-SPOMail</command:name> <maml:description> <maml:para>Sends an email using the Office 365 SMTP Service</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Send</command:verb> <command:noun>SPOMail</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Send-SPOMail</maml:name> <command:parameter required="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>From</maml:name> <maml:description> <maml:para>If using from address, you also have to provide a password</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>If using a password, you also have to provide the associated from address</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>To</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Cc</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Subject</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Body</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>From</maml:name> <maml:description> <maml:para>If using from address, you also have to provide a password</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>If using a password, you also have to provide the associated from address</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>To</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Cc</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Subject</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Body</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Send-SPOMail -To address@tenant.sharepointonline.com -Subject test -Body test</dev:code> <maml:remarks> <maml:para>Sends an e-mail using the SharePoint SendEmail method using the current context. E-mail is sent from the system account and can only be sent to accounts in the same tenant</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Send-SPOMail -To address@contoso.com -Subject test -Body test -From me@tenant.onmicrosoft.com -Password xyz</dev:code> <maml:remarks> <maml:para>Sends an e-mail via Office 365 SMTP and requires from address and password. E-mail is sent from the from user and can be sent to both internal and external addresses.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOWebPartToWebPartPage</command:name> <maml:description> <maml:para>Adds a webpart to a web part page in a specified zone</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOWebPartToWebPartPage</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOWebPartToWebPartPage</maml:name> <command:parameter required="true" position="named"> <maml:name>Xml</maml:name> <maml:description> <maml:para>A string containing the XML for the webpart.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Server Relative Url of the page to add the webpart to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ZoneId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ZoneIndex</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-SPOWebPartToWebPartPage</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>A path to a webpart file on a the file system.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Server Relative Url of the page to add the webpart to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ZoneId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ZoneIndex</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Server Relative Url of the page to add the webpart to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Xml</maml:name> <maml:description> <maml:para>A string containing the XML for the webpart.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>A path to a webpart file on a the file system.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ZoneId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ZoneIndex</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPOWebPartToWebPartPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Path "c:\myfiles\listview.webpart" -ZoneId "Header" -ZoneIndex 1 </dev:code> <maml:remarks> <maml:para>This will add the webpart as defined by the XML in the listview.webpart file to the specified page in the specified zone and with the order index of 1</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPOWebPartToWebPartPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -XML $webpart -ZoneId "Header" -ZoneIndex 1 </dev:code> <maml:remarks> <maml:para>This will add the webpart as defined by the XML in the $webpart variable to the specified page in the specified zone and with the order index of 1</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOWebPartToWikiPage</command:name> <maml:description> <maml:para>Adds a webpart to a wiki page in a specified table row and column</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOWebPartToWikiPage</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOWebPartToWikiPage</maml:name> <command:parameter required="true" position="named"> <maml:name>Xml</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Full server relative url of the webpart page, e.g. /sites/demo/sitepages/home.aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Row</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Column</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddSpace</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-SPOWebPartToWikiPage</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Full server relative url of the webpart page, e.g. /sites/demo/sitepages/home.aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Row</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Column</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddSpace</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Full server relative url of the webpart page, e.g. /sites/demo/sitepages/home.aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Xml</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Row</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Column</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddSpace</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPOWebPartToWikiPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Path "c:\myfiles\listview.webpart" -Row 1 -Column 1</dev:code> <maml:remarks> <maml:para>This will add the webpart as defined by the XML in the listview.webpart file to the specified page in the first row and the first column of the HTML table present on the page</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPOWebPartToWikiPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -XML $webpart -Row 1 -Column 1</dev:code> <maml:remarks> <maml:para>This will add the webpart as defined by the XML in the $webpart variable to the specified page in the first row and the first column of the HTML table present on the page</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPONavigationNode</command:name> <maml:description> <maml:para>Adds a menu item to either the quicklaunch or top navigation</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPONavigationNode</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPONavigationNode</maml:name> <command:parameter required="true" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location of the node to add. Either TopNavigationBar, QuickLaunch or SearchNav</maml:para> </maml:description> <command:parameterValue required="true">NavigationType</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the node to add</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The url to navigate to when clicking the new menu item.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Header</maml:name> <maml:description> <maml:para>Optionally value of a header entry to add the menu item to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>First</maml:name> <maml:description> <maml:para>Add the new menu item to beginning of the collection.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>External</maml:name> <maml:description> <maml:para>Indicates the destination URL is outside of the site collection.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location of the node to add. Either TopNavigationBar, QuickLaunch or SearchNav</maml:para> </maml:description> <command:parameterValue required="true">NavigationType</command:parameterValue> <dev:type> <maml:name>NavigationType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the node to add</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The url to navigate to when clicking the new menu item.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Header</maml:name> <maml:description> <maml:para>Optionally value of a header entry to add the menu item to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>First</maml:name> <maml:description> <maml:para>Add the new menu item to beginning of the collection.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>External</maml:name> <maml:description> <maml:para>Indicates the destination URL is outside of the site collection.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPONavigationNode -Title "Contoso" -Url "http://contoso.sharepoint.com/sites/contoso/" -Location "QuickLaunch"</dev:code> <maml:remarks> <maml:para>Adds a navigation node to the quicklaunch. The navigation node will have the title "Contoso" and will link to the url "http://contoso.sharepoint.com/sites/contoso/"</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPONavigationNode -Title "Contoso USA" -Url "http://contoso.sharepoint.com/sites/contoso/usa/" -Location "QuickLaunch" -Header "Contoso"</dev:code> <maml:remarks> <maml:para>Adds a navigation node to the quicklaunch. The navigation node will have the title "Contoso USA", will link to the url "http://contoso.sharepoint.com/sites/contoso/usa/" and will have "Contoso" as a parent navigation node.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPONavigationNode -Title "Contoso" -Url "http://contoso.sharepoint.com/sites/contoso/" -Location "QuickLaunch" -First</dev:code> <maml:remarks> <maml:para>Adds a navigation node to the quicklaunch, as the first item. The navigation node will have the title "Contoso" and will link to the url "http://contoso.sharepoint.com/sites/contoso/"</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPONavigationNode -Title "Contoso Pharmaceuticals" -Url "http://contoso.sharepoint.com/sites/contosopharma/" -Location "QuickLaunch" -External</dev:code> <maml:remarks> <maml:para>Adds a navigation node to the quicklaunch. The navigation node will have the title "Contoso Pharmaceuticals" and will link to the external url "http://contoso.sharepoint.com/sites/contosopharma/"</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPOWebPartProperty</command:name> <maml:description> <maml:para>Sets a web part property</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPOWebPartProperty</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPOWebPartProperty</maml:name> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SPOWebPart</command:name> <maml:description> <maml:para>Removes a webpart from a page</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPOWebPart</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-SPOWebPart</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SPOWebPart</maml:name> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOWebPart</command:name> <maml:description> <maml:para>Returns a webpart definition object</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOWebPart</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOWebPart</maml:name> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Full server relative url of the webpart page, e.g. /sites/mysite/sitepages/home.aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">WebPartPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Full server relative url of the webpart page, e.g. /sites/mysite/sitepages/home.aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">WebPartPipeBind</command:parameterValue> <dev:type> <maml:name>WebPartPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOWebPart -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx"</dev:code> <maml:remarks> <maml:para>Returns all webparts defined on the given page.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOWebPart -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Identity a2875399-d6ff-43a0-96da-be6ae5875f82</dev:code> <maml:remarks> <maml:para>Returns a specific webpart defined on the given page.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>-</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb></command:verb> <command:noun></command:noun> <dev:version></dev:version> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Import-SPOAppPackage</command:name> <maml:description> <maml:para>Adds a SharePoint Addin to a site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>SPOAppPackage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This commands requires that you have an addin package to deploy</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-SPOAppPackage</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path pointing to the .app file</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Will forcibly install the app by activating the addin sideloading feature, installing the addin, and deactivating the sideloading feature</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LoadOnly</maml:name> <maml:description> <maml:para>Will only upload the addin, but not install it</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Locale</maml:name> <maml:description> <maml:para>Will install the addin for the specified locale</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path pointing to the .app file</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Will forcibly install the app by activating the addin sideloading feature, installing the addin, and deactivating the sideloading feature</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LoadOnly</maml:name> <maml:description> <maml:para>Will only upload the addin, but not install it</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Locale</maml:name> <maml:description> <maml:para>Will install the addin for the specified locale</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Import-SPOAppPackage -Path c:\files\demo.app -LoadOnly</dev:code> <maml:remarks> <maml:para>This will load the addin in the demo.app package, but will not install it to the site. </maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Import-SPOAppPackage -Path c:\files\demo.app -Force</dev:code> <maml:remarks> <maml:para>This load first activate the addin sideloading feature, upload and install the addin, and deactivate the addin sideloading feature. </maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOAppInstance</command:name> <maml:description> <maml:para>Returns a SharePoint AddIn Instance in the site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOAppInstance</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOAppInstance</maml:name> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the Id of the App Instance</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the Id of the App Instance</maml:para> </maml:description> <command:parameterValue required="false">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOAppInstance</dev:code> <maml:remarks> <maml:para>This will return all addin instances in the site.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOAppInstance -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe</dev:code> <maml:remarks> <maml:para>This will return an addin instance with the specified id.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOFile</command:name> <maml:description> <maml:para>Downloads a file.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOFile</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOFile</maml:name> <command:parameter required="true" position="named"> <maml:name>ServerRelativeUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Filename</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsString</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SPOFile</maml:name> <command:parameter required="true" position="named"> <maml:name>SiteRelativeUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Filename</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsString</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ServerRelativeUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SiteRelativeUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Filename</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsString</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOFile -ServerRelativeUrl /sites/project/_catalogs/themes/15/company.spcolor</dev:code> <maml:remarks> <maml:para>Downloads the file and saves it to the current folder</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOFile -ServerRelativeUrl /sites/project/_catalogs/themes/15/company.spcolor -Path c:\temp -FileName company.spcolor</dev:code> <maml:remarks> <maml:para>Downloads the file and saves it to c:\temp\company.spcolor</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOFile -ServerRelativeUrl /sites/project/_catalogs/themes/15/company.spcolor -AsString</dev:code> <maml:remarks> <maml:para>Downloads the file and outputs its contents to the console</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOFile -SiteRelativeUrl _catalogs/themes/15/company.spcolor -Path c:\temp -FileName company.spcolor</dev:code> <maml:remarks> <maml:para>Refers to the file by site relative URL, downloads the file and saves it to c:\temp\company.spcolor</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOWeb</command:name> <maml:description> <maml:para>Returns the current web object</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOWeb</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOWeb</maml:name> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOSubWebs</command:name> <maml:description> <maml:para>Returns the subwebs</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOSubWebs</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOSubWebs</maml:name> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Find-SPOFile</command:name> <maml:description> <maml:para>Finds a file in the virtual file system of the web.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Find</command:verb> <command:noun>SPOFile</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Find-SPOFile</maml:name> <command:parameter required="true" position="named"> <maml:name>Match</maml:name> <maml:description> <maml:para>Wildcard query</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Match</maml:name> <maml:description> <maml:para>Wildcard query</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Find-SPOFile -Match *.master</dev:code> <maml:remarks> <maml:para>Will return all masterpages located in the current web.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SPOCustomAction</command:name> <maml:description> <maml:para>Removes a custom action</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPOCustomAction</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-SPOCustomAction</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The identifier of the CustomAction that needs to be removed</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Define if the CustomAction is to be found at the web or site collection scope. Specify All to allow deletion from either web or site collection.</maml:para> </maml:description> <command:parameterValue required="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Use the -Force flag to bypass the confirmation question</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The identifier of the CustomAction that needs to be removed</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Define if the CustomAction is to be found at the web or site collection scope. Specify All to allow deletion from either web or site collection.</maml:para> </maml:description> <command:parameterValue required="false">CustomActionScope</command:parameterValue> <dev:type> <maml:name>CustomActionScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Use the -Force flag to bypass the confirmation question</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOCustomAction -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2</dev:code> <maml:remarks> <maml:para>Removes the custom action with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2'.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOCustomAction -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2 -scope web</dev:code> <maml:remarks> <maml:para>Removes the custom action with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2' from the current web.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOCustomAction -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2 -force</dev:code> <maml:remarks> <maml:para>Removes the custom action with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2' without asking for confirmation.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOCustomAction</command:name> <maml:description> <maml:para>Returns all or a specific custom action(s)</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOCustomAction</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOCustomAction</maml:name> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity of the CustomAction to return. Omit to return all CustomActions.</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Scope of the CustomAction, either Web, Site or All to return both</maml:para> </maml:description> <command:parameterValue required="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity of the CustomAction to return. Omit to return all CustomActions.</maml:para> </maml:description> <command:parameterValue required="false">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Scope of the CustomAction, either Web, Site or All to return both</maml:para> </maml:description> <command:parameterValue required="false">CustomActionScope</command:parameterValue> <dev:type> <maml:name>CustomActionScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOCustomAction</dev:code> <maml:remarks> <maml:para>Returns all custom actions of the current site.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOCustomAction -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2</dev:code> <maml:remarks> <maml:para>Returns the custom action with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2'.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOCustomAction -Scope web</dev:code> <maml:remarks> <maml:para>Returns all custom actions for the current web object.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOCustomAction</command:name> <maml:description> <maml:para>Adds a custom action to a web</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOCustomAction</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOCustomAction</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>Sequence of this CustomAction being injected. Use when you have a specific sequence with which to have multple CustomActions being added to the page.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ImageUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CommandUIExtension</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RegistrationId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Rights</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">PermissionKind[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RegistrationType</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">UserCustomActionRegistrationType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The scope of the CustomAction to add to. Either Web or Site, defaults to Web. All is not valid for this command.</maml:para> </maml:description> <command:parameterValue required="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>Sequence of this CustomAction being injected. Use when you have a specific sequence with which to have multple CustomActions being added to the page.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ImageUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CommandUIExtension</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RegistrationId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Rights</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">PermissionKind[]</command:parameterValue> <dev:type> <maml:name>PermissionKind[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RegistrationType</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">UserCustomActionRegistrationType</command:parameterValue> <dev:type> <maml:name>UserCustomActionRegistrationType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The scope of the CustomAction to add to. Either Web or Site, defaults to Web. All is not valid for this command.</maml:para> </maml:description> <command:parameterValue required="false">CustomActionScope</command:parameterValue> <dev:type> <maml:name>CustomActionScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$cUIExtn = "<CommandUIExtension><CommandUIDefinitions><CommandUIDefinition Location=""Ribbon.List.Share.Controls._children""><Button Id=""Ribbon.List.Share.GetItemsCountButton"" Alt=""Get list items count"" Sequence=""11"" Command=""Invoke_GetItemsCountButtonRequest"" LabelText=""Get Items Count"" TemplateAlias=""o1"" Image32by32=""_layouts/15/images/placeholder32x32.png"" Image16by16=""_layouts/15/images/placeholder16x16.png"" /></CommandUIDefinition></CommandUIDefinitions><CommandUIHandlers><CommandUIHandler Command=""Invoke_GetItemsCountButtonRequest"" CommandAction=""javascript: alert('Total items in this list: '+ ctx.TotalListItems);"" EnabledScript=""javascript: function checkEnable() { return (true);} checkEnable();""/></CommandUIHandlers></CommandUIExtension>" Add-SPOCustomAction -Name 'GetItemsCount' -Title 'Invoke GetItemsCount Action' -Description 'Adds custom action to custom list ribbon' -Group 'Microsoft.SharePoint.Client.UserCustomAction.group' -Location 'CommandUI.Ribbon' -CommandUIExtension $cUIExtn</dev:code> <maml:remarks> <maml:para>Adds a new custom action to the custom list template, and sets the Title, Name and other fields with the specified values. On click it shows the number of items in that list. Notice, escape quotes in CommandUIExtension.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOPropertyBag</command:name> <maml:description> <maml:para>Returns the property bag values.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOPropertyBag</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOPropertyBag</maml:name> <command:parameter required="false" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Site relative url of the folder. See examples for use.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Site relative url of the folder. See examples for use.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOPropertyBag</dev:code> <maml:remarks> <maml:para>This will return all web property bag values</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOPropertyBag -Key MyKey</dev:code> <maml:remarks> <maml:para>This will return the value of the key MyKey from the web property bag</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOPropertyBag -Folder /MyFolder</dev:code> <maml:remarks> <maml:para>This will return all property bag values for the folder MyFolder which is located in the root of the current web</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOPropertyBag -Folder /MyFolder -Key vti_mykey</dev:code> <maml:remarks> <maml:para>This will return the value of the key vti_mykey from the folder MyFolder which is located in the root of the current web</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOPropertyBag -Folder / -Key vti_mykey</dev:code> <maml:remarks> <maml:para>This will return the value of the key vti_mykey from the root folder of the current web</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SPONavigationNode</command:name> <maml:description> <maml:para>Removes a menu item from either the quicklaunch or top navigation</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPONavigationNode</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-SPONavigationNode</maml:name> <command:parameter required="true" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">NavigationType</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Header</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">NavigationType</command:parameterValue> <dev:type> <maml:name>NavigationType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Header</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPONavigationNode -Title Recent -Location QuickLaunch</dev:code> <maml:remarks> <maml:para>Will remove the recent navigation node from the quick launch in the current web.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPONavigationNode -Title Home -Location TopNavigationBar -Force</dev:code> <maml:remarks> <maml:para>Will remove the home navigation node from the top navigation bar without prompting for a confirmation in the current web.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SPOPropertyBagValue</command:name> <maml:description> <maml:para>Removes a value from the property bag</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPOPropertyBagValue</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-SPOPropertyBagValue</maml:name> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Site relative url of the folder. See examples for use.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Site relative url of the folder. See examples for use.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOPropertyBagValue -Key MyKey</dev:code> <maml:remarks> <maml:para>This will remove the value with key MyKey from the current web property bag</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOPropertyBagValue -Key MyKey -Folder /MyFolder</dev:code> <maml:remarks> <maml:para>This will remove the value with key MyKey from the folder MyFolder which is located in the root folder of the current web</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOPropertyBagValue -Key MyKey -Folder /</dev:code> <maml:remarks> <maml:para>This will remove the value with key MyKey from the root folder of the current web</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Request-SPOReIndexWeb</command:name> <maml:description> <maml:para>Marks the web for full indexing during the next incremental crawl</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Request</command:verb> <command:noun>SPOReIndexWeb</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Request-SPOReIndexWeb</maml:name> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOMasterPage</command:name> <maml:description> <maml:para>Returns the URLS of the default Master Page and the custom Master Page.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOMasterPage</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOMasterPage</maml:name> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOHomePage</command:name> <maml:description> <maml:para>Returns the URL to the home page</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOHomePage</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOHomePage</maml:name> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOHomePage</dev:code> <maml:remarks> <maml:para>Will return the URL of the home page of the web.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPOMinimalDownloadStrategy</command:name> <maml:description> <maml:para>Activates or deactivates the minimal downloading strategy.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPOMinimalDownloadStrategy</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPOMinimalDownloadStrategy</maml:name> <command:parameter required="true" position="named"> <maml:name>On</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SPOMinimalDownloadStrategy</maml:name> <command:parameter required="true" position="named"> <maml:name>Off</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>On</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Off</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOMinimalDownloadStrategy -Off</dev:code> <maml:remarks> <maml:para>Will deactivate minimal download strategy (MDS) for the current web.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOMinimalDownloadStrategy -On</dev:code> <maml:remarks> <maml:para>Will activate minimal download strategy (MDS) for the current web.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPOHomePage</command:name> <maml:description> <maml:para>Sets the home page of the current web.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPOHomePage</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPOHomePage</maml:name> <command:parameter required="true" position="named"> <maml:name>RootFolderRelativeUrl</maml:name> <maml:description> <maml:para>The root folder relative url of the homepage, e.g. 'sitepages/home.aspx'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>RootFolderRelativeUrl</maml:name> <maml:description> <maml:para>The root folder relative url of the homepage, e.g. 'sitepages/home.aspx'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOHomePage -RootFolderRelativeUrl SitePages/Home.aspx</dev:code> <maml:remarks> <maml:para>Sets the home page to the home.aspx file which resides in the SitePages library</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPOPropertyBagValue</command:name> <maml:description> <maml:para>Sets a property bag value</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPOPropertyBagValue</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPOPropertyBagValue</maml:name> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Indexed</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SPOPropertyBagValue</maml:name> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Site relative url of the folder. See examples for use.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Indexed</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Site relative url of the folder. See examples for use.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOPropertyBagValue -Key MyKey -Value MyValue</dev:code> <maml:remarks> <maml:para>This sets or adds a value to the current web property bag</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOPropertyBagValue -Key MyKey -Value MyValue -Folder /</dev:code> <maml:remarks> <maml:para>This sets or adds a value to the root folder of the current web</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOPropertyBagValue -Key MyKey -Value MyValue -Folder /MyFolder</dev:code> <maml:remarks> <maml:para>This sets or adds a value to the folder MyFolder which is located in the root folder of the current web</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPOIndexedProperties</command:name> <maml:description> <maml:para>Marks values of the propertybag to be indexed by search. Notice that this will overwrite the existing flags, e.g. only the properties you define with the cmdlet will be indexed.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPOIndexedProperties</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPOIndexedProperties</maml:name> <command:parameter required="true" position="named"> <maml:name>Keys</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Keys</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>List`1</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPOFileCheckedIn</command:name> <maml:description> <maml:para>Checks in a file</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPOFileCheckedIn</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPOFileCheckedIn</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckinType</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">CheckinType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckinType</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">CheckinType</command:parameterValue> <dev:type> <maml:name>CheckinType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPOFileCheckedOut</command:name> <maml:description> <maml:para>Checks out a file</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPOFileCheckedOut</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPOFileCheckedOut</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOFile</command:name> <maml:description> <maml:para>Uploads a file to Web</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOFile</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOFile</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>The local file path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The destination folder in the site</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Checkout</maml:name> <maml:description> <maml:para>If versioning is enabled, this will check out the file first if it exists, upload the file, then check it in again.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Approve</maml:name> <maml:description> <maml:para>Will auto approve the uploaded file.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ApproveComment</maml:name> <maml:description> <maml:para>The comment added to the approval.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Publish</maml:name> <maml:description> <maml:para>Will auto publish the file.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PublishComment</maml:name> <maml:description> <maml:para>The comment added to the publish action.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UseWebDav</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>The local file path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The destination folder in the site</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Checkout</maml:name> <maml:description> <maml:para>If versioning is enabled, this will check out the file first if it exists, upload the file, then check it in again.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Approve</maml:name> <maml:description> <maml:para>Will auto approve the uploaded file.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ApproveComment</maml:name> <maml:description> <maml:para>The comment added to the approval.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Publish</maml:name> <maml:description> <maml:para>Will auto publish the file.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PublishComment</maml:name> <maml:description> <maml:para>The comment added to the publish action.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UseWebDav</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPOFile -Path c:\temp\company.master -Folder "_catalogs/masterpage"</dev:code> <maml:remarks> <maml:para>This will upload the file company.master to the masterpage catalog</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPOFile -Path .\displaytemplate.html -Folder "_catalogs/masterpage/display templates/test"</dev:code> <maml:remarks> <maml:para>This will upload the file displaytemplate.html to the test folder in the display templates folder. If the test folder not exists it will create it.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SPOWeb</command:name> <maml:description> <maml:para>Creates a new subweb to the current web</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>SPOWeb</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-SPOWeb</maml:name> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the new web</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the new web</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the new web</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Locale</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>The site definition template to use for the new web, e.g. STS#0</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BreakInheritance</maml:name> <maml:description> <maml:para>By default the subweb will inherit its security from its parent, specify this switch to break this inheritance</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>InheritNavigation</maml:name> <maml:description> <maml:para>Specifies whether the site inherits navigation.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the new web</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the new web</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the new web</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Locale</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>The site definition template to use for the new web, e.g. STS#0</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BreakInheritance</maml:name> <maml:description> <maml:para>By default the subweb will inherit its security from its parent, specify this switch to break this inheritance</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>InheritNavigation</maml:name> <maml:description> <maml:para>Specifies whether the site inherits navigation.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-SPOWeb -Title "Project A Web" -Url projectA -Description "Information about Project A" -Locale 1033 -Template "STS#0"</dev:code> <maml:remarks> <maml:para>Creates a new subweb under the current web with url projectA</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPOMasterPage</command:name> <maml:description> <maml:para>Sets the default master page of the current web.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPOMasterPage</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPOMasterPage</maml:name> <command:parameter required="false" position="named"> <maml:name>MasterPageServerRelativeUrl</maml:name> <maml:description> <maml:para>Specifies the Master page url based on the server relative URL</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CustomMasterPageServerRelativeUrl</maml:name> <maml:description> <maml:para>Specifies the custom Master page url based on the server relative URL</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SPOMasterPage</maml:name> <command:parameter required="false" position="named"> <maml:name>MasterPageSiteRelativeUrl</maml:name> <maml:description> <maml:para>Specifies the Master page url based on the site relative URL</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CustomMasterPageSiteRelativeUrl</maml:name> <maml:description> <maml:para>Specifies the custom Master page url based on the site relative URL</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>MasterPageServerRelativeUrl</maml:name> <maml:description> <maml:para>Specifies the Master page url based on the server relative URL</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CustomMasterPageServerRelativeUrl</maml:name> <maml:description> <maml:para>Specifies the custom Master page url based on the server relative URL</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MasterPageSiteRelativeUrl</maml:name> <maml:description> <maml:para>Specifies the Master page url based on the site relative URL</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CustomMasterPageSiteRelativeUrl</maml:name> <maml:description> <maml:para>Specifies the custom Master page url based on the site relative URL</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOMasterPage -MasterPageServerRelativeUrl /sites/projects/_catalogs/masterpage/oslo.master</dev:code> <maml:remarks> <maml:para>Sets the master page based on a server relative URL</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOMasterPage -MasterPageServerRelativeUrl /sites/projects/_catalogs/masterpage/oslo.master -CustomMasterPageServerRelativeUrl /sites/projects/_catalogs/masterpage/oslo.master</dev:code> <maml:remarks> <maml:para>Sets the master page and custom master page based on a server relative URL</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOMasterPage -MasterPageSiteRelativeUrl _catalogs/masterpage/oslo.master</dev:code> <maml:remarks> <maml:para>Sets the master page based on a site relative URL</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOMasterPage -MasterPageSiteRelativeUrl _catalogs/masterpage/oslo.master -CustomMasterPageSiteRelativeUrl _catalogs/masterpage/oslo.master</dev:code> <maml:remarks> <maml:para>Sets the master page and custom master page based on a site relative URL</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPOTheme</command:name> <maml:description> <maml:para>Sets the theme of the current web.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPOTheme</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> Sets the theme of the current web, if any of the attributes is not set, that value will be set to null</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-SPOTheme</maml:name> <command:parameter required="false" position="named"> <maml:name>ColorPaletteUrl</maml:name> <maml:description> <maml:para>Specifies the Color Palette Url based on the site relative url</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FontSchemeUrl</maml:name> <maml:description> <maml:para>Specifies the Font Scheme Url based on the server relative url</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BackgroundImageUrl</maml:name> <maml:description> <maml:para>Specifies the Background Image Url based on the server relative url</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShareGenerated</maml:name> <maml:description> <maml:para>true if the generated theme files should be placed in the root web, false to store them in this web. Default is false</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>ColorPaletteUrl</maml:name> <maml:description> <maml:para>Specifies the Color Palette Url based on the site relative url</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FontSchemeUrl</maml:name> <maml:description> <maml:para>Specifies the Font Scheme Url based on the server relative url</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BackgroundImageUrl</maml:name> <maml:description> <maml:para>Specifies the Background Image Url based on the server relative url</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShareGenerated</maml:name> <maml:description> <maml:para>true if the generated theme files should be placed in the root web, false to store them in this web. Default is false</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOTheme</dev:code> <maml:remarks> <maml:para>Removes the current theme</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOTheme -ColorPaletteUrl /_catalogs/theme/15/company.spcolor</dev:code> <maml:remarks> <maml:para /> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOTheme -ColorPaletteUrl /_catalogs/theme/15/company.spcolor -BackgroundImageUrl '/sites/teamsite/style library/background.png'</dev:code> <maml:remarks> <maml:para /> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>-</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb></command:verb> <command:noun></command:noun> <dev:version></dev:version> </command:details> <command:syntax> <command:syntaxItem> <maml:name>-</maml:name> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPOWeb</command:name> <maml:description> <maml:para>Sets properties on a web</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPOWeb</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPOWeb</maml:name> <command:parameter required="false" position="named"> <maml:name>SiteLogoUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AlternateCssUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MasterUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CustomMasterUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>SiteLogoUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AlternateCssUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MasterUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CustomMasterUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SPOWikiPage</command:name> <maml:description> <maml:para>Removes a wiki page</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPOWikiPage</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-SPOWikiPage</maml:name> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SPOWikiPage</maml:name> <command:parameter required="true" position="named"> <maml:name>SiteRelativePageUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SiteRelativePageUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOWikiPage</command:name> <maml:description> <maml:para>Adds a wiki page</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOWikiPage</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOWikiPage</maml:name> <command:parameter required="true" position="named"> <maml:name>Content</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-SPOWikiPage</maml:name> <command:parameter required="true" position="named"> <maml:name>Layout</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">WikiPageLayout</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Content</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Layout</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">WikiPageLayout</command:parameterValue> <dev:type> <maml:name>WikiPageLayout</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOWikiPageContent</command:name> <maml:description> <maml:para>Gets the contents/source of a wiki page</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOWikiPageContent</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOWikiPageContent</maml:name> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPOWikiPageContent</command:name> <maml:description> <maml:para>Sets the contents of a wikipage</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPOWikiPageContent</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPOWikiPageContent</maml:name> <command:parameter required="true" position="named"> <maml:name>Content</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Site Relative Page Url</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SPOWikiPageContent</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Site Relative Page Url</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Content</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Site Relative Page Url</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOUserProfileProperty</command:name> <maml:description> <maml:para>Office365 only: Uses the tenant API to retrieve site information. You must connect to the admin website (https://:<tenant>-admin.sharepoint.com) with Connect-SPOnline in order to use this command. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOUserProfileProperty</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Requires a connection to a SharePoint Tenant Admin site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOUserProfileProperty</maml:name> <command:parameter required="true" position="named"> <maml:name>Account</maml:name> <maml:description> <maml:para>The account of the user, formatted either as a login name, or as a claims identity, e.g. i:0#.f|membership|user@domain.com</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Account</maml:name> <maml:description> <maml:para>The account of the user, formatted either as a login name, or as a claims identity, e.g. i:0#.f|membership|user@domain.com</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOUserProfileProperty -Account 'user@domain.com'</dev:code> <maml:remarks> <maml:para>Returns the profile properties for the specified user</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOUserProfileProperty -Account 'user@domain.com','user2@domain.com'</dev:code> <maml:remarks> <maml:para>Returns the profile properties for the specified users</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOHtmlPublishingPageLayout</command:name> <maml:description> <maml:para>Adds a HTML based publishing page layout</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOHtmlPublishingPageLayout</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOHtmlPublishingPageLayout</maml:name> <command:parameter required="true" position="named"> <maml:name>SourceFilePath</maml:name> <maml:description> <maml:para>Path to the file which will be uploaded</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title for the page layout</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description for the page layout</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>AssociatedContentTypeID</maml:name> <maml:description> <maml:para>Associated content type ID</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DestinationFolderHierarchy</maml:name> <maml:description> <maml:para>Folder hierarchy where the html page layouts will be deployed</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>SourceFilePath</maml:name> <maml:description> <maml:para>Path to the file which will be uploaded</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title for the page layout</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description for the page layout</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>AssociatedContentTypeID</maml:name> <maml:description> <maml:para>Associated content type ID</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DestinationFolderHierarchy</maml:name> <maml:description> <maml:para>Folder hierarchy where the html page layouts will be deployed</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOPublishingPageLayout</command:name> <maml:description> <maml:para>Adds a publishing page layout</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOPublishingPageLayout</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOPublishingPageLayout</maml:name> <command:parameter required="true" position="named"> <maml:name>SourceFilePath</maml:name> <maml:description> <maml:para>Path to the file which will be uploaded</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title for the page layout</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description for the page layout</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>AssociatedContentTypeID</maml:name> <maml:description> <maml:para>Associated content type ID</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DestinationFolderHierarchy</maml:name> <maml:description> <maml:para>Folder hierarchy where the html page layouts will be deployed</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>SourceFilePath</maml:name> <maml:description> <maml:para>Path to the file which will be uploaded</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title for the page layout</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description for the page layout</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>AssociatedContentTypeID</maml:name> <maml:description> <maml:para>Associated content type ID</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DestinationFolderHierarchy</maml:name> <maml:description> <maml:para>Folder hierarchy where the html page layouts will be deployed</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOWorkflowDefinition</command:name> <maml:description> <maml:para>Adds a workflow definition</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOWorkflowDefinition</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOWorkflowDefinition</maml:name> <command:parameter required="true" position="named"> <maml:name>Definition</maml:name> <maml:description> <maml:para>The workflow definition to add.</maml:para> </maml:description> <command:parameterValue required="true">WorkflowDefinition</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DoNotPublish</maml:name> <maml:description> <maml:para>By default workflow definitions will be publish, specify this switch to override that.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Definition</maml:name> <maml:description> <maml:para>The workflow definition to add.</maml:para> </maml:description> <command:parameterValue required="true">WorkflowDefinition</command:parameterValue> <dev:type> <maml:name>WorkflowDefinition</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DoNotPublish</maml:name> <maml:description> <maml:para>By default workflow definitions will be publish, specify this switch to override that.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Add-SPOWorkflowDefinition -Definition $wfdef</dev:code> <maml:remarks> <maml:para>Adds an existing workflow definition, retrieved by Get-SPOWorkflowDefinition, to a site.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Resume-SPOWorkflowInstance</command:name> <maml:description> <maml:para>Resumes a previously stopped workflow instance</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Resume</command:verb> <command:noun>SPOWorkflowInstance</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Resume-SPOWorkflowInstance</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The instance to resume</maml:para> </maml:description> <command:parameterValue required="true">WorkflowInstancePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The instance to resume</maml:para> </maml:description> <command:parameterValue required="true">WorkflowInstancePipeBind</command:parameterValue> <dev:type> <maml:name>WorkflowInstancePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Stop-SPOWorkflowInstance</command:name> <maml:description> <maml:para>Stops a workflow instance</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>SPOWorkflowInstance</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Stop-SPOWorkflowInstance</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The instance to stop</maml:para> </maml:description> <command:parameterValue required="true">WorkflowInstancePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The instance to stop</maml:para> </maml:description> <command:parameterValue required="true">WorkflowInstancePipeBind</command:parameterValue> <dev:type> <maml:name>WorkflowInstancePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SPOWorkflowDefinition</command:name> <maml:description> <maml:para>Removes a workflow definition</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPOWorkflowDefinition</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-SPOWorkflowDefinition</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The subscription to remove</maml:para> </maml:description> <command:parameterValue required="true">WorkflowDefinitionPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The subscription to remove</maml:para> </maml:description> <command:parameterValue required="true">WorkflowDefinitionPipeBind</command:parameterValue> <dev:type> <maml:name>WorkflowDefinitionPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SPOWorkflowSubscription</command:name> <maml:description> <maml:para>Removes a workflow subscription</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPOWorkflowSubscription</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-SPOWorkflowSubscription</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The subscription to remove</maml:para> </maml:description> <command:parameterValue required="true">WorkflowSubscriptionPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The subscription to remove</maml:para> </maml:description> <command:parameterValue required="true">WorkflowSubscriptionPipeBind</command:parameterValue> <dev:type> <maml:name>WorkflowSubscriptionPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOWorkflowSubscription</command:name> <maml:description> <maml:para>Adds a workflow subscription to a list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOWorkflowSubscription</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOWorkflowSubscription</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the subscription</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DefinitionName</maml:name> <maml:description> <maml:para>The name of the workflow definition</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to add the workflow to</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StartManually</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StartOnCreated</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StartOnChanged</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>HistoryListName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TaskListName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AssociationValues</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Dictionary`2</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the subscription</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DefinitionName</maml:name> <maml:description> <maml:para>The name of the workflow definition</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to add the workflow to</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StartManually</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StartOnCreated</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StartOnChanged</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>HistoryListName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TaskListName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AssociationValues</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Dictionary`2</command:parameterValue> <dev:type> <maml:name>Dictionary`2</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOWorkflowDefinition</command:name> <maml:description> <maml:para>Returns a workflow definition</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOWorkflowDefinition</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOWorkflowDefinition</maml:name> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the workflow</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PublishedOnly</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the workflow</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PublishedOnly</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOWorkflowSubscription</command:name> <maml:description> <maml:para>Returns a workflow subscriptions from a list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOWorkflowSubscription</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOWorkflowSubscription</maml:name> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the workflow</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>List</maml:name> <maml:description> <maml:para>A list to search the association for</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the workflow</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>List</maml:name> <maml:description> <maml:para>A list to search the association for</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOWebPartXml</command:name> <maml:description> <maml:para>Returns the webpart XML of a webpart registered on a site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOWebPartXml</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOWebPartXml</maml:name> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Full server relative url of the webpart page, e.g. /sites/mysite/sitepages/home.aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Id or title of the webpart. Use Get-SPOWebPart to retrieve all webpart Ids</maml:para> </maml:description> <command:parameterValue required="true">WebPartPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Full server relative url of the webpart page, e.g. /sites/mysite/sitepages/home.aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Id or title of the webpart. Use Get-SPOWebPart to retrieve all webpart Ids</maml:para> </maml:description> <command:parameterValue required="true">WebPartPipeBind</command:parameterValue> <dev:type> <maml:name>WebPartPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOWebPartXml -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Identity a2875399-d6ff-43a0-96da-be6ae5875f82</dev:code> <maml:remarks> <maml:para>Returns the webpart XML for a given webpart on a page.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOSiteSearchQueryResults</command:name> <maml:description> <maml:para>Executes a search query to retrieve indexed site collections</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOSiteSearchQueryResults</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOSiteSearchQueryResults</maml:name> <command:parameter required="false" position="named"> <maml:name>Query</maml:name> <maml:description> <maml:para>Search query in Keyword Query Language (KQL) to execute to refine the returned sites. If omited, all indexed sites will be returned.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StartRow</maml:name> <maml:description> <maml:para>Search result item to start returning the results from. Useful for paging. Leave at 0 to return all results.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>Maximum amount of search results to return. Default is 500 search results.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Query</maml:name> <maml:description> <maml:para>Search query in Keyword Query Language (KQL) to execute to refine the returned sites. If omited, all indexed sites will be returned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StartRow</maml:name> <maml:description> <maml:para>Search result item to start returning the results from. Useful for paging. Leave at 0 to return all results.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>Maximum amount of search results to return. Default is 500 search results.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOSiteSearchQueryResults</dev:code> <maml:remarks> <maml:para>Returns all site collections indexed by SharePoint Search</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOSiteSearchQueryResults -Query "WebTemplate:STS"</dev:code> <maml:remarks> <maml:para>Returns all site collections indexed by SharePoint Search which have are based on the STS (Team Site) template</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOSiteSearchQueryResults -Query "WebTemplate:SPSPERS"</dev:code> <maml:remarks> <maml:para>Returns all site collections indexed by SharePoint Search which have are based on the SPSPERS (MySite) template</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOSiteSearchQueryResults -Query "Title:Intranet*"</dev:code> <maml:remarks> <maml:para>Returns all site collections indexed by SharePoint Search of which the title starts with the word Intranet</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPOSearchConfiguration</command:name> <maml:description> <maml:para>Sets the search configuration</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPOSearchConfiguration</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPOSearchConfiguration</maml:name> <command:parameter required="true" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Search configuration string</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">SearchConfigurationScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SPOSearchConfiguration</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to a search configuration</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">SearchConfigurationScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Search configuration string</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to a search configuration</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SearchConfigurationScope</command:parameterValue> <dev:type> <maml:name>SearchConfigurationScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOSearchConfiguration -Configuration $config</dev:code> <maml:remarks> <maml:para>Sets the search configuration for the current web</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOSearchConfiguration -Configuration $config -Scope Site</dev:code> <maml:remarks> <maml:para>Sets the search configuration for the current site collection</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOSearchConfiguration -Configuration $config -Scope Subscription</dev:code> <maml:remarks> <maml:para>Sets the search configuration for the current tenant</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOSearchConfiguration -Path searchconfig.xml -Scope Subscription</dev:code> <maml:remarks> <maml:para>Reads the search configuratino from the specified XML file and sets it for the current tenant</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOSearchConfiguration</command:name> <maml:description> <maml:para>Returns the search configuration</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOSearchConfiguration</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOSearchConfiguration</maml:name> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">SearchConfigurationScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SearchConfigurationScope</command:parameterValue> <dev:type> <maml:name>SearchConfigurationScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOSearchConfiguration</dev:code> <maml:remarks> <maml:para>Returns the search configuration for the current web</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOSearchConfiguration -Scope Site</dev:code> <maml:remarks> <maml:para>Returns the search configuration for the current site collection</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOSearchConfiguration -Scope Subscription</dev:code> <maml:remarks> <maml:para>Returns the search configuration for the current tenant</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOSearchConfiguration -Path searchconfig.xml -Scope Subscription</dev:code> <maml:remarks> <maml:para>Returns the search configuration for the current tenant and saves it to the specified file</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPOGroupPermissions</command:name> <maml:description> <maml:para>Adds and/or removes permissions of a specific SharePoint group</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPOGroupPermissions</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPOGroupPermissions</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Get the permissions of a specific group by name</maml:para> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to apply the command to.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para>Name of the permission set to add to this SharePoint group</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para>Name of the permission set to remove from this SharePoint group</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Get the permissions of a specific group by name</maml:para> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> <dev:type> <maml:name>GroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to apply the command to.</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para>Name of the permission set to add to this SharePoint group</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para>Name of the permission set to remove from this SharePoint group</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOGroupPermissions -Identity 'My Site Members' -AddRole Contribute</dev:code> <maml:remarks> <maml:para>Adds the 'Contribute' permission to the SharePoint group with the name 'My Site Members'</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOGroupPermissions -Identity 'My Site Members' -RemoveRole 'Full Control' -AddRole 'Read'</dev:code> <maml:remarks> <maml:para>Removes the 'Full Control' from and adds the 'Contribute' permissions to the SharePoint group with the name 'My Site Members'</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOGroupPermissions -Identity 'My Site Members' -AddRole @('Contribute', 'Design')</dev:code> <maml:remarks> <maml:para>Adds the 'Contribute' and 'Design' permissions to the SharePoint group with the name 'My Site Members'</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOGroupPermissions -Identity 'My Site Members' -RemoveRole @('Contribute', 'Design')</dev:code> <maml:remarks> <maml:para>Removes the 'Contribute' and 'Design' permissions from the SharePoint group with the name 'My Site Members'</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOGroupPermissions -Identity 'My Site Members' -List 'MyList' -RemoveRole @('Contribute')</dev:code> <maml:remarks> <maml:para>Removes the 'Contribute' permissions from the list 'MyList' for the group with the name 'My Site Members'</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOGroupPermissions</command:name> <maml:description> <maml:para>Returns the permissions for a specific SharePoint group</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOGroupPermissions</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOGroupPermissions</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Get the permissions of a specific group by name</maml:para> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Get the permissions of a specific group by name</maml:para> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> <dev:type> <maml:name>GroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOGroupPermissions -Identity 'My Site Members'</dev:code> <maml:remarks> <maml:para>Returns the permissions for the SharePoint group with the name 'My Site Members'</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SPOGroup</command:name> <maml:description> <maml:para>Removes a group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPOGroup</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-SPOGroup</maml:name> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">GroupPipeBind</command:parameterValue> <dev:type> <maml:name>GroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOGroup -Identity "My Users"</dev:code> <maml:remarks> <maml:para /> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPOGroup</command:name> <maml:description> <maml:para>Updates a group</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPOGroup</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPOGroup</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetAssociatedGroup</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">AssociatedGroupType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para>Name of the permission set to add to this SharePoint group</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para>Name of the permission set to remove from this SharePoint group</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>The owner for the group, which can be a user or another group</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description for the group</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowRequestToJoinLeave</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether to allow users to request membership in the group and to allow users to request to leave the group</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AutoAcceptRequestToJoinLeave</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether users are automatically added or removed when they make a request</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowMembersEditMembership</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether group members can modify membership in the group</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OnlyAllowMembersViewMembership</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether only group members are allowed to view the list of members in the group</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequestToJoinEmail</maml:name> <maml:description> <maml:para>The e-mail address to which membership requests are sent</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> <dev:type> <maml:name>GroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetAssociatedGroup</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">AssociatedGroupType</command:parameterValue> <dev:type> <maml:name>AssociatedGroupType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para>Name of the permission set to add to this SharePoint group</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para>Name of the permission set to remove from this SharePoint group</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>The owner for the group, which can be a user or another group</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description for the group</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowRequestToJoinLeave</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether to allow users to request membership in the group and to allow users to request to leave the group</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AutoAcceptRequestToJoinLeave</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether users are automatically added or removed when they make a request</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowMembersEditMembership</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether group members can modify membership in the group</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OnlyAllowMembersViewMembership</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether only group members are allowed to view the list of members in the group</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequestToJoinEmail</maml:name> <maml:description> <maml:para>The e-mail address to which membership requests are sent</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SPOGroup</command:name> <maml:description> <maml:para>Adds group to the Site Groups List and returns a group object</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>SPOGroup</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-SPOGroup</maml:name> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description for the group</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>The owner for the group, which can be a user or another group</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowRequestToJoinLeave</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether to allow users to request membership in the group and to allow users to request to leave the group</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AutoAcceptRequestToJoinLeave</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether users are automatically added or removed when they make a request</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowMembersEditMembership</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether group members can modify membership in the group</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OnlyAllowMembersViewMembership</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether only group members are allowed to view the list of members in the group</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequestToJoinEmail</maml:name> <maml:description> <maml:para>The e-mail address to which membership requests are sent</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description for the group</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>The owner for the group, which can be a user or another group</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowRequestToJoinLeave</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether to allow users to request membership in the group and to allow users to request to leave the group</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AutoAcceptRequestToJoinLeave</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether users are automatically added or removed when they make a request</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowMembersEditMembership</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether group members can modify membership in the group</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OnlyAllowMembersViewMembership</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether only group members are allowed to view the list of members in the group</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequestToJoinEmail</maml:name> <maml:description> <maml:para>The e-mail address to which membership requests are sent</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-SPOGroup -Title "My Site Users"</dev:code> <maml:remarks> <maml:para /> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SPOUserFromGroup</command:name> <maml:description> <maml:para>Removes a user from a group</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPOUserFromGroup</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-SPOUserFromGroup</maml:name> <command:parameter required="true" position="named"> <maml:name>LoginName</maml:name> <maml:description> <maml:para>A valid login name of a user</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>A group object, an ID or a name of a group</maml:para> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>LoginName</maml:name> <maml:description> <maml:para>A valid login name of a user</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>A group object, an ID or a name of a group</maml:para> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> <dev:type> <maml:name>GroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOUserFromGroup -LoginName user@company.com -GroupName 'Marketing Site Members'</dev:code> <maml:remarks> <maml:para /> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOUserToGroup</command:name> <maml:description> <maml:para>Adds a user to a group</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOUserToGroup</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOUserToGroup</maml:name> <command:parameter required="true" position="named"> <maml:name>LoginName</maml:name> <maml:description> <maml:para>The login name of the user</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The group id, group name or group object to add the user to.</maml:para> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>LoginName</maml:name> <maml:description> <maml:para>The login name of the user</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The group id, group name or group object to add the user to.</maml:para> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> <dev:type> <maml:name>GroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPOUserToGroup -LoginName user@company.com -Identity 'Marketing Site Members'</dev:code> <maml:remarks> <maml:para /> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPOUserToGroup -LoginName user@company.com -Identity 5</dev:code> <maml:remarks> <maml:para>Add the specified user to the group with Id 5</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOGroup</command:name> <maml:description> <maml:para>Returns a specific group or all groups.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOGroup</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOGroup</maml:name> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Get a specific group by name</maml:para> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SPOGroup</maml:name> <command:parameter required="false" position="named"> <maml:name>AssociatedMemberGroup</maml:name> <maml:description> <maml:para>Retrieve the associated member group</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SPOGroup</maml:name> <command:parameter required="false" position="named"> <maml:name>AssociatedVisitorGroup</maml:name> <maml:description> <maml:para>Retrieve the associated visitor group</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SPOGroup</maml:name> <command:parameter required="false" position="named"> <maml:name>AssociatedOwnerGroup</maml:name> <maml:description> <maml:para>Retrieve the associated owner group</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Get a specific group by name</maml:para> </maml:description> <command:parameterValue required="false">GroupPipeBind</command:parameterValue> <dev:type> <maml:name>GroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AssociatedMemberGroup</maml:name> <maml:description> <maml:para>Retrieve the associated member group</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AssociatedVisitorGroup</maml:name> <maml:description> <maml:para>Retrieve the associated visitor group</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AssociatedOwnerGroup</maml:name> <maml:description> <maml:para>Retrieve the associated owner group</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOGroup</dev:code> <maml:remarks> <maml:para>Returns all groups</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOGroup -Identity 'My Site Users'</dev:code> <maml:remarks> <maml:para>This will return the group called 'My Site Users' if available</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOGroup -AssociatedMemberGroup</dev:code> <maml:remarks> <maml:para>This will return the current members group for the site</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SPOUser</command:name> <maml:description> <maml:para>Adds a user to the build-in Site User Info List and returns a user object</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>SPOUser</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-SPOUser</maml:name> <command:parameter required="true" position="named"> <maml:name>LoginName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>LoginName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-SPOUser -LoginName user@company.com</dev:code> <maml:remarks> <maml:para /> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SPOListItem</command:name> <maml:description> <maml:para>Deletes an item from a list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPOListItem</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-SPOListItem</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the listitem, or actual ListItem object</maml:para> </maml:description> <command:parameterValue required="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the listitem, or actual ListItem object</maml:para> </maml:description> <command:parameterValue required="true">ListItemPipeBind</command:parameterValue> <dev:type> <maml:name>ListItemPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOListItem -List "Demo List" -Identity "1" -Force</dev:code> <maml:remarks> <maml:para>Removes the listitem with id "1" from the "Demo List" list.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPOListItem</command:name> <maml:description> <maml:para>Updates a list item</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPOListItem</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPOListItem</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the listitem, or actual ListItem object</maml:para> </maml:description> <command:parameterValue required="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Specify either the name, ID or an actual content type</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Use the internal names of the fields when specifying field names. Single line of text: -Values @{"Title" = "Title New"} Multiple lines of text: -Values @{"MultiText" = "New text\n\nMore text"} Rich text: -Values @{"MultiText" = "<strong>New</strong> text"} Choice: -Values @{"Choice" = "Value 1"} Number: -Values @{"Number" = "10"} Currency: -Values @{"Number" = "10"} Currency: -Values @{"Currency" = "10"} Date and Time: -Values @{"DateAndTime" = "03/10/2015 14:16"} Lookup (id of lookup value): -Values @{"Lookup" = "2"} Yes/No: -Values @{"YesNo" = "No"} Person/Group (id of user/group in Site User Info List): -Values @{"Person" = "3"} Hyperlink or Picture: -Values @{"Hyperlink" = "https://github.com/OfficeDev/, OfficePnp"}</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the listitem, or actual ListItem object</maml:para> </maml:description> <command:parameterValue required="true">ListItemPipeBind</command:parameterValue> <dev:type> <maml:name>ListItemPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Specify either the name, ID or an actual content type</maml:para> </maml:description> <command:parameterValue required="false">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Use the internal names of the fields when specifying field names. Single line of text: -Values @{"Title" = "Title New"} Multiple lines of text: -Values @{"MultiText" = "New text\n\nMore text"} Rich text: -Values @{"MultiText" = "<strong>New</strong> text"} Choice: -Values @{"Choice" = "Value 1"} Number: -Values @{"Number" = "10"} Currency: -Values @{"Number" = "10"} Currency: -Values @{"Currency" = "10"} Date and Time: -Values @{"DateAndTime" = "03/10/2015 14:16"} Lookup (id of lookup value): -Values @{"Lookup" = "2"} Yes/No: -Values @{"YesNo" = "No"} Person/Group (id of user/group in Site User Info List): -Values @{"Person" = "3"} Hyperlink or Picture: -Values @{"Hyperlink" = "https://github.com/OfficeDev/, OfficePnp"}</maml:para> </maml:description> <command:parameterValue required="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-SPOListItem -List "Demo List" -Identity 1 -Values @{"Title" = "Test Title"; "Category"="Test Category"}</dev:code> <maml:remarks> <maml:para>Sets fields value in the list item with ID 1 in the "Demo List". It sets both the Title and Category fields with the specified values. Notice, use the internal names of fields.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-SPOListItem -List "Demo List" -Identity 1 -ContentType "Company" -Values @{"Title" = "Test Title"; "Category"="Test Category"}</dev:code> <maml:remarks> <maml:para>Sets fields value in the list item with ID 1 in the "Demo List". It sets the content type of the item to "Company" and it sets both the Title and Category fields with the specified values. Notice, use the internal names of fields.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-SPOListItem -List "Demo List" -Identity $item -Values @{"Title" = "Test Title"; "Category"="Test Category"}</dev:code> <maml:remarks> <maml:para>Sets fields value in the list item which has been retrieved by for instance Get-SPOListItem. It sets the content type of the item to "Company" and it sets both the Title and Category fields with the specified values. Notice, use the internal names of fields.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOListItem</command:name> <maml:description> <maml:para>Retrieves list items</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOListItem</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOListItem</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to query</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the item to retrieve</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UniqueId</maml:name> <maml:description> <maml:para>The unique id (GUID) of the item to retrieve</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Query</maml:name> <maml:description> <maml:para>The CAML query to execute against the list</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>The fields to retrieve. If not specified all fields will be loaded in the returned list object.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to query</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the item to retrieve</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UniqueId</maml:name> <maml:description> <maml:para>The unique id (GUID) of the item to retrieve</maml:para> </maml:description> <command:parameterValue required="false">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Query</maml:name> <maml:description> <maml:para>The CAML query to execute against the list</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>The fields to retrieve. If not specified all fields will be loaded in the returned list object.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOListItem -List Tasks</dev:code> <maml:remarks> <maml:para>Retrieves all list items from the tasks lists</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOListItem -List Tasks -Id 1</dev:code> <maml:remarks> <maml:para>Retrieves the list item with ID 1 from from the tasks lists. This parameter is ignored if the Query parameter is specified.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOListItem -List Tasks -UniqueId bd6c5b3b-d960-4ee7-a02c-85dc6cd78cc3</dev:code> <maml:remarks> <maml:para>Retrieves the list item with unique id bd6c5b3b-d960-4ee7-a02c-85dc6cd78cc3 from from the tasks lists. This parameter is ignored if the Query parameter is specified.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOListItem -List Tasks -Fields "Title","GUID"</dev:code> <maml:remarks> <maml:para>Retrieves all list items, but only includes the values of the Title and GUID fields in the list item object. This parameter is ignored if the Query parameter is specified.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOListItem -List Tasks -Query "<View><Query><Where><Eq><FieldRef Name='GUID'/><Value Type='Guid'>bd6c5b3b-d960-4ee7-a02c-85dc6cd78cc3</Value></Eq></Where></Query></View>"</dev:code> <maml:remarks> <maml:para>Retrieves all list items based on the CAML query specified.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Request-SPOReIndexList</command:name> <maml:description> <maml:para>Marks the list for full indexing during the next incremental crawl</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Request</command:verb> <command:noun>SPOReIndexList</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Request-SPOReIndexList</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPOList</command:name> <maml:description> <maml:para>Updates list settings</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPOList</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPOList</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableContentTypes</maml:name> <maml:description> <maml:para>Set to $true to enable content types, set to $false to disable content types</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BreakRoleInheritance</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CopyRoleAssignments</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClearSubscopes</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableContentTypes</maml:name> <maml:description> <maml:para>Set to $true to enable content types, set to $false to disable content types</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BreakRoleInheritance</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CopyRoleAssignments</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClearSubscopes</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-SPOList -Identity "Demo List" -EnableContentTypes $true</dev:code> <maml:remarks> <maml:para>Switches the Enable Content Type switch on the list</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPOListPermission</command:name> <maml:description> <maml:para>Sets list permissions</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPOListPermission</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPOListPermission</maml:name> <command:parameter required="true" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SPOListPermission</maml:name> <command:parameter required="true" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> <dev:type> <maml:name>GroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOListPermission -Identity 'Documents' -User 'user@contoso.com' -AddRole 'Contribute'</dev:code> <maml:remarks> <maml:para>Adds the 'Contribute' permission to the user 'user@contoso.com' for the list 'Documents'</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOListPermission -Identity 'Documents' -User 'user@contoso.com' -RemoveRole 'Contribute'</dev:code> <maml:remarks> <maml:para>Removes the 'Contribute' permission to the user 'user@contoso.com' for the list 'Documents'</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SPOExtensbilityHandlerObject</command:name> <maml:description> <maml:para>Creates a ExtensibilityHandler Object, to be used by the Get-SPOProvisioningTemplate cmdlet</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>SPOExtensbilityHandlerObject</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-SPOExtensbilityHandlerObject</maml:name> <command:parameter required="true" position="named"> <maml:name>Assembly</maml:name> <maml:description> <maml:para>The full assembly name of the handler</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of the handler</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Any configuration data you want to send to the handler</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>If set, the handler will be disabled</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Assembly</maml:name> <maml:description> <maml:para>The full assembly name of the handler</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of the handler</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Any configuration data you want to send to the handler</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>If set, the handler will be disabled</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code> PS:> $handler = New-SPOExtensibilityHandlerObject -Assembly Contoso.Core.Handlers -Type Contoso.Core.Handlers.MyExtensibilityHandler PS:> Get-SPOProvisioningTemplate -Out NewTemplate.xml -ExtensibilityHandlers $handler</dev:code> <maml:remarks> <maml:para>This will create a new ExtensibilityHandler object that is run during extraction of the template</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOFeature</command:name> <maml:description> <maml:para>Returns all activated or a specific activated feature</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOFeature</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOFeature</maml:name> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">FeaturePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The scope of the feature. Defaults to Web.</maml:para> </maml:description> <command:parameterValue required="true">FeatureScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">FeaturePipeBind</command:parameterValue> <dev:type> <maml:name>FeaturePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The scope of the feature. Defaults to Web.</maml:para> </maml:description> <command:parameterValue required="false">FeatureScope</command:parameterValue> <dev:type> <maml:name>FeatureScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOFeature</dev:code> <maml:remarks> <maml:para>This will return all activated web scoped features</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOFeature -Scope Site</dev:code> <maml:remarks> <maml:para>This will return all activated site scoped features</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOFeature -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22</dev:code> <maml:remarks> <maml:para>This will return a specific activated web scoped feature</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOFeature -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22 -Scope Site</dev:code> <maml:remarks> <maml:para>This will return a specific activated site scoped feature</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-SPOFeature</command:name> <maml:description> <maml:para>Disables a feature</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>SPOFeature</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Disable-SPOFeature</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The id of the feature to disable.</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forcibly disable the feature.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Specify the scope of the feature to deactivate, either Web or Site. Defaults to Web.</maml:para> </maml:description> <command:parameterValue required="true">FeatureScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The id of the feature to disable.</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forcibly disable the feature.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Specify the scope of the feature to deactivate, either Web or Site. Defaults to Web.</maml:para> </maml:description> <command:parameterValue required="false">FeatureScope</command:parameterValue> <dev:type> <maml:name>FeatureScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Disable-SPOFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe</dev:code> <maml:remarks> <maml:para>This will enable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe"</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Disable-SPOFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Force</dev:code> <maml:remarks> <maml:para>This will enable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe" with force.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Disable-SPOFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Web</dev:code> <maml:remarks> <maml:para>This will enable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe" with the web scope.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-SPOFeature</command:name> <maml:description> <maml:para>Enables a feature</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>SPOFeature</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Enable-SPOFeature</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The id of the feature to enable.</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forcibly enable the feature.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Specify the scope of the feature to active, either Web or Site. Defaults to Web.</maml:para> </maml:description> <command:parameterValue required="true">FeatureScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Sandboxed</maml:name> <maml:description> <maml:para>Specify this parameter if the feature you're trying to active is part of a sandboxed solution.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The id of the feature to enable.</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forcibly enable the feature.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Specify the scope of the feature to active, either Web or Site. Defaults to Web.</maml:para> </maml:description> <command:parameterValue required="false">FeatureScope</command:parameterValue> <dev:type> <maml:name>FeatureScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Sandboxed</maml:name> <maml:description> <maml:para>Specify this parameter if the feature you're trying to active is part of a sandboxed solution.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Enable-SPOFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe</dev:code> <maml:remarks> <maml:para>This will enable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe"</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Enable-SPOFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Force</dev:code> <maml:remarks> <maml:para>This will enable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe" with force.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Enable-SPOFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Web</dev:code> <maml:remarks> <maml:para>This will enable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe" with the web scope.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPODocumentSet</command:name> <maml:description> <maml:para>Creates a new document set in a library.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPODocumentSet</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPODocumentSet</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPODocumentSet -List "Documents" -ContentType "Test Document Set" -Name "Test"</dev:code> <maml:remarks> <maml:para>This will add a new document set based upon the 'Test Document Set' content type to a list called 'Documents'. The document set will be named 'Test'</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPODocumentSetTemplate</command:name> <maml:description> <maml:para>Retrieves a document set template</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPODocumentSetTemplate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPODocumentSetTemplate</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Either specify a name, an id, a document set template object or a content type object</maml:para> </maml:description> <command:parameterValue required="true">DocumentSetPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Either specify a name, an id, a document set template object or a content type object</maml:para> </maml:description> <command:parameterValue required="true">DocumentSetPipeBind</command:parameterValue> <dev:type> <maml:name>DocumentSetPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPODocumentSetTemplate -Identity "Test Document Set"</dev:code> <maml:remarks> <maml:para>This will get the document set template with the name "Test Document Set"</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPODocumentSetTemplate -Identity "0x0120D520005DB65D094035A241BAC9AF083F825F3B"</dev:code> <maml:remarks> <maml:para>This will get the document set template with the id "0x0120D520005DB65D094035A241BAC9AF083F825F3B"</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SPOContentTypeFromDocumentSet</command:name> <maml:description> <maml:para>Removes a content type from a document set</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPOContentTypeFromDocumentSet</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-SPOContentTypeFromDocumentSet</maml:name> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The content type to remove. Either specify name, an id, or a content type object.</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DocumentSet</maml:name> <maml:description> <maml:para>The document set to remove the content type from. Either specify a name, a document set template object, an id, or a content type object</maml:para> </maml:description> <command:parameterValue required="true">DocumentSetPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The content type to remove. Either specify name, an id, or a content type object.</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DocumentSet</maml:name> <maml:description> <maml:para>The document set to remove the content type from. Either specify a name, a document set template object, an id, or a content type object</maml:para> </maml:description> <command:parameterValue required="true">DocumentSetPipeBind</command:parameterValue> <dev:type> <maml:name>DocumentSetPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOContentTypeFromDocumentSet -ContentType "Test CT" -DocumentSet "Test Document Set"</dev:code> <maml:remarks> <maml:para>This will remove the content type called 'Test CT' from the document set called ''Test Document Set'</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $docset = Remove-SPODocumentSetTemplate -Identity "Test Document Set" PS:> $ct = Get-SPOContentType -Identity "Test CT" PS:> Add-SPOContentTypeToDocumentSet -ContentType $ct -DocumentSet $docset</dev:code> <maml:remarks> <maml:para>This will remove the content type called 'Test CT' from the document set called ''Test Document Set'</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-SPOContentTypeFromDocumentSet -ContentType 0x0101001F1CEFF1D4126E4CAD10F00B6137E969 -DocumentSet 0x0120D520005DB65D094035A241BAC9AF083F825F3B</dev:code> <maml:remarks> <maml:para>This will remove the content type called 'Test CT' from the document set called ''Test Document Set'</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SPOContentTypeToDocumentSet</command:name> <maml:description> <maml:para>Adds a content type to a document set</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPOContentTypeToDocumentSet</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-SPOContentTypeToDocumentSet</maml:name> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The content type to add. Either specify name, an id, or a content type object.</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DocumentSet</maml:name> <maml:description> <maml:para>The document set to add the content type to. Either specify a name, a document set template object, an id, or a content type object</maml:para> </maml:description> <command:parameterValue required="true">DocumentSetPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The content type to add. Either specify name, an id, or a content type object.</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind[]</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DocumentSet</maml:name> <maml:description> <maml:para>The document set to add the content type to. Either specify a name, a document set template object, an id, or a content type object</maml:para> </maml:description> <command:parameterValue required="true">DocumentSetPipeBind</command:parameterValue> <dev:type> <maml:name>DocumentSetPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPOContentTypeToDocumentSet -ContentType "Test CT" -DocumentSet "Test Document Set"</dev:code> <maml:remarks> <maml:para>This will add the content type called 'Test CT' to the document set called ''Test Document Set'</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $docset = Get-SPODocumentSetTemplate -Identity "Test Document Set" PS:> $ct = Get-SPOContentType -Identity "Test CT" PS:> Add-SPOContentTypeToDocumentSet -ContentType $ct -DocumentSet $docset</dev:code> <maml:remarks> <maml:para>This will add the content type called 'Test CT' to the document set called ''Test Document Set'</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-SPOContentTypeToDocumentSet -ContentType 0x0101001F1CEFF1D4126E4CAD10F00B6137E969 -DocumentSet 0x0120D520005DB65D094035A241BAC9AF083F825F3B</dev:code> <maml:remarks> <maml:para>This will add the content type called 'Test CT' to the document set called ''Test Document Set'</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPODocumentSetField</command:name> <maml:description> <maml:para>Sets a site column from the avaiable content types to a document set</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPODocumentSetField</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPODocumentSetField</maml:name> <command:parameter required="true" position="named"> <maml:name>DocumentSet</maml:name> <maml:description> <maml:para>The document set to set the field in. Either specify a name, a document set template object, an id, or a content type object</maml:para> </maml:description> <command:parameterValue required="true">DocumentSetPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Field</maml:name> <maml:description> <maml:para>The field to set. The field needs to be available in one of the available content types. Either specify a name, an id or a field object</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSharedField</maml:name> <maml:description> <maml:para>Set the field as a Shared Field</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetWelcomePageField</maml:name> <maml:description> <maml:para>Set the field as a Welcome Page field</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveSharedField</maml:name> <maml:description> <maml:para>Removes the field as a Shared Field</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveWelcomePageField</maml:name> <maml:description> <maml:para>Removes the field as a Welcome Page Field</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>DocumentSet</maml:name> <maml:description> <maml:para>The document set to set the field in. Either specify a name, a document set template object, an id, or a content type object</maml:para> </maml:description> <command:parameterValue required="true">DocumentSetPipeBind</command:parameterValue> <dev:type> <maml:name>DocumentSetPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Field</maml:name> <maml:description> <maml:para>The field to set. The field needs to be available in one of the available content types. Either specify a name, an id or a field object</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> <dev:type> <maml:name>FieldPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSharedField</maml:name> <maml:description> <maml:para>Set the field as a Shared Field</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetWelcomePageField</maml:name> <maml:description> <maml:para>Set the field as a Welcome Page field</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveSharedField</maml:name> <maml:description> <maml:para>Removes the field as a Shared Field</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveWelcomePageField</maml:name> <maml:description> <maml:para>Removes the field as a Welcome Page Field</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPODocumentSetField -Field "Test Field" -DocumentSet "Test Document Set" -SetSharedField -SetWelcomePageField</dev:code> <maml:remarks> <maml:para>This will set the field, available in one the available content types, as a Shared Field and as a Welcome Page Field.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPODocumentSetField -Field "Test Field" -DocumentSet "Test Document Set" -RemoveSharedField -RemoveWelcomePageField</dev:code> <maml:remarks> <maml:para>This will remove the field, available in one the available content types, as a Shared Field and as a Welcome Page Field.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPOProvisioningTemplateMetadata</command:name> <maml:description> <maml:para>Sets metadata of a provisioning template</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPOProvisioningTemplateMetadata</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPOProvisioningTemplateMetadata</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to the xml or pnp file containing the provisioning template.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateDisplayName</maml:name> <maml:description> <maml:para>It can be used to specify the DisplayName of the template file that will be updated.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateImagePreviewUrl</maml:name> <maml:description> <maml:para>It can be used to specify the ImagePreviewUrl of the template file that will be updated.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProperties</maml:name> <maml:description> <maml:para>It can be used to specify custom Properties for the template file that will be updated.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while extracting a template.</maml:para> </maml:description> <command:parameterValue required="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to the xml or pnp file containing the provisioning template.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateDisplayName</maml:name> <maml:description> <maml:para>It can be used to specify the DisplayName of the template file that will be updated.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateImagePreviewUrl</maml:name> <maml:description> <maml:para>It can be used to specify the ImagePreviewUrl of the template file that will be updated.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProperties</maml:name> <maml:description> <maml:para>It can be used to specify custom Properties for the template file that will be updated.</maml:para> </maml:description> <command:parameterValue required="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while extracting a template.</maml:para> </maml:description> <command:parameterValue required="false">ITemplateProviderExtension[]</command:parameterValue> <dev:type> <maml:name>ITemplateProviderExtension[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOProvisioningTemplateMetadata -Path template.xml -TemplateDisplayName "DisplayNameValue"</dev:code> <maml:remarks> <maml:para>Sets the DisplayName property of a provisioning template in XML format. </maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOProvisioningTemplateMetadata -Path template.pnp -TemplateDisplayName "DisplayNameValue"</dev:code> <maml:remarks> <maml:para>Sets the DisplayName property of a provisioning template in Office Open XML format. </maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOProvisioningTemplateMetadata -Path template.xml -TemplateImagePreviewUrl "Full URL of the Image Preview"</dev:code> <maml:remarks> <maml:para>Sets the DisplayName property of a provisioning template in XML format. </maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOProvisioningTemplateMetadata -Path template.pnp -TemplateImagePreviewUrl "Full URL of the Image Preview"</dev:code> <maml:remarks> <maml:para>Sets the DisplayName property of a provisioning template in Office Open XML format. </maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOProvisioningTemplateMetadata -Path template.xml -TemplateProperties @{"Property1" = "Test Value 1"; "Property2"="Test Value 2"}</dev:code> <maml:remarks> <maml:para>Sets the DisplayName property of a provisioning template in XML format. </maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOProvisioningTemplateMetadata -Path template.pnp -TemplateProperties @{"Property1" = "Test Value 1"; "Property2"="Test Value 2"}</dev:code> <maml:remarks> <maml:para>Sets the DisplayName property of a provisioning template in Office Open XML format. </maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Convert-SPOFolderToProvisioningTemplate</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Convert</command:verb> <command:noun>SPOFolderToProvisioningTemplate</command:noun> <dev:version></dev:version> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Convert-SPOFolderToProvisioningTemplate</maml:name> <command:parameter required="true" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Folder to process. If not specified the current folder will be used.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Folder to process. If not specified the current folder will be used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Convert-SPOFolderToProvisioningTemplate -Out template.pnp</dev:code> <maml:remarks> <maml:para>Creates a pnp package file of an existing template xml, and includes all files in the current folder</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Convert-SPOFolderToProvisioningTemplate -Out template.pnp -Folder c:\temp</dev:code> <maml:remarks> <maml:para>Creates a pnp package file of an existing template xml, and includes all files in the c:\temp folder</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Convert-SPOProvisioningTemplate</command:name> <maml:description> <maml:para>Converts a provisioning template to a other schema version</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Convert</command:verb> <command:noun>SPOProvisioningTemplate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Convert-SPOProvisioningTemplate</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to the xml file containing the provisioning template</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ToSchema</maml:name> <maml:description> <maml:para>The schema of the output to use, defaults to the latest schema</maml:para> </maml:description> <command:parameterValue required="true">XMLPnPSchemaVersion</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Encoding</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to the xml file containing the provisioning template</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ToSchema</maml:name> <maml:description> <maml:para>The schema of the output to use, defaults to the latest schema</maml:para> </maml:description> <command:parameterValue required="false">XMLPnPSchemaVersion</command:parameterValue> <dev:type> <maml:name>XMLPnPSchemaVersion</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Encoding</command:parameterValue> <dev:type> <maml:name>Encoding</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Convert-SPOProvisioningTemplate -Path template.xml</dev:code> <maml:remarks> <maml:para>Converts a provisioning template to the latest schema and outputs the result to current console.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Convert-SPOPRovisioningTemplate -Path template.xml -Out newtemplate.xml</dev:code> <maml:remarks> <maml:para>Converts a provisioning template to the latest schema and outputs the result the newtemplate.xml file.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Convert-SPOPRovisioningTemplate -Path template.xml -Out newtemplate.xml -ToSchema V201512</dev:code> <maml:remarks> <maml:para>Converts a provisioning template to the latest schema using the 201512 schema and outputs the result the newtemplate.xml file.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Apply-SPOProvisioningTemplate</command:name> <maml:description> <maml:para>Applies a provisioning template to a web</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Apply</command:verb> <command:noun>SPOProvisioningTemplate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Apply-SPOProvisioningTemplate</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to the xml or pnp file containing the provisioning template.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResourceFolder</maml:name> <maml:description> <maml:para>Root folder where resources/files that are being referenced in the template are located. If not specified the same folder as where the provisioning template is located will be used.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OverwriteSystemPropertyBagValues</maml:name> <maml:description> <maml:para>Specify this parameter if you want to overwrite and/or create properties that are known to be system entries (starting with vti_, dlc_, etc.)</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>Allows you to specify parameters that can be referred to in the template by means of the {parameter:<Key>} token. See examples on how to use this parameter.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Handlers</maml:name> <maml:description> <maml:para>Allows you to only process a specific part of the template. Notice that this might fail, as some of the handlers require other artifacts in place if they are not part of what your applying.</maml:para> </maml:description> <command:parameterValue required="true">Handlers</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludeHandlers</maml:name> <maml:description> <maml:para>Allows you to run all handlers, excluding the ones specified.</maml:para> </maml:description> <command:parameterValue required="true">Handlers</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExtensibilityHandlers</maml:name> <maml:description> <maml:para>Allows you to specify ExtensbilityHandlers to execute while applying a template</maml:para> </maml:description> <command:parameterValue required="true">ExtensibilityHandler[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while applying a template.</maml:para> </maml:description> <command:parameterValue required="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to the xml or pnp file containing the provisioning template.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResourceFolder</maml:name> <maml:description> <maml:para>Root folder where resources/files that are being referenced in the template are located. If not specified the same folder as where the provisioning template is located will be used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OverwriteSystemPropertyBagValues</maml:name> <maml:description> <maml:para>Specify this parameter if you want to overwrite and/or create properties that are known to be system entries (starting with vti_, dlc_, etc.)</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>Allows you to specify parameters that can be referred to in the template by means of the {parameter:<Key>} token. See examples on how to use this parameter.</maml:para> </maml:description> <command:parameterValue required="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Handlers</maml:name> <maml:description> <maml:para>Allows you to only process a specific part of the template. Notice that this might fail, as some of the handlers require other artifacts in place if they are not part of what your applying.</maml:para> </maml:description> <command:parameterValue required="false">Handlers</command:parameterValue> <dev:type> <maml:name>Handlers</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludeHandlers</maml:name> <maml:description> <maml:para>Allows you to run all handlers, excluding the ones specified.</maml:para> </maml:description> <command:parameterValue required="false">Handlers</command:parameterValue> <dev:type> <maml:name>Handlers</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExtensibilityHandlers</maml:name> <maml:description> <maml:para>Allows you to specify ExtensbilityHandlers to execute while applying a template</maml:para> </maml:description> <command:parameterValue required="false">ExtensibilityHandler[]</command:parameterValue> <dev:type> <maml:name>ExtensibilityHandler[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while applying a template.</maml:para> </maml:description> <command:parameterValue required="false">ITemplateProviderExtension[]</command:parameterValue> <dev:type> <maml:name>ITemplateProviderExtension[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Apply-SPOProvisioningTemplate -Path template.xml</dev:code> <maml:remarks> <maml:para>Applies a provisioning template in XML format to the current web. </maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Apply-SPOProvisioningTemplate -Path template.xml -ResourceFolder c:\provisioning\resources</dev:code> <maml:remarks> <maml:para>Applies a provisioning template in XML format to the current web. Any resources like files that are referenced in the template will be retrieved from the folder as specified with the ResourceFolder parameter. </maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Apply-SPOProvisioningTemplate -Path template.xml -Parameters @{"ListTitle"="Projects";"parameter2"="a second value"}</dev:code> <maml:remarks> <maml:para>Applies a provisioning template in XML format to the current web. It will populate the parameter in the template the values as specified and in the template you can refer to those values with the {parameter:<key>} token. For instance with the example above, specifying {parameter:ListTitle} in your template will translate to 'Projects' when applying the template. These tokens can be used in most string values in a template.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Apply-SPOProvisioningTemplate -Path template.xml -Handlers Lists, SiteSecurity</dev:code> <maml:remarks> <maml:para>Applies a provisioning template in XML format to the current web. It will only apply the lists and site security part of the template.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Apply-SPOProvisioningTemplate -Path template.pnp</dev:code> <maml:remarks> <maml:para>Applies a provisioning template from a pnp package to the current web.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Apply-SPOProvisioningTemplate -Path https://tenant.sharepoint.com/sites/templatestorage/Documents/template.pnp</dev:code> <maml:remarks> <maml:para>Applies a provisioning template from a pnp package stored in a library to the current web.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 7---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code> PS:> $handler1 = New-SPOExtensibilityHandlerObject -Assembly Contoso.Core.Handlers -Type Contoso.Core.Handlers.MyExtensibilityHandler1 PS:> $handler2 = New-SPOExtensibilityHandlerObject -Assembly Contoso.Core.Handlers -Type Contoso.Core.Handlers.MyExtensibilityHandler1 PS:> Apply-SPOProvisioningTemplate -Path NewTemplate.xml -ExtensibilityHandlers $handler1,$handler2</dev:code> <maml:remarks> <maml:para>This will create two new ExtensibilityHandler objects that are run while provisioning the template</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOProvisioningTemplate</command:name> <maml:description> <maml:para>Generates a provisioning template from a web</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOProvisioningTemplate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOProvisioningTemplate</maml:name> <command:parameter required="false" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Schema</maml:name> <maml:description> <maml:para>The schema of the output to use, defaults to the latest schema</maml:para> </maml:description> <command:parameterValue required="true">XMLPnPSchemaVersion</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeAllTermGroups</maml:name> <maml:description> <maml:para>If specified, all term groups will be included. Overrides IncludeSiteCollectionTermGroup.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeSiteCollectionTermGroup</maml:name> <maml:description> <maml:para>If specified, all the site collection term groups will be included. Overridden by IncludeAllTermGroups.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeSiteGroups</maml:name> <maml:description> <maml:para>If specified all site groups will be included.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeTermGroupsSecurity</maml:name> <maml:description> <maml:para>If specified all the managers and contributors of term groups will be included.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PersistBrandingFiles</maml:name> <maml:description> <maml:para>If specified the files used for masterpages, sitelogo, alternate CSS and the files that make up the composed look will be saved.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PersistPublishingFiles</maml:name> <maml:description> <maml:para>If specified the files used for the publishing feature will be saved.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeNativePublishingFiles</maml:name> <maml:description> <maml:para>If specified, out of the box / native publishing files will be saved.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PersistMultiLanguageResources</maml:name> <maml:description> <maml:para>If specified, resource values for applicable artifacts will be persisted to a resource file</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResourceFilePrefix</maml:name> <maml:description> <maml:para>If specified, resource files will be saved with the specified prefix instead of using the template name specified. If no template name is specified the files will be called PnP-Resources.<language>.resx. See examples for more info.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Handlers</maml:name> <maml:description> <maml:para>Allows you to only process a specific type of artifact in the site. Notice that this might result in a non-working template, as some of the handlers require other artifacts in place if they are not part of what your extracting.</maml:para> </maml:description> <command:parameterValue required="true">Handlers</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludeHandlers</maml:name> <maml:description> <maml:para>Allows you to run all handlers, excluding the ones specified.</maml:para> </maml:description> <command:parameterValue required="true">Handlers</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExtensibilityHandlers</maml:name> <maml:description> <maml:para>Allows you to specify ExtensbilityHandlers to execute while extracting a template.</maml:para> </maml:description> <command:parameterValue required="true">ExtensibilityHandler[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while extracting a template.</maml:para> </maml:description> <command:parameterValue required="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Encoding</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateDisplayName</maml:name> <maml:description> <maml:para>It can be used to specify the DisplayName of the template file that will be extracted.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateImagePreviewUrl</maml:name> <maml:description> <maml:para>It can be used to specify the ImagePreviewUrl of the template file that will be extracted.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProperties</maml:name> <maml:description> <maml:para>It can be used to specify custom Properties for the template file that will be extracted.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Schema</maml:name> <maml:description> <maml:para>The schema of the output to use, defaults to the latest schema</maml:para> </maml:description> <command:parameterValue required="false">XMLPnPSchemaVersion</command:parameterValue> <dev:type> <maml:name>XMLPnPSchemaVersion</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeAllTermGroups</maml:name> <maml:description> <maml:para>If specified, all term groups will be included. Overrides IncludeSiteCollectionTermGroup.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeSiteCollectionTermGroup</maml:name> <maml:description> <maml:para>If specified, all the site collection term groups will be included. Overridden by IncludeAllTermGroups.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeSiteGroups</maml:name> <maml:description> <maml:para>If specified all site groups will be included.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeTermGroupsSecurity</maml:name> <maml:description> <maml:para>If specified all the managers and contributors of term groups will be included.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PersistBrandingFiles</maml:name> <maml:description> <maml:para>If specified the files used for masterpages, sitelogo, alternate CSS and the files that make up the composed look will be saved.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PersistPublishingFiles</maml:name> <maml:description> <maml:para>If specified the files used for the publishing feature will be saved.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeNativePublishingFiles</maml:name> <maml:description> <maml:para>If specified, out of the box / native publishing files will be saved.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PersistMultiLanguageResources</maml:name> <maml:description> <maml:para>If specified, resource values for applicable artifacts will be persisted to a resource file</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResourceFilePrefix</maml:name> <maml:description> <maml:para>If specified, resource files will be saved with the specified prefix instead of using the template name specified. If no template name is specified the files will be called PnP-Resources.<language>.resx. See examples for more info.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Handlers</maml:name> <maml:description> <maml:para>Allows you to only process a specific type of artifact in the site. Notice that this might result in a non-working template, as some of the handlers require other artifacts in place if they are not part of what your extracting.</maml:para> </maml:description> <command:parameterValue required="false">Handlers</command:parameterValue> <dev:type> <maml:name>Handlers</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludeHandlers</maml:name> <maml:description> <maml:para>Allows you to run all handlers, excluding the ones specified.</maml:para> </maml:description> <command:parameterValue required="false">Handlers</command:parameterValue> <dev:type> <maml:name>Handlers</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExtensibilityHandlers</maml:name> <maml:description> <maml:para>Allows you to specify ExtensbilityHandlers to execute while extracting a template.</maml:para> </maml:description> <command:parameterValue required="false">ExtensibilityHandler[]</command:parameterValue> <dev:type> <maml:name>ExtensibilityHandler[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while extracting a template.</maml:para> </maml:description> <command:parameterValue required="false">ITemplateProviderExtension[]</command:parameterValue> <dev:type> <maml:name>ITemplateProviderExtension[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Encoding</command:parameterValue> <dev:type> <maml:name>Encoding</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateDisplayName</maml:name> <maml:description> <maml:para>It can be used to specify the DisplayName of the template file that will be extracted.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateImagePreviewUrl</maml:name> <maml:description> <maml:para>It can be used to specify the ImagePreviewUrl of the template file that will be extracted.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProperties</maml:name> <maml:description> <maml:para>It can be used to specify custom Properties for the template file that will be extracted.</maml:para> </maml:description> <command:parameterValue required="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOProvisioningTemplate -Out template.pnp</dev:code> <maml:remarks> <maml:para>Extracts a provisioning template in Office Open XML from the current web.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOProvisioningTemplate -Out template.xml</dev:code> <maml:remarks> <maml:para>Extracts a provisioning template in XML format from the current web.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOProvisioningTemplate -Out template.pnp -Schema V201503</dev:code> <maml:remarks> <maml:para>Extracts a provisioning template in Office Open XML from the current web and saves it in the V201503 version of the schema.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOProvisioningTemplate -Out template.pnp -IncludeAllTermGroups</dev:code> <maml:remarks> <maml:para>Extracts a provisioning template in Office Open XML from the current web and includes all term groups, term sets and terms from the Managed Metadata Service Taxonomy.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOProvisioningTemplate -Out template.pnp -IncludeSiteCollectionTermGroup</dev:code> <maml:remarks> <maml:para>Extracts a provisioning template in Office Open XML from the current web and includes the term group currently (if set) assigned to the site collection.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOProvisioningTemplate -Out template.pnp -PersistComposedLookFiles</dev:code> <maml:remarks> <maml:para>Extracts a provisioning template in Office Open XML from the current web and saves the files that make up the composed look to the same folder as where the template is saved.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 7---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOProvisioningTemplate -Out template.pnp -Handlers Lists, SiteSecurity</dev:code> <maml:remarks> <maml:para>Extracts a provisioning template in Office Open XML from the current web, but only processes lists and site security when generating the template.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 8---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code> PS:> $handler1 = New-SPOExtensibilityHandlerObject -Assembly Contoso.Core.Handlers -Type Contoso.Core.Handlers.MyExtensibilityHandler1 PS:> $handler2 = New-SPOExtensibilityHandlerObject -Assembly Contoso.Core.Handlers -Type Contoso.Core.Handlers.MyExtensibilityHandler1 PS:> Get-SPOProvisioningTemplate -Out NewTemplate.xml -ExtensibilityHandlers $handler1,$handler2</dev:code> <maml:remarks> <maml:para>This will create two new ExtensibilityHandler objects that are run during extraction of the template</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 9---------------------</maml:title> <maml:introduction> <maml:para>Only supported on SP2016 and SP Online</maml:para> </maml:introduction> <dev:code>PS:> Get-SPOProvisioningTemplate -Out template.pnp -PersistMultiLanguageResources</dev:code> <maml:remarks> <maml:para>Extracts a provisioning template in Office Open XML from the current web, and for supported artifacts it will create a resource file for each supported language (based upon the language settings of the current web). The generated resource files will be named after the value specified in the Out parameter. For instance if the Out parameter is specified as -Out 'template.xml' the generated resource file will be called 'template.en-US.resx'.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 10---------------------</maml:title> <maml:introduction> <maml:para>Only supported on SP2016 and SP Online</maml:para> </maml:introduction> <dev:code>PS:> Get-SPOProvisioningTemplate -Out template.pnp -PersistMultiLanguageResources -ResourceFilePrefix MyResources</dev:code> <maml:remarks> <maml:para>Extracts a provisioning template in Office Open XML from the current web, and for supported artifacts it will create a resource file for each supported language (based upon the language settings of the current web). The generated resource files will be named 'MyResources.en-US.resx' etc.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SPOProvisioningTemplateFromFolder</command:name> <maml:description> <maml:para>Generates a provisioning template from a given folder, including only files that are present in that folder</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>SPOProvisioningTemplateFromFolder</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-SPOProvisioningTemplateFromFolder</maml:name> <command:parameter required="false" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Folder to process. If not specified the current folder will be used.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>TargetFolder</maml:name> <maml:description> <maml:para>Target folder to provision to files to. If not specified, the current folder name will be used.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Match</maml:name> <maml:description> <maml:para>Optional wildcard pattern to match filenames against. If empty all files will be included.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>An optional content type to use.</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Properties</maml:name> <maml:description> <maml:para>Additional properties to set for every file entry in the generated template.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Schema</maml:name> <maml:description> <maml:para>The schema of the output to use, defaults to the latest schema</maml:para> </maml:description> <command:parameterValue required="true">XMLPnPSchemaVersion</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsIncludeFile</maml:name> <maml:description> <maml:para>If specified, the output will only contain the <pnp:Files> element. This allows the output to be included in another template.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Encoding</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Folder to process. If not specified the current folder will be used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>TargetFolder</maml:name> <maml:description> <maml:para>Target folder to provision to files to. If not specified, the current folder name will be used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Match</maml:name> <maml:description> <maml:para>Optional wildcard pattern to match filenames against. If empty all files will be included.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>An optional content type to use.</maml:para> </maml:description> <command:parameterValue required="false">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Properties</maml:name> <maml:description> <maml:para>Additional properties to set for every file entry in the generated template.</maml:para> </maml:description> <command:parameterValue required="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Schema</maml:name> <maml:description> <maml:para>The schema of the output to use, defaults to the latest schema</maml:para> </maml:description> <command:parameterValue required="false">XMLPnPSchemaVersion</command:parameterValue> <dev:type> <maml:name>XMLPnPSchemaVersion</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsIncludeFile</maml:name> <maml:description> <maml:para>If specified, the output will only contain the <pnp:Files> element. This allows the output to be included in another template.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Encoding</command:parameterValue> <dev:type> <maml:name>Encoding</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-SPOProvisioningTemplateFromFolder -Out template.xml</dev:code> <maml:remarks> <maml:para>Creates an empty provisioning template, and includes all files in the current folder.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-SPOProvisioningTemplateFromFolder -Out template.xml -Folder c:\temp</dev:code> <maml:remarks> <maml:para>Creates an empty provisioning template, and includes all files in the c:\temp folder.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-SPOProvisioningTemplateFromFolder -Out template.xml -Folder c:\temp -Match *.js</dev:code> <maml:remarks> <maml:para>Creates an empty provisioning template, and includes all files with a JS extension in the c:\temp folder.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-SPOProvisioningTemplateFromFolder -Out template.xml -Folder c:\temp -Match *.js -TargetFolder "Shared Documents"</dev:code> <maml:remarks> <maml:para>Creates an empty provisioning template, and includes all files with a JS extension in the c:\temp folder and marks the files in the template to be added to the 'Shared Documents' folder</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-SPOProvisioningTemplateFromFolder -Out template.xml -Folder c:\temp -Match *.js -TargetFolder "Shared Documents" -ContentType "Test Content Type"</dev:code> <maml:remarks> <maml:para>Creates an empty provisioning template, and includes all files with a JS extension in the c:\temp folder and marks the files in the template to be added to the 'Shared Documents' folder. It will add a property to the item for the content type.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-SPOProvisioningTemplateFromFolder -Out template.xml -Folder c:\temp -Match *.js -TargetFolder "Shared Documents" -Properties @{"Title" = "Test Title"; "Category"="Test Category"}</dev:code> <maml:remarks> <maml:para>Creates an empty provisioning template, and includes all files with a JS extension in the c:\temp folder and marks the files in the template to be added to the 'Shared Documents' folder. It will add the specified properties to the file entries.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 7---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-SPOProvisioningTemplateFromFolder -Out template.pnp</dev:code> <maml:remarks> <maml:para>Creates an empty provisioning template as a pnp package file, and includes all files in the current folder</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 8---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-SPOProvisioningTemplateFromFolder -Out template.pnp -Folder c:\temp</dev:code> <maml:remarks> <maml:para>Creates an empty provisioning template as a pnp package file, and includes all files in the c:\temp folder</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOProperty</command:name> <maml:description> <maml:para>Will populate properties of an object and optionally, if needed, load the value from the server. If one property is specified its value will be returned to the output.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOProperty</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOProperty</maml:name> <command:parameter required="true" position="named"> <maml:name>ClientObject</maml:name> <maml:description> <maml:para>Specifies the object where the properties of should be retrieved</maml:para> </maml:description> <command:parameterValue required="true">ClientObject</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Property</maml:name> <maml:description> <maml:para>The properties to load. If one property is specified its value will be returned to the output.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ClientObject</maml:name> <maml:description> <maml:para>Specifies the object where the properties of should be retrieved</maml:para> </maml:description> <command:parameterValue required="true">ClientObject</command:parameterValue> <dev:type> <maml:name>ClientObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Property</maml:name> <maml:description> <maml:para>The properties to load. If one property is specified its value will be returned to the output.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code> PS:> $web = Get-SPOWeb PS:> Get-SPOProperty -ClientObject $web -Property Id, Lists PS:> $web.Lists</dev:code> <maml:remarks> <maml:para>Will load both the Id and Lists properties of the specified Web object.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code> PS:> $list = Get-SPOList -Identity 'Site Assets' PS:> Get-SPOProperty -ClientObject $list -Property Views</dev:code> <maml:remarks> <maml:para>Will load the views object of the specified list object and return its value to the output.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOAzureADManifestKeyCredentials</command:name> <maml:description> <maml:para>Creates the JSON snippet that is required for the manifest json file for Azure WebApplication / WebAPI apps</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOAzureADManifestKeyCredentials</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOAzureADManifestKeyCredentials</maml:name> <command:parameter required="true" position="named"> <maml:name>CertPath</maml:name> <maml:description> <maml:para>Specifies the path to the certificate like .\mycert.cer</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>CertPath</maml:name> <maml:description> <maml:para>Specifies the path to the certificate like .\mycert.cer</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOAzureADManifestKeyCredentials -CertPath .\mycert.cer</dev:code> <maml:remarks> <maml:para>Output the JSON snippet which needs to be replaced in the application manifest file</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOAzureADManifestKeyCredentials -CertPath .\mycert.cer | Set-Clipboard</dev:code> <maml:remarks> <maml:para>Output the JSON snippet which needs to be replaced in the application manifest file and copies it to the clipboard</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOContext</command:name> <maml:description> <maml:para>Returns a Client Side Object Model context</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOContext</command:noun> <dev:version /> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $ctx = Get-SPOContext</dev:code> <maml:remarks> <maml:para>This will put the current context in the $ctx variable.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOStoredCredential</command:name> <maml:description> <maml:para>Returns a stored credential from the Windows Credential Manager</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOStoredCredential</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SPOStoredCredential</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The credential to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>The object type of the credential to return from the Credential Manager. Possible valus are 'O365', 'OnPrem' or 'PSCredential'</maml:para> </maml:description> <command:parameterValue required="true">CredentialType</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The credential to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>The object type of the credential to return from the Credential Manager. Possible valus are 'O365', 'OnPrem' or 'PSCredential'</maml:para> </maml:description> <command:parameterValue required="false">CredentialType</command:parameterValue> <dev:type> <maml:name>CredentialType</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOnlineStoredCredential -Name O365</dev:code> <maml:remarks> <maml:para>Returns the credential associated with the specified identifier</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SPOHealthScore</command:name> <maml:description> <maml:para>Retrieves the current health score value of the server</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPOHealthScore</command:noun> <dev:version /> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOHealthScore</dev:code> <maml:remarks> <maml:para>This will retrieve the current health score of the server.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-SPOHealthScore -Url https://contoso.sharepoint.com</dev:code> <maml:remarks> <maml:para>This will retrieve the current health score for the url https://contoso.sharepoint.com.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Execute-SPOQuery</command:name> <maml:description> <maml:para>Executes any queued actions / changes on the SharePoint Client Side Object Model Context</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Execute</command:verb> <command:noun>SPOQuery</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Execute-SPOQuery</maml:name> <command:parameter required="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>Number to times to retry in case of throttling. Defaults to 10.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryWait</maml:name> <maml:description> <maml:para>Delay in seconds. Defaults to 1.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>Number to times to retry in case of throttling. Defaults to 10.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryWait</maml:name> <maml:description> <maml:para>Delay in seconds. Defaults to 1.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Execute-SPOQuery -RetryCount 5</dev:code> <maml:remarks> <maml:para>This will execute any queued actions / changes on the SharePoint Client Side Object Model Context and will retry 5 times in case of throttling.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disconnect-SPOnline</command:name> <maml:description> <maml:para>Disconnects the context</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disconnect</command:verb> <command:noun>SPOnline</command:noun> <dev:version /> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Disconnect-SPOnline</dev:code> <maml:remarks> <maml:para>This will disconnect you from the server.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPOContext</command:name> <maml:description> <maml:para>Sets the Client Context to use by the cmdlets</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPOContext</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPOContext</maml:name> <command:parameter required="true" position="1"> <maml:name>Context</maml:name> <maml:description> <maml:para>The ClientContext to set</maml:para> </maml:description> <command:parameterValue required="true">ClientContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="1"> <maml:name>Context</maml:name> <maml:description> <maml:para>The ClientContext to set</maml:para> </maml:description> <command:parameterValue required="true">ClientContext</command:parameterValue> <dev:type> <maml:name>ClientContext</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-SPOnline -Url $siteAurl -Credentials $credentials PS:> $ctx = Get-SPOContext PS:> Get-SPOList # returns the lists from site specified with $siteAurl PS:> Connect-SPOnline -Url $siteBurl -Credentials $credentials PS:> Get-SPOList # returns the lists from the site specified with $siteBurl PS:> Set-SPOContext -Context $ctx # switch back to site A PS:> Get-SPOList # returns the lists from site A</dev:code> <maml:remarks> <maml:para /> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>-</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb></command:verb> <command:noun></command:noun> <dev:version></dev:version> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Connect-SPOnline</command:name> <maml:description> <maml:para>Connects to a SharePoint site and creates an in-memory context</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Connect</command:verb> <command:noun>SPOnline</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>If no credentials have been specified, and the CurrentCredentials parameter has not been specified, you will be prompted for credentials.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-SPOnline</maml:name> <command:parameter required="false" position="named"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>Credentials of the user to connect with. Either specify a PSCredential object or a string. In case of a string value a lookup will be done to the Windows Credential Manager for the correct credentials.</maml:para> </maml:description> <command:parameterValue required="true">CredentialPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CurrentCredentials</maml:name> <maml:description> <maml:para>If you want to connect with the current user credentials</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UseAdfs</maml:name> <maml:description> <maml:para>If you want to connect to your on-premises SharePoint farm using ADFS</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AuthenticationMode</maml:name> <maml:description> <maml:para>Specify to use for instance use forms based authentication (FBA)</maml:para> </maml:description> <command:parameterValue required="true">ClientAuthenticationMode</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection to connect to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinimalHealthScore</maml:name> <maml:description> <maml:para>Specifies a minimal server healthscore before any requests are executed.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryWait</maml:name> <maml:description> <maml:para>Defines how many seconds to wait before each retry. Default is 1 second.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequestTimeout</maml:name> <maml:description> <maml:para>The request timeout. Default is 180000</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CreateDrive</maml:name> <maml:description> <maml:para>If you want to create a PSDrive connected to the URL</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DriveName</maml:name> <maml:description> <maml:para>Name of the PSDrive to create (default: SPO)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipTenantAdminCheck</maml:name> <maml:description> <maml:para>Should we skip the check if this site is the Tenant admin site. Default is false</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-SPOnline</maml:name> <command:parameter required="false" position="named"> <maml:name>Realm</maml:name> <maml:description> <maml:para>Authentication realm. If not specified will be resolved from the url specified.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>AppId</maml:name> <maml:description> <maml:para>The Application Client ID to use.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>AppSecret</maml:name> <maml:description> <maml:para>The Application Client Secret to use.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection to connect to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinimalHealthScore</maml:name> <maml:description> <maml:para>Specifies a minimal server healthscore before any requests are executed.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryWait</maml:name> <maml:description> <maml:para>Defines how many seconds to wait before each retry. Default is 1 second.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequestTimeout</maml:name> <maml:description> <maml:para>The request timeout. Default is 180000</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CreateDrive</maml:name> <maml:description> <maml:para>If you want to create a PSDrive connected to the URL</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DriveName</maml:name> <maml:description> <maml:para>Name of the PSDrive to create (default: SPO)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipTenantAdminCheck</maml:name> <maml:description> <maml:para>Should we skip the check if this site is the Tenant admin site. Default is false</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-SPOnline</maml:name> <command:parameter required="true" position="named"> <maml:name>UseWebLogin</maml:name> <maml:description> <maml:para>If you want to connect to SharePoint with browser based login</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection to connect to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinimalHealthScore</maml:name> <maml:description> <maml:para>Specifies a minimal server healthscore before any requests are executed.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryWait</maml:name> <maml:description> <maml:para>Defines how many seconds to wait before each retry. Default is 1 second.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequestTimeout</maml:name> <maml:description> <maml:para>The request timeout. Default is 180000</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CreateDrive</maml:name> <maml:description> <maml:para>If you want to create a PSDrive connected to the URL</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DriveName</maml:name> <maml:description> <maml:para>Name of the PSDrive to create (default: SPO)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipTenantAdminCheck</maml:name> <maml:description> <maml:para>Should we skip the check if this site is the Tenant admin site. Default is false</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection to connect to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>Credentials of the user to connect with. Either specify a PSCredential object or a string. In case of a string value a lookup will be done to the Windows Credential Manager for the correct credentials.</maml:para> </maml:description> <command:parameterValue required="false">CredentialPipeBind</command:parameterValue> <dev:type> <maml:name>CredentialPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CurrentCredentials</maml:name> <maml:description> <maml:para>If you want to connect with the current user credentials</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UseAdfs</maml:name> <maml:description> <maml:para>If you want to connect to your on-premises SharePoint farm using ADFS</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinimalHealthScore</maml:name> <maml:description> <maml:para>Specifies a minimal server healthscore before any requests are executed.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryWait</maml:name> <maml:description> <maml:para>Defines how many seconds to wait before each retry. Default is 1 second.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequestTimeout</maml:name> <maml:description> <maml:para>The request timeout. Default is 180000</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Realm</maml:name> <maml:description> <maml:para>Authentication realm. If not specified will be resolved from the url specified.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>AppId</maml:name> <maml:description> <maml:para>The Application Client ID to use.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>AppSecret</maml:name> <maml:description> <maml:para>The Application Client Secret to use.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>UseWebLogin</maml:name> <maml:description> <maml:para>If you want to connect to SharePoint with browser based login</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AuthenticationMode</maml:name> <maml:description> <maml:para>Specify to use for instance use forms based authentication (FBA)</maml:para> </maml:description> <command:parameterValue required="false">ClientAuthenticationMode</command:parameterValue> <dev:type> <maml:name>ClientAuthenticationMode</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CreateDrive</maml:name> <maml:description> <maml:para>If you want to create a PSDrive connected to the URL</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DriveName</maml:name> <maml:description> <maml:para>Name of the PSDrive to create (default: SPO)</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipTenantAdminCheck</maml:name> <maml:description> <maml:para>Should we skip the check if this site is the Tenant admin site. Default is false</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-SPOnline -Url https://contoso.sharepoint.com</dev:code> <maml:remarks> <maml:para>This will prompt for username and password and creates a context for the other PowerShell commands to use. When a generic credential is added to the Windows Credential Manager with https://contoso.sharepoint.com, PowerShell will not prompt for username and password.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-SPOnline -Url https://contoso.sharepoint.com -Credentials (Get-Credential)</dev:code> <maml:remarks> <maml:para>This will prompt for username and password and creates a context for the other PowerShell commands to use. </maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-SPOnline -Url http://yourlocalserver -CurrentCredentials</dev:code> <maml:remarks> <maml:para>This will use the current user credentials and connects to the server specified by the Url parameter.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-SPOnline -Url http://yourlocalserver -Credentials 'O365Creds'</dev:code> <maml:remarks> <maml:para>This will use credentials from the Windows Credential Manager, as defined by the label 'O365Creds'.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-SPOnline -Url http://yourlocalserver -Credentials (Get-Credential) -UseAdfs</dev:code> <maml:remarks> <maml:para>This will prompt for username and password and creates a context using ADFS to authenticate.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-SPOnline -Url https://yourserver -Credentials (Get-Credential) -CreateDrive cd SPO:\\ dir</dev:code> <maml:remarks> <maml:para>This will prompt you for credentials and creates a context for the other PowerShell commands to use. It will also create a SPO:\\ drive you can use to navigate around the site</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 7---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-SPOnline -Url https://yourserver -Credentials (Get-Credential) -AuthenticationMode FormsAuthentication</dev:code> <maml:remarks> <maml:para>This will prompt you for credentials and creates a context for the other PowerShell commands to use. It assumes your server is configured for Forms Based Authentication (FBA)</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SPOTraceLog</command:name> <maml:description> <maml:para>Defines if tracing should be turned on. PnP Core, which is the foundation of these cmdlets utilizes the standard Trace functionality of .NET. With this cmdlet you can turn capturing of this trace to a log file on or off.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPOTraceLog</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-SPOTraceLog</maml:name> <command:parameter required="true" position="named"> <maml:name>On</maml:name> <maml:description> <maml:para>Turn on tracing to log file</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LogFile</maml:name> <maml:description> <maml:para>The path and filename of the file to write the trace log to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Level</maml:name> <maml:description> <maml:para>The level of events to capture. Possible values are 'Debug', 'Error', 'Warning', 'Information'. Defaults to 'Information'.</maml:para> </maml:description> <command:parameterValue required="true">LogLevel</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Delimiter</maml:name> <maml:description> <maml:para>If specified the trace log entries will be delimited with this value.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IndentSize</maml:name> <maml:description> <maml:para>Indents in the tracelog will be with this amount of characters. Defaults to 4.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AutoFlush</maml:name> <maml:description> <maml:para>Auto flush the trace log. Defaults to true.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SPOTraceLog</maml:name> <command:parameter required="true" position="named"> <maml:name>Off</maml:name> <maml:description> <maml:para>Turn off tracing to log file.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>On</maml:name> <maml:description> <maml:para>Turn on tracing to log file</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LogFile</maml:name> <maml:description> <maml:para>The path and filename of the file to write the trace log to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Level</maml:name> <maml:description> <maml:para>The level of events to capture. Possible values are 'Debug', 'Error', 'Warning', 'Information'. Defaults to 'Information'.</maml:para> </maml:description> <command:parameterValue required="false">LogLevel</command:parameterValue> <dev:type> <maml:name>LogLevel</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Delimiter</maml:name> <maml:description> <maml:para>If specified the trace log entries will be delimited with this value.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IndentSize</maml:name> <maml:description> <maml:para>Indents in the tracelog will be with this amount of characters. Defaults to 4.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AutoFlush</maml:name> <maml:description> <maml:para>Auto flush the trace log. Defaults to true.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Off</maml:name> <maml:description> <maml:para>Turn off tracing to log file.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>description</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOTraceLog -On -LogFile traceoutput.txt</dev:code> <maml:remarks> <maml:para>This turns on trace logging to the file 'traceoutput.txt' and will capture events of at least 'Information' level.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOTraceLog -On -LogFile traceoutput.txt -Level Debug</dev:code> <maml:remarks> <maml:para>This turns on trace logging to the file 'traceoutput.txt' and will capture debug events.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOTraceLog -On -LogFile traceoutput.txt -Level Debug -Delimiter ","</dev:code> <maml:remarks> <maml:para>This turns on trace logging to the file 'traceoutput.txt' and will write the entries as comma separated. Debug events are captured.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-SPOTraceLog -Off</dev:code> <maml:remarks> <maml:para>This turns off trace logging. It will flush any remaining messages to the log file.</maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Office 365 Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/officedevpnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |