Update azure_rm_virtualmachinescalesetinstance related document (#58909)

* Update azure_rm_virtualmachinescalesetinstance related documentation
pull/59052/head
Fred-sun 5 years ago committed by Alicia Cozine
parent fec314febb
commit 8c55a9c70b

@ -17,7 +17,7 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_virtualmachinescalesetinstance module: azure_rm_virtualmachinescalesetinstance
version_added: "2.8" 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: description:
- Get facts of Azure Virtual Machine Scale Set VMs. - Get facts of Azure Virtual Machine Scale Set VMs.
@ -48,8 +48,7 @@ options:
- 'deallocated' - 'deallocated'
state: state:
description: description:
- Assert the state of the VMSS instance. Use 'present' to update a instance and - State of the VMSS instance. Use C(present) to update an instance and C(absent) to delete an instance.
'absent' to delete instance.
default: present default: present
choices: choices:
- absent - absent
@ -59,7 +58,7 @@ extends_documentation_fragment:
- azure - azure
author: author:
- "Zim Kalinowski (@zikalino)" - Zim Kalinowski (@zikalino)
''' '''
@ -74,13 +73,14 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
instances: instances:
description: A list of instances. description:
- A list of instances.
returned: always returned: always
type: complex type: complex
contains: contains:
id: id:
description: description:
- Instance resource ID - Instance resource ID.
returned: always returned: always
type: str type: str
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/TestGroup/providers/Microsoft.Compute/scalesets/myscaleset/vms/myvm sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/TestGroup/providers/Microsoft.Compute/scalesets/myscaleset/vms/myvm

@ -17,7 +17,7 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_virtualmachinescalesetinstance_facts module: azure_rm_virtualmachinescalesetinstance_facts
version_added: "2.8" 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: description:
- Get facts of Azure Virtual Machine Scale Set VMs. - Get facts of Azure Virtual Machine Scale Set VMs.
@ -41,7 +41,7 @@ extends_documentation_fragment:
- azure - azure
author: author:
- "Zim Kalinowski (@zikalino)" - Zim Kalinowski (@zikalino)
''' '''
@ -54,56 +54,57 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
instances: 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 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/my sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/my
VMSS/virtualMachines/2" VMSS/virtualMachines/2"
tags: tags:
description: description:
- Resource tags - Resource tags.
returned: always returned: always
type: complex type: dict
sample: { 'tag1': 'abc' } sample: { 'tag1': 'abc' }
instance_id: instance_id:
description: description:
- Virtual Machine instance Id - Virtual Machine instance ID.
returned: always returned: always
type: str type: str
sample: 0 sample: 0
name: name:
description: description:
- Virtual Machine name - Virtual Machine name.
returned: always returned: always
type: str type: str
sample: myVMSS_2 sample: myVMSS_2
latest_model: latest_model:
description: description:
- Is latest model applied? - Whether applied latest model.
returned: always returned: always
type: bool type: bool
sample: True sample: True
provisioning_state: provisioning_state:
description: description:
- Provisioning state of the Virtual Machine - Provisioning state of the Virtual Machine.
returned: always returned: always
type: str type: str
sample: Succeeded sample: Succeeded
power_state: power_state:
description: description:
- Provisioning state of the Virtual Machine - Provisioning state of the Virtual Machine's power.
returned: always returned: always
type: str type: str
sample: running sample: running
vm_id: vm_id:
description: description:
- Virtual Machine Id - Virtual Machine ID
returned: always returned: always
type: str type: str
sample: 94a141a9-4530-46ac-b151-2c7ff09aa823 sample: 94a141a9-4530-46ac-b151-2c7ff09aa823

Loading…
Cancel
Save