Small documentation change to Get-AzLog.md#11068
Conversation
The -CorrelationId parameter is not a required parameter.
|
|
||
| ### -CorrelationId | ||
| Specifies the correlation ID. | ||
| This parameter is required. |
There was a problem hiding this comment.
this parameter seems required
Mandatory = true
There was a problem hiding this comment.
But it is not. Look at the examples.
There was a problem hiding this comment.
Can you point which example indicates "-CorrelationId" is not required?
There was a problem hiding this comment.
Get-AzLog -MaxRecord 100
Get-AzLog -ResourceId $ResourceId -MaxRecord 5
Get-AzLog -DetailedOutput -ResourceId $ResourceId -Caller '*@dnhf.onmicrosoft.com'
All of these works fine.
There was a problem hiding this comment.
cmdlets can have multiple parameter sets,
CorrelationId is required in parameter set "CorrelationIdParameterSetName", other parameter sets could work fine without it.
There was a problem hiding this comment.
Ok, this is the last time I will ever make any contribution to the Azure Powershell module.
I waste my weekend trying to make it better and it is just closed!! No wonder the documentation is so shit.
There was a problem hiding this comment.
Hi @theheatDK ,
this PR is to make change the description of parameter "-CorrelationId" which is incorrect as we discussed.
We appreciate your passion and effort to help make azure-powershell better, however to have an alias for this cmdlet, we need a dedicated issue to track it.
About this help doc, it seems it was not generated properly, thanks for point it out, we'll regenerate doc for monitor in the future releases.
There was a problem hiding this comment.
I wrote this:
The -CorrelationId parameter is not a required parameter.
It is not mentioned anywhere that the module retrieves Activity Log events. It is nice with a bit of context. In the Portal it is called Activity Log and the CLI uses "az monitor activity-log".
I made 3 changes to the text. One regarding the parameter and two to make it clear that this cmdlet is used for Activity logs. I would have assumed that you looked at my changes before dismissing them.
There was a problem hiding this comment.
Reopened PR,
Can you add the "This parameter is required." back, and something more meaningful in the ChangeLog.md? Something like "fix description of cmdlet, thanks.
There was a problem hiding this comment.
Hi @VeryEarly,
I have added the text back and changed the text in the ChangeLog.md.
Regards Peter
|
It's true that the name is inconsistent with CLI and azure portal. |
Added "This parameter is required." again.
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
Small documentation change to Get-AzLog.md
The -CorrelationId parameter is not a required parameter.
It is not mentioned anywhere that the module retrieves Activity Log events. It is nice with a bit of context. In the Portal it is called Activity Log and the CLI uses "az monitor activity-log".
Description
Checklist
CONTRIBUTING.mdChangeLog.mdfile(s) has been updated:ChangeLog.mdfile can be found atsrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md## Upcoming Releaseheader -- no new version header should be added