1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Update azure_rm_image relate document (#57043)

This commit is contained in:
Fred-sun 2019-05-29 15:12:36 -04:00 committed by Alicia Cozine
parent 00067c8d54
commit 163d3efbf8
2 changed files with 12 additions and 10 deletions

View file

@ -17,7 +17,7 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_image module: azure_rm_image
version_added: "2.5" version_added: "2.5"
short_description: Manage Azure image. short_description: Manage Azure image
description: description:
- Create, delete an image from virtual machine, blob uri, managed disk or snapshot. - Create, delete an image from virtual machine, blob uri, managed disk or snapshot.
options: options:
@ -33,9 +33,9 @@ options:
description: description:
- OS disk source from the same region. - OS disk source from the same region.
- It can be a virtual machine, OS disk blob URI, managed OS disk, or OS snapshot. - 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 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 type: raw
required: true required: true
data_disk_sources: data_disk_sources:
@ -63,7 +63,7 @@ extends_documentation_fragment:
- azure_tags - azure_tags
author: author:
- "Yuwei Zhou (@yuwzho)" - Yuwei Zhou (@yuwzho)
''' '''
@ -107,7 +107,8 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
id: id:
description: Image resource path. description:
- Image resource path.
type: str type: str
returned: success returned: success
example: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Compute/images/myImage" example: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Compute/images/myImage"

View file

@ -16,7 +16,7 @@ module: azure_rm_image_facts
version_added: "2.8" version_added: "2.8"
short_description: Get facts about azure custom images. short_description: Get facts about azure custom images
description: description:
- List azure custom images. The images can be listed where scope of listing can be based on subscription, resource group, name or tags. - 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 - azure
author: author:
- "Madhura Naniwadekar (@Madhura-CSI)" - Madhura Naniwadekar (@Madhura-CSI)
''' '''
@ -60,7 +60,8 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
images: images:
description: List of image dicts. description:
- List of image dicts.
returned: always returned: always
type: complex type: complex
contains: contains:
@ -98,7 +99,7 @@ images:
type: str type: str
os_state: os_state:
description: 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 returned: always
type: str type: str
sample: Generalized sample: Generalized
@ -121,7 +122,7 @@ images:
sample: Succeeded sample: Succeeded
source: source:
description: 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 type: str
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/xx sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/xx
tags: tags: