1. Packages
  2. Azure Classic
  3. API Docs
  4. datafactory
  5. DatasetAzureBlob

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.datafactory.DatasetAzureBlob

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

    Manages an Azure Blob Dataset inside an Azure Data Factory.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const exampleResourceGroup = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const example = azure.storage.getAccountOutput({
        name: "storageaccountname",
        resourceGroupName: exampleResourceGroup.name,
    });
    const exampleFactory = new azure.datafactory.Factory("example", {
        name: "example",
        location: exampleResourceGroup.location,
        resourceGroupName: exampleResourceGroup.name,
    });
    const exampleLinkedServiceAzureBlobStorage = new azure.datafactory.LinkedServiceAzureBlobStorage("example", {
        name: "example",
        dataFactoryId: exampleFactory.id,
        connectionString: example.apply(example => example.primaryConnectionString),
    });
    const exampleDatasetAzureBlob = new azure.datafactory.DatasetAzureBlob("example", {
        name: "example",
        dataFactoryId: exampleFactory.id,
        linkedServiceName: exampleLinkedServiceAzureBlobStorage.name,
        path: "foo",
        filename: "bar.png",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example_resource_group = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example = azure.storage.get_account_output(name="storageaccountname",
        resource_group_name=example_resource_group.name)
    example_factory = azure.datafactory.Factory("example",
        name="example",
        location=example_resource_group.location,
        resource_group_name=example_resource_group.name)
    example_linked_service_azure_blob_storage = azure.datafactory.LinkedServiceAzureBlobStorage("example",
        name="example",
        data_factory_id=example_factory.id,
        connection_string=example.primary_connection_string)
    example_dataset_azure_blob = azure.datafactory.DatasetAzureBlob("example",
        name="example",
        data_factory_id=example_factory.id,
        linked_service_name=example_linked_service_azure_blob_storage.name,
        path="foo",
        filename="bar.png")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/datafactory"
    	"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, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		example := storage.LookupAccountOutput(ctx, storage.GetAccountOutputArgs{
    			Name:              pulumi.String("storageaccountname"),
    			ResourceGroupName: exampleResourceGroup.Name,
    		}, nil)
    		exampleFactory, err := datafactory.NewFactory(ctx, "example", &datafactory.FactoryArgs{
    			Name:              pulumi.String("example"),
    			Location:          exampleResourceGroup.Location,
    			ResourceGroupName: exampleResourceGroup.Name,
    		})
    		if err != nil {
    			return err
    		}
    		exampleLinkedServiceAzureBlobStorage, err := datafactory.NewLinkedServiceAzureBlobStorage(ctx, "example", &datafactory.LinkedServiceAzureBlobStorageArgs{
    			Name:          pulumi.String("example"),
    			DataFactoryId: exampleFactory.ID(),
    			ConnectionString: example.ApplyT(func(example storage.GetAccountResult) (*string, error) {
    				return &example.PrimaryConnectionString, nil
    			}).(pulumi.StringPtrOutput),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = datafactory.NewDatasetAzureBlob(ctx, "example", &datafactory.DatasetAzureBlobArgs{
    			Name:              pulumi.String("example"),
    			DataFactoryId:     exampleFactory.ID(),
    			LinkedServiceName: exampleLinkedServiceAzureBlobStorage.Name,
    			Path:              pulumi.String("foo"),
    			Filename:          pulumi.String("bar.png"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var example = Azure.Storage.GetAccount.Invoke(new()
        {
            Name = "storageaccountname",
            ResourceGroupName = exampleResourceGroup.Name,
        });
    
        var exampleFactory = new Azure.DataFactory.Factory("example", new()
        {
            Name = "example",
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
        });
    
        var exampleLinkedServiceAzureBlobStorage = new Azure.DataFactory.LinkedServiceAzureBlobStorage("example", new()
        {
            Name = "example",
            DataFactoryId = exampleFactory.Id,
            ConnectionString = example.Apply(getAccountResult => getAccountResult.PrimaryConnectionString),
        });
    
        var exampleDatasetAzureBlob = new Azure.DataFactory.DatasetAzureBlob("example", new()
        {
            Name = "example",
            DataFactoryId = exampleFactory.Id,
            LinkedServiceName = exampleLinkedServiceAzureBlobStorage.Name,
            Path = "foo",
            Filename = "bar.png",
        });
    
    });
    
    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.StorageFunctions;
    import com.pulumi.azure.storage.inputs.GetAccountArgs;
    import com.pulumi.azure.datafactory.Factory;
    import com.pulumi.azure.datafactory.FactoryArgs;
    import com.pulumi.azure.datafactory.LinkedServiceAzureBlobStorage;
    import com.pulumi.azure.datafactory.LinkedServiceAzureBlobStorageArgs;
    import com.pulumi.azure.datafactory.DatasetAzureBlob;
    import com.pulumi.azure.datafactory.DatasetAzureBlobArgs;
    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()
                .name("example-resources")
                .location("West Europe")
                .build());
    
            final var example = StorageFunctions.getAccount(GetAccountArgs.builder()
                .name("storageaccountname")
                .resourceGroupName(exampleResourceGroup.name())
                .build());
    
            var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
                .name("example")
                .location(exampleResourceGroup.location())
                .resourceGroupName(exampleResourceGroup.name())
                .build());
    
            var exampleLinkedServiceAzureBlobStorage = new LinkedServiceAzureBlobStorage("exampleLinkedServiceAzureBlobStorage", LinkedServiceAzureBlobStorageArgs.builder()
                .name("example")
                .dataFactoryId(exampleFactory.id())
                .connectionString(example.applyValue(getAccountResult -> getAccountResult).applyValue(example -> example.applyValue(getAccountResult -> getAccountResult.primaryConnectionString())))
                .build());
    
            var exampleDatasetAzureBlob = new DatasetAzureBlob("exampleDatasetAzureBlob", DatasetAzureBlobArgs.builder()
                .name("example")
                .dataFactoryId(exampleFactory.id())
                .linkedServiceName(exampleLinkedServiceAzureBlobStorage.name())
                .path("foo")
                .filename("bar.png")
                .build());
    
        }
    }
    
    resources:
      exampleResourceGroup:
        type: azure:core:ResourceGroup
        name: example
        properties:
          name: example-resources
          location: West Europe
      exampleFactory:
        type: azure:datafactory:Factory
        name: example
        properties:
          name: example
          location: ${exampleResourceGroup.location}
          resourceGroupName: ${exampleResourceGroup.name}
      exampleLinkedServiceAzureBlobStorage:
        type: azure:datafactory:LinkedServiceAzureBlobStorage
        name: example
        properties:
          name: example
          dataFactoryId: ${exampleFactory.id}
          connectionString: ${example.primaryConnectionString}
      exampleDatasetAzureBlob:
        type: azure:datafactory:DatasetAzureBlob
        name: example
        properties:
          name: example
          dataFactoryId: ${exampleFactory.id}
          linkedServiceName: ${exampleLinkedServiceAzureBlobStorage.name}
          path: foo
          filename: bar.png
    variables:
      example:
        fn::invoke:
          Function: azure:storage:getAccount
          Arguments:
            name: storageaccountname
            resourceGroupName: ${exampleResourceGroup.name}
    

    Create DatasetAzureBlob Resource

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

    Constructor syntax

    new DatasetAzureBlob(name: string, args: DatasetAzureBlobArgs, opts?: CustomResourceOptions);
    @overload
    def DatasetAzureBlob(resource_name: str,
                         args: DatasetAzureBlobArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def DatasetAzureBlob(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         data_factory_id: Optional[str] = None,
                         linked_service_name: Optional[str] = None,
                         filename: Optional[str] = None,
                         description: Optional[str] = None,
                         dynamic_filename_enabled: Optional[bool] = None,
                         dynamic_path_enabled: Optional[bool] = None,
                         additional_properties: Optional[Mapping[str, str]] = None,
                         folder: Optional[str] = None,
                         annotations: Optional[Sequence[str]] = None,
                         name: Optional[str] = None,
                         parameters: Optional[Mapping[str, str]] = None,
                         path: Optional[str] = None,
                         schema_columns: Optional[Sequence[DatasetAzureBlobSchemaColumnArgs]] = None)
    func NewDatasetAzureBlob(ctx *Context, name string, args DatasetAzureBlobArgs, opts ...ResourceOption) (*DatasetAzureBlob, error)
    public DatasetAzureBlob(string name, DatasetAzureBlobArgs args, CustomResourceOptions? opts = null)
    public DatasetAzureBlob(String name, DatasetAzureBlobArgs args)
    public DatasetAzureBlob(String name, DatasetAzureBlobArgs args, CustomResourceOptions options)
    
    type: azure:datafactory:DatasetAzureBlob
    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 DatasetAzureBlobArgs
    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 DatasetAzureBlobArgs
    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 DatasetAzureBlobArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatasetAzureBlobArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatasetAzureBlobArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var datasetAzureBlobResource = new Azure.DataFactory.DatasetAzureBlob("datasetAzureBlobResource", new()
    {
        DataFactoryId = "string",
        LinkedServiceName = "string",
        Filename = "string",
        Description = "string",
        DynamicFilenameEnabled = false,
        DynamicPathEnabled = false,
        AdditionalProperties = 
        {
            { "string", "string" },
        },
        Folder = "string",
        Annotations = new[]
        {
            "string",
        },
        Name = "string",
        Parameters = 
        {
            { "string", "string" },
        },
        Path = "string",
        SchemaColumns = new[]
        {
            new Azure.DataFactory.Inputs.DatasetAzureBlobSchemaColumnArgs
            {
                Name = "string",
                Description = "string",
                Type = "string",
            },
        },
    });
    
    example, err := datafactory.NewDatasetAzureBlob(ctx, "datasetAzureBlobResource", &datafactory.DatasetAzureBlobArgs{
    	DataFactoryId:          pulumi.String("string"),
    	LinkedServiceName:      pulumi.String("string"),
    	Filename:               pulumi.String("string"),
    	Description:            pulumi.String("string"),
    	DynamicFilenameEnabled: pulumi.Bool(false),
    	DynamicPathEnabled:     pulumi.Bool(false),
    	AdditionalProperties: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Folder: pulumi.String("string"),
    	Annotations: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    	Parameters: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Path: pulumi.String("string"),
    	SchemaColumns: datafactory.DatasetAzureBlobSchemaColumnArray{
    		&datafactory.DatasetAzureBlobSchemaColumnArgs{
    			Name:        pulumi.String("string"),
    			Description: pulumi.String("string"),
    			Type:        pulumi.String("string"),
    		},
    	},
    })
    
    var datasetAzureBlobResource = new DatasetAzureBlob("datasetAzureBlobResource", DatasetAzureBlobArgs.builder()
        .dataFactoryId("string")
        .linkedServiceName("string")
        .filename("string")
        .description("string")
        .dynamicFilenameEnabled(false)
        .dynamicPathEnabled(false)
        .additionalProperties(Map.of("string", "string"))
        .folder("string")
        .annotations("string")
        .name("string")
        .parameters(Map.of("string", "string"))
        .path("string")
        .schemaColumns(DatasetAzureBlobSchemaColumnArgs.builder()
            .name("string")
            .description("string")
            .type("string")
            .build())
        .build());
    
    dataset_azure_blob_resource = azure.datafactory.DatasetAzureBlob("datasetAzureBlobResource",
        data_factory_id="string",
        linked_service_name="string",
        filename="string",
        description="string",
        dynamic_filename_enabled=False,
        dynamic_path_enabled=False,
        additional_properties={
            "string": "string",
        },
        folder="string",
        annotations=["string"],
        name="string",
        parameters={
            "string": "string",
        },
        path="string",
        schema_columns=[azure.datafactory.DatasetAzureBlobSchemaColumnArgs(
            name="string",
            description="string",
            type="string",
        )])
    
    const datasetAzureBlobResource = new azure.datafactory.DatasetAzureBlob("datasetAzureBlobResource", {
        dataFactoryId: "string",
        linkedServiceName: "string",
        filename: "string",
        description: "string",
        dynamicFilenameEnabled: false,
        dynamicPathEnabled: false,
        additionalProperties: {
            string: "string",
        },
        folder: "string",
        annotations: ["string"],
        name: "string",
        parameters: {
            string: "string",
        },
        path: "string",
        schemaColumns: [{
            name: "string",
            description: "string",
            type: "string",
        }],
    });
    
    type: azure:datafactory:DatasetAzureBlob
    properties:
        additionalProperties:
            string: string
        annotations:
            - string
        dataFactoryId: string
        description: string
        dynamicFilenameEnabled: false
        dynamicPathEnabled: false
        filename: string
        folder: string
        linkedServiceName: string
        name: string
        parameters:
            string: string
        path: string
        schemaColumns:
            - description: string
              name: string
              type: string
    

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

    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    LinkedServiceName string
    The Data Factory Linked Service name in which to associate the Dataset with.
    AdditionalProperties Dictionary<string, string>

    A map of additional properties to associate with the Data Factory Dataset.

    The following supported arguments are specific to Azure Blob Dataset:

    Annotations List<string>
    List of tags that can be used for describing the Data Factory Dataset.
    Description string
    The description for the Data Factory Dataset.
    DynamicFilenameEnabled bool
    Is the filename using dynamic expression, function or system variables? Defaults to false.
    DynamicPathEnabled bool
    Is the path using dynamic expression, function or system variables? Defaults to false.
    Filename string
    The filename of the Azure Blob.
    Folder string
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    Name string
    Specifies the name of the Data Factory Dataset. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    Parameters Dictionary<string, string>
    A map of parameters to associate with the Data Factory Dataset.
    Path string
    The path of the Azure Blob.
    SchemaColumns List<DatasetAzureBlobSchemaColumn>
    A schema_column block as defined below.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    LinkedServiceName string
    The Data Factory Linked Service name in which to associate the Dataset with.
    AdditionalProperties map[string]string

    A map of additional properties to associate with the Data Factory Dataset.

    The following supported arguments are specific to Azure Blob Dataset:

    Annotations []string
    List of tags that can be used for describing the Data Factory Dataset.
    Description string
    The description for the Data Factory Dataset.
    DynamicFilenameEnabled bool
    Is the filename using dynamic expression, function or system variables? Defaults to false.
    DynamicPathEnabled bool
    Is the path using dynamic expression, function or system variables? Defaults to false.
    Filename string
    The filename of the Azure Blob.
    Folder string
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    Name string
    Specifies the name of the Data Factory Dataset. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    Parameters map[string]string
    A map of parameters to associate with the Data Factory Dataset.
    Path string
    The path of the Azure Blob.
    SchemaColumns []DatasetAzureBlobSchemaColumnArgs
    A schema_column block as defined below.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    linkedServiceName String
    The Data Factory Linked Service name in which to associate the Dataset with.
    additionalProperties Map<String,String>

    A map of additional properties to associate with the Data Factory Dataset.

    The following supported arguments are specific to Azure Blob Dataset:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Dataset.
    description String
    The description for the Data Factory Dataset.
    dynamicFilenameEnabled Boolean
    Is the filename using dynamic expression, function or system variables? Defaults to false.
    dynamicPathEnabled Boolean
    Is the path using dynamic expression, function or system variables? Defaults to false.
    filename String
    The filename of the Azure Blob.
    folder String
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    name String
    Specifies the name of the Data Factory Dataset. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    parameters Map<String,String>
    A map of parameters to associate with the Data Factory Dataset.
    path String
    The path of the Azure Blob.
    schemaColumns List<DatasetAzureBlobSchemaColumn>
    A schema_column block as defined below.
    dataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    linkedServiceName string
    The Data Factory Linked Service name in which to associate the Dataset with.
    additionalProperties {[key: string]: string}

    A map of additional properties to associate with the Data Factory Dataset.

    The following supported arguments are specific to Azure Blob Dataset:

    annotations string[]
    List of tags that can be used for describing the Data Factory Dataset.
    description string
    The description for the Data Factory Dataset.
    dynamicFilenameEnabled boolean
    Is the filename using dynamic expression, function or system variables? Defaults to false.
    dynamicPathEnabled boolean
    Is the path using dynamic expression, function or system variables? Defaults to false.
    filename string
    The filename of the Azure Blob.
    folder string
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    name string
    Specifies the name of the Data Factory Dataset. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    parameters {[key: string]: string}
    A map of parameters to associate with the Data Factory Dataset.
    path string
    The path of the Azure Blob.
    schemaColumns DatasetAzureBlobSchemaColumn[]
    A schema_column block as defined below.
    data_factory_id str
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    linked_service_name str
    The Data Factory Linked Service name in which to associate the Dataset with.
    additional_properties Mapping[str, str]

    A map of additional properties to associate with the Data Factory Dataset.

    The following supported arguments are specific to Azure Blob Dataset:

    annotations Sequence[str]
    List of tags that can be used for describing the Data Factory Dataset.
    description str
    The description for the Data Factory Dataset.
    dynamic_filename_enabled bool
    Is the filename using dynamic expression, function or system variables? Defaults to false.
    dynamic_path_enabled bool
    Is the path using dynamic expression, function or system variables? Defaults to false.
    filename str
    The filename of the Azure Blob.
    folder str
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    name str
    Specifies the name of the Data Factory Dataset. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    parameters Mapping[str, str]
    A map of parameters to associate with the Data Factory Dataset.
    path str
    The path of the Azure Blob.
    schema_columns Sequence[DatasetAzureBlobSchemaColumnArgs]
    A schema_column block as defined below.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    linkedServiceName String
    The Data Factory Linked Service name in which to associate the Dataset with.
    additionalProperties Map<String>

    A map of additional properties to associate with the Data Factory Dataset.

    The following supported arguments are specific to Azure Blob Dataset:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Dataset.
    description String
    The description for the Data Factory Dataset.
    dynamicFilenameEnabled Boolean
    Is the filename using dynamic expression, function or system variables? Defaults to false.
    dynamicPathEnabled Boolean
    Is the path using dynamic expression, function or system variables? Defaults to false.
    filename String
    The filename of the Azure Blob.
    folder String
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    name String
    Specifies the name of the Data Factory Dataset. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    parameters Map<String>
    A map of parameters to associate with the Data Factory Dataset.
    path String
    The path of the Azure Blob.
    schemaColumns List<Property Map>
    A schema_column block as defined below.

    Outputs

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

    Get an existing DatasetAzureBlob 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?: DatasetAzureBlobState, opts?: CustomResourceOptions): DatasetAzureBlob
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            additional_properties: Optional[Mapping[str, str]] = None,
            annotations: Optional[Sequence[str]] = None,
            data_factory_id: Optional[str] = None,
            description: Optional[str] = None,
            dynamic_filename_enabled: Optional[bool] = None,
            dynamic_path_enabled: Optional[bool] = None,
            filename: Optional[str] = None,
            folder: Optional[str] = None,
            linked_service_name: Optional[str] = None,
            name: Optional[str] = None,
            parameters: Optional[Mapping[str, str]] = None,
            path: Optional[str] = None,
            schema_columns: Optional[Sequence[DatasetAzureBlobSchemaColumnArgs]] = None) -> DatasetAzureBlob
    func GetDatasetAzureBlob(ctx *Context, name string, id IDInput, state *DatasetAzureBlobState, opts ...ResourceOption) (*DatasetAzureBlob, error)
    public static DatasetAzureBlob Get(string name, Input<string> id, DatasetAzureBlobState? state, CustomResourceOptions? opts = null)
    public static DatasetAzureBlob get(String name, Output<String> id, DatasetAzureBlobState 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:
    AdditionalProperties Dictionary<string, string>

    A map of additional properties to associate with the Data Factory Dataset.

    The following supported arguments are specific to Azure Blob Dataset:

    Annotations List<string>
    List of tags that can be used for describing the Data Factory Dataset.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    Description string
    The description for the Data Factory Dataset.
    DynamicFilenameEnabled bool
    Is the filename using dynamic expression, function or system variables? Defaults to false.
    DynamicPathEnabled bool
    Is the path using dynamic expression, function or system variables? Defaults to false.
    Filename string
    The filename of the Azure Blob.
    Folder string
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    LinkedServiceName string
    The Data Factory Linked Service name in which to associate the Dataset with.
    Name string
    Specifies the name of the Data Factory Dataset. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    Parameters Dictionary<string, string>
    A map of parameters to associate with the Data Factory Dataset.
    Path string
    The path of the Azure Blob.
    SchemaColumns List<DatasetAzureBlobSchemaColumn>
    A schema_column block as defined below.
    AdditionalProperties map[string]string

    A map of additional properties to associate with the Data Factory Dataset.

    The following supported arguments are specific to Azure Blob Dataset:

    Annotations []string
    List of tags that can be used for describing the Data Factory Dataset.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    Description string
    The description for the Data Factory Dataset.
    DynamicFilenameEnabled bool
    Is the filename using dynamic expression, function or system variables? Defaults to false.
    DynamicPathEnabled bool
    Is the path using dynamic expression, function or system variables? Defaults to false.
    Filename string
    The filename of the Azure Blob.
    Folder string
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    LinkedServiceName string
    The Data Factory Linked Service name in which to associate the Dataset with.
    Name string
    Specifies the name of the Data Factory Dataset. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    Parameters map[string]string
    A map of parameters to associate with the Data Factory Dataset.
    Path string
    The path of the Azure Blob.
    SchemaColumns []DatasetAzureBlobSchemaColumnArgs
    A schema_column block as defined below.
    additionalProperties Map<String,String>

    A map of additional properties to associate with the Data Factory Dataset.

    The following supported arguments are specific to Azure Blob Dataset:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Dataset.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    description String
    The description for the Data Factory Dataset.
    dynamicFilenameEnabled Boolean
    Is the filename using dynamic expression, function or system variables? Defaults to false.
    dynamicPathEnabled Boolean
    Is the path using dynamic expression, function or system variables? Defaults to false.
    filename String
    The filename of the Azure Blob.
    folder String
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    linkedServiceName String
    The Data Factory Linked Service name in which to associate the Dataset with.
    name String
    Specifies the name of the Data Factory Dataset. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    parameters Map<String,String>
    A map of parameters to associate with the Data Factory Dataset.
    path String
    The path of the Azure Blob.
    schemaColumns List<DatasetAzureBlobSchemaColumn>
    A schema_column block as defined below.
    additionalProperties {[key: string]: string}

    A map of additional properties to associate with the Data Factory Dataset.

    The following supported arguments are specific to Azure Blob Dataset:

    annotations string[]
    List of tags that can be used for describing the Data Factory Dataset.
    dataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    description string
    The description for the Data Factory Dataset.
    dynamicFilenameEnabled boolean
    Is the filename using dynamic expression, function or system variables? Defaults to false.
    dynamicPathEnabled boolean
    Is the path using dynamic expression, function or system variables? Defaults to false.
    filename string
    The filename of the Azure Blob.
    folder string
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    linkedServiceName string
    The Data Factory Linked Service name in which to associate the Dataset with.
    name string
    Specifies the name of the Data Factory Dataset. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    parameters {[key: string]: string}
    A map of parameters to associate with the Data Factory Dataset.
    path string
    The path of the Azure Blob.
    schemaColumns DatasetAzureBlobSchemaColumn[]
    A schema_column block as defined below.
    additional_properties Mapping[str, str]

    A map of additional properties to associate with the Data Factory Dataset.

    The following supported arguments are specific to Azure Blob Dataset:

    annotations Sequence[str]
    List of tags that can be used for describing the Data Factory Dataset.
    data_factory_id str
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    description str
    The description for the Data Factory Dataset.
    dynamic_filename_enabled bool
    Is the filename using dynamic expression, function or system variables? Defaults to false.
    dynamic_path_enabled bool
    Is the path using dynamic expression, function or system variables? Defaults to false.
    filename str
    The filename of the Azure Blob.
    folder str
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    linked_service_name str
    The Data Factory Linked Service name in which to associate the Dataset with.
    name str
    Specifies the name of the Data Factory Dataset. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    parameters Mapping[str, str]
    A map of parameters to associate with the Data Factory Dataset.
    path str
    The path of the Azure Blob.
    schema_columns Sequence[DatasetAzureBlobSchemaColumnArgs]
    A schema_column block as defined below.
    additionalProperties Map<String>

    A map of additional properties to associate with the Data Factory Dataset.

    The following supported arguments are specific to Azure Blob Dataset:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Dataset.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    description String
    The description for the Data Factory Dataset.
    dynamicFilenameEnabled Boolean
    Is the filename using dynamic expression, function or system variables? Defaults to false.
    dynamicPathEnabled Boolean
    Is the path using dynamic expression, function or system variables? Defaults to false.
    filename String
    The filename of the Azure Blob.
    folder String
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    linkedServiceName String
    The Data Factory Linked Service name in which to associate the Dataset with.
    name String
    Specifies the name of the Data Factory Dataset. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    parameters Map<String>
    A map of parameters to associate with the Data Factory Dataset.
    path String
    The path of the Azure Blob.
    schemaColumns List<Property Map>
    A schema_column block as defined below.

    Supporting Types

    DatasetAzureBlobSchemaColumn, DatasetAzureBlobSchemaColumnArgs

    Name string
    The name of the column.
    Description string
    The description of the column.
    Type string
    Type of the column. Valid values are Byte, Byte[], Boolean, Date, DateTime,DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Single, String, TimeSpan. Please note these values are case sensitive.
    Name string
    The name of the column.
    Description string
    The description of the column.
    Type string
    Type of the column. Valid values are Byte, Byte[], Boolean, Date, DateTime,DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Single, String, TimeSpan. Please note these values are case sensitive.
    name String
    The name of the column.
    description String
    The description of the column.
    type String
    Type of the column. Valid values are Byte, Byte[], Boolean, Date, DateTime,DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Single, String, TimeSpan. Please note these values are case sensitive.
    name string
    The name of the column.
    description string
    The description of the column.
    type string
    Type of the column. Valid values are Byte, Byte[], Boolean, Date, DateTime,DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Single, String, TimeSpan. Please note these values are case sensitive.
    name str
    The name of the column.
    description str
    The description of the column.
    type str
    Type of the column. Valid values are Byte, Byte[], Boolean, Date, DateTime,DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Single, String, TimeSpan. Please note these values are case sensitive.
    name String
    The name of the column.
    description String
    The description of the column.
    type String
    Type of the column. Valid values are Byte, Byte[], Boolean, Date, DateTime,DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Single, String, TimeSpan. Please note these values are case sensitive.

    Import

    Data Factory Datasets can be imported using the resource id, e.g.

    $ pulumi import azure:datafactory/datasetAzureBlob:DatasetAzureBlob example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/datasets/example
    

    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 Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi