Fix usability bugs in Get-AzureRmOperationalInsightsSearchResults (#3343)

* Improve Get-AzureRmOperationalInsightsSearchResults cmdlet

1.  Default Top parameter to 10 if it is not present
2.  Introduce 2 parameter sets to make usage and documentation more
clear
3.  Don't emit an error object if there was no error
4.  Improve default formatting of result objects

* Revert nullable Top parameter type change

Author: pilor

src/ResourceManager/OperationalInsights/ChangeLog.md

@@ -18,6 +18,7 @@
         - Additional information about change #1
 -->
 ## Current Release
+* Get-AzureRmOperationalInsightsSearchResults no longer requires the Top parameter to retrieve results
 
 ## Version 2.4.0
 

src/ResourceManager/OperationalInsights/Commands.OperationalInsights.Test/Commands.OperationalInsights.Test.csproj

@@ -222,7 +222,7 @@
     <None Include="SessionRecords\Microsoft.Azure.Commands.OperationalInsights.Test.SearchTests\TestSearchSetAndRemoveSavedSearches.json">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
-    <None Include="SessionRecords\Microsoft.Azure.Commands.OperationalInsights.Test.StorageInsightTests\TestStorageInsightCreateFailsWithoutWorkspace.json">
+    <None Include="SessionRecords\Microsoft.Azure.Commands.OperationalInsights.Test.StorageInsightTests\TestStorageInsightCreateFailsNoWs.json">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
     <None Include="SessionRecords\Microsoft.Azure.Commands.OperationalInsights.Test.StorageInsightTests\TestStorageInsightCreateUpdateDelete.json">
@@ -243,4 +243,4 @@
   </ItemGroup>
   <ItemGroup />
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
-</Project>
+</Project>

src/ResourceManager/OperationalInsights/Commands.OperationalInsights.Test/ScenarioTests/StorageInsightTests.cs

@@ -35,9 +35,9 @@ public void TestStorageInsightCreateUpdateDelete()
 
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
-        public void TestStorageInsightCreateFailsWithoutWorkspace()
+        public void TestStorageInsightCreateFailsNoWs()
         {
-            RunPowerShellTest("Test-StorageInsightCreateFailsWithoutWorkspace");
+            RunPowerShellTest("Test-StorageInsightCreateFailsNoWs");
         }
     }
 }

src/ResourceManager/OperationalInsights/Commands.OperationalInsights.Test/ScenarioTests/StorageInsightTests.ps1

@@ -99,7 +99,7 @@ function Test-StorageInsightCreateUpdateDelete
 .SYNOPSIS
 Validate that storage insight creation fails without a valid parent workspace
 #>
-function Test-StorageInsightCreateFailsWithoutWorkspace
+function Test-StorageInsightCreateFailsNoWs
 {
     $wsname = Get-ResourceName
     $siname = Get-ResourceName

src/ResourceManager/OperationalInsights/Commands.OperationalInsights.Test/SessionRecords/Microsoft.Azure.Commands.OperationalInsights.Test.StorageInsightTests/TestStorageInsightCreateFailsWithoutWorkspace.json renamed to src/ResourceManager/OperationalInsights/Commands.OperationalInsights.Test/SessionRecords/Microsoft.Azure.Commands.OperationalInsights.Test.StorageInsightTests/TestStorageInsightCreateFailsNoWs.json

@@ -362,7 +362,7 @@
     }
   ],
   "Names": {
-    "Test-StorageInsightCreateFailsWithoutWorkspace": [
+    "Test-StorageInsightCreateFailsNoWs": [
       "onesdk4327",
       "onesdk2618",
       "onesdk7042",

src/ResourceManager/OperationalInsights/Commands.OperationalInsights/Client/OperationalInsightsClient.Search.cs

@@ -62,16 +62,18 @@ public virtual PSSearchGetSchemaResponse GetSchema(string resourceGroupName, str
         public virtual PSSearchGetSearchResultsResponse GetSearchResults(string resourceGroupName, string workspaceName, PSSearchGetSearchResultsParameters psParameters)
         {
             SearchGetSearchResultsParameters parameters = new SearchGetSearchResultsParameters();
-            parameters.Top = psParameters.Top;
+            
             if (psParameters.Highlight != null)
             {
                 parameters.Highlight = new Highlight();
                 parameters.Highlight.Pre = psParameters.Highlight.Pre;
                 parameters.Highlight.Post = psParameters.Highlight.Post;
             }
+            
+            parameters.Top = psParameters.Top == 0 ? 10 : psParameters.Top;
             parameters.Query = psParameters.Query;
             parameters.Start = psParameters.Start;
-            parameters.End = psParameters.End;
+            parameters.End = psParameters.End.GetValueOrDefault(DateTime.UtcNow);
 
             SearchGetSearchResultsResponse response = OperationalInsightsManagementClient.Search.GetSearchResults(resourceGroupName, workspaceName, parameters);
             PSSearchGetSearchResultsResponse searchResponse = new PSSearchGetSearchResultsResponse(response);