1. Packages
  2. Azure Classic
  3. API Docs
  4. datashare
  5. DatasetDataLakeGen2

We recommend using Azure Native.

Azure v6.31.0 published on Monday, Dec 29, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-azure

azure.datashare.DatasetDataLakeGen2

azure logo

We recommend using Azure Native.

Azure v6.31.0 published on Monday, Dec 29, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-azure

    Manages a Data Share Data Lake Gen2 Dataset.

    Create DatasetDataLakeGen2 Resource

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

    Constructor syntax

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

@overload
def DatasetDataLakeGen2(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        file_system_name: Optional[str] = None,
                        share_id: Optional[str] = None,
                        storage_account_id: Optional[str] = None,
                        file_path: Optional[str] = None,
                        folder_path: Optional[str] = None,
                        name: Optional[str] = None)
    func NewDatasetDataLakeGen2(ctx *Context, name string, args DatasetDataLakeGen2Args, opts ...ResourceOption) (*DatasetDataLakeGen2, error)
    public DatasetDataLakeGen2(string name, DatasetDataLakeGen2Args args, CustomResourceOptions? opts = null)
    public DatasetDataLakeGen2(String name, DatasetDataLakeGen2Args args)
public DatasetDataLakeGen2(String name, DatasetDataLakeGen2Args args, CustomResourceOptions options)

    type: azure:datashare:DatasetDataLakeGen2
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 DatasetDataLakeGen2Args
    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 DatasetDataLakeGen2Args
    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 DatasetDataLakeGen2Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatasetDataLakeGen2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatasetDataLakeGen2Args
    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 datasetDataLakeGen2Resource = new Azure.DataShare.DatasetDataLakeGen2("datasetDataLakeGen2Resource", new()
{
    FileSystemName = "string",
    ShareId = "string",
    StorageAccountId = "string",
    FilePath = "string",
    FolderPath = "string",
    Name = "string",
});

    example, err := datashare.NewDatasetDataLakeGen2(ctx, "datasetDataLakeGen2Resource", &datashare.DatasetDataLakeGen2Args{
	FileSystemName:   pulumi.String("string"),
	ShareId:          pulumi.String("string"),
	StorageAccountId: pulumi.String("string"),
	FilePath:         pulumi.String("string"),
	FolderPath:       pulumi.String("string"),
	Name:             pulumi.String("string"),
})

    var datasetDataLakeGen2Resource = new DatasetDataLakeGen2("datasetDataLakeGen2Resource", DatasetDataLakeGen2Args.builder()
    .fileSystemName("string")
    .shareId("string")
    .storageAccountId("string")
    .filePath("string")
    .folderPath("string")
    .name("string")
    .build());

    dataset_data_lake_gen2_resource = azure.datashare.DatasetDataLakeGen2("datasetDataLakeGen2Resource",
    file_system_name="string",
    share_id="string",
    storage_account_id="string",
    file_path="string",
    folder_path="string",
    name="string")

    const datasetDataLakeGen2Resource = new azure.datashare.DatasetDataLakeGen2("datasetDataLakeGen2Resource", {
    fileSystemName: "string",
    shareId: "string",
    storageAccountId: "string",
    filePath: "string",
    folderPath: "string",
    name: "string",
});

    type: azure:datashare:DatasetDataLakeGen2
properties:
    filePath: string
    fileSystemName: string
    folderPath: string
    name: string
    shareId: string
    storageAccountId: string

    DatasetDataLakeGen2 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 DatasetDataLakeGen2 resource accepts the following input properties:

    FileSystemName string
    The name of the data lake file system to be shared with the receiver. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    ShareId string
    The resource ID of the Data Share where this Data Share Data Lake Gen2 Dataset should be created. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    StorageAccountId string
    The resource id of the storage account of the data lake file system to be shared with the receiver. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    FilePath string
    The path of the file in the data lake file system to be shared with the receiver. Conflicts with folder_path Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    FolderPath string
    The folder path in the data lake file system to be shared with the receiver. Conflicts with file_path Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    Name string
    The name which should be used for this Data Share Data Lake Gen2 Dataset. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    FileSystemName string
    The name of the data lake file system to be shared with the receiver. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    ShareId string
    The resource ID of the Data Share where this Data Share Data Lake Gen2 Dataset should be created. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    StorageAccountId string
    The resource id of the storage account of the data lake file system to be shared with the receiver. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    FilePath string
    The path of the file in the data lake file system to be shared with the receiver. Conflicts with folder_path Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    FolderPath string
    The folder path in the data lake file system to be shared with the receiver. Conflicts with file_path Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    Name string
    The name which should be used for this Data Share Data Lake Gen2 Dataset. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    fileSystemName String
    The name of the data lake file system to be shared with the receiver. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    shareId String
    The resource ID of the Data Share where this Data Share Data Lake Gen2 Dataset should be created. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    storageAccountId String
    The resource id of the storage account of the data lake file system to be shared with the receiver. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    filePath String
    The path of the file in the data lake file system to be shared with the receiver. Conflicts with folder_path Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    folderPath String
    The folder path in the data lake file system to be shared with the receiver. Conflicts with file_path Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    name String
    The name which should be used for this Data Share Data Lake Gen2 Dataset. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    fileSystemName string
    The name of the data lake file system to be shared with the receiver. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    shareId string
    The resource ID of the Data Share where this Data Share Data Lake Gen2 Dataset should be created. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    storageAccountId string
    The resource id of the storage account of the data lake file system to be shared with the receiver. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    filePath string
    The path of the file in the data lake file system to be shared with the receiver. Conflicts with folder_path Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    folderPath string
    The folder path in the data lake file system to be shared with the receiver. Conflicts with file_path Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    name string
    The name which should be used for this Data Share Data Lake Gen2 Dataset. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    file_system_name str
    The name of the data lake file system to be shared with the receiver. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    share_id str
    The resource ID of the Data Share where this Data Share Data Lake Gen2 Dataset should be created. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    storage_account_id str
    The resource id of the storage account of the data lake file system to be shared with the receiver. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    file_path str
    The path of the file in the data lake file system to be shared with the receiver. Conflicts with folder_path Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    folder_path str
    The folder path in the data lake file system to be shared with the receiver. Conflicts with file_path Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    name str
    The name which should be used for this Data Share Data Lake Gen2 Dataset. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    fileSystemName String
    The name of the data lake file system to be shared with the receiver. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    shareId String
    The resource ID of the Data Share where this Data Share Data Lake Gen2 Dataset should be created. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    storageAccountId String
    The resource id of the storage account of the data lake file system to be shared with the receiver. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    filePath String
    The path of the file in the data lake file system to be shared with the receiver. Conflicts with folder_path Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    folderPath String
    The folder path in the data lake file system to be shared with the receiver. Conflicts with file_path Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    name String
    The name which should be used for this Data Share Data Lake Gen2 Dataset. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.

    Outputs

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

    DisplayName string
    The name of the Data Share Dataset.
    Id string
    The provider-assigned unique ID for this managed resource.
    DisplayName string
    The name of the Data Share Dataset.
    Id string
    The provider-assigned unique ID for this managed resource.
    displayName String
    The name of the Data Share Dataset.
    id String
    The provider-assigned unique ID for this managed resource.
    displayName string
    The name of the Data Share Dataset.
    id string
    The provider-assigned unique ID for this managed resource.
    display_name str
    The name of the Data Share Dataset.
    id str
    The provider-assigned unique ID for this managed resource.
    displayName String
    The name of the Data Share Dataset.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DatasetDataLakeGen2 Resource

    Get an existing DatasetDataLakeGen2 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?: DatasetDataLakeGen2State, opts?: CustomResourceOptions): DatasetDataLakeGen2
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        display_name: Optional[str] = None,
        file_path: Optional[str] = None,
        file_system_name: Optional[str] = None,
        folder_path: Optional[str] = None,
        name: Optional[str] = None,
        share_id: Optional[str] = None,
        storage_account_id: Optional[str] = None) -> DatasetDataLakeGen2
    func GetDatasetDataLakeGen2(ctx *Context, name string, id IDInput, state *DatasetDataLakeGen2State, opts ...ResourceOption) (*DatasetDataLakeGen2, error)
    public static DatasetDataLakeGen2 Get(string name, Input<string> id, DatasetDataLakeGen2State? state, CustomResourceOptions? opts = null)
    public static DatasetDataLakeGen2 get(String name, Output<String> id, DatasetDataLakeGen2State state, CustomResourceOptions options)
    resources:  _:    type: azure:datashare:DatasetDataLakeGen2    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:
    DisplayName string
    The name of the Data Share Dataset.
    FilePath string
    The path of the file in the data lake file system to be shared with the receiver. Conflicts with folder_path Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    FileSystemName string
    The name of the data lake file system to be shared with the receiver. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    FolderPath string
    The folder path in the data lake file system to be shared with the receiver. Conflicts with file_path Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    Name string
    The name which should be used for this Data Share Data Lake Gen2 Dataset. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    ShareId string
    The resource ID of the Data Share where this Data Share Data Lake Gen2 Dataset should be created. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    StorageAccountId string
    The resource id of the storage account of the data lake file system to be shared with the receiver. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    DisplayName string
    The name of the Data Share Dataset.
    FilePath string
    The path of the file in the data lake file system to be shared with the receiver. Conflicts with folder_path Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    FileSystemName string
    The name of the data lake file system to be shared with the receiver. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    FolderPath string
    The folder path in the data lake file system to be shared with the receiver. Conflicts with file_path Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    Name string
    The name which should be used for this Data Share Data Lake Gen2 Dataset. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    ShareId string
    The resource ID of the Data Share where this Data Share Data Lake Gen2 Dataset should be created. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    StorageAccountId string
    The resource id of the storage account of the data lake file system to be shared with the receiver. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    displayName String
    The name of the Data Share Dataset.
    filePath String
    The path of the file in the data lake file system to be shared with the receiver. Conflicts with folder_path Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    fileSystemName String
    The name of the data lake file system to be shared with the receiver. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    folderPath String
    The folder path in the data lake file system to be shared with the receiver. Conflicts with file_path Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    name String
    The name which should be used for this Data Share Data Lake Gen2 Dataset. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    shareId String
    The resource ID of the Data Share where this Data Share Data Lake Gen2 Dataset should be created. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    storageAccountId String
    The resource id of the storage account of the data lake file system to be shared with the receiver. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    displayName string
    The name of the Data Share Dataset.
    filePath string
    The path of the file in the data lake file system to be shared with the receiver. Conflicts with folder_path Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    fileSystemName string
    The name of the data lake file system to be shared with the receiver. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    folderPath string
    The folder path in the data lake file system to be shared with the receiver. Conflicts with file_path Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    name string
    The name which should be used for this Data Share Data Lake Gen2 Dataset. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    shareId string
    The resource ID of the Data Share where this Data Share Data Lake Gen2 Dataset should be created. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    storageAccountId string
    The resource id of the storage account of the data lake file system to be shared with the receiver. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    display_name str
    The name of the Data Share Dataset.
    file_path str
    The path of the file in the data lake file system to be shared with the receiver. Conflicts with folder_path Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    file_system_name str
    The name of the data lake file system to be shared with the receiver. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    folder_path str
    The folder path in the data lake file system to be shared with the receiver. Conflicts with file_path Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    name str
    The name which should be used for this Data Share Data Lake Gen2 Dataset. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    share_id str
    The resource ID of the Data Share where this Data Share Data Lake Gen2 Dataset should be created. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    storage_account_id str
    The resource id of the storage account of the data lake file system to be shared with the receiver. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    displayName String
    The name of the Data Share Dataset.
    filePath String
    The path of the file in the data lake file system to be shared with the receiver. Conflicts with folder_path Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    fileSystemName String
    The name of the data lake file system to be shared with the receiver. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    folderPath String
    The folder path in the data lake file system to be shared with the receiver. Conflicts with file_path Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    name String
    The name which should be used for this Data Share Data Lake Gen2 Dataset. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    shareId String
    The resource ID of the Data Share where this Data Share Data Lake Gen2 Dataset should be created. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.
    storageAccountId String
    The resource id of the storage account of the data lake file system to be shared with the receiver. Changing this forces a new Data Share Data Lake Gen2 Dataset to be created.

    Import

    Data Share Data Lake Gen2 Datasets can be imported using the resource id, e.g.

    $ pulumi import azure:datashare/datasetDataLakeGen2:DatasetDataLakeGen2 example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.DataShare/accounts/account1/shares/share1/dataSets/dataSet1

    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.

    Azure v6.31.0 published on Monday, Dec 29, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure
      Meet Neo: Your AI Platform Teammate