Update azure_rm_virtualmachineextesion related document (#58907)

* Update azure_rm_virtualmachineextension related documentation
pull/59052/head
Fred-sun 5 years ago committed by Alicia Cozine
parent dd30d86f1e
commit 343acd76d4

@ -22,10 +22,8 @@ version_added: "2.4"
short_description: Managed Azure Virtual Machine extension
description:
- Create, update and delete Azure Virtual Machine Extension
notes:
- This module was called C(azure_rm_virtualmachine_extension) before Ansible 2.8. The usage did not change.
- Create, update and delete Azure Virtual Machine Extension.
- Note that this module was called M(azure_rm_virtualmachine_extension) before Ansible 2.8. The usage did not change.
options:
resource_group:
@ -34,19 +32,18 @@ options:
required: true
name:
description:
- Name of the vm extension
- Name of the vm extension.
required: true
state:
description:
- Assert the state of the vm extension. Use C(present) to create or update a vm extension and
C(absent) to delete a vm extension.
- State of the vm extension. Use C(present) to create or update a vm extension and C(absent) to delete a vm extension.
default: present
choices:
- absent
- present
location:
description:
- Valid azure location. Defaults to location of the resource group.
- Valid Azure location. Defaults to location of the resource group.
virtual_machine_name:
description:
- The name of the virtual machine where the extension should be create or updated.
@ -74,8 +71,8 @@ extends_documentation_fragment:
- azure
author:
- "Sertac Ozercan (@sozercan)"
- "Julien Stroheker (@julienstroheker)"
- Sertac Ozercan (@sozercan)
- Julien Stroheker (@julienstroheker)
'''
EXAMPLES = '''
@ -102,13 +99,18 @@ EXAMPLES = '''
RETURN = '''
state:
description: Current state of the vm extension
description:
- Current state of the vm extension.
returned: always
type: dict
sample: { "state":"Deleted" }
changed:
description: Whether or not the resource has changed
description:
- Whether or not the resource has changed.
returned: always
type: bool
sample: true
'''
from ansible.module_utils.azure_rm_common import AzureRMModuleBase

@ -17,7 +17,7 @@ DOCUMENTATION = '''
---
module: azure_rm_virtualmachineextension_facts
version_added: "2.8"
short_description: Get Azure Virtual Machine Extension facts.
short_description: Get Azure Virtual Machine Extension facts
description:
- Get facts of Azure Virtual Machine Extension.
@ -41,7 +41,7 @@ extends_documentation_fragment:
- azure
author:
- "Zim Kalinowski (@zikalino)"
- Zim Kalinowski (@zikalino)
'''
@ -60,74 +60,75 @@ EXAMPLES = '''
RETURN = '''
extensions:
description: A list of dictionaries containing facts for Virtual Machine Extension.
description:
- A list of dictionaries containing facts for Virtual Machine Extension.
returned: always
type: complex
contains:
id:
description:
- Resource Id
- Resource ID.
returned: always
type: str
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myvm/testVM/extens
ions/myextension"
resource_group:
description:
- Resource group name
- Resource group name.
returned: always
type: str
sample: myResourceGroup
virtual_machine_name:
description:
- Virtual machine name
- Virtual machine name.
returned: always
type: str
sample: myvm
name:
description:
- Virtual machine name
- Virtual machine name.
returned: always
type: str
sample: myextension
location:
description:
- Location
- The resource location.
returned: always
type: str
sample: eastus
publisher:
description:
- Extension publisher
- Extension publisher.
returned: always
type: str
sample: Microsoft.Azure.Extensions
type:
description:
- Extension type
- Extension type.
returned: always
type: str
sample: CustomScript
settings:
description:
- Extension specific settings dictionary
- Extension specific settings dictionary.
returned: always
type: complex
sample: "{'commandToExecute': 'hostname'}"
type: dict
sample: { 'commandToExecute':'hostname' }
auto_upgrade_minor_version:
description:
- Autoupgrade minor version flag
- Autoupgrade minor version flag.
returned: always
type: bool
sample: true
tags:
description:
- Resource tags
- Resource tags.
returned: always
type: complex
sample: "{ mytag: abc }"
type: dict
sample: { "mytag":"abc" }
provisioning_state:
description:
- Provisioning state of the extension
- Provisioning state of the extension.
returned: always
type: str
sample: Succeeded

Loading…
Cancel
Save