Update azure_rm_virtualmachinescalesetextension related document (#58908)

* Update azure_rm_virtualmachinescalesetextension documentation
This commit is contained in:
Fred-sun 2019-07-16 05:02:42 +08:00 committed by Alicia Cozine
parent ee71a7df74
commit 9e6399f74c
2 changed files with 21 additions and 20 deletions

View file

@ -19,10 +19,10 @@ module: azure_rm_virtualmachinescalesetextension
version_added: "2.8" version_added: "2.8"
short_description: Managed Azure Virtual Machine Scale Set extension short_description: Manage Azure Virtual Machine Scale Set (VMSS) extensions
description: description:
- Create, update and delete Azure Virtual Machine Extension - Create, update and delete Azure Virtual Machine Scale Set (VMSS) extensions.
options: options:
resource_group: resource_group:
@ -35,10 +35,10 @@ options:
required: true required: true
name: name:
description: description:
- Name of the VMSS extension - Name of the VMSS extension.
location: location:
description: description:
- Valid azure location. Defaults to location of the resource group. - Valid Azure location. Defaults to location of the resource group.
publisher: publisher:
description: description:
- The name of the extension handler publisher. - The name of the extension handler publisher.
@ -76,7 +76,7 @@ extends_documentation_fragment:
- azure - azure
author: author:
- "Zim Kalinowski (@zikalino)" - Zim Kalinowski (@zikalino)
''' '''
EXAMPLES = ''' EXAMPLES = '''
@ -104,7 +104,7 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
id: id:
description: description:
- VMSS extension resource ID - VMSS extension resource ID.
returned: always returned: always
type: str type: str
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/scalesets/myscaleset/extensions/myext sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/scalesets/myscaleset/extensions/myext

View file

@ -17,7 +17,7 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_virtualmachinescalesetextension_facts module: azure_rm_virtualmachinescalesetextension_facts
version_added: "2.8" version_added: "2.8"
short_description: Get Azure Virtual Machine Scale Set Extension facts. short_description: Get Azure Virtual Machine Scale Set Extension facts
description: description:
- Get facts of Azure Virtual Machine Scale Set Extension. - Get facts of Azure Virtual Machine Scale Set Extension.
@ -38,7 +38,7 @@ extends_documentation_fragment:
- azure - azure
author: author:
- "Zim Kalinowski (@zikalino)" - Zim Kalinowski (@zikalino)
''' '''
@ -57,62 +57,63 @@ 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/virtualMachineScaleSets/ sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/
myvmss/extensions/myextension" myvmss/extensions/myextension"
resource_group: resource_group:
description: description:
- Resource group name - Resource group name.
returned: always returned: always
type: str type: str
sample: myrg sample: myrg
vmss_name: vmss_name:
description: description:
- Virtual machine name - Virtual machine scale set name.
returned: always returned: always
type: str type: str
sample: myvmss sample: myvmss
name: name:
description: description:
- Virtual machine name - Virtual machine extension name.
returned: always returned: always
type: str type: str
sample: myextension sample: myextension
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
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