Merge pull request #602 from SharePoint/dev

December 2016 Release

Author: erwinvanhunen

Binaries/SharePointPnPPowerShell2013.msi

@@ -0,0 +1 @@
+The PowerShell Setup Binaries can be downloaded from https://github.com/SharePoint/PnP-PowerShell/releases

Binaries/SharePointPnPPowerShell2016.msi

@@ -527,15 +527,15 @@ static void Main(string[] args)
             var psd1Path = $"{new FileInfo(inFile).Directory}\\ModuleFiles\\SharePointPnPPowerShell{spVersion}.psd1";
             var cmdletsToExportString = string.Join(",", cmdletsToExport.Select(x => "'" + x + "'"));
             var aliasesToExportString = string.Join(",", aliasesToExport.Select(x => "'" + x + "'"));
-            WriteModuleManifest(psd1Path, spVersion, cmdletsToExportString, aliasesToExportString);
+            WriteModuleManifest(psd1Path, spVersion, cmdletsToExportString, aliasesToExportString, assembly);
         }
 
-        private static void WriteModuleManifest(string path, string version, string cmdletsToExport, string aliasesToExport)
+        private static void WriteModuleManifest(string path, string version, string cmdletsToExport, string aliasesToExport, Assembly assembly)
         {
             var manifest = $@"@{{
     ModuleToProcess = 'SharePointPnPPowerShell{version}.psm1'
     NestedModules   = 'SharePointPnP.PowerShell.{version}.Commands.dll'
-    ModuleVersion = '2.9.1611.0'
+    ModuleVersion = '{assembly.GetName().Version}'
     Description = 'SharePoint Patterns and Practices PowerShell Cmdlets for SharePoint {version}'
     GUID = '8f1147be-a8e4-4bd2-a705-841d5334edc0'
     Author = 'SharePoint Patterns and Practices'

Binaries/SharePointPnPPowerShellOnline.msi

@@ -60,7 +60,7 @@ public class NewTenantSite : SPOAdminCmdlet
         public long StorageQuotaWarningLevel = 100;
 
 #if !ONPREMISES
-        [Parameter(Mandatory = false)]
+        [Parameter(Mandatory = false, HelpMessage = "Specifies if any existing site with the same URL should be removed from the recycle bin")]
         public SwitchParameter RemoveDeletedSite;
 #endif
         [Parameter(Mandatory = false)]

Binaries/readme.md

@@ -6,7 +6,7 @@
 namespace SharePointPnP.PowerShell.Commands
 {
     [Cmdlet(VerbsLifecycle.Uninstall, "PnPAppInstance", SupportsShouldProcess = true)]
-    [CmdletAlias("Uinstall-SPOAppInstance")]
+    [CmdletAlias("Uninstall-SPOAppInstance")]
     [CmdletHelp("Removes an app from a site", Category = CmdletHelpCategory.Apps)]
     [CmdletExample(Code = @"PS:> Uninstall-PnPAppInstance -Identity $appinstance", Remarks = "Uninstalls the app instance which was retrieved with the command Get-PnPAppInstance", SortOrder = 1)]
     [CmdletExample(Code = @"PS:> Uninstall-PnPAppInstance -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe", Remarks = "Uninstalls the app instance with the ID '99a00f6e-fb81-4dc7-8eac-e09c6f9132fe'", SortOrder = 2)]

CmdletHelpGenerator/Program.cs

@@ -13,11 +13,11 @@ namespace SharePointPnP.PowerShell.Commands.Base
       Remarks = @"This will execute any queued actions / changes on the SharePoint Client Side Object Model Context and will retry 5 times in case of throttling.", SortOrder = 1)]
     [CmdletExample(
       Code = @"PS:> Execute-PnPQuery -RetryWait 10",
-      Remarks = @"This will execute any queued actions / changes on the SharePoint Client Side Object Model Context and delay the execution with 10 seconds when it needs to retry the execution.", SortOrder = 2)]
+      Remarks = @"This will execute any queued actions / changes on the SharePoint Client Side Object Model Context and delay the execution for 10 seconds before it retries the execution.", SortOrder = 2)]
 
     public class ExecuteSPOQuery : SPOCmdlet
     {
-        [Parameter(Mandatory = false, HelpMessage = "Number to times to retry in case of throttling. Defaults to 10.")]
+        [Parameter(Mandatory = false, HelpMessage = "Number of times to retry in case of throttling. Defaults to 10.")]
         public int RetryCount = 10;
 
         [Parameter(Mandatory = false, HelpMessage = "Delay in seconds. Defaults to 1.")]

Commands/Admin/NewTenantSite.cs

@@ -22,7 +22,7 @@ namespace SharePointPnP.PowerShell.Commands.ContentTypes
         SortOrder = 2)]
     [CmdletExample(
         Code = @"PS:> Get-PnPContentType -Identity ""Project Document""",
-        Remarks = @"This will get a listing of content types within the current context",
+        Remarks = @"This will get the content type with the name ""Project Document"" within the current context",
         SortOrder = 3)]
     [CmdletExample(
         Code = @"PS:> Get-PnPContentType -List ""Documents""",

Commands/Apps/UninstallAppInstance.cs

@@ -8,7 +8,7 @@ namespace SharePointPnP.PowerShell.Commands.ContentTypes
 {
     [Cmdlet(VerbsCommon.Remove, "PnPContentType")]
     [CmdletAlias("Remove-SPOContentType")]
-    [CmdletHelp("Removes a content type", 
+    [CmdletHelp("Removes a content type from a web", 
         Category = CmdletHelpCategory.ContentTypes)]
     [CmdletExample(
         Code = @"PS:> Remove-PnPContentType -Identity ""Project Document""",

Commands/Base/ExecuteQuery.cs

@@ -14,7 +14,7 @@ namespace SharePointPnP.PowerShell.Commands.DocumentSets
         SortOrder = 1)]
     [CmdletExample(
         Code = @"PS:> Remove-PnPContentTypeFromDocumentSet -ContentType 0x0101001F1CEFF1D4126E4CAD10F00B6137E969 -DocumentSet 0x0120D520005DB65D094035A241BAC9AF083F825F3B",
-        Remarks = "This will remove the content type called 'Test CT' from the document set called ''Test Document Set'",
+        Remarks = "This will remove the content type with ID '0x0101001F1CEFF1D4126E4CAD10F00B6137E969' from the document set with ID '0x0120D520005DB65D094035A241BAC9AF083F825F3B'",
         SortOrder = 2)]
     public class RemoveContentTypeFromDocumentSet : SPOWebCmdlet
     {

Commands/ContentTypes/GetContentType.cs

@@ -17,7 +17,7 @@ namespace SharePointPnP.PowerShell.Commands.Events
       Remarks = @"This will return all registered event receivers on the current web", SortOrder = 1)]
     [CmdletExample(
       Code = @"PS:> Get-PnPEventReceiver -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22",
-      Remarks = @"This will return a specific registered event receivers from the current web", SortOrder = 2)]
+      Remarks = @"This will return a specific registered event receiver from the current web", SortOrder = 2)]
     [CmdletExample(
       Code = @"PS:> Get-PnPEventReceiver -List ""ProjectList""",
       Remarks = @"This will return all registered event receivers in the list with the name ProjectList", SortOrder = 3)]
@@ -26,7 +26,7 @@ namespace SharePointPnP.PowerShell.Commands.Events
       Remarks = @"This will return a specific registered event receiver in the list with the name ProjectList", SortOrder = 4)]
     public class GetEventReceiver : SPOWebCmdlet
     {
-        [Parameter(Mandatory = false, ParameterSetName = "List", HelpMessage = "The list object from where to get the event receiver object")]
+        [Parameter(Mandatory = false, ParameterSetName = "List", HelpMessage = "The list object from which to get the event receiver object")]
         public ListPipeBind List;
 
         [Parameter(Mandatory = false, HelpMessage = "The Guid of the event receiver on the list")]

Commands/ContentTypes/RemoveContentType.cs

@@ -12,15 +12,15 @@ namespace SharePointPnP.PowerShell.Commands.Features
     [CmdletHelp("Disables a feature", Category = CmdletHelpCategory.Features)]
     [CmdletExample(
         Code = "PS:> Disable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe",
-        Remarks = @"This will enable the feature with the id ""99a00f6e-fb81-4dc7-8eac-e09c6f9132fe""",          
+        Remarks = @"This will disable the feature with the id ""99a00f6e-fb81-4dc7-8eac-e09c6f9132fe""",          
         SortOrder = 1)]
     [CmdletExample(
         Code = "PS:> Disable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Force", 
-        Remarks = @"This will enable the feature with the id ""99a00f6e-fb81-4dc7-8eac-e09c6f9132fe"" with force.", 
+        Remarks = @"This will disable the feature with the id ""99a00f6e-fb81-4dc7-8eac-e09c6f9132fe"" with force.", 
         SortOrder = 2)]
     [CmdletExample(
         Code = "PS:> Disable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Web", 
-        Remarks = @"This will enable the feature with the id ""99a00f6e-fb81-4dc7-8eac-e09c6f9132fe"" with the web scope.", 
+        Remarks = @"This will disable the feature with the id ""99a00f6e-fb81-4dc7-8eac-e09c6f9132fe"" with the web scope.", 
         SortOrder = 3)]
     public class DisableFeature : SPOWebCmdlet
     {

Commands/DocumentSets/RemoveContentTypeFromDocumentSet.cs

@@ -29,10 +29,10 @@ public class EnableFeature : SPOWebCmdlet
         [Parameter(Mandatory = false, HelpMessage = "Forcibly enable the feature.")]
         public SwitchParameter Force;
 
-        [Parameter(Mandatory = false, HelpMessage = "Specify the scope of the feature to active, either Web or Site. Defaults to Web.")]
+        [Parameter(Mandatory = false, HelpMessage = "Specify the scope of the feature to activate, either Web or Site. Defaults to Web.")]
         public FeatureScope Scope = FeatureScope.Web;
 
-        [Parameter(Mandatory = false, HelpMessage = "Specify this parameter if the feature you're trying to active is part of a sandboxed solution.")]
+        [Parameter(Mandatory = false, HelpMessage = "Specify this parameter if the feature you're trying to activate is part of a sandboxed solution.")]
         public SwitchParameter Sandboxed;
 
 

Commands/Events/GetEventReceiver.cs

@@ -15,10 +15,10 @@ namespace SharePointPnP.PowerShell.Commands.Fields
         OutputTypeLink = "https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.field.aspx")]
     [CmdletExample(
      Code = @"PS:> Add-PnPField -List ""Demo list"" -DisplayName ""Location"" -InternalName ""SPSLocation"" -Type Choice -Group ""Demo Group"" -AddToDefaultView -Choices ""Stockholm"",""Helsinki"",""Oslo""",
-     Remarks = @"This will add field of type Choice to a the list ""Demo List"".", SortOrder = 1)]
+     Remarks = @"This will add a field of type Choice to the list ""Demo List"".", SortOrder = 1)]
     [CmdletExample(
      Code = @"PS:>Add-PnPField -List ""Demo list"" -DisplayName ""Speakers"" -InternalName ""SPSSpeakers"" -Type MultiChoice -Group ""Demo Group"" -AddToDefaultView -Choices ""Obiwan Kenobi"",""Darth Vader"", ""Anakin Skywalker""",
-Remarks = @"This will add field of type Multiple Choice to a the list ""Demo List"". (you can pick several choices for the same item)", SortOrder = 2)]
+Remarks = @"This will add a field of type Multiple Choice to the list ""Demo List"". (you can pick several choices for the same item)", SortOrder = 2)]
     [CmdletAdditionalParameter(ParameterType = typeof(string[]),ParameterName = "Choices", HelpMessage = "Specify choices, only valid if the field type is Choice", ParameterSetName = "ListPara")]
     [CmdletAdditionalParameter(ParameterType = typeof(string[]), ParameterName = "Choices", HelpMessage = "Specify choices, only valid if the field type is Choice", ParameterSetName = "WebPara")]
     public class AddField : SPOWebCmdlet, IDynamicParameters

Commands/Features/DisableFeature.cs

@@ -19,7 +19,7 @@ namespace SharePointPnP.PowerShell.Commands.Fields
     [CmdletExample(
         Code = @"PS:> $xml = '<Field Type=""Text"" Name=""PSCmdletTest"" DisplayName=""PSCmdletTest"" ID=""{27d81055-f208-41c9-a976-61c5473eed4a}"" Group=""Test"" Required=""FALSE"" StaticName=""PSCmdletTest"" />'
 PS:> Add-PnPFieldFromXml -List ""Demo List"" -FieldXml $xml",
-        Remarks = "Adds a field with the specified field CAML code to the site.",
+        Remarks = @"Adds a field with the specified field CAML code to the list ""Demo List"".",
         SortOrder = 2)]
     [CmdletRelatedLink(
         Text = "Field CAML",

Commands/Features/EnableFeature.cs

@@ -53,7 +53,7 @@ public class AddTaxonomyField : SPOWebCmdlet
         [Parameter(Mandatory = false, ParameterSetName = ParameterAttribute.AllParameterSets, HelpMessage = "Switch Parameter if the field is a required field")]
         public SwitchParameter Required;
 
-        [Parameter(Mandatory = false, ParameterSetName = ParameterAttribute.AllParameterSets)]
+        [Parameter(Mandatory = false, ParameterSetName = ParameterAttribute.AllParameterSets, HelpMessage = "Specifies the control settings while adding a field. See https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.addfieldoptions.aspx for details")]
         public AddFieldOptions FieldOptions = AddFieldOptions.DefaultValue;
 
 

Commands/Fields/AddField.cs

@@ -12,11 +12,11 @@ namespace SharePointPnP.PowerShell.Commands.Fields
         Category = CmdletHelpCategory.Fields)]
     [CmdletExample(
         Code = @"PS:> Remove-PnPField -Identity ""Speakers""",
-        Remarks = @"Gets the speakers field from the site columns",
+        Remarks = @"Removes the speakers field from the site columns",
         SortOrder = 1)]
     [CmdletExample(
         Code = @"PS:> Remove-PnPField -List ""Demo list"" -Identity ""Speakers""",
-        Remarks = @"Gets the speakers field from the list Demo list",
+        Remarks = @"Removes the speakers field from the list Demo list",
         SortOrder = 1)]
     public class RemoveField : SPOWebCmdlet
     {

Commands/Fields/AddFieldFromXml.cs

@@ -19,20 +19,32 @@ namespace SharePointPnP.PowerShell.Commands.Files
         SortOrder = 1)]
     [CmdletExample(
         Code = @"PS:> Add-PnPFile -Path .\displaytemplate.html -Folder ""_catalogs/masterpage/display templates/test""", 
-        Remarks = "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.",
+        Remarks = "This will upload the file displaytemplate.html to the test folder in the display templates folder. If the test folder does not exist it will create it.",
         SortOrder = 2)]
     [CmdletExample(
         Code = @"PS:> Add-PnPFile -Path .\sample.doc -Folder ""Shared Documents"" -Values @{Modified=""1/1/2016""}",
         Remarks = "This will upload the file sample.doc to the Shared Documnets folder. After uploading it will set the Modified date to 1/1/2016.",
         SortOrder = 3)]
+    [CmdletExample(
+        Code = @"PS:> Add-PnPFile -FileName sample.doc -Folder ""Shared Documents"" -Stream $fileStream -Values @{Modified=""1/1/2016""}",
+        Remarks = "This will add a file sample.doc with the contents of the stream into the Shared Documents folder. After adding it will set the Modified date to 1/1/2016.",
+        SortOrder = 4)]
+
     public class AddFile : SPOWebCmdlet
     {
-        [Parameter(Mandatory = true, HelpMessage = "The local file path.")]
+
+        [Parameter(Mandatory = true, ParameterSetName = "AsFile", HelpMessage = "The local file path.")]
         public string Path = string.Empty;
 
         [Parameter(Mandatory = true, HelpMessage = "The destination folder in the site")]
         public string Folder = string.Empty;
 
+        [Parameter(Mandatory = true, ParameterSetName = "AsStream", HelpMessage = "Name for file")]
+        public string FileName = string.Empty;
+        [Parameter(Mandatory = true, ParameterSetName = "AsStream", HelpMessage = "Stream with the file contents")]
+        public Stream Stream ;
+
+
         [Parameter(Mandatory = false, HelpMessage = "If versioning is enabled, this will check out the file first if it exists, upload the file, then check it in again.")]
         public SwitchParameter Checkout;
 
@@ -59,16 +71,19 @@ public class AddFile : SPOWebCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            if (!System.IO.Path.IsPathRooted(Path))
-            {
-                Path = System.IO.Path.Combine(SessionState.Path.CurrentFileSystemLocation.Path, Path);
+            if (ParameterSetName == "AsFile") {
+                if (!System.IO.Path.IsPathRooted(Path))
+                {
+                    Path = System.IO.Path.Combine(SessionState.Path.CurrentFileSystemLocation.Path, Path);
+                }
+                FileName = System.IO.Path.GetFileName(Path);
             }
 
             SelectedWeb.EnsureProperty(w => w.ServerRelativeUrl);
 
             var folder = SelectedWeb.EnsureFolder(SelectedWeb.RootFolder, Folder);
 
-            var fileUrl = UrlUtility.Combine(folder.ServerRelativeUrl, System.IO.Path.GetFileName(Path));
+            var fileUrl = UrlUtility.Combine(folder.ServerRelativeUrl, FileName );
 
             // Check if the file exists
             if (Checkout)
@@ -86,10 +101,16 @@ protected override void ExecuteCmdlet()
                 { // Swallow exception, file does not exist 
                 }
             }
+            Microsoft.SharePoint.Client.File file =null ;
+            if (ParameterSetName == "AsFile")
+            {
 
-            var file = folder.UploadFile(new FileInfo(Path).Name, Path, true);
+                file = folder.UploadFile(FileName, Path, true);
+            }
+            else {
+                file = folder.UploadFile(FileName, Stream, true);
+            }
 
-       
             if (Values != null)
             {
                 var item = file.ListItemAllFields;

Commands/Fields/AddTaxonomyField.cs

@@ -11,6 +11,7 @@ namespace SharePointPnP.PowerShell.Commands.Files
         Category = CmdletHelpCategory.Files)]
     [CmdletExample(
         Code = @"PS:> Add-PnPFolder -Name NewFolder -Folder _catalogs/masterpage",
+		Remarks = "This will create the folder NewFolder in the masterpage catalog",
         SortOrder = 1)]
     public class AddFolder : SPOWebCmdlet
     {