Update azure_rm_virtualmachine related document

[Fred-sun]

SUMMARY

Update azure_rm_virtualmachine related document.

ISSUE TYPE

• Docs Pull Request

COMPONENT NAME

azure_rm_virtualmachine/azure_rm_virtualmachine_facts

ADDITIONAL INFORMATION

[ansibot]

cc @cperrin88 @gustavomcarmo @haroldwongms @jeking3 @nitzmahone @trstringer @yungezz @yuwzho @zikalino
click here for bot help

[ansibot]

@Fred-sun, 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

[Fred-sun]

ready_for_review

[acozine]

This module has a lot of parameters, making it tricky to document. This PR is a good start - thanks @Fred-sun. I found some areas for improvement, and would like to review it again before merging.

[Fred-sun]

ready_for_review

[nitzmahone]

couple minor tweaks

[ansibot]

The test ansible-test sanity --test ansible-doc --python 2.6 [explain] failed with the error:

Command "ansible-doc -t module azure_rm_virtualmachine azure_rm_virtualmachine_facts" returned exit status 250.
>>> Standard Error
ERROR! Unexpected Exception, this is probably a bug: sequence item 5: expected string or Unicode, AnsibleMapping found

The test ansible-test sanity --test ansible-doc --python 2.7 [explain] failed with the error:

Command "ansible-doc -t module azure_rm_virtualmachine azure_rm_virtualmachine_facts" returned exit status 250.
>>> Standard Error
ERROR! Unexpected Exception, this is probably a bug: sequence item 5: expected string or Unicode, AnsibleMapping found

The test ansible-test sanity --test ansible-doc --python 3.5 [explain] failed with the error:

Command "ansible-doc -t module azure_rm_virtualmachine azure_rm_virtualmachine_facts" returned exit status 250.
>>> Standard Error
ERROR! Unexpected Exception, this is probably a bug: sequence item 5: expected str instance, AnsibleMapping found

The test ansible-test sanity --test ansible-doc --python 3.6 [explain] failed with the error:

Command "ansible-doc -t module azure_rm_virtualmachine azure_rm_virtualmachine_facts" returned exit status 250.
>>> Standard Error
ERROR! Unexpected Exception, this is probably a bug: sequence item 5: expected str instance, AnsibleMapping found

The test ansible-test sanity --test ansible-doc --python 3.7 [explain] failed with the error:

Command "ansible-doc -t module azure_rm_virtualmachine azure_rm_virtualmachine_facts" returned exit status 250.
>>> Standard Error
ERROR! Unexpected Exception, this is probably a bug: sequence item 5: expected str instance, AnsibleMapping found

The test ansible-test sanity --test ansible-doc --python 3.8 [explain] failed with the error:

Command "ansible-doc -t module azure_rm_virtualmachine azure_rm_virtualmachine_facts" returned exit status 250.
>>> Standard Error
ERROR! Unexpected Exception, this is probably a bug: sequence item 5: expected str instance, AnsibleMapping found

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

docs/docsite/rst/modules/list_of_all_modules.rst:363:0: undefined-label: undefined label: azure_rm_virtualmachine_module (if the link has no caption the label must precede a section header)
docs/docsite/rst/modules/list_of_cloud_modules.rst:374:0: undefined-label: undefined label: azure_rm_virtualmachine_module (if the link has no caption the label must precede a section header)
docs/docsite/rst/porting_guides/porting_guide_2.4.rst:94:0: undefined-label: undefined label: azure_rm_virtualmachine_module (if the link has no caption the label must precede a section header)

The test ansible-test sanity --test pep8 [explain] failed with 4 errors:

lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py:31:161: E501 line too long (178 > 160 characters)
lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py:111:161: E501 line too long (233 > 160 characters)
lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py:116:161: E501 line too long (177 > 160 characters)
lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py:362:161: E501 line too long (196 > 160 characters)

The test ansible-test sanity --test validate-modules [explain] failed with 3 errors:

lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py:0:0: E305 DOCUMENTATION.description.5: expected str @ data['description'][5]. Got {'List of Linux images with cloud-init enabled': 'U(https://docs.microsoft.com/en-us/azure/virtual-machines/linux/using-cloud-init#cloud-init-overview).'}
lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py:0:0: E305 DOCUMENTATION.description.6: expected str @ data['description'][6]. Got {'To enable cloud-init on other Linux images': 'U(https://docs.microsoft.com/en-us/azure/virtual-machines/linux/cloudinit-prepare-custom-image).'}
lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py:0:0: E326 Argument 'remove_on_absent' in argument_spec defines choices as ([]) but documentation defines choices as ([['all'], ['all_autocreated'], ['network_interfaces'], ['virtual_storage'], ['public_ips']])

click here for bot help