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
Alicia Cozine
parent
7864df8cb9
commit
8043940c93
2 changed files with 24 additions and 22 deletions
|
|
@ -17,7 +17,7 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: azure_rm_devtestlabvirtualmachine
|
||||
version_added: "2.8"
|
||||
short_description: Manage Azure DevTest Lab Virtual Machine instance.
|
||||
short_description: Manage Azure DevTest Lab Virtual Machine instance
|
||||
description:
|
||||
- Create, update and delete instance of Azure DevTest Lab Virtual Machine.
|
||||
|
||||
|
|
@ -45,9 +45,10 @@ options:
|
|||
- linux
|
||||
vm_size:
|
||||
description:
|
||||
- A valid Azure VM size value. For example, 'Standard_D4'. The list of choices varies depending on the
|
||||
subscription and location. Check your subscription for available choices. Required when creating a VM.
|
||||
- "Available values can be found here: U(https://docs.microsoft.com/en-us/azure/virtual-machines/windows/sizes-general)"
|
||||
- A valid Azure VM size value. For example, C(Standard_D4).
|
||||
- The list of choices varies depending on the subscription and location. Check your subscription for available choices.
|
||||
- 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:
|
||||
description:
|
||||
- The user name of the virtual machine.
|
||||
|
|
@ -59,7 +60,7 @@ options:
|
|||
- The SSH key of the virtual machine administrator.
|
||||
lab_subnet:
|
||||
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 a dict which contains C(virtual_network_name) and C(name).
|
||||
disallow_public_ip_address:
|
||||
|
|
@ -72,10 +73,10 @@ options:
|
|||
suboptions:
|
||||
source_name:
|
||||
description:
|
||||
- "The artifact's source name."
|
||||
- The artifact's source name.
|
||||
source_path:
|
||||
description:
|
||||
- "The artifact's path in the source repository."
|
||||
- The artifact's path in the source repository.
|
||||
parameters:
|
||||
description:
|
||||
- The parameters of the artifact.
|
||||
|
|
@ -120,19 +121,19 @@ options:
|
|||
- premium
|
||||
state:
|
||||
description:
|
||||
- Assert the state of the Virtual Machine.
|
||||
- Use 'present' to create or update an Virtual Machine and 'absent' to delete it.
|
||||
- Assert the state of the Virtual Machine.
|
||||
- Use C(present) to create or update an Virtual Machine and C(absent) to delete it.
|
||||
default: present
|
||||
choices:
|
||||
- absent
|
||||
- present
|
||||
- absent
|
||||
- present
|
||||
|
||||
extends_documentation_fragment:
|
||||
- azure
|
||||
- azure_tags
|
||||
|
||||
author:
|
||||
- "Zim Kalinowski (@zikalino)"
|
||||
- Zim Kalinowski (@zikalino)
|
||||
|
||||
'''
|
||||
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: azure_rm_devtestlabvirtualmachine_facts
|
||||
version_added: "2.8"
|
||||
short_description: Get Azure DevTest Lab Virtual Machine facts.
|
||||
short_description: Get Azure DevTest Lab Virtual Machine facts
|
||||
description:
|
||||
- Get facts of Azure DevTest Lab Virtual Machine.
|
||||
|
||||
|
|
@ -41,7 +41,7 @@ extends_documentation_fragment:
|
|||
- azure
|
||||
|
||||
author:
|
||||
- "Zim Kalinowski (@zikalino)"
|
||||
- Zim Kalinowski (@zikalino)
|
||||
|
||||
'''
|
||||
|
||||
|
|
@ -55,7 +55,8 @@ EXAMPLES = '''
|
|||
|
||||
RETURN = '''
|
||||
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
|
||||
type: complex
|
||||
contains:
|
||||
|
|
@ -110,7 +111,7 @@ virtualmachines:
|
|||
contains:
|
||||
offer:
|
||||
description:
|
||||
- Offer.
|
||||
- The offer of the gallery image.
|
||||
returned: when created from gallery image
|
||||
type: str
|
||||
sample: UbuntuServer
|
||||
|
|
@ -122,19 +123,19 @@ virtualmachines:
|
|||
sample: Linux
|
||||
sku:
|
||||
description:
|
||||
- SKU.
|
||||
- The SKU of the gallery image.
|
||||
returned: when created from gallery image
|
||||
type: str
|
||||
sample: 16.04-LTS
|
||||
publisher:
|
||||
description:
|
||||
- Publisher.
|
||||
- The publisher of the gallery image.
|
||||
returned: when created from gallery image
|
||||
type: str
|
||||
sample: Canonical
|
||||
version:
|
||||
description:
|
||||
- Version.
|
||||
- The version of the gallery image.
|
||||
returned: when created from gallery image
|
||||
type: str
|
||||
sample: latest
|
||||
|
|
@ -158,7 +159,7 @@ virtualmachines:
|
|||
sample: dtl_admin
|
||||
storage_type:
|
||||
description:
|
||||
- Storage type.
|
||||
- Storage type to use for virtual machine.
|
||||
returned: always
|
||||
type: str
|
||||
sample: standard
|
||||
|
|
@ -194,10 +195,10 @@ virtualmachines:
|
|||
sample: Succeeded
|
||||
tags:
|
||||
description:
|
||||
- Tags
|
||||
- The tags of the resource.
|
||||
returned: always
|
||||
type: complex
|
||||
sample: { 'foo': 'bar' }
|
||||
sample: "{ 'foo': 'bar' }"
|
||||
'''
|
||||
|
||||
from ansible.module_utils.azure_rm_common import AzureRMModuleBase
|
||||
|
|
|
|||
Loading…
Reference in a new issue