ansible / ansible.builtin / v2.9.17 / module / azure_rm_hdinsightcluster Manage Azure HDInsight Cluster instance | "added in version" 2.8 of ansible.builtin" Authors: Zim Kalinowski (@zikalino) preview | supported by communityansible.builtin.azure_rm_hdinsightcluster (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
Create, update and delete instance of Azure HDInsight Cluster.
- name: Create instance of HDInsight Cluster azure_rm_hdinsightcluster: resource_group: myResourceGroup name: myCluster location: eastus2 cluster_version: 3.6 os_type: linux tier: standard cluster_definition: kind: spark gateway_rest_username: http-user gateway_rest_password: MuABCPassword!!@123 storage_accounts: - name: myStorageAccount.blob.core.windows.net is_default: yes container: myContainer key: GExmaxH4lDNdHA9nwAsCt8t4AOQas2y9vXQP1kKALTram7Q3/5xLVIab3+nYG1x63Xyak9/VXxQyNBHA9pDWw== compute_profile_roles: - name: headnode target_instance_count: 2 hardware_profile: vm_size: Standard_D3 linux_profile: username: sshuser password: MuABCPassword!!@123 - name: workernode target_instance_count: 2 vm_size: Standard_D3 linux_profile: username: sshuser password: MuABCPassword!!@123
name: description: - The name of the cluster. required: true tags: description: - Dictionary of string:string pairs to assign as metadata to the object. - Metadata tags on the object will be updated with any provided values. - To remove tags set append_tags option to false. type: dict tier: choices: - standard - premium description: - The cluster tier. state: choices: - absent - present default: present description: - Assert the state of the cluster. - Use C(present) to create or update a cluster and C(absent) to delete it. secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str tenant: description: - Azure tenant ID. Use when authenticating with a Service Principal. type: str ad_user: description: - Active Directory username. Use when authenticating with an Active Directory user rather than service principal. type: str os_type: choices: - linux description: - The type of operating system. profile: description: - Security profile found in ~/.azure/credentials file. type: str location: description: - Resource location. If not set, location from the resource group will be used as default. password: description: - Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. type: str client_id: description: - Azure client ID. Use when authenticating with a Service Principal. type: str api_profile: default: latest description: - Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. type: str version_added: 0.0.1 version_added_collection: azure.azcollection append_tags: default: true description: - Use to control if tags field is canonical or just appends to existing tags. - When canonical, any tags not found in the tags parameter will be removed from the object's metadata. type: bool auth_source: choices: - auto - cli - credential_file - env - msi default: auto description: - Controls the source of the credentials to use for authentication. - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. - When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli). - When set to C(env), the credentials will be read from the environment variables - When set to C(credential_file), it will read the profile from C(~/.azure/credentials). - When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID) can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used. - When set to C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID) can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen. - The C(msi) was added in Ansible 2.6. type: str version_added: 0.0.1 version_added_collection: azure.azcollection resource_group: description: - The name of the resource group. required: true cluster_version: description: - The version of the cluster. For example C(3.6). subscription_id: description: - Your Azure subscription Id. type: str storage_accounts: description: - The list of storage accounts in the cluster. suboptions: container: description: - The container in the storage account. is_default: description: - Whether or not the storage account is the default storage account. key: description: - The storage account access key. name: description: - Blob storage endpoint. For example storage_account_name.blob.core.windows.net. type: list cloud_environment: default: AzureCloud description: - For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection adfs_authority_url: description: - Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. type: str version_added: 0.0.1 version_added_collection: azure.azcollection cluster_definition: description: - The cluster definition. suboptions: gateway_rest_password: description: - Gateway REST password. gateway_rest_username: description: - Gateway REST user name. kind: choices: - hadoop - spark - hbase - storm description: - The type of cluster. cert_validation_mode: choices: - ignore - validate description: - Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection compute_profile_roles: description: - The list of roles in the cluster. suboptions: linux_profile: description: - The Linux OS profile. suboptions: password: description: - SSH password. username: description: - SSH user name. min_instance_count: description: - The minimum instance count of the cluster. name: choices: - headnode - workernode - zookepernode description: - The name of the role. target_instance_count: description: - The instance count of the cluster. vm_size: description: - The size of the VM. type: list
id: description: - Fully qualified resource id of the cluster. returned: always sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.HDInsight/clusters/myCluster type: str