Docs Packages
  1. Pulumi Registry
  2. Azure Classic
  3. API Docs
  4. storage
  5. DataLakeGen2Filesystem
azure logo
Azure Classic v5.43.0, May 6 23

azure.storage.DataLakeGen2Filesystem

Explore with Pulumi AI

Manages a Data Lake Gen2 File System within an Azure Storage Account.

NOTE: This resource requires some Storage specific roles which are not granted by default. Some of the built-ins roles that can be attributed are Storage Account Contributor, Storage Blob Data Owner, Storage Blob Data Contributor, Storage Blob Data Reader.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleAccount = new Azure.Storage.Account("exampleAccount", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
        AccountTier = "Standard",
        AccountReplicationType = "LRS",
        AccountKind = "StorageV2",
        IsHnsEnabled = true,
    });

    var exampleDataLakeGen2Filesystem = new Azure.Storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", new()
    {
        StorageAccountId = exampleAccount.Id,
        Properties = 
        {
            { "hello", "aGVsbG8=" },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
			ResourceGroupName:      exampleResourceGroup.Name,
			Location:               exampleResourceGroup.Location,
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
			AccountKind:            pulumi.String("StorageV2"),
			IsHnsEnabled:           pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = storage.NewDataLakeGen2Filesystem(ctx, "exampleDataLakeGen2Filesystem", &storage.DataLakeGen2FilesystemArgs{
			StorageAccountId: exampleAccount.ID(),
			Properties: pulumi.StringMap{
				"hello": pulumi.String("aGVsbG8="),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.storage.DataLakeGen2Filesystem;
import com.pulumi.azure.storage.DataLakeGen2FilesystemArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .accountKind("StorageV2")
            .isHnsEnabled("true")
            .build());

        var exampleDataLakeGen2Filesystem = new DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", DataLakeGen2FilesystemArgs.builder()        
            .storageAccountId(exampleAccount.id())
            .properties(Map.of("hello", "aGVsbG8="))
            .build());

    }
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS",
    account_kind="StorageV2",
    is_hns_enabled=True)
example_data_lake_gen2_filesystem = azure.storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem",
    storage_account_id=example_account.id,
    properties={
        "hello": "aGVsbG8=",
    })

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
    accountKind: "StorageV2",
    isHnsEnabled: true,
});
const exampleDataLakeGen2Filesystem = new azure.storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", {
    storageAccountId: exampleAccount.id,
    properties: {
        hello: "aGVsbG8=",
    },
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleAccount:
    type: azure:storage:Account
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      accountTier: Standard
      accountReplicationType: LRS
      accountKind: StorageV2
      isHnsEnabled: 'true'
  exampleDataLakeGen2Filesystem:
    type: azure:storage:DataLakeGen2Filesystem
    properties:
      storageAccountId: ${exampleAccount.id}
      properties:
        hello: aGVsbG8=

Create DataLakeGen2Filesystem Resource

new DataLakeGen2Filesystem(name: string, args: DataLakeGen2FilesystemArgs, opts?: CustomResourceOptions);
@overload
def DataLakeGen2Filesystem(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           aces: Optional[Sequence[DataLakeGen2FilesystemAceArgs]] = None,
                           group: Optional[str] = None,
                           name: Optional[str] = None,
                           owner: Optional[str] = None,
                           properties: Optional[Mapping[str, str]] = None,
                           storage_account_id: Optional[str] = None)
@overload
def DataLakeGen2Filesystem(resource_name: str,
                           args: DataLakeGen2FilesystemArgs,
                           opts: Optional[ResourceOptions] = None)
func NewDataLakeGen2Filesystem(ctx *Context, name string, args DataLakeGen2FilesystemArgs, opts ...ResourceOption) (*DataLakeGen2Filesystem, error)
public DataLakeGen2Filesystem(string name, DataLakeGen2FilesystemArgs args, CustomResourceOptions? opts = null)
public DataLakeGen2Filesystem(String name, DataLakeGen2FilesystemArgs args)
public DataLakeGen2Filesystem(String name, DataLakeGen2FilesystemArgs args, CustomResourceOptions options)

type: azure:storage:DataLakeGen2Filesystem
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DataLakeGen2FilesystemArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args DataLakeGen2FilesystemArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DataLakeGen2FilesystemArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DataLakeGen2FilesystemArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DataLakeGen2FilesystemArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

DataLakeGen2Filesystem Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The DataLakeGen2Filesystem resource accepts the following input properties:

StorageAccountId string

Specifies the ID of the Storage Account in which the Data Lake Gen2 File System should exist. Changing this forces a new resource to be created.

Aces List<DataLakeGen2FilesystemAceArgs>

One or more ace blocks as defined below to specify the entries for the ACL for the path.

Group string

Specifies the Object ID of the Azure Active Directory Group to make the owning group of the root path (i.e. /). Possible values also include $superuser.

Name string

The name of the Data Lake Gen2 File System which should be created within the Storage Account. Must be unique within the storage account the queue is located. Changing this forces a new resource to be created.

Owner string

Specifies the Object ID of the Azure Active Directory User to make the owning user of the root path (i.e. /). Possible values also include $superuser.

Properties Dictionary<string, string>

A mapping of Key to Base64-Encoded Values which should be assigned to this Data Lake Gen2 File System.

StorageAccountId string

Specifies the ID of the Storage Account in which the Data Lake Gen2 File System should exist. Changing this forces a new resource to be created.

Aces []DataLakeGen2FilesystemAceArgs

One or more ace blocks as defined below to specify the entries for the ACL for the path.

Group string

Specifies the Object ID of the Azure Active Directory Group to make the owning group of the root path (i.e. /). Possible values also include $superuser.

Name string

The name of the Data Lake Gen2 File System which should be created within the Storage Account. Must be unique within the storage account the queue is located. Changing this forces a new resource to be created.

Owner string

Specifies the Object ID of the Azure Active Directory User to make the owning user of the root path (i.e. /). Possible values also include $superuser.

Properties map[string]string

A mapping of Key to Base64-Encoded Values which should be assigned to this Data Lake Gen2 File System.

storageAccountId String

Specifies the ID of the Storage Account in which the Data Lake Gen2 File System should exist. Changing this forces a new resource to be created.

aces List<DataLakeGen2FilesystemAceArgs>

One or more ace blocks as defined below to specify the entries for the ACL for the path.

group String

Specifies the Object ID of the Azure Active Directory Group to make the owning group of the root path (i.e. /). Possible values also include $superuser.

name String

The name of the Data Lake Gen2 File System which should be created within the Storage Account. Must be unique within the storage account the queue is located. Changing this forces a new resource to be created.

owner String

Specifies the Object ID of the Azure Active Directory User to make the owning user of the root path (i.e. /). Possible values also include $superuser.

properties Map<String,String>

A mapping of Key to Base64-Encoded Values which should be assigned to this Data Lake Gen2 File System.

storageAccountId string

Specifies the ID of the Storage Account in which the Data Lake Gen2 File System should exist. Changing this forces a new resource to be created.

aces DataLakeGen2FilesystemAceArgs[]

One or more ace blocks as defined below to specify the entries for the ACL for the path.

group string

Specifies the Object ID of the Azure Active Directory Group to make the owning group of the root path (i.e. /). Possible values also include $superuser.

name string

The name of the Data Lake Gen2 File System which should be created within the Storage Account. Must be unique within the storage account the queue is located. Changing this forces a new resource to be created.

owner string

Specifies the Object ID of the Azure Active Directory User to make the owning user of the root path (i.e. /). Possible values also include $superuser.

properties {[key: string]: string}

A mapping of Key to Base64-Encoded Values which should be assigned to this Data Lake Gen2 File System.

storage_account_id str

Specifies the ID of the Storage Account in which the Data Lake Gen2 File System should exist. Changing this forces a new resource to be created.

aces Sequence[DataLakeGen2FilesystemAceArgs]

One or more ace blocks as defined below to specify the entries for the ACL for the path.

group str

Specifies the Object ID of the Azure Active Directory Group to make the owning group of the root path (i.e. /). Possible values also include $superuser.

name str

The name of the Data Lake Gen2 File System which should be created within the Storage Account. Must be unique within the storage account the queue is located. Changing this forces a new resource to be created.

owner str

Specifies the Object ID of the Azure Active Directory User to make the owning user of the root path (i.e. /). Possible values also include $superuser.

properties Mapping[str, str]

A mapping of Key to Base64-Encoded Values which should be assigned to this Data Lake Gen2 File System.

storageAccountId String

Specifies the ID of the Storage Account in which the Data Lake Gen2 File System should exist. Changing this forces a new resource to be created.

aces List<Property Map>

One or more ace blocks as defined below to specify the entries for the ACL for the path.

group String

Specifies the Object ID of the Azure Active Directory Group to make the owning group of the root path (i.e. /). Possible values also include $superuser.

name String

The name of the Data Lake Gen2 File System which should be created within the Storage Account. Must be unique within the storage account the queue is located. Changing this forces a new resource to be created.

owner String

Specifies the Object ID of the Azure Active Directory User to make the owning user of the root path (i.e. /). Possible values also include $superuser.

properties Map<String>

A mapping of Key to Base64-Encoded Values which should be assigned to this Data Lake Gen2 File System.

Outputs

All input properties are implicitly available as output properties. Additionally, the DataLakeGen2Filesystem resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing DataLakeGen2Filesystem Resource

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

public static get(name: string, id: Input<ID>, state?: DataLakeGen2FilesystemState, opts?: CustomResourceOptions): DataLakeGen2Filesystem
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aces: Optional[Sequence[DataLakeGen2FilesystemAceArgs]] = None,
        group: Optional[str] = None,
        name: Optional[str] = None,
        owner: Optional[str] = None,
        properties: Optional[Mapping[str, str]] = None,
        storage_account_id: Optional[str] = None) -> DataLakeGen2Filesystem
func GetDataLakeGen2Filesystem(ctx *Context, name string, id IDInput, state *DataLakeGen2FilesystemState, opts ...ResourceOption) (*DataLakeGen2Filesystem, error)
public static DataLakeGen2Filesystem Get(string name, Input<string> id, DataLakeGen2FilesystemState? state, CustomResourceOptions? opts = null)
public static DataLakeGen2Filesystem get(String name, Output<String> id, DataLakeGen2FilesystemState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Aces List<DataLakeGen2FilesystemAceArgs>

One or more ace blocks as defined below to specify the entries for the ACL for the path.

Group string

Specifies the Object ID of the Azure Active Directory Group to make the owning group of the root path (i.e. /). Possible values also include $superuser.

Name string

The name of the Data Lake Gen2 File System which should be created within the Storage Account. Must be unique within the storage account the queue is located. Changing this forces a new resource to be created.

Owner string

Specifies the Object ID of the Azure Active Directory User to make the owning user of the root path (i.e. /). Possible values also include $superuser.

Properties Dictionary<string, string>

A mapping of Key to Base64-Encoded Values which should be assigned to this Data Lake Gen2 File System.

StorageAccountId string

Specifies the ID of the Storage Account in which the Data Lake Gen2 File System should exist. Changing this forces a new resource to be created.

Aces []DataLakeGen2FilesystemAceArgs

One or more ace blocks as defined below to specify the entries for the ACL for the path.

Group string

Specifies the Object ID of the Azure Active Directory Group to make the owning group of the root path (i.e. /). Possible values also include $superuser.

Name string

The name of the Data Lake Gen2 File System which should be created within the Storage Account. Must be unique within the storage account the queue is located. Changing this forces a new resource to be created.

Owner string

Specifies the Object ID of the Azure Active Directory User to make the owning user of the root path (i.e. /). Possible values also include $superuser.

Properties map[string]string

A mapping of Key to Base64-Encoded Values which should be assigned to this Data Lake Gen2 File System.

StorageAccountId string

Specifies the ID of the Storage Account in which the Data Lake Gen2 File System should exist. Changing this forces a new resource to be created.

aces List<DataLakeGen2FilesystemAceArgs>

One or more ace blocks as defined below to specify the entries for the ACL for the path.

group String

Specifies the Object ID of the Azure Active Directory Group to make the owning group of the root path (i.e. /). Possible values also include $superuser.

name String

The name of the Data Lake Gen2 File System which should be created within the Storage Account. Must be unique within the storage account the queue is located. Changing this forces a new resource to be created.

owner String

Specifies the Object ID of the Azure Active Directory User to make the owning user of the root path (i.e. /). Possible values also include $superuser.

properties Map<String,String>

A mapping of Key to Base64-Encoded Values which should be assigned to this Data Lake Gen2 File System.

storageAccountId String

Specifies the ID of the Storage Account in which the Data Lake Gen2 File System should exist. Changing this forces a new resource to be created.

aces DataLakeGen2FilesystemAceArgs[]

One or more ace blocks as defined below to specify the entries for the ACL for the path.

group string

Specifies the Object ID of the Azure Active Directory Group to make the owning group of the root path (i.e. /). Possible values also include $superuser.

name string

The name of the Data Lake Gen2 File System which should be created within the Storage Account. Must be unique within the storage account the queue is located. Changing this forces a new resource to be created.

owner string

Specifies the Object ID of the Azure Active Directory User to make the owning user of the root path (i.e. /). Possible values also include $superuser.

properties {[key: string]: string}

A mapping of Key to Base64-Encoded Values which should be assigned to this Data Lake Gen2 File System.

storageAccountId string

Specifies the ID of the Storage Account in which the Data Lake Gen2 File System should exist. Changing this forces a new resource to be created.

aces Sequence[DataLakeGen2FilesystemAceArgs]

One or more ace blocks as defined below to specify the entries for the ACL for the path.

group str

Specifies the Object ID of the Azure Active Directory Group to make the owning group of the root path (i.e. /). Possible values also include $superuser.

name str

The name of the Data Lake Gen2 File System which should be created within the Storage Account. Must be unique within the storage account the queue is located. Changing this forces a new resource to be created.

owner str

Specifies the Object ID of the Azure Active Directory User to make the owning user of the root path (i.e. /). Possible values also include $superuser.

properties Mapping[str, str]

A mapping of Key to Base64-Encoded Values which should be assigned to this Data Lake Gen2 File System.

storage_account_id str

Specifies the ID of the Storage Account in which the Data Lake Gen2 File System should exist. Changing this forces a new resource to be created.

aces List<Property Map>

One or more ace blocks as defined below to specify the entries for the ACL for the path.

group String

Specifies the Object ID of the Azure Active Directory Group to make the owning group of the root path (i.e. /). Possible values also include $superuser.

name String

The name of the Data Lake Gen2 File System which should be created within the Storage Account. Must be unique within the storage account the queue is located. Changing this forces a new resource to be created.

owner String

Specifies the Object ID of the Azure Active Directory User to make the owning user of the root path (i.e. /). Possible values also include $superuser.

properties Map<String>

A mapping of Key to Base64-Encoded Values which should be assigned to this Data Lake Gen2 File System.

storageAccountId String

Specifies the ID of the Storage Account in which the Data Lake Gen2 File System should exist. Changing this forces a new resource to be created.

Supporting Types

DataLakeGen2FilesystemAce

Permissions string

Specifies the permissions for the entry in rwx form. For example, rwx gives full permissions but r-- only gives read permissions.

Type string

Specifies the type of entry. Can be user, group, mask or other.

Id string

Specifies the Object ID of the Azure Active Directory User or Group that the entry relates to. Only valid for user or group entries.

Scope string

Specifies whether the ACE represents an access entry or a default entry. Default value is access.

Permissions string

Specifies the permissions for the entry in rwx form. For example, rwx gives full permissions but r-- only gives read permissions.

Type string

Specifies the type of entry. Can be user, group, mask or other.

Id string

Specifies the Object ID of the Azure Active Directory User or Group that the entry relates to. Only valid for user or group entries.

Scope string

Specifies whether the ACE represents an access entry or a default entry. Default value is access.

permissions String

Specifies the permissions for the entry in rwx form. For example, rwx gives full permissions but r-- only gives read permissions.

type String

Specifies the type of entry. Can be user, group, mask or other.

id String

Specifies the Object ID of the Azure Active Directory User or Group that the entry relates to. Only valid for user or group entries.

scope String

Specifies whether the ACE represents an access entry or a default entry. Default value is access.

permissions string

Specifies the permissions for the entry in rwx form. For example, rwx gives full permissions but r-- only gives read permissions.

type string

Specifies the type of entry. Can be user, group, mask or other.

id string

Specifies the Object ID of the Azure Active Directory User or Group that the entry relates to. Only valid for user or group entries.

scope string

Specifies whether the ACE represents an access entry or a default entry. Default value is access.

permissions str

Specifies the permissions for the entry in rwx form. For example, rwx gives full permissions but r-- only gives read permissions.

type str

Specifies the type of entry. Can be user, group, mask or other.

id str

Specifies the Object ID of the Azure Active Directory User or Group that the entry relates to. Only valid for user or group entries.

scope str

Specifies whether the ACE represents an access entry or a default entry. Default value is access.

permissions String

Specifies the permissions for the entry in rwx form. For example, rwx gives full permissions but r-- only gives read permissions.

type String

Specifies the type of entry. Can be user, group, mask or other.

id String

Specifies the Object ID of the Azure Active Directory User or Group that the entry relates to. Only valid for user or group entries.

scope String

Specifies whether the ACE represents an access entry or a default entry. Default value is access.

Import

Data Lake Gen2 File System’s can be imported using the resource id, e.g.

 $ pulumi import azure:storage/dataLakeGen2Filesystem:DataLakeGen2Filesystem queue1 https://account1.dfs.core.windows.net/fileSystem1

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.