azure.azcollection.azure_rm_datalakestore_info – Get Azure Data Lake Store info

Note

This plugin is part of the azure.azcollection collection (version 1.5.0).

To install it use: ansible-galaxy collection install azure.azcollection.

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

New in version 1.4.0: of azure.azcollection

Synopsis

• Get Azure Data Lake Store info.

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 0.0.1 of azure.azcollection		Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile string added in 0.0.1 of azure.azcollection	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.
auth_source string added in 0.0.1 of azure.azcollection	Choices: auto ← cli credential_file env msi	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.
cert_validation_mode string added in 0.0.1 of azure.azcollection	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 0.0.1 of azure.azcollection	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.
name string		The name of the Data Lake Store account.
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 string		The name of the Azure resource group. aliases: resource_group_name
secret string		Azure client secret. Use when authenticating with a Service Principal.
subscription_id string		Your Azure subscription Id.
tenant string		Azure tenant ID. 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: Get Azure Data Lake Store info from resource group 'myResourceGroup' and name 'myDataLakeStore'
  azure_rm_datalakestore_info:
    resource_group: myResourceGroup
    name: myDataLakeStore

- name: Get Azure Data Lake Store info from resource group 'myResourceGroup'
  azure_rm_datalakestore_info:
    resource_group: myResourceGroup

- name: Get Azure Data Lake Store info
  azure_rm_datalakestore_info:

Return Values

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

Key				Returned	Description
datalake complex				always	A list of dictionaries containing facts for Azure Data Lake Store.
	account_id string			always	The unique identifier associated with this Data Lake Store account. Sample: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
	creation_time string			always	The account creation time. Sample: 2020-01-01T00:00:00.000000+00:00
	current_tier string			success	The commitment tier in use for the current month. Sample: Consumption
	default_group string			success	The default owner group for all new folders and files created in the Data Lake Store account.
	encryption_config complex			success	The Key Vault encryption configuration.
		key_vault_meta_info complex		success	The Key Vault information for connecting to user managed encryption keys.
			encryption_key_name string	always	The name of the user managed encryption key. Sample: KeyName
			encryption_key_version string	always	The version of the user managed encryption key. Sample: 86a1e3b7406f45afa0d54e21eff47e39
			key_vault_resource_id string	always	The resource identifier for the user managed Key Vault being used to encrypt. Sample: /subscriptions/{subscriptionId}/resourceGroups/myRG/providers/Microsoft.KeyVault/vaults/testkv
		type string		always	The type of encryption configuration being used. Sample: ServiceManaged
	encryption_provisioning_state string			success	The current state of encryption provisioning for this Data Lake Store account. Sample: Succeeded
	encryption_state string			success	The current state of encryption for this Data Lake Store account. Sample: Enabled
	endpoint string			always	The full CName endpoint for this account. Sample: testaccount.azuredatalakestore.net
	firewall_allow_azure_ips string			success	The current state of allowing or disallowing IPs originating within Azure through the firewall. Sample: Disabled
	firewall_rules list / elements=string			success	The list of firewall rules associated with this Data Lake Store account.
		end_ip_address string		always	The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. Sample: 192.168.1.254
		name string		always	The resource name. Sample: Example Name
		start_ip_address string		always	The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. Sample: 192.168.1.1
	firewall_state string			success	The current state of the IP address firewall for this Data Lake Store account. Sample: Enabled
	id string			always	The resource identifier. Sample: /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.DataLakeStore/accounts/testaccount
	identity complex			success	The Key Vault encryption identity, if any.
		principal_id string		success	The principal identifier associated with the encryption. Sample: 00000000-0000-0000-0000-000000000000
		tenant_id string		success	The tenant identifier associated with the encryption. Sample: 00000000-0000-0000-0000-000000000000
		type string		success	The type of encryption being used. Sample: SystemAssigned
	last_modified_time string			always	The account last modified time. Sample: 2020-01-01T00:00:00.000000+00:00
	location string			always	The resource location. Sample: westeurope
	name string			always	The resource name. Sample: testaccount
	new_tier string			success	The commitment tier to use for next month. Sample: Consumption
	provisioning_state string			always	The provisioning status of the Data Lake Store account. Sample: Succeeded
	state string			always	The state of the Data Lake Store account. Sample: Active
	tags dictionary			always	The resource tags. Sample: {'tag1': 'abc'}
	trusted_id_provider_state string			success	The list of trusted identity providers associated with this Data Lake Store account. Sample: Enabled
	trusted_id_providers list / elements=string			success	The current state of the trusted identity provider feature for this Data Lake Store account.
		id string		success	The resource identifier.
		id_provider string		success	The URL of this trusted identity provider.
		name string		success	The resource name.
		type string		success	The resource type.
	type string			always	The resource type. Sample: Microsoft.DataLakeStore/accounts
	virtual_network_rules list / elements=string			success	The list of virtual network rules associated with this Data Lake Store account.
		name string		success	The resource name. Sample: Rule Name
		subnet_id string		success	The resource identifier for the subnet. Sample: /subscriptions/{subscriptionId}/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet/subnets/default

Authors

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