Migrate NewRelic to TypeSpec - #29988
Draft
JiaSeng-v wants to merge 3 commits into
Draft
Conversation
Contributor
|
Azure Pipelines: Successfully started running 1 pipeline(s). There may be pipelines that require an authorized user to comment /azp run to run. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR migrates the Az.NewRelic module’s code-generation configuration from the prior AutoRest README-based setup to a TypeSpec-based setup, updating the generated cmdlet help/docs and related metadata to match the new pipeline.
Changes:
- Added TypeSpec emitter configuration for NewRelic (
tspconfig.yaml+tsp-location.yaml) and removed the old AutoRest configuration block fromREADME.md. - Regenerated help/reference docs and UX metadata to reflect updated descriptions/parameter sets (including JSON-based update variants).
- Updated module packaging metadata (manifest, solution project GUID) and introduced a custom wrapper for
Get-AzNewRelicConnectedPartnerResource.
Reviewed changes
Copilot reviewed 69 out of 69 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| src/NewRelic/NewRelic/help/Update-AzNewRelicMonitorTagRule.md | Regenerated cmdlet help text and parameter descriptions. |
| src/NewRelic/NewRelic/help/Update-AzNewRelicMonitorIngestionKey.md | Regenerated cmdlet help text/parameter details. |
| src/NewRelic/NewRelic/help/Update-AzNewRelicMonitoredSubscription.md | Updated parameter sets (JSON input variants) and regenerated examples/help. |
| src/NewRelic/NewRelic/help/Switch-AzNewRelicMonitorBilling.md | Regenerated cmdlet help text and parameter descriptions. |
| src/NewRelic/NewRelic/help/Remove-AzNewRelicMonitorTagRule.md | Regenerated cmdlet help text/parameter details. |
| src/NewRelic/NewRelic/help/Remove-AzNewRelicMonitoredSubscription.md | Regenerated cmdlet help text/parameter details. |
| src/NewRelic/NewRelic/help/Remove-AzNewRelicMonitor.md | Regenerated cmdlet help text/parameter details. |
| src/NewRelic/NewRelic/help/New-AzNewRelicMonitorTagRule.md | Regenerated cmdlet help text/parameter details. |
| src/NewRelic/NewRelic/help/New-AzNewRelicMonitoredSubscriptionObject.md | Updated model-cmdlet help messages/descriptions. |
| src/NewRelic/NewRelic/help/New-AzNewRelicMonitoredSubscription.md | Regenerated cmdlet help text/parameter details. |
| src/NewRelic/NewRelic/help/Invoke-AzNewRelicResubscribeMonitor.md | Regenerated help and renamed parameter (SubscriptionId1 → NewSubscriptionId). |
| src/NewRelic/NewRelic/help/Invoke-AzNewRelicLinkMonitorSaaS.md | Regenerated cmdlet help text/parameter details. |
| src/NewRelic/NewRelic/help/Invoke-AzNewRelicLatestMonitorLinkedSaaS.md | Regenerated cmdlet help text/parameter details. |
| src/NewRelic/NewRelic/help/Invoke-AzNewRelicHostMonitor.md | Regenerated cmdlet help text/parameter details. |
| src/NewRelic/NewRelic/help/Initialize-AzNewRelicSaaSResource.md | Regenerated cmdlet help text/parameter details. |
| src/NewRelic/NewRelic/help/Get-AzNewRelicPlan.md | Regenerated cmdlet help text/parameter details. |
| src/NewRelic/NewRelic/help/Get-AzNewRelicOrganization.md | Regenerated cmdlet help text/parameter details. |
| src/NewRelic/NewRelic/help/Get-AzNewRelicMonitorTagRule.md | Regenerated cmdlet help text/parameter details. |
| src/NewRelic/NewRelic/help/Get-AzNewRelicMonitorMonitoredResource.md | Regenerated cmdlet help text/parameter details. |
| src/NewRelic/NewRelic/help/Get-AzNewRelicMonitorMetricStatus.md | Regenerated cmdlet help text/parameter details. |
| src/NewRelic/NewRelic/help/Get-AzNewRelicMonitorMetricRule.md | Regenerated cmdlet help text/parameter details. |
| src/NewRelic/NewRelic/help/Get-AzNewRelicMonitoredSubscription.md | Regenerated cmdlet help text/parameter details. |
| src/NewRelic/NewRelic/help/Get-AzNewRelicMonitoredHost.md | Regenerated cmdlet help text/parameter details. |
| src/NewRelic/NewRelic/help/Get-AzNewRelicMonitoredAppService.md | Regenerated cmdlet help text/parameter details. |
| src/NewRelic/NewRelic/help/Get-AzNewRelicConnectedPartnerResource.md | Regenerated help; synopsis/description/parameter text impacted by migration. |
| src/NewRelic/NewRelic/help/Get-AzNewRelicBillingInfo.md | Regenerated help with updated synopsis/description. |
| src/NewRelic/NewRelic/help/Get-AzNewRelicAccount.md | Regenerated cmdlet help text/parameter details. |
| src/NewRelic/NewRelic/help/Az.NewRelic.md | Regenerated module help index descriptions. |
| src/NewRelic/NewRelic/ChangeLog.md | Added an “Upcoming Release” entry for the generation migration. |
| src/NewRelic/NewRelic/Az.NewRelic.psd1 | Updated generation date and minimum required Az.Accounts version; minor manifest formatting. |
| src/NewRelic/NewRelic.sln | Updated project GUID mapping for the generated Az.NewRelic project. |
| src/NewRelic/NewRelic.Autorest/UX/NewRelic.Observability/monitors.json | Updated command descriptions/examples used for UX/help generation. |
| src/NewRelic/NewRelic.Autorest/UX/NewRelic.Observability/monitors-monitoredSubscriptions.json | Updated command descriptions/examples used for UX/help generation. |
| src/NewRelic/NewRelic.Autorest/tspconfig.yaml | Added TypeSpec PowerShell emitter configuration and directives for cmdlet shaping. |
| src/NewRelic/NewRelic.Autorest/tsp-location.yaml | Added TypeSpec source location (repo/commit/directory) for reproducible generation. |
| src/NewRelic/NewRelic.Autorest/README.md | Removed the old AutoRest YAML configuration section (now using TypeSpec config). |
| src/NewRelic/NewRelic.Autorest/Properties/AssemblyInfo.cs | Updated assembly metadata; header/license block changed. |
| src/NewRelic/NewRelic.Autorest/generate-info.json | Updated generation identifier. |
| src/NewRelic/NewRelic.Autorest/examples/Update-AzNewRelicMonitoredSubscription.md | Regenerated example content for Update cmdlet. |
| src/NewRelic/NewRelic.Autorest/docs/Update-AzNewRelicMonitorTagRule.md | Regenerated reference docs content. |
| src/NewRelic/NewRelic.Autorest/docs/Update-AzNewRelicMonitorIngestionKey.md | Regenerated reference docs content. |
| src/NewRelic/NewRelic.Autorest/docs/Update-AzNewRelicMonitoredSubscription.md | Regenerated reference docs with JSON variants and examples. |
| src/NewRelic/NewRelic.Autorest/docs/Switch-AzNewRelicMonitorBilling.md | Regenerated reference docs content. |
| src/NewRelic/NewRelic.Autorest/docs/Remove-AzNewRelicMonitorTagRule.md | Regenerated reference docs content. |
| src/NewRelic/NewRelic.Autorest/docs/Remove-AzNewRelicMonitoredSubscription.md | Regenerated reference docs content. |
| src/NewRelic/NewRelic.Autorest/docs/Remove-AzNewRelicMonitor.md | Regenerated reference docs content. |
| src/NewRelic/NewRelic.Autorest/docs/New-AzNewRelicMonitorTagRule.md | Regenerated reference docs content. |
| src/NewRelic/NewRelic.Autorest/docs/New-AzNewRelicMonitoredSubscriptionObject.md | Regenerated reference docs content. |
| src/NewRelic/NewRelic.Autorest/docs/New-AzNewRelicMonitoredSubscription.md | Regenerated reference docs content. |
| src/NewRelic/NewRelic.Autorest/docs/Invoke-AzNewRelicResubscribeMonitor.md | Regenerated reference docs; parameter rename reflected. |
| src/NewRelic/NewRelic.Autorest/docs/Invoke-AzNewRelicLinkMonitorSaaS.md | Regenerated reference docs content. |
| src/NewRelic/NewRelic.Autorest/docs/Invoke-AzNewRelicLatestMonitorLinkedSaaS.md | Regenerated reference docs content. |
| src/NewRelic/NewRelic.Autorest/docs/Invoke-AzNewRelicHostMonitor.md | Regenerated reference docs content. |
| src/NewRelic/NewRelic.Autorest/docs/Initialize-AzNewRelicSaaSResource.md | Regenerated reference docs content. |
| src/NewRelic/NewRelic.Autorest/docs/Get-AzNewRelicPlan.md | Regenerated reference docs content. |
| src/NewRelic/NewRelic.Autorest/docs/Get-AzNewRelicOrganization.md | Regenerated reference docs content. |
| src/NewRelic/NewRelic.Autorest/docs/Get-AzNewRelicMonitorTagRule.md | Regenerated reference docs content. |
| src/NewRelic/NewRelic.Autorest/docs/Get-AzNewRelicMonitorMonitoredResource.md | Regenerated reference docs content. |
| src/NewRelic/NewRelic.Autorest/docs/Get-AzNewRelicMonitorMetricStatus.md | Regenerated reference docs content. |
| src/NewRelic/NewRelic.Autorest/docs/Get-AzNewRelicMonitorMetricRule.md | Regenerated reference docs content. |
| src/NewRelic/NewRelic.Autorest/docs/Get-AzNewRelicMonitoredSubscription.md | Regenerated reference docs content. |
| src/NewRelic/NewRelic.Autorest/docs/Get-AzNewRelicMonitoredHost.md | Regenerated reference docs content. |
| src/NewRelic/NewRelic.Autorest/docs/Get-AzNewRelicMonitoredAppService.md | Regenerated reference docs content. |
| src/NewRelic/NewRelic.Autorest/docs/Get-AzNewRelicConnectedPartnerResource.md | Regenerated reference docs; synopsis/parameter text impacted by migration. |
| src/NewRelic/NewRelic.Autorest/docs/Get-AzNewRelicBillingInfo.md | Regenerated reference docs content. |
| src/NewRelic/NewRelic.Autorest/docs/Get-AzNewRelicAccount.md | Regenerated reference docs content. |
| src/NewRelic/NewRelic.Autorest/docs/Az.NewRelic.md | Regenerated module docs index (GUID + cmdlet descriptions). |
| src/NewRelic/NewRelic.Autorest/custom/Get-AzNewRelicConnectedPartnerResource.ps1 | Added a custom wrapper cmdlet that calls the internal implementation with an empty JSON body. |
| src/NewRelic/NewRelic.Autorest/custom/autogen-model-cmdlets/New-AzNewRelicMonitoredSubscriptionObject.ps1 | Updated help message for -MetricRuleUserEmail. |
Suppressed comments (5)
src/NewRelic/NewRelic/help/Get-AzNewRelicConnectedPartnerResource.md:21
- The cmdlet description section is empty; please restore a meaningful description so users understand what this cmdlet does.
src/NewRelic/NewRelic/help/Get-AzNewRelicConnectedPartnerResource.md:55 - Parameter documentation for -MonitorName is currently blank. Please add a description to match other NewRelic cmdlets.
src/NewRelic/NewRelic/help/Get-AzNewRelicConnectedPartnerResource.md:69 - Parameter documentation for -ResourceGroupName is currently blank. Please add a description so the help matches the rest of the module.
src/NewRelic/NewRelic/help/Get-AzNewRelicConnectedPartnerResource.md:83 - Parameter documentation for -SubscriptionId is currently blank. Please add a description to avoid publishing incomplete help.
src/NewRelic/NewRelic/help/Get-AzNewRelicBillingInfo.md:28 - The description "A synchronous resource action." is too generic for user-facing help. Consider restoring the previous description so the help content explains the cmdlet's purpose.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| ## SYNOPSIS | ||
| List of all active deployments that are associated with the marketplace subscription linked to the given monitor. | ||
|
|
Comment on lines
39
to
41
| ### -DefaultProfile | ||
| The DefaultProfile parameter is not functional. | ||
| Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. | ||
|
|
||
| ```yaml |
Comment on lines
48
to
+52
| ## EXAMPLES | ||
|
|
||
| ### Example 1: Update the subscriptions that are being monitored by the NewRelic monitor resource | ||
| ### Example 1: {{ Add title here }} | ||
| ```powershell | ||
| {{ Add code here }} |
Comment on lines
+1
to
4
| ### Example 1: {{ Add title here }} | ||
| ```powershell | ||
| $includeFT = New-AzNewRelicFilteringTagObject -Action Include -Name testLogRule1 -Value filteringTag1 | ||
| $sub1 = New-AzNewRelicMonitoredSubscriptionObject -LogRuleFilteringTag $includeFT -LogRuleSendAadLog Enabled -LogRuleSendActivityLog Enabled -LogRuleSendSubscriptionLog Enabled -MetricRuleFilteringTag $includeFT -MetricRuleUserEmail user1@outlook.com -Status Active -SubscriptionId 11111111-2222-3333-4444-12345678910122 | ||
| Update-AzNewRelicMonitoredSubscription -MonitorName test-01 -ResourceGroupName group-test -PatchOperation AddComplete -MonitoredSubscriptionList $sub1 | ||
| {{ Add code here }} | ||
| ``` |
|
|
||
| ### [Get-AzNewRelicConnectedPartnerResource](Get-AzNewRelicConnectedPartnerResource.md) | ||
| List of all active deployments that are associated with the marketplace subscription linked to the given monitor. | ||
|
|
|
|
||
| ## SYNOPSIS | ||
| Retrieves marketplace and organization information mapped to the given New Relic monitor resource | ||
| A synchronous resource action. |
| - Additional information about change #1 | ||
| --> | ||
| ## Upcoming Release | ||
| * Internal code generation updated. No user-facing changes in this release. |
Comment on lines
1
to
5
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. See License.txt in the project root for license information. | ||
| // Changes may cause incorrect behavior and will be lost if the code is regenerated. | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the Apache License, Version 2.0 (the ""License""); |
Comment on lines
+17
to
+22
| directive: | ||
| - where: | ||
| subject: Operation | ||
| hide: true | ||
| - where: | ||
| parameter-name: SubscriptionId |
Member
|
/azp run |
Contributor
|
Azure Pipelines: Successfully started running 3 pipeline(s). |
Member
|
/azp run |
Contributor
|
Azure Pipelines: Successfully started running 3 pipeline(s). |
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 69 out of 69 changed files in this pull request and generated no new comments.
Suppressed comments (12)
src/NewRelic/NewRelic.Autorest/examples/Update-AzNewRelicMonitoredSubscription.md:5
- This examples file contains only template placeholders and should not be checked in as-is; it will render as broken documentation. Please replace with at least one real example (the previous example can be reused) or remove the placeholders.
src/NewRelic/NewRelic/help/Get-AzNewRelicBillingInfo.md:12 - The cmdlet synopsis/description was replaced with the generic text "A synchronous resource action.", which is not meaningful for users browsing reference help. Please restore a descriptive synopsis/description that explains what billing info is returned and for which resource.
src/NewRelic/NewRelic/help/Get-AzNewRelicConnectedPartnerResource.md:42 - The DefaultProfile parameter section lost its description and is now blank, unlike other cmdlets in this module. Please restore a short description so the rendered help is complete.
src/NewRelic/NewRelic/help/Get-AzNewRelicConnectedPartnerResource.md:70 - The ResourceGroupName parameter section is missing its description (blank). Please restore the standard resource group description used elsewhere in this module.
src/NewRelic/NewRelic/help/Get-AzNewRelicConnectedPartnerResource.md:84 - The SubscriptionId parameter section is missing its description (blank). Please restore the standard subscription ID description to keep the help complete.
src/NewRelic/NewRelic.Autorest/Properties/AssemblyInfo.cs:5 - The file header now includes both an MIT license line and an Apache 2.0 license header, and duplicates the copyright line. This is internally inconsistent and can cause compliance confusion; other *.Autorest AssemblyInfo.cs files use only the Apache 2.0 header.
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
// Changes may cause incorrect behavior and will be lost if the code is regenerated.
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the Apache License, Version 2.0 (the ""License"");
src/NewRelic/NewRelic.Autorest/tspconfig.yaml:21
- tspconfig.yaml introduces many TypeSpec emitter directives, but none of them are commented. In this repo, directives are expected to be documented with comments explaining the "why" so future maintainers can safely update/regenerate.
src/NewRelic/NewRelic/help/Update-AzNewRelicMonitoredSubscription.md:52 - The EXAMPLES section still contains template placeholders ("{{ Add title here }}", "{{ Add code here }}"), which will ship as broken reference help. Either restore a real example (previous content existed) or remove the placeholder blocks.
src/NewRelic/NewRelic/help/Update-AzNewRelicMonitoredSubscription.md:12 - The SYNOPSIS/DESCRIPTION were reduced to type names ("Update a MonitoredSubscriptionProperties"), which is not user-focused and reads like a code artifact. Please restore a descriptive synopsis/description of what the cmdlet does.
src/NewRelic/NewRelic/help/Invoke-AzNewRelicResubscribeMonitor.md:12 - The synopsis/description is currently the generic placeholder "A long-running resource action." which doesn't describe the operation. Please update it to describe resubscribing the New Relic organization/monitor to Azure Marketplace billing.
src/NewRelic/NewRelic/help/Get-AzNewRelicConnectedPartnerResource.md:56 - The MonitorName parameter section is missing its description (blank). This makes the generated help harder to understand and is inconsistent with other NewRelic cmdlets.
This issue also appears in the following locations of the same file:
- line 69
- line 83
src/NewRelic/NewRelic/ChangeLog.md:22
- The changelog claims "No user-facing changes", but this PR updates public-facing reference help (synopsis/examples) and changes module import requirements (Az.Accounts minimum version). Please update the Upcoming Release entry to reflect the user-visible impact (and mention any breaking parameter renames such as SubscriptionId1 -> NewSubscriptionId if applicable).
Member
|
/azp run |
Contributor
|
Azure Pipelines: Successfully started running 3 pipeline(s). |
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 70 out of 70 changed files in this pull request and generated no new comments.
Suppressed comments (20)
src/NewRelic/NewRelic/help/Update-AzNewRelicMonitoredSubscription.md:54
- The Update-AzNewRelicMonitoredSubscription examples were replaced with placeholders ("{{ Add title here }}", "{{ Add code here }}"), which leaves the published cmdlet help unusable and is explicitly called out by static analysis (MissingExampleTitle/Code/Description). Please restore at least one real example (title, code, and description) instead of shipping placeholders.
src/NewRelic/NewRelic.Autorest/examples/Update-AzNewRelicMonitoredSubscription.md:4 - The examples markdown for Update-AzNewRelicMonitoredSubscription was replaced with placeholders. This file is used as the source for generated reference examples, so placeholders will leak into published docs unless replaced with a real scenario.
src/NewRelic/NewRelic/help/Get-AzNewRelicConnectedPartnerResource.md:42 - Parameter help text for -DefaultProfile was removed, leaving the section empty. Please restore a short description so the generated reference docs are not missing parameter documentation.
src/NewRelic/NewRelic/help/Get-AzNewRelicConnectedPartnerResource.md:70 - Parameter help text for -ResourceGroupName is currently empty. Please restore a short description so the help file isn't missing documentation.
src/NewRelic/NewRelic/help/Get-AzNewRelicConnectedPartnerResource.md:84 - Parameter help text for -SubscriptionId is currently empty. Restoring a short description prevents the generated docs from having a blank parameter section.
src/NewRelic/NewRelic.Autorest/docs/Get-AzNewRelicConnectedPartnerResource.md:57 - The -MonitorName parameter section is missing its description (blank line under the header). Restoring a short description improves readability of the generated docs.
### -MonitorName
src/NewRelic/NewRelic.Autorest/docs/Get-AzNewRelicConnectedPartnerResource.md:72
- The -ResourceGroupName parameter section is missing its description (blank line under the header). Please restore the description so the reference doc isn't empty here.
### -ResourceGroupName
src/NewRelic/NewRelic.Autorest/docs/Get-AzNewRelicConnectedPartnerResource.md:87
- The -SubscriptionId parameter section is missing its description (blank line under the header). Restoring a short description prevents publishing an empty parameter section.
### -SubscriptionId
src/NewRelic/NewRelic/help/Get-AzNewRelicBillingInfo.md:12
- The cmdlet synopsis was changed to the generic text "A synchronous resource action.", which is much less informative than the previous description and doesn't help users understand what the cmdlet returns.
src/NewRelic/NewRelic.Autorest/UX/NewRelic.Observability/monitors.json:30 - The example description in the UX file is also set to the generic placeholder text. This text is surfaced to users in generated examples and should describe the scenario instead.
"examples": [
{
"description": "A synchronous resource action.",
"parameters": [
{
src/NewRelic/NewRelic.Autorest/UX/NewRelic.Observability/monitors-monitoredSubscriptions.json:29
- The example description is also using the internal model name ("Get a MonitoredSubscriptionProperties"). This text is shown in generated examples and should describe what the example does.
"examples": [
{
"description": "Get a MonitoredSubscriptionProperties",
"parameters": [
src/NewRelic/NewRelic/ChangeLog.md:22
- The upcoming release entry says "No user-facing changes", but this PR changes the published help content and updates the Az.Accounts minimum dependency in the module manifest. The changelog entry should reflect the user-impact (at minimum, the new Az.Accounts requirement).
src/NewRelic/NewRelic.Autorest/docs/Update-AzNewRelicMonitoredSubscription.md:52 - The Update-AzNewRelicMonitoredSubscription reference docs still contain placeholder examples ("{{ Add title here }}" / "{{ Add code here }}"). This results in incomplete help content and is the underlying reason Example static analysis is being suppressed via ExampleIssues.csv.
tools/StaticAnalysis/Exceptions/Az.NewRelic/ExampleIssues.csv:13 - This exception list suppresses MissingExampleTitle/Code/Description findings for Update-AzNewRelicMonitoredSubscription, but the underlying issue is that the examples currently contain placeholders. Once the examples are restored, these suppressions should be removed so static analysis can enforce real documentation quality.
src/NewRelic/NewRelic/help/Get-AzNewRelicConnectedPartnerResource.md:56 - Parameter help text for -MonitorName is currently empty. Adding back a brief description improves the usability of the reference docs.
This issue also appears in the following locations of the same file:
- line 69
- line 83
src/NewRelic/NewRelic.Autorest/docs/Get-AzNewRelicConnectedPartnerResource.md:42
- In the AutoRest-generated reference doc, the parameter descriptions for Get-AzNewRelicConnectedPartnerResource were removed and left blank. This makes the docs incomplete; please restore brief descriptions for the parameters.
This issue also appears in the following locations of the same file:
- line 55
- line 70
- line 85
### -DefaultProfile
src/NewRelic/NewRelic/help/Get-AzNewRelicBillingInfo.md:28
- The cmdlet description was changed to the generic text "A synchronous resource action.", which removes the user-facing explanation of the command.
src/NewRelic/NewRelic.Autorest/UX/NewRelic.Observability/monitors.json:10 - The UX metadata for Get-AzNewRelicBillingInfo now uses the generic description "A synchronous resource action.", which degrades the generated help/UX content. Prefer a user-facing description of what the cmdlet does.
This issue also appears on line 26 of the same file.
{
"name": "Get-AzNewRelicBillingInfo",
"description": "A synchronous resource action.",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/getBillingInfo",
"help": {
src/NewRelic/NewRelic.Autorest/UX/NewRelic.Observability/monitors-monitoredSubscriptions.json:10
- The UX description for Get-AzNewRelicMonitoredSubscription was replaced with the internal model name ("Get a MonitoredSubscriptionProperties"), which is not user-focused and reads like a generated placeholder. Prefer the prior behavior-based description so generated help remains clear.
This issue also appears on line 26 of the same file.
{
"name": "Get-AzNewRelicMonitoredSubscription",
"description": "Get a MonitoredSubscriptionProperties",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/monitoredSubscriptions/{configurationName}",
"help": {
src/NewRelic/NewRelic.Autorest/custom/autogen-model-cmdlets/New-AzNewRelicMonitoredSubscriptionObject.ps1:60
- The MetricRuleUserEmail help message was changed to "Reusable representation of an email address.", which is generic and doesn’t tell users what the value is used for in this model. A concise user-facing description (e.g., "User email address.") is clearer in Get-Help output.
[Parameter(HelpMessage="Reusable representation of an email address.")]
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Mandatory Checklist
Please choose the target release of Azure PowerShell. (⚠️ Target release is a different concept from API readiness. Please click below links for details.)
Check this box to confirm: I have read the Submitting Changes section of
CONTRIBUTING.mdand reviewed the following information:ChangeLog.mdfile(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.## Upcoming Releaseheader in the past tense.ChangeLog.mdif no new release is required, such as fixing test case only.