Update azure_rm_virtualmachinescalesetextension related document (#58908)
* Update azure_rm_virtualmachinescalesetextension documentation
This commit is contained in:
parent
ee71a7df74
commit
9e6399f74c
2 changed files with 21 additions and 20 deletions
|
@ -19,10 +19,10 @@ module: azure_rm_virtualmachinescalesetextension
|
|||
|
||||
version_added: "2.8"
|
||||
|
||||
short_description: Managed Azure Virtual Machine Scale Set extension
|
||||
short_description: Manage Azure Virtual Machine Scale Set (VMSS) extensions
|
||||
|
||||
description:
|
||||
- Create, update and delete Azure Virtual Machine Extension
|
||||
- Create, update and delete Azure Virtual Machine Scale Set (VMSS) extensions.
|
||||
|
||||
options:
|
||||
resource_group:
|
||||
|
@ -35,10 +35,10 @@ options:
|
|||
required: true
|
||||
name:
|
||||
description:
|
||||
- Name of the VMSS extension
|
||||
- Name of the VMSS extension.
|
||||
location:
|
||||
description:
|
||||
- Valid azure location. Defaults to location of the resource group.
|
||||
- Valid Azure location. Defaults to location of the resource group.
|
||||
publisher:
|
||||
description:
|
||||
- The name of the extension handler publisher.
|
||||
|
@ -76,7 +76,7 @@ extends_documentation_fragment:
|
|||
- azure
|
||||
|
||||
author:
|
||||
- "Zim Kalinowski (@zikalino)"
|
||||
- Zim Kalinowski (@zikalino)
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
@ -104,7 +104,7 @@ EXAMPLES = '''
|
|||
RETURN = '''
|
||||
id:
|
||||
description:
|
||||
- VMSS extension resource ID
|
||||
- VMSS extension resource ID.
|
||||
returned: always
|
||||
type: str
|
||||
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/scalesets/myscaleset/extensions/myext
|
||||
|
|
|
@ -17,7 +17,7 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: azure_rm_virtualmachinescalesetextension_facts
|
||||
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:
|
||||
- Get facts of Azure Virtual Machine Scale Set Extension.
|
||||
|
||||
|
@ -38,7 +38,7 @@ extends_documentation_fragment:
|
|||
- azure
|
||||
|
||||
author:
|
||||
- "Zim Kalinowski (@zikalino)"
|
||||
- Zim Kalinowski (@zikalino)
|
||||
|
||||
'''
|
||||
|
||||
|
@ -57,62 +57,63 @@ 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/virtualMachineScaleSets/
|
||||
myvmss/extensions/myextension"
|
||||
resource_group:
|
||||
description:
|
||||
- Resource group name
|
||||
- Resource group name.
|
||||
returned: always
|
||||
type: str
|
||||
sample: myrg
|
||||
vmss_name:
|
||||
description:
|
||||
- Virtual machine name
|
||||
- Virtual machine scale set name.
|
||||
returned: always
|
||||
type: str
|
||||
sample: myvmss
|
||||
name:
|
||||
description:
|
||||
- Virtual machine name
|
||||
- Virtual machine extension name.
|
||||
returned: always
|
||||
type: str
|
||||
sample: myextension
|
||||
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
|
||||
provisioning_state:
|
||||
description:
|
||||
- Provisioning state of the extension
|
||||
- Provisioning state of the extension.
|
||||
returned: always
|
||||
type: str
|
||||
sample: Succeeded
|
||||
|
|
Loading…
Reference in a new issue