summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFred-sun <37327967+Fred-sun@users.noreply.github.com>2019-07-13 04:11:45 +0800
committerAlicia Cozine <879121+acozine@users.noreply.github.com>2019-07-12 15:11:45 -0500
commit8c55a9c70b44727f308cd393342171cbe7d9471d (patch)
treef7cd1c3450b18d04b1b706212a3efe542d2bec1c
parentfec314febb63185151dfae7386c29f0623894288 (diff)
downloadansible-8c55a9c70b44727f308cd393342171cbe7d9471d.tar.gz
Update azure_rm_virtualmachinescalesetinstance related document (#58909)
* Update azure_rm_virtualmachinescalesetinstance related documentation
-rw-r--r--lib/ansible/modules/cloud/azure/azure_rm_virtualmachinescalesetinstance.py12
-rw-r--r--lib/ansible/modules/cloud/azure/azure_rm_virtualmachinescalesetinstance_facts.py25
2 files changed, 19 insertions, 18 deletions
diff --git a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachinescalesetinstance.py b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachinescalesetinstance.py
index d54f73eb5a..2cbacfe670 100644
--- a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachinescalesetinstance.py
+++ b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachinescalesetinstance.py
@@ -17,7 +17,7 @@ DOCUMENTATION = '''
---
module: azure_rm_virtualmachinescalesetinstance
version_added: "2.8"
-short_description: Get Azure Virtual Machine Scale Set Instance facts.
+short_description: Get Azure Virtual Machine Scale Set Instance facts
description:
- Get facts of Azure Virtual Machine Scale Set VMs.
@@ -48,8 +48,7 @@ options:
- 'deallocated'
state:
description:
- - Assert the state of the VMSS instance. Use 'present' to update a instance and
- 'absent' to delete instance.
+ - State of the VMSS instance. Use C(present) to update an instance and C(absent) to delete an instance.
default: present
choices:
- absent
@@ -59,7 +58,7 @@ extends_documentation_fragment:
- azure
author:
- - "Zim Kalinowski (@zikalino)"
+ - Zim Kalinowski (@zikalino)
'''
@@ -74,13 +73,14 @@ EXAMPLES = '''
RETURN = '''
instances:
- description: A list of instances.
+ description:
+ - A list of instances.
returned: always
type: complex
contains:
id:
description:
- - Instance resource ID
+ - Instance resource ID.
returned: always
type: str
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/TestGroup/providers/Microsoft.Compute/scalesets/myscaleset/vms/myvm
diff --git a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachinescalesetinstance_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachinescalesetinstance_facts.py
index fdb92e355a..c6c310a353 100644
--- a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachinescalesetinstance_facts.py
+++ b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachinescalesetinstance_facts.py
@@ -17,7 +17,7 @@ DOCUMENTATION = '''
---
module: azure_rm_virtualmachinescalesetinstance_facts
version_added: "2.8"
-short_description: Get Azure Virtual Machine Scale Set Instance facts.
+short_description: Get Azure Virtual Machine Scale Set Instance facts
description:
- Get facts of Azure Virtual Machine Scale Set VMs.
@@ -41,7 +41,7 @@ extends_documentation_fragment:
- azure
author:
- - "Zim Kalinowski (@zikalino)"
+ - Zim Kalinowski (@zikalino)
'''
@@ -54,56 +54,57 @@ EXAMPLES = '''
RETURN = '''
instances:
- description: A list of dictionaries containing facts for Virtual Machine Scale Set VM.
+ description:
+ - A list of dictionaries containing facts for Virtual Machine Scale Set VM.
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/my
VMSS/virtualMachines/2"
tags:
description:
- - Resource tags
+ - Resource tags.
returned: always
- type: complex
+ type: dict
sample: { 'tag1': 'abc' }
instance_id:
description:
- - Virtual Machine instance Id
+ - Virtual Machine instance ID.
returned: always
type: str
sample: 0
name:
description:
- - Virtual Machine name
+ - Virtual Machine name.
returned: always
type: str
sample: myVMSS_2
latest_model:
description:
- - Is latest model applied?
+ - Whether applied latest model.
returned: always
type: bool
sample: True
provisioning_state:
description:
- - Provisioning state of the Virtual Machine
+ - Provisioning state of the Virtual Machine.
returned: always
type: str
sample: Succeeded
power_state:
description:
- - Provisioning state of the Virtual Machine
+ - Provisioning state of the Virtual Machine's power.
returned: always
type: str
sample: running
vm_id:
description:
- - Virtual Machine Id
+ - Virtual Machine ID
returned: always
type: str
sample: 94a141a9-4530-46ac-b151-2c7ff09aa823