1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Update azure_rm_devtestlabvirtualmachine relate document (#56828)

* Update azure_rm_devtestlabvirtualmachine documentation
This commit is contained in:
Fred-sun 2019-05-29 12:03:42 -04:00 committed by Alicia Cozine
parent 7864df8cb9
commit 8043940c93
2 changed files with 24 additions and 22 deletions

View file

@ -17,7 +17,7 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_devtestlabvirtualmachine module: azure_rm_devtestlabvirtualmachine
version_added: "2.8" version_added: "2.8"
short_description: Manage Azure DevTest Lab Virtual Machine instance. short_description: Manage Azure DevTest Lab Virtual Machine instance
description: description:
- Create, update and delete instance of Azure DevTest Lab Virtual Machine. - Create, update and delete instance of Azure DevTest Lab Virtual Machine.
@ -45,9 +45,10 @@ options:
- linux - linux
vm_size: vm_size:
description: description:
- A valid Azure VM size value. For example, 'Standard_D4'. The list of choices varies depending on the - A valid Azure VM size value. For example, C(Standard_D4).
subscription and location. Check your subscription for available choices. Required when creating a VM. - The list of choices varies depending on the subscription and location. Check your subscription for available choices.
- "Available values can be found here: U(https://docs.microsoft.com/en-us/azure/virtual-machines/windows/sizes-general)" - Available values can be found on this website, link U(https://docs.microsoft.com/en-us/azure/virtual-machines/windows/sizes-general).
- Required when I(state=present).
user_name: user_name:
description: description:
- The user name of the virtual machine. - The user name of the virtual machine.
@ -59,7 +60,7 @@ options:
- The SSH key of the virtual machine administrator. - The SSH key of the virtual machine administrator.
lab_subnet: lab_subnet:
description: description:
- An existing subnet within lab's virtual network - An existing subnet within lab's virtual network.
- It can be the subnet's resource id. - It can be the subnet's resource id.
- It can be a dict which contains C(virtual_network_name) and C(name). - It can be a dict which contains C(virtual_network_name) and C(name).
disallow_public_ip_address: disallow_public_ip_address:
@ -72,10 +73,10 @@ options:
suboptions: suboptions:
source_name: source_name:
description: description:
- "The artifact's source name." - The artifact's source name.
source_path: source_path:
description: description:
- "The artifact's path in the source repository." - The artifact's path in the source repository.
parameters: parameters:
description: description:
- The parameters of the artifact. - The parameters of the artifact.
@ -120,19 +121,19 @@ options:
- premium - premium
state: state:
description: description:
- Assert the state of the Virtual Machine. - Assert the state of the Virtual Machine.
- Use 'present' to create or update an Virtual Machine and 'absent' to delete it. - Use C(present) to create or update an Virtual Machine and C(absent) to delete it.
default: present default: present
choices: choices:
- absent - absent
- present - present
extends_documentation_fragment: extends_documentation_fragment:
- azure - azure
- azure_tags - azure_tags
author: author:
- "Zim Kalinowski (@zikalino)" - Zim Kalinowski (@zikalino)
''' '''

View file

@ -17,7 +17,7 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_devtestlabvirtualmachine_facts module: azure_rm_devtestlabvirtualmachine_facts
version_added: "2.8" version_added: "2.8"
short_description: Get Azure DevTest Lab Virtual Machine facts. short_description: Get Azure DevTest Lab Virtual Machine facts
description: description:
- Get facts of Azure DevTest Lab Virtual Machine. - Get facts of Azure DevTest Lab Virtual Machine.
@ -41,7 +41,7 @@ extends_documentation_fragment:
- azure - azure
author: author:
- "Zim Kalinowski (@zikalino)" - Zim Kalinowski (@zikalino)
''' '''
@ -55,7 +55,8 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
virtualmachines: virtualmachines:
description: A list of dictionaries containing facts for DevTest Lab Virtual Machine. description:
- A list of dictionaries containing facts for DevTest Lab Virtual Machine.
returned: always returned: always
type: complex type: complex
contains: contains:
@ -110,7 +111,7 @@ virtualmachines:
contains: contains:
offer: offer:
description: description:
- Offer. - The offer of the gallery image.
returned: when created from gallery image returned: when created from gallery image
type: str type: str
sample: UbuntuServer sample: UbuntuServer
@ -122,19 +123,19 @@ virtualmachines:
sample: Linux sample: Linux
sku: sku:
description: description:
- SKU. - The SKU of the gallery image.
returned: when created from gallery image returned: when created from gallery image
type: str type: str
sample: 16.04-LTS sample: 16.04-LTS
publisher: publisher:
description: description:
- Publisher. - The publisher of the gallery image.
returned: when created from gallery image returned: when created from gallery image
type: str type: str
sample: Canonical sample: Canonical
version: version:
description: description:
- Version. - The version of the gallery image.
returned: when created from gallery image returned: when created from gallery image
type: str type: str
sample: latest sample: latest
@ -158,7 +159,7 @@ virtualmachines:
sample: dtl_admin sample: dtl_admin
storage_type: storage_type:
description: description:
- Storage type. - Storage type to use for virtual machine.
returned: always returned: always
type: str type: str
sample: standard sample: standard
@ -194,10 +195,10 @@ virtualmachines:
sample: Succeeded sample: Succeeded
tags: tags:
description: description:
- Tags - The tags of the resource.
returned: always returned: always
type: complex type: complex
sample: { 'foo': 'bar' } sample: "{ 'foo': 'bar' }"
''' '''
from ansible.module_utils.azure_rm_common import AzureRMModuleBase from ansible.module_utils.azure_rm_common import AzureRMModuleBase