Skip to content

Update operation support should be removed from reference doc of creation related cmdlets #899

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

Closed
dingmeng-xue opened this issue Jan 18, 2022 · 2 comments

Comments

@dingmeng-xue
Copy link
Member

Description of creation operation cmdlets comes from the description of PUT operation on Swagger. Since PUT supports resource creation or update both by many services, it leads Azure PowerShell reference doc shows New-Az{Noun} cmdlet supports creation and update operation both.

It is not accurate in many cases especially when service add additional logic on creation or update. We should filter out "update" from reference doc or allow developer to customize reference doc.

@dingmeng-xue dingmeng-xue changed the title Update operation should be removed from reference doc of creation related cmdlets Update operation support should be removed from reference doc of creation related cmdlets Jan 18, 2022
@v-mosh21
Copy link

Hi @dingmeng-xue, thanks for checking this issue. I just want to point out that the Update-AzCloudService document also states it could create or update cloud service, but this cmdlet is used for update purpose not create. Thanks for your help!

Reference doc: https://docs.microsoft.com/en-us/powershell/module/az.cloudservice/update-azcloudservice?view=azps-7.2.0

@BethanyZhou
Copy link
Contributor

Two requested features are supported in autorest.powershell v4

  • Supported customizing description for cmdlet
  • Filtered 'Create(s) or Update(s)' in description and replaced them by actual cmdlet action.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants