Skip to content

-PerformancePlus for New-AzDiskConfig #20937

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.

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 3 commits into from
Feb 17, 2023
Merged

-PerformancePlus for New-AzDiskConfig #20937

merged 3 commits into from
Feb 17, 2023

Conversation

grizzlytheodore
Copy link
Member

@grizzlytheodore grizzlytheodore commented Feb 15, 2023

Description

Checklist

  • SHOULD select appropriate branch. Cmdlets from Autorest.PowerShell should go to generation branch.
  • SHOULD make the title of PR clear and informative, and in the present imperative tense.
  • SHOULD update ChangeLog.md file(s) appropriately
    • For any service, the ChangeLog.md file can be found at src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md
    • A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense. Add changelog in description section if PR goes into generation branch.
    • Should not change ChangeLog.md if no new release is required, such as fixing test case only.
  • SHOULD have approved design review for the changes in this repository (Microsoft internal only) with following situations
    • Create new module from scratch
    • Create new resource types which are not easy to conform to Azure PowerShell Design Guidelines
    • Create new resource type which name doesn't use module name as prefix
    • Have design question before implementation
  • SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
  • SHOULD have proper test coverage for changes in pull request.
  • SHOULD NOT introduce breaking changes in Az minor release except preview version.
  • SHOULD NOT adjust version of module manually in pull request

Mandatory = false,
ValueFromPipelineByPropertyName = true,
HelpMessage = "Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.")]
public bool? PerformancePlus { get; set; }
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'd like suggest to use switch parameter for PerformancePlus in New-Az* command

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, switchParameter would make more sense but all the boolean properties for Disk in this cmdlet New-AzDiskConfig are defined as boolean and not Switch. So I wanted to keep it consistent within this cmdlet.
I think it's better than having one boolean property be switch while ~3 others are all boolean for this cmdlet.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

@BethanyZhou BethanyZhou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suppress false positive for

  D:\a\_work\1\s\artifacts//StaticAnalysisResults\SignatureIssues.csv Errors
  "Module","ClassName","Target","Severity","ProblemId","Description","Remediation"
  "Az.Compute","Microsoft.Azure.Commands.Compute.Automation.NewAzureRmDiskConfigCommand","New-AzDiskConfig","1","8410","Parameter PerformancePlus of cmdlet New-AzDiskConfig does not follow the enforced naming convention of using a singular noun for a parameter name.","Consider using a singular noun for the parameter name."

@grizzlytheodore
Copy link
Member Author

Suppress false positive for

  D:\a\_work\1\s\artifacts//StaticAnalysisResults\SignatureIssues.csv Errors
  "Module","ClassName","Target","Severity","ProblemId","Description","Remediation"
  "Az.Compute","Microsoft.Azure.Commands.Compute.Automation.NewAzureRmDiskConfigCommand","New-AzDiskConfig","1","8410","Parameter PerformancePlus of cmdlet New-AzDiskConfig does not follow the enforced naming convention of using a singular noun for a parameter name.","Consider using a singular noun for the parameter name."

thank you. suppressed

Copy link
Contributor

@BethanyZhou BethanyZhou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me

@BethanyZhou BethanyZhou merged commit 96a3e1d into main Feb 17, 2023
@BethanyZhou BethanyZhou deleted the cplat/performanceplus branch February 17, 2023 00:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants