1. Packages
  2. Packages
  3. Azure Classic
  4. API Docs
  5. datalake
  6. StoreFile

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.datalake.StoreFile

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    Manages a Azure Data Lake Store File.

    Note: This resoruce manages an Azure Data Lake Storage Gen1, previously known as Azure Data Lake Store.

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

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleStore = new azure.datalake.Store("exampleStore", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
});
const exampleStoreFile = new azure.datalake.StoreFile("exampleStoreFile", {
    resourceGroupName: exampleResourceGroup.name,
    localFilePath: "/path/to/local/file",
    remoteFilePath: "/path/created/for/remote/file",
});

    Example coming soon!

    Example coming soon!

    Create StoreFile Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new StoreFile(name: string, args: StoreFileArgs, opts?: CustomResourceOptions);
    @overload
def StoreFile(resource_name: str,
              args: StoreFileArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def StoreFile(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              account_name: Optional[str] = None,
              local_file_path: Optional[str] = None,
              remote_file_path: Optional[str] = None)
    func NewStoreFile(ctx *Context, name string, args StoreFileArgs, opts ...ResourceOption) (*StoreFile, error)
    public StoreFile(string name, StoreFileArgs args, CustomResourceOptions? opts = null)
    public StoreFile(String name, StoreFileArgs args)
public StoreFile(String name, StoreFileArgs args, CustomResourceOptions options)

    type: azure:datalake:StoreFile
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args StoreFileArgs
    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 StoreFileArgs
    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 StoreFileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StoreFileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StoreFileArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var storeFileResource = new Azure.DataLake.StoreFile("storeFileResource", new()
{
    AccountName = "string",
    LocalFilePath = "string",
    RemoteFilePath = "string",
});

    example, err := datalake.NewStoreFile(ctx, "storeFileResource", &datalake.StoreFileArgs{
	AccountName:    pulumi.String("string"),
	LocalFilePath:  pulumi.String("string"),
	RemoteFilePath: pulumi.String("string"),
})

    var storeFileResource = new StoreFile("storeFileResource", StoreFileArgs.builder()
    .accountName("string")
    .localFilePath("string")
    .remoteFilePath("string")
    .build());

    store_file_resource = azure.datalake.StoreFile("storeFileResource",
    account_name="string",
    local_file_path="string",
    remote_file_path="string")

    const storeFileResource = new azure.datalake.StoreFile("storeFileResource", {
    accountName: "string",
    localFilePath: "string",
    remoteFilePath: "string",
});

    type: azure:datalake:StoreFile
properties:
    accountName: string
    localFilePath: string
    remoteFilePath: string

    StoreFile Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The StoreFile resource accepts the following input properties:

    AccountName string
    Specifies the name of the Data Lake Store for which the File should created.
    LocalFilePath string
    The path to the local file to be added to the Data Lake Store.
    RemoteFilePath string
    The path created for the file on the Data Lake Store.
    AccountName string
    Specifies the name of the Data Lake Store for which the File should created.
    LocalFilePath string
    The path to the local file to be added to the Data Lake Store.
    RemoteFilePath string
    The path created for the file on the Data Lake Store.
    accountName String
    Specifies the name of the Data Lake Store for which the File should created.
    localFilePath String
    The path to the local file to be added to the Data Lake Store.
    remoteFilePath String
    The path created for the file on the Data Lake Store.
    accountName string
    Specifies the name of the Data Lake Store for which the File should created.
    localFilePath string
    The path to the local file to be added to the Data Lake Store.
    remoteFilePath string
    The path created for the file on the Data Lake Store.
    account_name str
    Specifies the name of the Data Lake Store for which the File should created.
    local_file_path str
    The path to the local file to be added to the Data Lake Store.
    remote_file_path str
    The path created for the file on the Data Lake Store.
    accountName String
    Specifies the name of the Data Lake Store for which the File should created.
    localFilePath String
    The path to the local file to be added to the Data Lake Store.
    remoteFilePath String
    The path created for the file on the Data Lake Store.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the StoreFile 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 StoreFile Resource

    Get an existing StoreFile 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?: StoreFileState, opts?: CustomResourceOptions): StoreFile
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_name: Optional[str] = None,
        local_file_path: Optional[str] = None,
        remote_file_path: Optional[str] = None) -> StoreFile
    func GetStoreFile(ctx *Context, name string, id IDInput, state *StoreFileState, opts ...ResourceOption) (*StoreFile, error)
    public static StoreFile Get(string name, Input<string> id, StoreFileState? state, CustomResourceOptions? opts = null)
    public static StoreFile get(String name, Output<String> id, StoreFileState state, CustomResourceOptions options)
    resources:  _:    type: azure:datalake:StoreFile    get:      id: ${id}
    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:
    AccountName string
    Specifies the name of the Data Lake Store for which the File should created.
    LocalFilePath string
    The path to the local file to be added to the Data Lake Store.
    RemoteFilePath string
    The path created for the file on the Data Lake Store.
    AccountName string
    Specifies the name of the Data Lake Store for which the File should created.
    LocalFilePath string
    The path to the local file to be added to the Data Lake Store.
    RemoteFilePath string
    The path created for the file on the Data Lake Store.
    accountName String
    Specifies the name of the Data Lake Store for which the File should created.
    localFilePath String
    The path to the local file to be added to the Data Lake Store.
    remoteFilePath String
    The path created for the file on the Data Lake Store.
    accountName string
    Specifies the name of the Data Lake Store for which the File should created.
    localFilePath string
    The path to the local file to be added to the Data Lake Store.
    remoteFilePath string
    The path created for the file on the Data Lake Store.
    account_name str
    Specifies the name of the Data Lake Store for which the File should created.
    local_file_path str
    The path to the local file to be added to the Data Lake Store.
    remote_file_path str
    The path created for the file on the Data Lake Store.
    accountName String
    Specifies the name of the Data Lake Store for which the File should created.
    localFilePath String
    The path to the local file to be added to the Data Lake Store.
    remoteFilePath String
    The path created for the file on the Data Lake Store.

    Import

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

     $ pulumi import azure:datalake/storeFile:StoreFile example example.azuredatalakestore.net/test/example.txt

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure
      Try Pulumi Cloud free. Your team will thank you.