This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

datalake¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.datalake.AnalyticsAccount(resource_name, opts=None, default_store_account_name=None, location=None, name=None, resource_group_name=None, tags=None, tier=None, __props__=None, __name__=None, __opts__=None)¶

Manages an Azure Data Lake Analytics Account.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
example_store = azure.datalake.Store("exampleStore",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location)
example_analytics_account = azure.datalake.AnalyticsAccount("exampleAnalyticsAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    default_store_account_name=example_store.name)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
default_store_account_name (pulumi.Input[str]) – Specifies the data lake store to use by default. Changing this forces a new resource to be created.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Data Lake Analytics Account. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Lake Analytics Account.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
tier (pulumi.Input[str]) – The monthly commitment tier for Data Lake Analytics Account. Accepted values are Consumption, Commitment_100000AUHours, Commitment_10000AUHours, Commitment_1000AUHours, Commitment_100AUHours, Commitment_500000AUHours, Commitment_50000AUHours, Commitment_5000AUHours, or Commitment_500AUHours.

default_store_account_name: pulumi.Output[str] = None¶: Specifies the data lake store to use by default. Changing this forces a new resource to be created.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Data Lake Analytics Account. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Data Lake Analytics Account.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

tier: pulumi.Output[str] = None¶: The monthly commitment tier for Data Lake Analytics Account. Accepted values are Consumption, Commitment_100000AUHours, Commitment_10000AUHours, Commitment_1000AUHours, Commitment_100AUHours, Commitment_500000AUHours, Commitment_50000AUHours, Commitment_5000AUHours, or Commitment_500AUHours.

static get(resource_name, id, opts=None, default_store_account_name=None, location=None, name=None, resource_group_name=None, tags=None, tier=None)¶

Get an existing AnalyticsAccount resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
default_store_account_name (pulumi.Input[str]) – Specifies the data lake store to use by default. Changing this forces a new resource to be created.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Data Lake Analytics Account. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Lake Analytics Account.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
tier (pulumi.Input[str]) – The monthly commitment tier for Data Lake Analytics Account. Accepted values are Consumption, Commitment_100000AUHours, Commitment_10000AUHours, Commitment_1000AUHours, Commitment_100AUHours, Commitment_500000AUHours, Commitment_50000AUHours, Commitment_5000AUHours, or Commitment_500AUHours.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.datalake.AnalyticsFirewallRule(resource_name, opts=None, account_name=None, end_ip_address=None, name=None, resource_group_name=None, start_ip_address=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Azure Data Lake Analytics Firewall Rule.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
example_store = azure.datalake.Store("exampleStore",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location)
example_analytics_account = azure.datalake.AnalyticsAccount("exampleAnalyticsAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    default_store_account_name=example_store.name)
example_analytics_firewall_rule = azure.datalake.AnalyticsFirewallRule("exampleAnalyticsFirewallRule",
    account_name=azurerm_data_lake_analytics["example"]["name"],
    resource_group_name=example_resource_group.name,
    start_ip_address="1.2.3.4",
    end_ip_address="2.3.4.5")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
account_name (pulumi.Input[str]) – Specifies the name of the Data Lake Analytics for which the Firewall Rule should take effect.
end_ip_address (pulumi.Input[str]) – The End IP Address for the firewall rule.
name (pulumi.Input[str]) – Specifies the name of the Data Lake Analytics. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Lake Analytics.
start_ip_address (pulumi.Input[str]) – The Start IP address for the firewall rule.

account_name: pulumi.Output[str] = None¶: Specifies the name of the Data Lake Analytics for which the Firewall Rule should take effect.

end_ip_address: pulumi.Output[str] = None¶: The End IP Address for the firewall rule.

name: pulumi.Output[str] = None¶: Specifies the name of the Data Lake Analytics. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Data Lake Analytics.

start_ip_address: pulumi.Output[str] = None¶: The Start IP address for the firewall rule.

static get(resource_name, id, opts=None, account_name=None, end_ip_address=None, name=None, resource_group_name=None, start_ip_address=None)¶

Get an existing AnalyticsFirewallRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
account_name (pulumi.Input[str]) – Specifies the name of the Data Lake Analytics for which the Firewall Rule should take effect.
end_ip_address (pulumi.Input[str]) – The End IP Address for the firewall rule.
name (pulumi.Input[str]) – Specifies the name of the Data Lake Analytics. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Lake Analytics.
start_ip_address (pulumi.Input[str]) – The Start IP address for the firewall rule.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.datalake.AwaitableGetStoreResult(encryption_state=None, encryption_type=None, firewall_allow_azure_ips=None, firewall_state=None, id=None, location=None, name=None, resource_group_name=None, tags=None, tier=None)¶

class pulumi_azure.datalake.GetStoreResult(encryption_state=None, encryption_type=None, firewall_allow_azure_ips=None, firewall_state=None, id=None, location=None, name=None, resource_group_name=None, tags=None, tier=None)¶

A collection of values returned by getStore.

encryption_state = None¶: the Encryption State of this Data Lake Store Account, such as Enabled or Disabled.

encryption_type = None¶: the Encryption Type used for this Data Lake Store Account.

firewall_allow_azure_ips = None¶: are Azure Service IP’s allowed through the firewall?

firewall_state = None¶: the state of the firewall, such as Enabled or Disabled.

id = None¶: The provider-assigned unique ID for this managed resource.

tags = None¶: A mapping of tags to assign to the Data Lake Store.

tier = None¶: Current monthly commitment tier for the account.

class pulumi_azure.datalake.Store(resource_name, opts=None, encryption_state=None, encryption_type=None, firewall_allow_azure_ips=None, firewall_state=None, location=None, name=None, resource_group_name=None, tags=None, tier=None, __props__=None, __name__=None, __opts__=None)¶

Manages an Azure Data Lake Store.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
example_store = azure.datalake.Store("exampleStore",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    encryption_state="Enabled",
    encryption_type="ServiceManaged")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
encryption_state (pulumi.Input[str]) – Is Encryption enabled on this Data Lake Store Account? Possible values are Enabled or Disabled. Defaults to Enabled.
encryption_type (pulumi.Input[str]) – The Encryption Type used for this Data Lake Store Account. Currently can be set to ServiceManaged when encryption_state is Enabled - and must be a blank string when it’s Disabled.
firewall_allow_azure_ips (pulumi.Input[str]) – are Azure Service IP’s allowed through the firewall? Possible values are Enabled and Disabled. Defaults to Enabled.
firewall_state (pulumi.Input[str]) – the state of the Firewall. Possible values are Enabled and Disabled. Defaults to Enabled.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Data Lake Store. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Lake Store.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
tier (pulumi.Input[str]) – The monthly commitment tier for Data Lake Store. Accepted values are Consumption, Commitment_1TB, Commitment_10TB, Commitment_100TB, Commitment_500TB, Commitment_1PB or Commitment_5PB.

encryption_state: pulumi.Output[str] = None¶: Is Encryption enabled on this Data Lake Store Account? Possible values are Enabled or Disabled. Defaults to Enabled.

encryption_type: pulumi.Output[str] = None¶: The Encryption Type used for this Data Lake Store Account. Currently can be set to ServiceManaged when encryption_state is Enabled - and must be a blank string when it’s Disabled.

endpoint: pulumi.Output[str] = None¶: The Endpoint for the Data Lake Store.

firewall_allow_azure_ips: pulumi.Output[str] = None¶: are Azure Service IP’s allowed through the firewall? Possible values are Enabled and Disabled. Defaults to Enabled.

firewall_state: pulumi.Output[str] = None¶: the state of the Firewall. Possible values are Enabled and Disabled. Defaults to Enabled.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Data Lake Store. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Data Lake Store.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

tier: pulumi.Output[str] = None¶: The monthly commitment tier for Data Lake Store. Accepted values are Consumption, Commitment_1TB, Commitment_10TB, Commitment_100TB, Commitment_500TB, Commitment_1PB or Commitment_5PB.

static get(resource_name, id, opts=None, encryption_state=None, encryption_type=None, endpoint=None, firewall_allow_azure_ips=None, firewall_state=None, location=None, name=None, resource_group_name=None, tags=None, tier=None)¶

Get an existing Store resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
encryption_state (pulumi.Input[str]) – Is Encryption enabled on this Data Lake Store Account? Possible values are Enabled or Disabled. Defaults to Enabled.
encryption_type (pulumi.Input[str]) – The Encryption Type used for this Data Lake Store Account. Currently can be set to ServiceManaged when encryption_state is Enabled - and must be a blank string when it’s Disabled.
endpoint (pulumi.Input[str]) – The Endpoint for the Data Lake Store.
firewall_allow_azure_ips (pulumi.Input[str]) – are Azure Service IP’s allowed through the firewall? Possible values are Enabled and Disabled. Defaults to Enabled.
firewall_state (pulumi.Input[str]) – the state of the Firewall. Possible values are Enabled and Disabled. Defaults to Enabled.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Data Lake Store. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Lake Store.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
tier (pulumi.Input[str]) – The monthly commitment tier for Data Lake Store. Accepted values are Consumption, Commitment_1TB, Commitment_10TB, Commitment_100TB, Commitment_500TB, Commitment_1PB or Commitment_5PB.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.datalake.StoreFile(resource_name, opts=None, account_name=None, local_file_path=None, remote_file_path=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Azure Data Lake Store File.

Note: If you want to change the data in the remote file without changing the local_file_path, then taint the resource so the datalake.StoreFile gets recreated with the new data.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
example_store = azure.datalake.Store("exampleStore",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location)
example_store_file = azure.datalake.StoreFile("exampleStoreFile",
    resource_group_name=example_resource_group.name,
    local_file_path="/path/to/local/file",
    remote_file_path="/path/created/for/remote/file")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
account_name (pulumi.Input[str]) – Specifies the name of the Data Lake Store for which the File should created.
local_file_path (pulumi.Input[str]) – The path to the local file to be added to the Data Lake Store.
remote_file_path (pulumi.Input[str]) – The path created for the file on the Data Lake Store.

account_name: pulumi.Output[str] = None¶: Specifies the name of the Data Lake Store for which the File should created.

local_file_path: pulumi.Output[str] = None¶: The path to the local file to be added to the Data Lake Store.

remote_file_path: pulumi.Output[str] = None¶: The path created for the file on the Data Lake Store.

static get(resource_name, id, opts=None, account_name=None, local_file_path=None, remote_file_path=None)¶

Get an existing StoreFile resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
account_name (pulumi.Input[str]) – Specifies the name of the Data Lake Store for which the File should created.
local_file_path (pulumi.Input[str]) – The path to the local file to be added to the Data Lake Store.
remote_file_path (pulumi.Input[str]) – The path created for the file on the Data Lake Store.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.datalake.StoreFirewallRule(resource_name, opts=None, account_name=None, end_ip_address=None, name=None, resource_group_name=None, start_ip_address=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Azure Data Lake Store Firewall Rule.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
example_store = azure.datalake.Store("exampleStore",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location)
example_store_firewall_rule = azure.datalake.StoreFirewallRule("exampleStoreFirewallRule",
    account_name=example_store.name,
    resource_group_name=example_resource_group.name,
    start_ip_address="1.2.3.4",
    end_ip_address="2.3.4.5")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
account_name (pulumi.Input[str]) – Specifies the name of the Data Lake Store for which the Firewall Rule should take effect.
end_ip_address (pulumi.Input[str]) – The End IP Address for the firewall rule.
name (pulumi.Input[str]) – Specifies the name of the Data Lake Store. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Lake Store.
start_ip_address (pulumi.Input[str]) – The Start IP address for the firewall rule.

account_name: pulumi.Output[str] = None¶: Specifies the name of the Data Lake Store for which the Firewall Rule should take effect.

end_ip_address: pulumi.Output[str] = None¶: The End IP Address for the firewall rule.

name: pulumi.Output[str] = None¶: Specifies the name of the Data Lake Store. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Data Lake Store.

start_ip_address: pulumi.Output[str] = None¶: The Start IP address for the firewall rule.

static get(resource_name, id, opts=None, account_name=None, end_ip_address=None, name=None, resource_group_name=None, start_ip_address=None)¶

Get an existing StoreFirewallRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
account_name (pulumi.Input[str]) – Specifies the name of the Data Lake Store for which the Firewall Rule should take effect.
end_ip_address (pulumi.Input[str]) – The End IP Address for the firewall rule.
name (pulumi.Input[str]) – Specifies the name of the Data Lake Store. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Lake Store.
start_ip_address (pulumi.Input[str]) – The Start IP address for the firewall rule.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_azure.datalake.get_store(name=None, resource_group_name=None, opts=None)¶

Use this data source to access information about an existing Data Lake Store.

import pulumi
import pulumi_azure as azure

example = azure.datalake.get_store(name="testdatalake",
    resource_group_name="testdatalake")
pulumi.export("dataLakeStoreId", example.id)

Parameters

name (str) – The name of the Data Lake Store.
resource_group_name (str) – The Name of the Resource Group where the Data Lake Store exists.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

datalake¶

On This Page