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

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

Loading…
Cancel
Save