Event Hubs PowerShell: Generating Markdown files

[sethmanheim]

Description

---

This checklist is used to make sure that common guidelines for a pull request are followed. You can find a more complete discussion of PowerShell cmdlet best practices here.

• I have read the contribution guidelines.
• If changes were made to any cmdlet, the XML help was regenerated using the platyPSHelp module.
• If any large changes are made to a service, they are reflected in the respective change log.

General Guidelines

• Title of the pull request is clear and informative.
• There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.
• The pull request does not introduce breaking changes (unless a major version change occurs in the assembly and module).

Testing Guidelines

• Pull request includes test coverage for the included changes.
• PowerShell scripts used in tests should do any necessary setup as part of the test or suite setup, and should not use hard-coded values for locations or existing resources.

Cmdlet Signature Guidelines

• New cmdlets that make changes or have side effects should implement ShouldProcess and have SupportShouldProcess=true specified in the cmdlet attribute. You can find more information on ShouldProcess here.
• Cmdlet specifies OutputType attribute if any output is produced - if the cmdlet produces no output, it should implement a PassThru parameter.

Cmdlet Parameter Guidelines

• Parameter types should not expose types from the management library - complex parameter types should be defined in the module.
• Complex parameter types are discouraged - a parameter type should be simple types as often as possible. If complex types are used, they should be shallow and easily creatable from a constructor or another cmdlet.
• Cmdlet parameter sets should be mutually exclusive - each parameter set must have at least one mandatory parameter not in other parameter sets.

[azurecla]

Hi @sethmanheim, I'm your friendly neighborhood Azure Pull Request Bot (You can call me AZPRBOT). Thanks for your contribution!

It looks like you're working at Microsoft (sethm). If you're full-time, we DON'T require a contribution license agreement.

If you are a vendor, DO please sign the electronic contribution license agreement. It will take 2 minutes and there's no faxing! https://cla.azure.com.

TTYL, AZPRBOT;

[sethmanheim]

Please don't merge yet; adding content to the Markdowns.

[sethmanheim]

Content added to markdowns, please review.

cc @jtaubensee @v-Ajnava @zeeshansayyed

[cormacpayne]

@sethmanheim Hey Seth, it looks like BreakingChangeIssues.csv got included in your pull request somehow. Would you mind pulling the latest from dev and see if that gets rid of it?

[sethmanheim]

@cormacpayne File removed -- looks good now, OK to merge.

[cormacpayne]

LGTM

@sethmanheim thanks Seth!

[Pacort]

@sethmanheim @cormacpayne This change is breaking our build, error message from App Veyor: {"message":"Not Found","documentation_url":"https://developer.github.com/v3"} I believe there needs to be a "message", could you please fix it? Otherwise I might need to revert the commit in our PS documentation repo. Related question: Seth, did you on-boarded by yourself Evenhub or did Tara helped you? Thanks

[sethmanheim]

@Pacort Yes I worked with Tara on this. I don't know how to fix the error -- sorry. Can you help?

[Pacort]

@sethmanheim Sorry, I meant a URL needs to be corrected. Thanks.

[Pacort]

Oh, I see. Ok. I will try to fix it. Looks like this URL https://developer.github.com/v3 is causing issues for some reason. I will try and if not I will escalate to VSC. Thanks!