Merge pull request Azure#3321 from Azure/richrundmsft-patch-1

Update SetAzureRmDiagnosticSettingCommand.cs to better describe workspaceid parameter

Author: cormacpayne

src/ResourceManager/Insights/Commands.Insights/Diagnostics/SetAzureRmDiagnosticSettingCommand.cs

@@ -85,7 +85,7 @@ public class SetAzureRmDiagnosticSettingCommand : ManagementCmdletBase
         /// <summary>
         /// Gets or sets the OMS workspace Id
         /// </summary>
-        [Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = "The OMS workspace Id")]
+        [Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = "The resource Id of the Log Analytics workspace to send logs/metrics to")]
         [ValidateNotNullOrEmpty]
         public string WorkspaceId { get; set; }
 

src/ResourceManager/Insights/Commands.Insights/Microsoft.Azure.Commands.Insights.dll-Help.xml

@@ -7047,7 +7047,7 @@ $rule2 = New-AzureRmAutoscaleRule -MetricName Requests -MetricResourceId "/
 			<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
 				<maml:name>WorkspaceId</maml:name>
 				<maml:description>
-					<maml:para>The Id of the workspace</maml:para>
+					<maml:para>The resource Id of the Log Analytics workspace to send logs/metrics to.</maml:para>
 				</maml:description>
 				<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
 			</command:parameter>
@@ -7162,7 +7162,7 @@ $rule2 = New-AzureRmAutoscaleRule -MetricName Requests -MetricResourceId &quot;/
 		<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
 			<maml:name>WorkspaceId</maml:name>
 			<maml:description>
-				<maml:para>The Id of the workspace</maml:para>
+				<maml:para>The resource Id of the Log Analytics workspace to send logs/metrics to.</maml:para>
 			</maml:description>
 			<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
 			<dev:type>
@@ -7323,6 +7323,26 @@ $rule2 = New-AzureRmAutoscaleRule -MetricName Requests -MetricResourceId &quot;/
 				</command:commandLine>
 			</command:commandLines>
 		</command:example>
+		<command:example>
+			<maml:title>--------------------------  Enabling logs and metrics to go to a Log Analytics workspace  --------------------------</maml:title>
+			<maml:introduction>
+				<maml:paragraph>PS C:\&gt;</maml:paragraph>
+			</maml:introduction>
+			<dev:code>Set-AzureRmDiagnosticSetting -ResourceId &lt;resourceId&gt; --WorkspaceId $workspaceResourceId -Enable $true</dev:code>
+			<dev:remarks>
+				<maml:para>This will enable all logs and metrics for the resource to be sent to a Log Analytics workspace. You can get the resource Id for a workspace using (Get-AzureRmOperationalInsightsWorkspace).ResourceId .</maml:para>
+				<maml:para />
+				<maml:para />
+				<maml:para></maml:para>
+			</dev:remarks>
+			<command:commandLines>
+				<command:commandLine>
+					<command:commandText>
+						<maml:para />
+					</command:commandText>
+				</command:commandLine>
+			</command:commandLines>
+		</command:example>
 	</command:examples>
 	<maml:relatedLinks>
 		<maml:navigationLink>
@@ -7331,4 +7351,4 @@ $rule2 = New-AzureRmAutoscaleRule -MetricName Requests -MetricResourceId &quot;/
 		</maml:navigationLink>
 	</maml:relatedLinks>
 </command:command>
-</helpItems>
+</helpItems>