azure.azcollection.azure_rm_datalakestore module – Manage Azure data lake store

Note

This module is part of the azure.azcollection collection (version 1.16.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install azure.azcollection. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: azure.azcollection.azure_rm_datalakestore.

New in azure.azcollection 1.4.0

Synopsis

  • Create, update or delete a data lake store.

Requirements

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

  • python >= 2.7

  • The host that executes this module must have the azure.azcollection collection installed via galaxy

  • All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection

  • Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection

Parameters

Parameter

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 azure.azcollection 0.0.1

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

api_profile

string

added in azure.azcollection 0.0.1

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.

Default: "latest"

append_tags

boolean

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.

Choices:

  • false

  • true ← (default)

auth_source

string

added in azure.azcollection 0.0.1

Controls the source of the credentials to use for authentication.

Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.

When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli.

When set to env, the credentials will be read from the environment variables

When set to credential_file, it will read the profile from ~/.azure/credentials.

When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable 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 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.

Choices:

  • "auto" ← (default)

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

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.

Choices:

  • "ignore"

  • "validate"

client_id

string

Azure client ID. Use when authenticating with a Service Principal.

cloud_environment

string

added in azure.azcollection 0.0.1

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.

Default: "AzureCloud"

default_group

string

The default owner group for all new folders and files created in the Data Lake Store account.

encryption_config

dictionary

The Key Vault encryption configuration.

key_vault_meta_info

dictionary

The Key Vault information for connecting to user managed encryption keys.

encryption_key_name

string / required

The name of the user managed encryption key.

encryption_key_version

string / required

The version of the user managed encryption key.

key_vault_resource_id

string / required

The resource identifier for the user managed Key Vault being used to encrypt.

type

string / required

The type of encryption configuration being used.

Choices:

  • "UserManaged"

  • "ServiceManaged"

encryption_state

string

The current state of encryption for this Data Lake Store account.

Choices:

  • "Enabled"

  • "Disabled"

firewall_allow_azure_ips

string

The current state of allowing or disallowing IPs originating within Azure through the firewall.

If the firewall is disabled, this is not enforced.

Choices:

  • "Enabled"

  • "Disabled"

firewall_rules

list / elements=dictionary

The list of firewall rules associated with this Data Lake Store account.

end_ip_address

string / required

The end IP address for the firewall rule.

This can be either ipv4 or ipv6.

Start and End should be in the same protocol.

name

string / required

The unique name of the firewall rule to create.

start_ip_address

string / required

The start IP address for the firewall rule.

This can be either ipv4 or ipv6.

Start and End should be in the same protocol.

firewall_state

string

The current state of the IP address firewall for this Data Lake Store account.

Choices:

  • "Enabled"

  • "Disabled"

identity

string

The Key Vault encryption identity, if any.

Choices:

  • "SystemAssigned"

location

string

The resource location.

log_mode

string

Parent argument.

log_path

string

Parent argument.

name

string / required

The name of the Data Lake Store account.

new_tier

string

The commitment tier to use for next month.

Choices:

  • "Consumption"

  • "Commitment_1TB"

  • "Commitment_10TB"

  • "Commitment_100TB"

  • "Commitment_500TB"

  • "Commitment_1PB"

  • "Commitment_5PB"

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

aliases: resource_group_name

string / required

The name of the Azure resource group to use.

secret

string

Azure client secret. Use when authenticating with a Service Principal.

state

string

State of the data lake store. Use present to create or update a data lake store and use absent to delete it.

Choices:

  • "absent"

  • "present" ← (default)

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.

Currently, Azure DNS zones and Traffic Manager services also don’t allow the use of spaces in the tag.

Azure Front Door doesn’t support the use of

Azure Automation and Azure CDN only support 15 tags on resources.

tenant

string

Azure tenant ID. Use when authenticating with a Service Principal.

thumbprint

string

added in azure.azcollection 1.14.0

The thumbprint of the private key specified in x509_certificate_path.

Use when authenticating with a Service Principal.

Required if x509_certificate_path is defined.

virtual_network_rules

list / elements=dictionary

The list of virtual network rules associated with this Data Lake Store account.

name

string / required

The unique name of the virtual network rule to create.

subnet_id

string / required

The resource identifier for the subnet.

x509_certificate_path

path

added in azure.azcollection 1.14.0

Path to the X509 certificate used to create the service principal in PEM format.

The certificate must be appended to the private key.

Use when authenticating with a Service Principal.

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 Azure Data Lake Store
  azure_rm_datalakestore:
    resource_group: myResourceGroup
    name: myDataLakeStore

Return Values

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

Key

Description

state

complex

Facts for Azure Data Lake Store created/updated.

Returned: always

account_id

string

The unique identifier associated with this Data Lake Store account.

Returned: always

Sample: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

creation_time

string

The account creation time.

Returned: always

Sample: "2020-01-01T00:00:00.000000+00:00"

current_tier

string

The commitment tier in use for the current month.

Returned: always

Sample: "Consumption"

default_group

string

The default owner group for all new folders and files created in the Data Lake Store account.

Returned: success

encryption_config

complex

The Key Vault encryption configuration.

Returned: success

key_vault_meta_info

complex

The Key Vault information for connecting to user managed encryption keys.

Returned: success

encryption_key_name

string

The name of the user managed encryption key.

Returned: always

Sample: "KeyName"

encryption_key_version

string

The version of the user managed encryption key.

Returned: always

Sample: "86a1e3b7406f45afa0d54e21eff47e39"

key_vault_resource_id

string

The resource identifier for the user managed Key Vault being used to encrypt.

Returned: always

Sample: "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/tstkv"

type

string

The type of encryption configuration being used.

Returned: always

Sample: "ServiceManaged"

encryption_provisioning_state

string

The current state of encryption provisioning for this Data Lake Store account.

Returned: success

Sample: "Succeeded"

encryption_state

string

The current state of encryption for this Data Lake Store account.

Returned: always

Sample: "Enabled"

endpoint

string

The full CName endpoint for this account.

Returned: always

Sample: "testaccount.azuredatalakestore.net"

firewall_allow_azure_ips

string

The current state of allowing or disallowing IPs originating within Azure through the firewall.

If the firewall is disabled, this is not enforced.

Returned: always

Sample: "Disabled"

firewall_rules

list / elements=string

The list of firewall rules associated with this Data Lake Store account.

Returned: always

end_ip_address

string

The end IP address for the firewall rule.

This can be either ipv4 or ipv6.

Start and End should be in the same protocol.

Returned: always

Sample: "192.168.1.254"

name

string

The resource name.

Returned: always

Sample: "Example Name"

start_ip_address

string

The start IP address for the firewall rule.

This can be either ipv4 or ipv6.

Start and End should be in the same protocol.

Returned: always

Sample: "192.168.1.1"

firewall_state

string

The current state of the IP address firewall for this Data Lake Store account.

Returned: always

Sample: "Enabled"

id

string

The resource identifier.

Returned: always

Sample: "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.DataLakeStore/accounts/testaccount"

identity

complex

The Key Vault encryption identity, if any.

Returned: success

principal_id

string

The principal identifier associated with the encryption.

Returned: success

Sample: "00000000-0000-0000-0000-000000000000"

tenant_id

string

The tenant identifier associated with the encryption.

Returned: success

Sample: "00000000-0000-0000-0000-000000000000"

type

string

The type of encryption being used.

Returned: success

Sample: "SystemAssigned"

last_modified_time

string

The account last modified time.

Returned: always

Sample: "2020-01-01T00:00:00.000000+00:00"

location

string

The resource location.

Returned: always

Sample: "westeurope"

name

string

The resource name.

Returned: always

Sample: "testaccount"

new_tier

string

The commitment tier to use for next month.

Returned: always

Sample: "Consumption"

provisioning_state

string

The provisioning status of the Data Lake Store account.

Returned: always

Sample: "Succeeded"

state

string

The state of the Data Lake Store account.

Returned: always

Sample: "Active"

tags

dictionary

The resource tags.

Returned: always

Sample: {"tag1": "abc"}

trusted_id_provider_state

string

The list of trusted identity providers associated with this Data Lake Store account.

Returned: always

Sample: "Enabled"

trusted_id_providers

list / elements=string

The current state of the trusted identity provider feature for this Data Lake Store account.

Returned: always

id

string

The resource identifier.

Returned: success

id_provider

string

The URL of this trusted identity provider.

Returned: success

name

string

The resource name.

Returned: success

type

string

The resource type.

Returned: success

type

string

The resource type.

Returned: always

Sample: "Microsoft.DataLakeStore/accounts"

virtual_network_rules

list / elements=string

The list of virtual network rules associated with this Data Lake Store account.

Returned: always

name

string

The resource name.

Returned: success

Sample: "Rule Name"

subnet_id

string

The resource identifier for the subnet.

Returned: success

Sample: "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/default"

Authors

  • David Duque Hernández (@next-davidduquehernandez)