Update azure_rm_virtualmachine.py

[isopy]

SUMMARY

A lot of Azure images are not cloud-init ready and need to be prepared manually before attempting to use the custom_data option of this module. Adding a line to the description to make others aware. If, like me, they are used to working with AWS AMIs that all seem to have cloud-init baked in, this could prevent some troubleshooting as to why their custom_data scripts aren't running in Azure.

ISSUE TYPE

• Docs Pull Request

COMPONENT NAME

lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py

ANSIBLE VERSION

ansible 2.6.3

ADDITIONAL INFORMATION

N/A

[ansibot]

cc @haroldwongms @nitzmahone @trstringer @xscript @yuwzho @zikalino
click here for bot help

[ansibot]

Hi @isopy,

Thank you for the pullrequest, just so you are aware we have a dedicated Working Group for azure.
You can find other people interested in this in #ansible-azure on Freenode IRC
For more information about communities, meetings and agendas see https://github.com/ansible/community

click here for bot help

[ansibot]

The test ansible-test sanity --test docs-build [explain] failed with 2 errors:

docs/docsite/rst/modules/azure_rm_virtualmachine_module.rst:22:0: warning: Unknown target name: "these steps < https://docs.microsoft.com/en-us/azure/virtual-machines/linux/cloudinit-prepare-custom-image>".
docs/docsite/rst/modules/azure_rm_virtualmachine_module.rst:22:0: warning: Unknown target name: "this list < https://docs.microsoft.com/en-us/azure/virtual-machines/linux/using-cloud-init#cloud-init-overview>".

click here for bot help

[yuwzho]

HI @isopy Thanks for your contribution, your documentation seems contain some syntax error, would you mind fixing this? Please refer this site: https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_documenting.html#formatting-functions to refine your doc

[isopy]

@yuwzho my apologies. first time using this type of syntax and misread the usage of of L(). This latest commit should fix it.

[Fred-sun]

@isopy Thanks for the contribution, Could you help confirm that you have finished change this PR or not? if finish, I will push to review. Thanks!

[isopy]

@Fred-sun Confirming that I’m finished changing this PR.

[yuwzho]

shipit