Format azure_rm_snapshot document (#64579)

pull/64775/head
Fred-sun 6 years ago committed by Sandra McCann
parent 0b8b84c16f
commit cc2e48a40e

@ -17,83 +17,78 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_snapshot module: azure_rm_snapshot
version_added: '2.9' version_added: '2.9'
short_description: Manage Azure Snapshot instance. short_description: Manage Azure Snapshot instance
description: description:
- 'Create, update and delete instance of Azure Snapshot.' - Create, update and delete instance of Azure Snapshot.
options: options:
resource_group: resource_group:
description:
- The name of the resource group.
required: true
type: str
name:
description:
- Resource name
type: str
location:
description:
- Resource location
type: str
sku:
description:
- SKU
type: dict
suboptions:
name:
description: description:
- The sku name. - The name of the resource group.
required: true
type: str type: str
choices: name:
- Standard_LRS
- Premium_LRS
- Standard_ZRS
tier:
description: description:
- The sku tier. - Resource name.
type: str type: str
os_type: location:
description:
- The Operating System type.
type: str
choices:
- Linux
- Windows
creation_data:
description:
- >-
Disk source information. CreationData information cannot be changed
after the disk has been created.
type: dict
suboptions:
create_option:
description: description:
- This enumerates the possible sources of a disk's creation. - Resource location.
type: str
sku:
description:
- The snapshots SKU.
type: dict
suboptions:
name:
description:
- The sku name.
type: str
choices:
- Standard_LRS
- Premium_LRS
- Standard_ZRS
tier:
description:
- The sku tier.
type: str
os_type:
description:
- The Operating System type.
type: str type: str
default: Import
choices: choices:
- Import - Linux
source_uri: - Windows
creation_data:
description:
- Disk source information.
- CreationData information cannot be changed after the disk has been created.
type: dict
suboptions:
create_option:
description:
- This enumerates the possible sources of a disk's creation.
type: str
default: Import
choices:
- Import
source_uri:
description:
- If I(createOption=Import), this is the URI of a blob to be imported into a managed disk.
type: str
state:
description: description:
- >- - Assert the state of the Snapshot.
If createOption is Import, this is the URI of a blob to be imported - Use C(present) to create or update an Snapshot and C(absent) to delete it.
into a managed disk. default: present
type: str type: str
state: choices:
description: - absent
- Assert the state of the Snapshot. - present
- >-
Use C(present) to create or update an Snapshot and C(absent) to delete
it.
default: present
type: str
choices:
- absent
- present
extends_documentation_fragment: extends_documentation_fragment:
- azure - azure
- azure_tags - azure_tags
author: author:
- Zim Kalinowski (@zikalino) - Zim Kalinowski (@zikalino)
''' '''
@ -110,11 +105,11 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
id: id:
description: description:
- Resource Id - Resource ID.
returned: always returned: always
type: str type: str
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot
''' '''
import time import time

Loading…
Cancel
Save