Try SpotterManage Azure data lake store
| "added in version" 1.4.0 of azure.azcollection"
Authors: David Duque Hernández (@next-davidduquehernandez)
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections:
- name: azure.azcollection
version: 2.3.0Create, update or delete a data lake store.
- name: Create Azure Data Lake Store
azure_rm_datalakestore:
resource_group: myResourceGroup
name: myDataLakeStore
name:
description:
- The name of the Data Lake Store account.
required: true
type: str
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.
- 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.
type: dict
state:
choices:
- absent
- present
default: present
description:
- State of the data lake store. Use C(present) to create or update a data lake store
and use C(absent) to delete it.
type: str
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
profile:
description:
- Security profile found in ~/.azure/credentials file.
type: str
identity:
choices:
- SystemAssigned
description:
- The Key Vault encryption identity, if any.
type: str
location:
description:
- The resource location.
type: str
log_mode:
description:
- Parent argument.
type: str
log_path:
description:
- Parent argument.
type: str
new_tier:
choices:
- Consumption
- Commitment_1TB
- Commitment_10TB
- Commitment_100TB
- Commitment_500TB
- Commitment_1PB
- Commitment_5PB
description:
- The commitment tier to use for next month.
type: str
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 or Managed Identity
(msi).
- Can also be set via the C(AZURE_CLIENT_ID) environment variable.
type: str
thumbprint:
description:
- The thumbprint of the private key specified in I(x509_certificate_path).
- Use when authenticating with a Service Principal.
- Required if I(x509_certificate_path) is defined.
type: str
version_added: 1.14.0
version_added_collection: azure.azcollection
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
default_group:
description:
- The default owner group for all new folders and files created in the Data Lake Store
account.
type: str
firewall_rules:
description:
- The list of firewall rules associated with this Data Lake Store account.
elements: dict
suboptions:
end_ip_address:
description:
- The end IP address for the firewall rule.
- This can be either ipv4 or ipv6.
- Start and End should be in the same protocol.
required: true
type: str
name:
description:
- The unique name of the firewall rule to create.
required: true
type: str
start_ip_address:
description:
- The start IP address for the firewall rule.
- This can be either ipv4 or ipv6.
- Start and End should be in the same protocol.
required: true
type: str
type: list
firewall_state:
choices:
- Enabled
- Disabled
description:
- The current state of the IP address firewall for this Data Lake Store account.
type: str
resource_group:
aliases:
- resource_group_name
description:
- The name of the Azure resource group to use.
required: true
type: str
subscription_id:
description:
- Your Azure subscription Id.
type: str
encryption_state:
choices:
- Enabled
- Disabled
description:
- The current state of encryption for this Data Lake Store account.
type: str
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
encryption_config:
description:
- The Key Vault encryption configuration.
suboptions:
key_vault_meta_info:
description:
- The Key Vault information for connecting to user managed encryption keys.
suboptions:
encryption_key_name:
description:
- The name of the user managed encryption key.
required: true
type: str
encryption_key_version:
description:
- The version of the user managed encryption key.
required: true
type: str
key_vault_resource_id:
description:
- The resource identifier for the user managed Key Vault being used to encrypt.
required: true
type: str
type: dict
type:
choices:
- UserManaged
- ServiceManaged
description:
- The type of encryption configuration being used.
required: true
type: str
type: dict
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
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
virtual_network_rules:
description:
- The list of virtual network rules associated with this Data Lake Store account.
elements: dict
suboptions:
name:
description:
- The unique name of the virtual network rule to create.
required: true
type: str
subnet_id:
description:
- The resource identifier for the subnet.
required: true
type: str
type: list
x509_certificate_path:
description:
- 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.
type: path
version_added: 1.14.0
version_added_collection: azure.azcollection
firewall_allow_azure_ips:
choices:
- Enabled
- Disabled
description:
- The current state of allowing or disallowing IPs originating within Azure through
the firewall.
- If the firewall is disabled, this is not enforced.
type: str
disable_instance_discovery:
default: false
description:
- Determines whether or not instance discovery is performed when attempting to authenticate.
Setting this to true will completely disable both instance discovery and authority
validation. This functionality is intended for use in scenarios where the metadata
endpoint cannot be reached such as in private clouds or Azure Stack. The process
of instance discovery entails retrieving authority metadata from https://login.microsoft.com/
to validate the authority. By setting this to **True**, the validation of the authority
is disabled. As a result, it is crucial to ensure that the configured authority
host is valid and trustworthy.
- Set via credential file profile or the C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment
variable.
type: bool
version_added: 2.3.0
version_added_collection: azure.azcollection
state:
contains:
account_id:
description:
- The unique identifier associated with this Data Lake Store account.
returned: always
sample: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
type: str
creation_time:
description:
- The account creation time.
returned: always
sample: '2020-01-01T00:00:00.000000+00:00'
type: str
current_tier:
description:
- The commitment tier in use for the current month.
returned: always
sample: Consumption
type: str
default_group:
description:
- The default owner group for all new folders and files created in the Data
Lake Store account.
sample: null
type: str
encryption_config:
contains:
key_vault_meta_info:
contains:
encryption_key_name:
description:
- The name of the user managed encryption key.
returned: always
sample: KeyName
type: str
encryption_key_version:
description:
- The version of the user managed encryption key.
returned: always
sample: 86a1e3b7406f45afa0d54e21eff47e39
type: str
key_vault_resource_id:
description:
- 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: str
description:
- The Key Vault information for connecting to user managed encryption keys.
type: complex
type:
description:
- The type of encryption configuration being used.
returned: always
sample: ServiceManaged
type: str
description:
- The Key Vault encryption configuration.
type: complex
encryption_provisioning_state:
description:
- The current state of encryption provisioning for this Data Lake Store account.
sample: Succeeded
type: str
encryption_state:
description:
- The current state of encryption for this Data Lake Store account.
returned: always
sample: Enabled
type: str
endpoint:
description:
- The full CName endpoint for this account.
returned: always
sample: testaccount.azuredatalakestore.net
type: str
firewall_allow_azure_ips:
description:
- 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
type: str
firewall_rules:
contains:
end_ip_address:
description:
- 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
type: str
name:
description:
- The resource name.
returned: always
sample: Example Name
type: str
start_ip_address:
description:
- 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
type: str
description:
- The list of firewall rules associated with this Data Lake Store account.
returned: always
type: list
firewall_state:
description:
- The current state of the IP address firewall for this Data Lake Store account.
returned: always
sample: Enabled
type: str
id:
description:
- The resource identifier.
returned: always
sample: /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.DataLakeStore/accounts/testaccount
type: str
identity:
contains:
principal_id:
description:
- The principal identifier associated with the encryption.
sample: 00000000-0000-0000-0000-000000000000
type: str
tenant_id:
description:
- The tenant identifier associated with the encryption.
sample: 00000000-0000-0000-0000-000000000000
type: str
type:
description:
- The type of encryption being used.
sample: SystemAssigned
type: str
description:
- The Key Vault encryption identity, if any.
type: complex
last_modified_time:
description:
- The account last modified time.
returned: always
sample: '2020-01-01T00:00:00.000000+00:00'
type: str
location:
description:
- The resource location.
returned: always
sample: westeurope
type: str
name:
description:
- The resource name.
returned: always
sample: testaccount
type: str
new_tier:
description:
- The commitment tier to use for next month.
returned: always
sample: Consumption
type: str
provisioning_state:
description:
- The provisioning status of the Data Lake Store account.
returned: always
sample: Succeeded
type: str
state:
description:
- The state of the Data Lake Store account.
returned: always
sample: Active
type: str
tags:
description:
- The resource tags.
returned: always
sample:
tag1: abc
type: dict
trusted_id_provider_state:
description:
- The list of trusted identity providers associated with this Data Lake Store
account.
returned: always
sample: Enabled
type: str
trusted_id_providers:
contains:
id:
description:
- The resource identifier.
type: str
id_provider:
description:
- The URL of this trusted identity provider.
type: str
name:
description:
- The resource name.
type: str
type:
description:
- The resource type.
type: str
description:
- The current state of the trusted identity provider feature for this Data Lake
Store account.
returned: always
type: list
type:
description:
- The resource type.
returned: always
sample: Microsoft.DataLakeStore/accounts
type: str
virtual_network_rules:
contains:
name:
description:
- The resource name.
sample: Rule Name
type: str
subnet_id:
description:
- The resource identifier for the subnet.
sample: /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/default
type: str
description:
- The list of virtual network rules associated with this Data Lake Store account.
returned: always
type: list
description:
- Facts for Azure Data Lake Store created/updated.
returned: always
type: complex