Skip to content
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

Update documentation for Get-AzApiManagementSubscription cmdlet #18027

Merged
merged 3 commits into from
May 5, 2022
Merged

Update documentation for Get-AzApiManagementSubscription cmdlet #18027

merged 3 commits into from
May 5, 2022

Conversation

scottwtang
Copy link
Contributor

@scottwtang scottwtang commented May 3, 2022

Description

Version 2.0.0 introduced a change to Get-AzApiManagementSubscription to no longer return subscription keys, which is reflected in the the documentation description.

Keys will not be included into result details. To get keys, use Get-AzApiManagementSubscriptionKey.

The documentation examples were not updated with the new behavior.

Removed PrimaryKey and SecondaryKey values from Example 5 and Example 6 to avoid confusion.

Checklist

  • I have read the Submitting Changes section of CONTRIBUTING.md
  • The title of the PR is clear and informative
  • The appropriate ChangeLog.md file(s) has been updated:
    • 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 -- no new version header should be added
  • The PR does not introduce breaking changes
  • If applicable, the changes made in the PR have proper test coverage
  • For public API changes to cmdlets:
    • a cmdlet design review was approved for the changes in this repository (Microsoft internal only)
      • {Please put the link here}
    • the markdown help files have been regenerated using the commands listed here

scottwtang added 2 commits May 3, 2022 12:32
The documentation description states "Keys will not be included into result details. To get keys, use **Get-AzApiManagementSubscriptionKey**."
Removed PrimaryKey and SecondaryKey values from Example 5 and Example 6 to avoid confusion.
@ghost ghost added the customer-reported label May 3, 2022
@ghost
Copy link

ghost commented May 3, 2022

Thank you for your contribution scottwtang! We will review the pull request and get back to you soon.

wyunchi-ms
wyunchi-ms previously approved these changes May 5, 2022
@wyunchi-ms
Copy link
Contributor

/azp run azure-powershell - security-tools

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 1 pipeline(s).

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