From 163d3efbf88d220b7f76adc7c81059f3d8b5cab3 Mon Sep 17 00:00:00 2001 From: Fred-sun <37327967+Fred-sun@users.noreply.github.com> Date: Wed, 29 May 2019 15:12:36 -0400 Subject: [PATCH] Update azure_rm_image relate document (#57043) --- lib/ansible/modules/cloud/azure/azure_rm_image.py | 11 ++++++----- .../modules/cloud/azure/azure_rm_image_facts.py | 11 ++++++----- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/lib/ansible/modules/cloud/azure/azure_rm_image.py b/lib/ansible/modules/cloud/azure/azure_rm_image.py index b5dff335e4..b2cdf5331b 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_image.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_image.py @@ -17,7 +17,7 @@ DOCUMENTATION = ''' --- module: azure_rm_image version_added: "2.5" -short_description: Manage Azure image. +short_description: Manage Azure image description: - Create, delete an image from virtual machine, blob uri, managed disk or snapshot. options: @@ -33,9 +33,9 @@ options: description: - OS disk source from the same region. - It can be a virtual machine, OS disk blob URI, managed OS disk, or OS snapshot. - - Each type of source except for blob URI can be given as resource id, name or a dict contains C(resource_group), C(name) and C(types). + - Each type of source except for blob URI can be given as resource id, name or a dict contains C(resource_group), C(name) and C(type). - If source type is blob URI, the source should be the full URI of the blob in string type. - - If you specify the C(type) in a dict, acceptable value contains C(disks), C(virtual_machines) and C(snapshots). + - If you specify the I(type) in a dict, acceptable value contains C(disks), C(virtual_machines) and C(snapshots). type: raw required: true data_disk_sources: @@ -63,7 +63,7 @@ extends_documentation_fragment: - azure_tags author: - - "Yuwei Zhou (@yuwzho)" + - Yuwei Zhou (@yuwzho) ''' @@ -107,7 +107,8 @@ EXAMPLES = ''' RETURN = ''' id: - description: Image resource path. + description: + - Image resource path. type: str returned: success example: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Compute/images/myImage" diff --git a/lib/ansible/modules/cloud/azure/azure_rm_image_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_image_facts.py index 9911bef932..2b73f46735 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_image_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_image_facts.py @@ -16,7 +16,7 @@ module: azure_rm_image_facts version_added: "2.8" -short_description: Get facts about azure custom images. +short_description: Get facts about azure custom images description: - List azure custom images. The images can be listed where scope of listing can be based on subscription, resource group, name or tags. @@ -36,7 +36,7 @@ extends_documentation_fragment: - azure author: - - "Madhura Naniwadekar (@Madhura-CSI)" + - Madhura Naniwadekar (@Madhura-CSI) ''' @@ -60,7 +60,8 @@ EXAMPLES = ''' RETURN = ''' images: - description: List of image dicts. + description: + - List of image dicts. returned: always type: complex contains: @@ -98,7 +99,7 @@ images: type: str os_state: description: - - Specifies image operating system state. Possible values are 'Generalized' or 'Specialized'. + - Specifies image operating system state. Possible values are C(Generalized) or C(Specialized). returned: always type: str sample: Generalized @@ -121,7 +122,7 @@ images: sample: Succeeded source: description: - - Resource id of source VM from which the image is created + - Resource id of source VM from which the image is created. type: str sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/xx tags: