Skip to content

Update SetAzureRmDiagnosticSettingCommand.cs to better describe workspaceid parameter #3321

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 21, 2016
Merged

Update SetAzureRmDiagnosticSettingCommand.cs to better describe workspaceid parameter #3321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dbff226
Update SetAzureRmDiagnosticSettingCommand.cs
Dec 20, 2016
3a7e2fd
Update Microsoft.Azure.Commands.Insights.dll-Help.xml
Dec 20, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...ourceManager/Insights/Commands.Insights/Diagnostics/SetAzureRmDiagnosticSettingCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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; }

Expand Down
26 changes: 23 additions & 3 deletions ...ResourceManager/Insights/Commands.Insights/Microsoft.Azure.Commands.Insights.dll-Help.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7047,7 +7047,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>
</command:parameter>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand All @@ -7331,4 +7351,4 @@ $rule2 = New-AzureRmAutoscaleRule -MetricName Requests -MetricResourceId &quot;/
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
</helpItems>
</helpItems>