Update azure_rm_hdinsightcluster related document (#57037)

* Update azure_rm_hdinsightcluster related documentation
pull/57198/head
Fred-sun 6 years ago committed by Alicia Cozine
parent 6bceea4f51
commit 3ef09496a3

@ -17,7 +17,7 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_hdinsightcluster module: azure_rm_hdinsightcluster
version_added: "2.8" version_added: "2.8"
short_description: Manage Azure HDInsight Cluster instance. short_description: Manage Azure HDInsight Cluster instance
description: description:
- Create, update and delete instance of Azure HDInsight Cluster. - Create, update and delete instance of Azure HDInsight Cluster.
@ -35,7 +35,7 @@ options:
- Resource location. If not set, location from the resource group will be used as default. - Resource location. If not set, location from the resource group will be used as default.
cluster_version: cluster_version:
description: description:
- The version of the cluster. For example I(3.6) - The version of the cluster. For example C(3.6).
os_type: os_type:
description: description:
- The type of operating system. - The type of operating system.
@ -85,17 +85,17 @@ options:
- The instance count of the cluster. - The instance count of the cluster.
vm_size: vm_size:
description: description:
- The size of the VM - The size of the VM.
linux_profile: linux_profile:
description: description:
- The Linux OS profile. - The Linux OS profile.
suboptions: suboptions:
username: username:
description: description:
- User name - SSH user name.
password: password:
description: description:
- Password - SSH password.
storage_accounts: storage_accounts:
description: description:
- The list of storage accounts in the cluster. - The list of storage accounts in the cluster.
@ -103,7 +103,7 @@ options:
suboptions: suboptions:
name: name:
description: description:
- Blob storage endpoint. - Blob storage endpoint. For example storage_account_name.blob.core.windows.net.
is_default: is_default:
description: description:
- Whether or not the storage account is the default storage account. - Whether or not the storage account is the default storage account.
@ -115,19 +115,19 @@ options:
- The storage account access key. - The storage account access key.
state: state:
description: description:
- Assert the state of the cluster. - Assert the state of the cluster.
- Use C(present) to create or update a cluster and C(absent) to delete it. - Use C(present) to create or update a cluster and C(absent) to delete it.
default: present default: present
choices: choices:
- absent - absent
- present - present
extends_documentation_fragment: extends_documentation_fragment:
- azure - azure
- azure_tags - azure_tags
author: author:
- "Zim Kalinowski (@zikalino)" - Zim Kalinowski (@zikalino)
''' '''

@ -17,7 +17,7 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_hdinsightcluster_facts module: azure_rm_hdinsightcluster_facts
version_added: "2.8" version_added: "2.8"
short_description: Get Azure HDInsight Cluster facts. short_description: Get Azure HDInsight Cluster facts
description: description:
- Get facts of Azure HDInsight Cluster. - Get facts of Azure HDInsight Cluster.
@ -36,7 +36,7 @@ extends_documentation_fragment:
- azure - azure
author: author:
- "Zim Kalinowski (@zikalino)" - Zim Kalinowski (@zikalino)
''' '''
@ -53,7 +53,8 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
clusters: clusters:
description: A list of dictionaries containing facts for HDInsight Cluster. description:
- A list of dictionaries containing facts for HDInsight Cluster.
returned: always returned: always
type: complex type: complex
contains: contains:
@ -128,7 +129,7 @@ clusters:
sample: 2 sample: 2
vm_size: vm_size:
description: description:
- The size of the VM - The size of the VM.
returned: always returned: always
type: str type: str
sample: Standard_D3 sample: Standard_D3
@ -138,7 +139,7 @@ clusters:
contains: contains:
username: username:
description: description:
- User name - User name.
returned: always returned: always
type: str type: str
sample: myuser sample: myuser
@ -173,7 +174,7 @@ clusters:
sample: TCP sample: TCP
tags: tags:
description: description:
- Tags - The tags of the resource.
returned: always returned: always
type: complex type: complex
sample: {} sample: {}

Loading…
Cancel
Save