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

We recommend using Azure Native.

Azure Classic v5.71.0 published on Tuesday, Apr 9, 2024 by Pulumi

azure.datafactory.DatasetJson

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.71.0 published on Tuesday, Apr 9, 2024 by Pulumi

    Manages an Azure JSON Dataset inside an Azure Data Factory.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleFactory = new azure.datafactory.Factory("example", {
        name: "example",
        location: example.location,
        resourceGroupName: example.name,
    });
    const exampleLinkedServiceWeb = new azure.datafactory.LinkedServiceWeb("example", {
        name: "example",
        dataFactoryId: exampleFactory.id,
        authenticationType: "Anonymous",
        url: "https://www.bing.com",
    });
    const exampleDatasetJson = new azure.datafactory.DatasetJson("example", {
        name: "example",
        dataFactoryId: exampleFactory.id,
        linkedServiceName: exampleLinkedServiceWeb.name,
        httpServerLocation: {
            relativeUrl: "/fizz/buzz/",
            path: "foo/bar/",
            filename: "foo.txt",
        },
        encoding: "UTF-8",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_factory = azure.datafactory.Factory("example",
        name="example",
        location=example.location,
        resource_group_name=example.name)
    example_linked_service_web = azure.datafactory.LinkedServiceWeb("example",
        name="example",
        data_factory_id=example_factory.id,
        authentication_type="Anonymous",
        url="https://www.bing.com")
    example_dataset_json = azure.datafactory.DatasetJson("example",
        name="example",
        data_factory_id=example_factory.id,
        linked_service_name=example_linked_service_web.name,
        http_server_location=azure.datafactory.DatasetJsonHttpServerLocationArgs(
            relative_url="/fizz/buzz/",
            path="foo/bar/",
            filename="foo.txt",
        ),
        encoding="UTF-8")
    
    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/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleFactory, err := datafactory.NewFactory(ctx, "example", &datafactory.FactoryArgs{
    			Name:              pulumi.String("example"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    		})
    		if err != nil {
    			return err
    		}
    		exampleLinkedServiceWeb, err := datafactory.NewLinkedServiceWeb(ctx, "example", &datafactory.LinkedServiceWebArgs{
    			Name:               pulumi.String("example"),
    			DataFactoryId:      exampleFactory.ID(),
    			AuthenticationType: pulumi.String("Anonymous"),
    			Url:                pulumi.String("https://www.bing.com"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = datafactory.NewDatasetJson(ctx, "example", &datafactory.DatasetJsonArgs{
    			Name:              pulumi.String("example"),
    			DataFactoryId:     exampleFactory.ID(),
    			LinkedServiceName: exampleLinkedServiceWeb.Name,
    			HttpServerLocation: &datafactory.DatasetJsonHttpServerLocationArgs{
    				RelativeUrl: pulumi.String("/fizz/buzz/"),
    				Path:        pulumi.String("foo/bar/"),
    				Filename:    pulumi.String("foo.txt"),
    			},
    			Encoding: pulumi.String("UTF-8"),
    		})
    		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 example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleFactory = new Azure.DataFactory.Factory("example", new()
        {
            Name = "example",
            Location = example.Location,
            ResourceGroupName = example.Name,
        });
    
        var exampleLinkedServiceWeb = new Azure.DataFactory.LinkedServiceWeb("example", new()
        {
            Name = "example",
            DataFactoryId = exampleFactory.Id,
            AuthenticationType = "Anonymous",
            Url = "https://www.bing.com",
        });
    
        var exampleDatasetJson = new Azure.DataFactory.DatasetJson("example", new()
        {
            Name = "example",
            DataFactoryId = exampleFactory.Id,
            LinkedServiceName = exampleLinkedServiceWeb.Name,
            HttpServerLocation = new Azure.DataFactory.Inputs.DatasetJsonHttpServerLocationArgs
            {
                RelativeUrl = "/fizz/buzz/",
                Path = "foo/bar/",
                Filename = "foo.txt",
            },
            Encoding = "UTF-8",
        });
    
    });
    
    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.datafactory.Factory;
    import com.pulumi.azure.datafactory.FactoryArgs;
    import com.pulumi.azure.datafactory.LinkedServiceWeb;
    import com.pulumi.azure.datafactory.LinkedServiceWebArgs;
    import com.pulumi.azure.datafactory.DatasetJson;
    import com.pulumi.azure.datafactory.DatasetJsonArgs;
    import com.pulumi.azure.datafactory.inputs.DatasetJsonHttpServerLocationArgs;
    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 example = new ResourceGroup("example", ResourceGroupArgs.builder()        
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()        
                .name("example")
                .location(example.location())
                .resourceGroupName(example.name())
                .build());
    
            var exampleLinkedServiceWeb = new LinkedServiceWeb("exampleLinkedServiceWeb", LinkedServiceWebArgs.builder()        
                .name("example")
                .dataFactoryId(exampleFactory.id())
                .authenticationType("Anonymous")
                .url("https://www.bing.com")
                .build());
    
            var exampleDatasetJson = new DatasetJson("exampleDatasetJson", DatasetJsonArgs.builder()        
                .name("example")
                .dataFactoryId(exampleFactory.id())
                .linkedServiceName(exampleLinkedServiceWeb.name())
                .httpServerLocation(DatasetJsonHttpServerLocationArgs.builder()
                    .relativeUrl("/fizz/buzz/")
                    .path("foo/bar/")
                    .filename("foo.txt")
                    .build())
                .encoding("UTF-8")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleFactory:
        type: azure:datafactory:Factory
        name: example
        properties:
          name: example
          location: ${example.location}
          resourceGroupName: ${example.name}
      exampleLinkedServiceWeb:
        type: azure:datafactory:LinkedServiceWeb
        name: example
        properties:
          name: example
          dataFactoryId: ${exampleFactory.id}
          authenticationType: Anonymous
          url: https://www.bing.com
      exampleDatasetJson:
        type: azure:datafactory:DatasetJson
        name: example
        properties:
          name: example
          dataFactoryId: ${exampleFactory.id}
          linkedServiceName: ${exampleLinkedServiceWeb.name}
          httpServerLocation:
            relativeUrl: /fizz/buzz/
            path: foo/bar/
            filename: foo.txt
          encoding: UTF-8
    

    Create DatasetJson Resource

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

    Constructor syntax

    new DatasetJson(name: string, args: DatasetJsonArgs, opts?: CustomResourceOptions);
    @overload
    def DatasetJson(resource_name: str,
                    args: DatasetJsonArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def DatasetJson(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    data_factory_id: Optional[str] = None,
                    linked_service_name: Optional[str] = None,
                    additional_properties: Optional[Mapping[str, str]] = None,
                    annotations: Optional[Sequence[str]] = None,
                    azure_blob_storage_location: Optional[DatasetJsonAzureBlobStorageLocationArgs] = None,
                    description: Optional[str] = None,
                    encoding: Optional[str] = None,
                    folder: Optional[str] = None,
                    http_server_location: Optional[DatasetJsonHttpServerLocationArgs] = None,
                    name: Optional[str] = None,
                    parameters: Optional[Mapping[str, str]] = None,
                    schema_columns: Optional[Sequence[DatasetJsonSchemaColumnArgs]] = None)
    func NewDatasetJson(ctx *Context, name string, args DatasetJsonArgs, opts ...ResourceOption) (*DatasetJson, error)
    public DatasetJson(string name, DatasetJsonArgs args, CustomResourceOptions? opts = null)
    public DatasetJson(String name, DatasetJsonArgs args)
    public DatasetJson(String name, DatasetJsonArgs args, CustomResourceOptions options)
    
    type: azure:datafactory:DatasetJson
    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 DatasetJsonArgs
    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 DatasetJsonArgs
    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 DatasetJsonArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatasetJsonArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatasetJsonArgs
    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 datasetJsonResource = new Azure.DataFactory.DatasetJson("datasetJsonResource", new()
    {
        DataFactoryId = "string",
        LinkedServiceName = "string",
        AdditionalProperties = 
        {
            { "string", "string" },
        },
        Annotations = new[]
        {
            "string",
        },
        AzureBlobStorageLocation = new Azure.DataFactory.Inputs.DatasetJsonAzureBlobStorageLocationArgs
        {
            Container = "string",
            Filename = "string",
            Path = "string",
            DynamicContainerEnabled = false,
            DynamicFilenameEnabled = false,
            DynamicPathEnabled = false,
        },
        Description = "string",
        Encoding = "string",
        Folder = "string",
        HttpServerLocation = new Azure.DataFactory.Inputs.DatasetJsonHttpServerLocationArgs
        {
            Filename = "string",
            Path = "string",
            RelativeUrl = "string",
            DynamicFilenameEnabled = false,
            DynamicPathEnabled = false,
        },
        Name = "string",
        Parameters = 
        {
            { "string", "string" },
        },
        SchemaColumns = new[]
        {
            new Azure.DataFactory.Inputs.DatasetJsonSchemaColumnArgs
            {
                Name = "string",
                Description = "string",
                Type = "string",
            },
        },
    });
    
    example, err := datafactory.NewDatasetJson(ctx, "datasetJsonResource", &datafactory.DatasetJsonArgs{
    	DataFactoryId:     pulumi.String("string"),
    	LinkedServiceName: pulumi.String("string"),
    	AdditionalProperties: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Annotations: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	AzureBlobStorageLocation: &datafactory.DatasetJsonAzureBlobStorageLocationArgs{
    		Container:               pulumi.String("string"),
    		Filename:                pulumi.String("string"),
    		Path:                    pulumi.String("string"),
    		DynamicContainerEnabled: pulumi.Bool(false),
    		DynamicFilenameEnabled:  pulumi.Bool(false),
    		DynamicPathEnabled:      pulumi.Bool(false),
    	},
    	Description: pulumi.String("string"),
    	Encoding:    pulumi.String("string"),
    	Folder:      pulumi.String("string"),
    	HttpServerLocation: &datafactory.DatasetJsonHttpServerLocationArgs{
    		Filename:               pulumi.String("string"),
    		Path:                   pulumi.String("string"),
    		RelativeUrl:            pulumi.String("string"),
    		DynamicFilenameEnabled: pulumi.Bool(false),
    		DynamicPathEnabled:     pulumi.Bool(false),
    	},
    	Name: pulumi.String("string"),
    	Parameters: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	SchemaColumns: datafactory.DatasetJsonSchemaColumnArray{
    		&datafactory.DatasetJsonSchemaColumnArgs{
    			Name:        pulumi.String("string"),
    			Description: pulumi.String("string"),
    			Type:        pulumi.String("string"),
    		},
    	},
    })
    
    var datasetJsonResource = new DatasetJson("datasetJsonResource", DatasetJsonArgs.builder()        
        .dataFactoryId("string")
        .linkedServiceName("string")
        .additionalProperties(Map.of("string", "string"))
        .annotations("string")
        .azureBlobStorageLocation(DatasetJsonAzureBlobStorageLocationArgs.builder()
            .container("string")
            .filename("string")
            .path("string")
            .dynamicContainerEnabled(false)
            .dynamicFilenameEnabled(false)
            .dynamicPathEnabled(false)
            .build())
        .description("string")
        .encoding("string")
        .folder("string")
        .httpServerLocation(DatasetJsonHttpServerLocationArgs.builder()
            .filename("string")
            .path("string")
            .relativeUrl("string")
            .dynamicFilenameEnabled(false)
            .dynamicPathEnabled(false)
            .build())
        .name("string")
        .parameters(Map.of("string", "string"))
        .schemaColumns(DatasetJsonSchemaColumnArgs.builder()
            .name("string")
            .description("string")
            .type("string")
            .build())
        .build());
    
    dataset_json_resource = azure.datafactory.DatasetJson("datasetJsonResource",
        data_factory_id="string",
        linked_service_name="string",
        additional_properties={
            "string": "string",
        },
        annotations=["string"],
        azure_blob_storage_location=azure.datafactory.DatasetJsonAzureBlobStorageLocationArgs(
            container="string",
            filename="string",
            path="string",
            dynamic_container_enabled=False,
            dynamic_filename_enabled=False,
            dynamic_path_enabled=False,
        ),
        description="string",
        encoding="string",
        folder="string",
        http_server_location=azure.datafactory.DatasetJsonHttpServerLocationArgs(
            filename="string",
            path="string",
            relative_url="string",
            dynamic_filename_enabled=False,
            dynamic_path_enabled=False,
        ),
        name="string",
        parameters={
            "string": "string",
        },
        schema_columns=[azure.datafactory.DatasetJsonSchemaColumnArgs(
            name="string",
            description="string",
            type="string",
        )])
    
    const datasetJsonResource = new azure.datafactory.DatasetJson("datasetJsonResource", {
        dataFactoryId: "string",
        linkedServiceName: "string",
        additionalProperties: {
            string: "string",
        },
        annotations: ["string"],
        azureBlobStorageLocation: {
            container: "string",
            filename: "string",
            path: "string",
            dynamicContainerEnabled: false,
            dynamicFilenameEnabled: false,
            dynamicPathEnabled: false,
        },
        description: "string",
        encoding: "string",
        folder: "string",
        httpServerLocation: {
            filename: "string",
            path: "string",
            relativeUrl: "string",
            dynamicFilenameEnabled: false,
            dynamicPathEnabled: false,
        },
        name: "string",
        parameters: {
            string: "string",
        },
        schemaColumns: [{
            name: "string",
            description: "string",
            type: "string",
        }],
    });
    
    type: azure:datafactory:DatasetJson
    properties:
        additionalProperties:
            string: string
        annotations:
            - string
        azureBlobStorageLocation:
            container: string
            dynamicContainerEnabled: false
            dynamicFilenameEnabled: false
            dynamicPathEnabled: false
            filename: string
            path: string
        dataFactoryId: string
        description: string
        encoding: string
        folder: string
        httpServerLocation:
            dynamicFilenameEnabled: false
            dynamicPathEnabled: false
            filename: string
            path: string
            relativeUrl: string
        linkedServiceName: string
        name: string
        parameters:
            string: string
        schemaColumns:
            - description: string
              name: string
              type: string
    

    DatasetJson 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 DatasetJson 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 JSON Dataset:

    Annotations List<string>
    List of tags that can be used for describing the Data Factory Dataset.
    AzureBlobStorageLocation DatasetJsonAzureBlobStorageLocation

    A azure_blob_storage_location block as defined below.

    The following supported arguments are specific to Delimited Text Dataset:

    Description string
    The description for the Data Factory Dataset.
    Encoding string
    The encoding format for the file.
    Folder string
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    HttpServerLocation DatasetJsonHttpServerLocation
    A http_server_location block as defined below.
    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.
    SchemaColumns List<DatasetJsonSchemaColumn>
    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 JSON Dataset:

    Annotations []string
    List of tags that can be used for describing the Data Factory Dataset.
    AzureBlobStorageLocation DatasetJsonAzureBlobStorageLocationArgs

    A azure_blob_storage_location block as defined below.

    The following supported arguments are specific to Delimited Text Dataset:

    Description string
    The description for the Data Factory Dataset.
    Encoding string
    The encoding format for the file.
    Folder string
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    HttpServerLocation DatasetJsonHttpServerLocationArgs
    A http_server_location block as defined below.
    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.
    SchemaColumns []DatasetJsonSchemaColumnArgs
    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 JSON Dataset:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Dataset.
    azureBlobStorageLocation DatasetJsonAzureBlobStorageLocation

    A azure_blob_storage_location block as defined below.

    The following supported arguments are specific to Delimited Text Dataset:

    description String
    The description for the Data Factory Dataset.
    encoding String
    The encoding format for the file.
    folder String
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    httpServerLocation DatasetJsonHttpServerLocation
    A http_server_location block as defined below.
    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.
    schemaColumns List<DatasetJsonSchemaColumn>
    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 JSON Dataset:

    annotations string[]
    List of tags that can be used for describing the Data Factory Dataset.
    azureBlobStorageLocation DatasetJsonAzureBlobStorageLocation

    A azure_blob_storage_location block as defined below.

    The following supported arguments are specific to Delimited Text Dataset:

    description string
    The description for the Data Factory Dataset.
    encoding string
    The encoding format for the file.
    folder string
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    httpServerLocation DatasetJsonHttpServerLocation
    A http_server_location block as defined below.
    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.
    schemaColumns DatasetJsonSchemaColumn[]
    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 JSON Dataset:

    annotations Sequence[str]
    List of tags that can be used for describing the Data Factory Dataset.
    azure_blob_storage_location DatasetJsonAzureBlobStorageLocationArgs

    A azure_blob_storage_location block as defined below.

    The following supported arguments are specific to Delimited Text Dataset:

    description str
    The description for the Data Factory Dataset.
    encoding str
    The encoding format for the file.
    folder str
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    http_server_location DatasetJsonHttpServerLocationArgs
    A http_server_location block as defined below.
    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.
    schema_columns Sequence[DatasetJsonSchemaColumnArgs]
    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 JSON Dataset:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Dataset.
    azureBlobStorageLocation Property Map

    A azure_blob_storage_location block as defined below.

    The following supported arguments are specific to Delimited Text Dataset:

    description String
    The description for the Data Factory Dataset.
    encoding String
    The encoding format for the file.
    folder String
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    httpServerLocation Property Map
    A http_server_location block as defined below.
    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.
    schemaColumns List<Property Map>
    A schema_column block as defined below.

    Outputs

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

    Get an existing DatasetJson 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?: DatasetJsonState, opts?: CustomResourceOptions): DatasetJson
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            additional_properties: Optional[Mapping[str, str]] = None,
            annotations: Optional[Sequence[str]] = None,
            azure_blob_storage_location: Optional[DatasetJsonAzureBlobStorageLocationArgs] = None,
            data_factory_id: Optional[str] = None,
            description: Optional[str] = None,
            encoding: Optional[str] = None,
            folder: Optional[str] = None,
            http_server_location: Optional[DatasetJsonHttpServerLocationArgs] = None,
            linked_service_name: Optional[str] = None,
            name: Optional[str] = None,
            parameters: Optional[Mapping[str, str]] = None,
            schema_columns: Optional[Sequence[DatasetJsonSchemaColumnArgs]] = None) -> DatasetJson
    func GetDatasetJson(ctx *Context, name string, id IDInput, state *DatasetJsonState, opts ...ResourceOption) (*DatasetJson, error)
    public static DatasetJson Get(string name, Input<string> id, DatasetJsonState? state, CustomResourceOptions? opts = null)
    public static DatasetJson get(String name, Output<String> id, DatasetJsonState 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 JSON Dataset:

    Annotations List<string>
    List of tags that can be used for describing the Data Factory Dataset.
    AzureBlobStorageLocation DatasetJsonAzureBlobStorageLocation

    A azure_blob_storage_location block as defined below.

    The following supported arguments are specific to Delimited Text 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.
    Encoding string
    The encoding format for the file.
    Folder string
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    HttpServerLocation DatasetJsonHttpServerLocation
    A http_server_location block as defined below.
    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.
    SchemaColumns List<DatasetJsonSchemaColumn>
    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 JSON Dataset:

    Annotations []string
    List of tags that can be used for describing the Data Factory Dataset.
    AzureBlobStorageLocation DatasetJsonAzureBlobStorageLocationArgs

    A azure_blob_storage_location block as defined below.

    The following supported arguments are specific to Delimited Text 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.
    Encoding string
    The encoding format for the file.
    Folder string
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    HttpServerLocation DatasetJsonHttpServerLocationArgs
    A http_server_location block as defined below.
    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.
    SchemaColumns []DatasetJsonSchemaColumnArgs
    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 JSON Dataset:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Dataset.
    azureBlobStorageLocation DatasetJsonAzureBlobStorageLocation

    A azure_blob_storage_location block as defined below.

    The following supported arguments are specific to Delimited Text 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.
    encoding String
    The encoding format for the file.
    folder String
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    httpServerLocation DatasetJsonHttpServerLocation
    A http_server_location block as defined below.
    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.
    schemaColumns List<DatasetJsonSchemaColumn>
    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 JSON Dataset:

    annotations string[]
    List of tags that can be used for describing the Data Factory Dataset.
    azureBlobStorageLocation DatasetJsonAzureBlobStorageLocation

    A azure_blob_storage_location block as defined below.

    The following supported arguments are specific to Delimited Text 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.
    encoding string
    The encoding format for the file.
    folder string
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    httpServerLocation DatasetJsonHttpServerLocation
    A http_server_location block as defined below.
    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.
    schemaColumns DatasetJsonSchemaColumn[]
    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 JSON Dataset:

    annotations Sequence[str]
    List of tags that can be used for describing the Data Factory Dataset.
    azure_blob_storage_location DatasetJsonAzureBlobStorageLocationArgs

    A azure_blob_storage_location block as defined below.

    The following supported arguments are specific to Delimited Text 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.
    encoding str
    The encoding format for the file.
    folder str
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    http_server_location DatasetJsonHttpServerLocationArgs
    A http_server_location block as defined below.
    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.
    schema_columns Sequence[DatasetJsonSchemaColumnArgs]
    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 JSON Dataset:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Dataset.
    azureBlobStorageLocation Property Map

    A azure_blob_storage_location block as defined below.

    The following supported arguments are specific to Delimited Text 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.
    encoding String
    The encoding format for the file.
    folder String
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    httpServerLocation Property Map
    A http_server_location block as defined below.
    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.
    schemaColumns List<Property Map>
    A schema_column block as defined below.

    Supporting Types

    DatasetJsonAzureBlobStorageLocation, DatasetJsonAzureBlobStorageLocationArgs

    Container string
    The container on the Azure Blob Storage Account hosting the file.
    Filename string
    The filename of the file on the web server.
    Path string
    The folder path to the file on the web server.
    DynamicContainerEnabled bool
    Is the container using dynamic expression, function or system variables? Defaults to false.
    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.
    Container string
    The container on the Azure Blob Storage Account hosting the file.
    Filename string
    The filename of the file on the web server.
    Path string
    The folder path to the file on the web server.
    DynamicContainerEnabled bool
    Is the container using dynamic expression, function or system variables? Defaults to false.
    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.
    container String
    The container on the Azure Blob Storage Account hosting the file.
    filename String
    The filename of the file on the web server.
    path String
    The folder path to the file on the web server.
    dynamicContainerEnabled Boolean
    Is the container using dynamic expression, function or system variables? Defaults to false.
    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.
    container string
    The container on the Azure Blob Storage Account hosting the file.
    filename string
    The filename of the file on the web server.
    path string
    The folder path to the file on the web server.
    dynamicContainerEnabled boolean
    Is the container using dynamic expression, function or system variables? Defaults to false.
    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.
    container str
    The container on the Azure Blob Storage Account hosting the file.
    filename str
    The filename of the file on the web server.
    path str
    The folder path to the file on the web server.
    dynamic_container_enabled bool
    Is the container using dynamic expression, function or system variables? Defaults to false.
    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.
    container String
    The container on the Azure Blob Storage Account hosting the file.
    filename String
    The filename of the file on the web server.
    path String
    The folder path to the file on the web server.
    dynamicContainerEnabled Boolean
    Is the container using dynamic expression, function or system variables? Defaults to false.
    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.

    DatasetJsonHttpServerLocation, DatasetJsonHttpServerLocationArgs

    Filename string
    The filename of the file on the web server.
    Path string
    The folder path to the file on the web server.
    RelativeUrl string
    The base URL to the web server hosting the file.
    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 file on the web server.
    Path string
    The folder path to the file on the web server.
    RelativeUrl string
    The base URL to the web server hosting the file.
    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 file on the web server.
    path String
    The folder path to the file on the web server.
    relativeUrl String
    The base URL to the web server hosting the file.
    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 file on the web server.
    path string
    The folder path to the file on the web server.
    relativeUrl string
    The base URL to the web server hosting the file.
    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 str
    The filename of the file on the web server.
    path str
    The folder path to the file on the web server.
    relative_url str
    The base URL to the web server hosting the file.
    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 String
    The filename of the file on the web server.
    path String
    The folder path to the file on the web server.
    relativeUrl String
    The base URL to the web server hosting the file.
    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.

    DatasetJsonSchemaColumn, DatasetJsonSchemaColumnArgs

    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/datasetJson:DatasetJson 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.71.0 published on Tuesday, Apr 9, 2024 by Pulumi