# azure_rm_hdinsightcluster – Manage Azure HDInsight Cluster instance

New in version 2.8.

- Synopsis

- Requirements

- Parameters

- Notes

- See Also

- Examples

- Return Values

- Status

## Synopsis

- Create, update and delete instance of Azure HDInsight Cluster.

## Requirements

The below requirements are needed on the host that executes this module.

- python >= 2.7

- azure >= 2.0.0

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
ad_user string |  | Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url string added in 2.6 |  | Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile string added in 2.5 | Default: "latest" | Selects an API profile to use when communicating with Azure services. Default value of `latest` is appropriate for public clouds; future values will allow use with Azure Stack.

append_tags
boolean

Choices:
- no
- yes ←

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.

auth_source
string
added in 2.5

Choices:
- auto
- cli
- credential_file
- env
- msi

Controls the source of the credentials to use for authentication.
If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to `auto` if variable is not defined.
`auto` will follow the default precedence of module parameters -> environment variables -> default profile in credential file `~/.azure/credentials`.
When set to `cli`, the credentials will be sources from the default Azure CLI profile.
Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable.
When set to `msi`, the host machine must be an azure resource with an enabled MSI extension. `subscription_id` or the environment variable `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 `msi` was added in Ansible 2.6.

cert_validation_mode
string
added in 2.5

Choices:
- ignore
- validate

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 `ignore`. Can also be set via credential file profile or the `AZURE_CERT_VALIDATION` environment variable.

client_id string |  | Azure client ID. Use when authenticating with a Service Principal.
cloud_environment string added in 2.4 | Default: "AzureCloud" | For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, `AzureChinaCloud`, `AzureUSGovernment`), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the `AZURE_CLOUD_ENVIRONMENT` environment variable.
cluster_definition - |  | The cluster definition.
| gateway_rest_password - |  | Gateway REST password.
| gateway_rest_username - |  | Gateway REST user name.

kind
-

Choices:
- hadoop
- spark
- hbase
- storm

The type of cluster.

cluster_version - |  | The version of the cluster. For example `3.6`.
compute_profile_roles list |  | The list of roles in the cluster.
| linux_profile - |  | The Linux OS profile.
|  | password - |  | SSH password.
|  | username - |  | SSH user name.
| min_instance_count - |  | The minimum instance count of the cluster.

name
-

Choices:
- headnode
- workernode
- zookepernode

The name of the role.

| target_instance_count - |  | The instance count of the cluster.
| vm_size - |  | The size of the VM.
location - |  | Resource location. If not set, location from the resource group will be used as default.
name - / required |  | The name of the cluster.

os_type
-

Choices:
- linux

The type of operating system.

password string |  | Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile string |  | Security profile found in ~/.azure/credentials file.
resource_group - / required |  | The name of the resource group.
secret string |  | Azure client secret. Use when authenticating with a Service Principal.

state
-

Choices:
- absent
- present ←

Assert the state of the cluster.
Use `present` to create or update a cluster and `absent` to delete it.

storage_accounts list |  | The list of storage accounts in the cluster.
| container - |  | The container in the storage account.
| is_default - |  | Whether or not the storage account is the default storage account.
| key - |  | The storage account access key.
| name - |  | Blob storage endpoint. For example storage_account_name.blob.core.windows.net.
subscription_id string |  | Your Azure subscription Id.
tags dictionary |  | 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.
tenant string |  | Azure tenant ID. Use when authenticating with a Service Principal.

tier
-

Choices:
- standard
- premium

The cluster tier.

## Notes

Note

- For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with `az login`.

- Authentication is also possible using a service principal or Active Directory user.

- To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.

- To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.

- Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

## See Also

See also

Sign in with Azure CLI

  How to authenticate using the `az login` command.

## Examples

    - 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

## Return Values

Common return values are documented here, the following are the fields unique to this module:

Key | Returned | Description
--- | --- | ---
id string | always | Fully qualified resource id of the cluster. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.HDInsight/clusters/myCluster

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]

- This module is maintained by the Ansible Community. [community]

### Authors

- Zim Kalinowski (@zikalino)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.