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

We recommend using Azure Native.

Azure Classic v5.73.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure

azure.datafactory.DatasetBinary

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.73.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Data Factory Binary 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",
    location: "West Europe",
});
const exampleFactory = new azure.datafactory.Factory("example", {
    name: "example",
    location: example.location,
    resourceGroupName: example.name,
});
const exampleLinkedServiceSftp = new azure.datafactory.LinkedServiceSftp("example", {
    name: "example",
    dataFactoryId: exampleFactory.id,
    authenticationType: "Basic",
    host: "http://www.bing.com",
    port: 22,
    username: "foo",
    password: "bar",
});
const exampleDatasetBinary = new azure.datafactory.DatasetBinary("example", {
    name: "example",
    dataFactoryId: exampleFactory.id,
    linkedServiceName: exampleLinkedServiceSftp.name,
    sftpServerLocation: {
        path: "/test/",
        filename: "**",
    },
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example",
    location="West Europe")
example_factory = azure.datafactory.Factory("example",
    name="example",
    location=example.location,
    resource_group_name=example.name)
example_linked_service_sftp = azure.datafactory.LinkedServiceSftp("example",
    name="example",
    data_factory_id=example_factory.id,
    authentication_type="Basic",
    host="http://www.bing.com",
    port=22,
    username="foo",
    password="bar")
example_dataset_binary = azure.datafactory.DatasetBinary("example",
    name="example",
    data_factory_id=example_factory.id,
    linked_service_name=example_linked_service_sftp.name,
    sftp_server_location=azure.datafactory.DatasetBinarySftpServerLocationArgs(
        path="/test/",
        filename="**",
    ))

    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"),
			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
		}
		exampleLinkedServiceSftp, err := datafactory.NewLinkedServiceSftp(ctx, "example", &datafactory.LinkedServiceSftpArgs{
			Name:               pulumi.String("example"),
			DataFactoryId:      exampleFactory.ID(),
			AuthenticationType: pulumi.String("Basic"),
			Host:               pulumi.String("http://www.bing.com"),
			Port:               pulumi.Int(22),
			Username:           pulumi.String("foo"),
			Password:           pulumi.String("bar"),
		})
		if err != nil {
			return err
		}
		_, err = datafactory.NewDatasetBinary(ctx, "example", &datafactory.DatasetBinaryArgs{
			Name:              pulumi.String("example"),
			DataFactoryId:     exampleFactory.ID(),
			LinkedServiceName: exampleLinkedServiceSftp.Name,
			SftpServerLocation: &datafactory.DatasetBinarySftpServerLocationArgs{
				Path:     pulumi.String("/test/"),
				Filename: pulumi.String("**"),
			},
		})
		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",
        Location = "West Europe",
    });

    var exampleFactory = new Azure.DataFactory.Factory("example", new()
    {
        Name = "example",
        Location = example.Location,
        ResourceGroupName = example.Name,
    });

    var exampleLinkedServiceSftp = new Azure.DataFactory.LinkedServiceSftp("example", new()
    {
        Name = "example",
        DataFactoryId = exampleFactory.Id,
        AuthenticationType = "Basic",
        Host = "http://www.bing.com",
        Port = 22,
        Username = "foo",
        Password = "bar",
    });

    var exampleDatasetBinary = new Azure.DataFactory.DatasetBinary("example", new()
    {
        Name = "example",
        DataFactoryId = exampleFactory.Id,
        LinkedServiceName = exampleLinkedServiceSftp.Name,
        SftpServerLocation = new Azure.DataFactory.Inputs.DatasetBinarySftpServerLocationArgs
        {
            Path = "/test/",
            Filename = "**",
        },
    });

});

    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.LinkedServiceSftp;
import com.pulumi.azure.datafactory.LinkedServiceSftpArgs;
import com.pulumi.azure.datafactory.DatasetBinary;
import com.pulumi.azure.datafactory.DatasetBinaryArgs;
import com.pulumi.azure.datafactory.inputs.DatasetBinarySftpServerLocationArgs;
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")
            .location("West Europe")
            .build());

        var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()        
            .name("example")
            .location(example.location())
            .resourceGroupName(example.name())
            .build());

        var exampleLinkedServiceSftp = new LinkedServiceSftp("exampleLinkedServiceSftp", LinkedServiceSftpArgs.builder()        
            .name("example")
            .dataFactoryId(exampleFactory.id())
            .authenticationType("Basic")
            .host("http://www.bing.com")
            .port(22)
            .username("foo")
            .password("bar")
            .build());

        var exampleDatasetBinary = new DatasetBinary("exampleDatasetBinary", DatasetBinaryArgs.builder()        
            .name("example")
            .dataFactoryId(exampleFactory.id())
            .linkedServiceName(exampleLinkedServiceSftp.name())
            .sftpServerLocation(DatasetBinarySftpServerLocationArgs.builder()
                .path("/test/")
                .filename("**")
                .build())
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example
      location: West Europe
  exampleFactory:
    type: azure:datafactory:Factory
    name: example
    properties:
      name: example
      location: ${example.location}
      resourceGroupName: ${example.name}
  exampleLinkedServiceSftp:
    type: azure:datafactory:LinkedServiceSftp
    name: example
    properties:
      name: example
      dataFactoryId: ${exampleFactory.id}
      authenticationType: Basic
      host: http://www.bing.com
      port: 22
      username: foo
      password: bar
  exampleDatasetBinary:
    type: azure:datafactory:DatasetBinary
    name: example
    properties:
      name: example
      dataFactoryId: ${exampleFactory.id}
      linkedServiceName: ${exampleLinkedServiceSftp.name}
      sftpServerLocation:
        path: /test/
        filename: '**'

    Create DatasetBinary Resource

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

    Constructor syntax

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

@overload
def DatasetBinary(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[DatasetBinaryAzureBlobStorageLocationArgs] = None,
                  compression: Optional[DatasetBinaryCompressionArgs] = None,
                  description: Optional[str] = None,
                  folder: Optional[str] = None,
                  http_server_location: Optional[DatasetBinaryHttpServerLocationArgs] = None,
                  name: Optional[str] = None,
                  parameters: Optional[Mapping[str, str]] = None,
                  sftp_server_location: Optional[DatasetBinarySftpServerLocationArgs] = None)
    func NewDatasetBinary(ctx *Context, name string, args DatasetBinaryArgs, opts ...ResourceOption) (*DatasetBinary, error)
    public DatasetBinary(string name, DatasetBinaryArgs args, CustomResourceOptions? opts = null)
    public DatasetBinary(String name, DatasetBinaryArgs args)
public DatasetBinary(String name, DatasetBinaryArgs args, CustomResourceOptions options)

    type: azure:datafactory:DatasetBinary
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 DatasetBinaryArgs
    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 DatasetBinaryArgs
    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 DatasetBinaryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatasetBinaryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatasetBinaryArgs
    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 datasetBinaryResource = new Azure.DataFactory.DatasetBinary("datasetBinaryResource", new()
{
    DataFactoryId = "string",
    LinkedServiceName = "string",
    AdditionalProperties = 
    {
        { "string", "string" },
    },
    Annotations = new[]
    {
        "string",
    },
    AzureBlobStorageLocation = new Azure.DataFactory.Inputs.DatasetBinaryAzureBlobStorageLocationArgs
    {
        Container = "string",
        DynamicContainerEnabled = false,
        DynamicFilenameEnabled = false,
        DynamicPathEnabled = false,
        Filename = "string",
        Path = "string",
    },
    Compression = new Azure.DataFactory.Inputs.DatasetBinaryCompressionArgs
    {
        Type = "string",
        Level = "string",
    },
    Description = "string",
    Folder = "string",
    HttpServerLocation = new Azure.DataFactory.Inputs.DatasetBinaryHttpServerLocationArgs
    {
        Filename = "string",
        Path = "string",
        RelativeUrl = "string",
        DynamicFilenameEnabled = false,
        DynamicPathEnabled = false,
    },
    Name = "string",
    Parameters = 
    {
        { "string", "string" },
    },
    SftpServerLocation = new Azure.DataFactory.Inputs.DatasetBinarySftpServerLocationArgs
    {
        Filename = "string",
        Path = "string",
        DynamicFilenameEnabled = false,
        DynamicPathEnabled = false,
    },
});

    example, err := datafactory.NewDatasetBinary(ctx, "datasetBinaryResource", &datafactory.DatasetBinaryArgs{
	DataFactoryId:     pulumi.String("string"),
	LinkedServiceName: pulumi.String("string"),
	AdditionalProperties: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Annotations: pulumi.StringArray{
		pulumi.String("string"),
	},
	AzureBlobStorageLocation: &datafactory.DatasetBinaryAzureBlobStorageLocationArgs{
		Container:               pulumi.String("string"),
		DynamicContainerEnabled: pulumi.Bool(false),
		DynamicFilenameEnabled:  pulumi.Bool(false),
		DynamicPathEnabled:      pulumi.Bool(false),
		Filename:                pulumi.String("string"),
		Path:                    pulumi.String("string"),
	},
	Compression: &datafactory.DatasetBinaryCompressionArgs{
		Type:  pulumi.String("string"),
		Level: pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Folder:      pulumi.String("string"),
	HttpServerLocation: &datafactory.DatasetBinaryHttpServerLocationArgs{
		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"),
	},
	SftpServerLocation: &datafactory.DatasetBinarySftpServerLocationArgs{
		Filename:               pulumi.String("string"),
		Path:                   pulumi.String("string"),
		DynamicFilenameEnabled: pulumi.Bool(false),
		DynamicPathEnabled:     pulumi.Bool(false),
	},
})

    var datasetBinaryResource = new DatasetBinary("datasetBinaryResource", DatasetBinaryArgs.builder()        
    .dataFactoryId("string")
    .linkedServiceName("string")
    .additionalProperties(Map.of("string", "string"))
    .annotations("string")
    .azureBlobStorageLocation(DatasetBinaryAzureBlobStorageLocationArgs.builder()
        .container("string")
        .dynamicContainerEnabled(false)
        .dynamicFilenameEnabled(false)
        .dynamicPathEnabled(false)
        .filename("string")
        .path("string")
        .build())
    .compression(DatasetBinaryCompressionArgs.builder()
        .type("string")
        .level("string")
        .build())
    .description("string")
    .folder("string")
    .httpServerLocation(DatasetBinaryHttpServerLocationArgs.builder()
        .filename("string")
        .path("string")
        .relativeUrl("string")
        .dynamicFilenameEnabled(false)
        .dynamicPathEnabled(false)
        .build())
    .name("string")
    .parameters(Map.of("string", "string"))
    .sftpServerLocation(DatasetBinarySftpServerLocationArgs.builder()
        .filename("string")
        .path("string")
        .dynamicFilenameEnabled(false)
        .dynamicPathEnabled(false)
        .build())
    .build());

    dataset_binary_resource = azure.datafactory.DatasetBinary("datasetBinaryResource",
    data_factory_id="string",
    linked_service_name="string",
    additional_properties={
        "string": "string",
    },
    annotations=["string"],
    azure_blob_storage_location=azure.datafactory.DatasetBinaryAzureBlobStorageLocationArgs(
        container="string",
        dynamic_container_enabled=False,
        dynamic_filename_enabled=False,
        dynamic_path_enabled=False,
        filename="string",
        path="string",
    ),
    compression=azure.datafactory.DatasetBinaryCompressionArgs(
        type="string",
        level="string",
    ),
    description="string",
    folder="string",
    http_server_location=azure.datafactory.DatasetBinaryHttpServerLocationArgs(
        filename="string",
        path="string",
        relative_url="string",
        dynamic_filename_enabled=False,
        dynamic_path_enabled=False,
    ),
    name="string",
    parameters={
        "string": "string",
    },
    sftp_server_location=azure.datafactory.DatasetBinarySftpServerLocationArgs(
        filename="string",
        path="string",
        dynamic_filename_enabled=False,
        dynamic_path_enabled=False,
    ))

    const datasetBinaryResource = new azure.datafactory.DatasetBinary("datasetBinaryResource", {
    dataFactoryId: "string",
    linkedServiceName: "string",
    additionalProperties: {
        string: "string",
    },
    annotations: ["string"],
    azureBlobStorageLocation: {
        container: "string",
        dynamicContainerEnabled: false,
        dynamicFilenameEnabled: false,
        dynamicPathEnabled: false,
        filename: "string",
        path: "string",
    },
    compression: {
        type: "string",
        level: "string",
    },
    description: "string",
    folder: "string",
    httpServerLocation: {
        filename: "string",
        path: "string",
        relativeUrl: "string",
        dynamicFilenameEnabled: false,
        dynamicPathEnabled: false,
    },
    name: "string",
    parameters: {
        string: "string",
    },
    sftpServerLocation: {
        filename: "string",
        path: "string",
        dynamicFilenameEnabled: false,
        dynamicPathEnabled: false,
    },
});

    type: azure:datafactory:DatasetBinary
properties:
    additionalProperties:
        string: string
    annotations:
        - string
    azureBlobStorageLocation:
        container: string
        dynamicContainerEnabled: false
        dynamicFilenameEnabled: false
        dynamicPathEnabled: false
        filename: string
        path: string
    compression:
        level: string
        type: string
    dataFactoryId: string
    description: string
    folder: string
    httpServerLocation:
        dynamicFilenameEnabled: false
        dynamicPathEnabled: false
        filename: string
        path: string
        relativeUrl: string
    linkedServiceName: string
    name: string
    parameters:
        string: string
    sftpServerLocation:
        dynamicFilenameEnabled: false
        dynamicPathEnabled: false
        filename: string
        path: string

    DatasetBinary 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 DatasetBinary 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 Binary Dataset with.
    AdditionalProperties Dictionary<string, string>
    A map of additional properties to associate with the Data Factory Binary Dataset.
    Annotations List<string>
    List of tags that can be used for describing the Data Factory Binary Dataset.
    AzureBlobStorageLocation DatasetBinaryAzureBlobStorageLocation
    A azure_blob_storage_location block as defined below.
    Compression DatasetBinaryCompression
    A compression block as defined below.
    Description string
    The description for the Data Factory Dataset.
    Folder string
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    HttpServerLocation DatasetBinaryHttpServerLocation
    A http_server_location block as defined below.
    Name string
    Specifies the name of the Data Factory Binary 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>

    Specifies a list of parameters to associate with the Data Factory Binary Dataset.

    The following supported locations for a Binary Dataset. One of these should be specified:

    SftpServerLocation DatasetBinarySftpServerLocation
    A sftp_server_location 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 Binary Dataset with.
    AdditionalProperties map[string]string
    A map of additional properties to associate with the Data Factory Binary Dataset.
    Annotations []string
    List of tags that can be used for describing the Data Factory Binary Dataset.
    AzureBlobStorageLocation DatasetBinaryAzureBlobStorageLocationArgs
    A azure_blob_storage_location block as defined below.
    Compression DatasetBinaryCompressionArgs
    A compression block as defined below.
    Description string
    The description for the Data Factory Dataset.
    Folder string
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    HttpServerLocation DatasetBinaryHttpServerLocationArgs
    A http_server_location block as defined below.
    Name string
    Specifies the name of the Data Factory Binary 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

    Specifies a list of parameters to associate with the Data Factory Binary Dataset.

    The following supported locations for a Binary Dataset. One of these should be specified:

    SftpServerLocation DatasetBinarySftpServerLocationArgs
    A sftp_server_location 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 Binary Dataset with.
    additionalProperties Map<String,String>
    A map of additional properties to associate with the Data Factory Binary Dataset.
    annotations List<String>
    List of tags that can be used for describing the Data Factory Binary Dataset.
    azureBlobStorageLocation DatasetBinaryAzureBlobStorageLocation
    A azure_blob_storage_location block as defined below.
    compression DatasetBinaryCompression
    A compression block as defined below.
    description String
    The description for the Data Factory Dataset.
    folder String
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    httpServerLocation DatasetBinaryHttpServerLocation
    A http_server_location block as defined below.
    name String
    Specifies the name of the Data Factory Binary 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>

    Specifies a list of parameters to associate with the Data Factory Binary Dataset.

    The following supported locations for a Binary Dataset. One of these should be specified:

    sftpServerLocation DatasetBinarySftpServerLocation
    A sftp_server_location 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 Binary Dataset with.
    additionalProperties {[key: string]: string}
    A map of additional properties to associate with the Data Factory Binary Dataset.
    annotations string[]
    List of tags that can be used for describing the Data Factory Binary Dataset.
    azureBlobStorageLocation DatasetBinaryAzureBlobStorageLocation
    A azure_blob_storage_location block as defined below.
    compression DatasetBinaryCompression
    A compression block as defined below.
    description string
    The description for the Data Factory Dataset.
    folder string
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    httpServerLocation DatasetBinaryHttpServerLocation
    A http_server_location block as defined below.
    name string
    Specifies the name of the Data Factory Binary 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}

    Specifies a list of parameters to associate with the Data Factory Binary Dataset.

    The following supported locations for a Binary Dataset. One of these should be specified:

    sftpServerLocation DatasetBinarySftpServerLocation
    A sftp_server_location 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 Binary Dataset with.
    additional_properties Mapping[str, str]
    A map of additional properties to associate with the Data Factory Binary Dataset.
    annotations Sequence[str]
    List of tags that can be used for describing the Data Factory Binary Dataset.
    azure_blob_storage_location DatasetBinaryAzureBlobStorageLocationArgs
    A azure_blob_storage_location block as defined below.
    compression DatasetBinaryCompressionArgs
    A compression block as defined below.
    description str
    The description for the Data Factory Dataset.
    folder str
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    http_server_location DatasetBinaryHttpServerLocationArgs
    A http_server_location block as defined below.
    name str
    Specifies the name of the Data Factory Binary 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]

    Specifies a list of parameters to associate with the Data Factory Binary Dataset.

    The following supported locations for a Binary Dataset. One of these should be specified:

    sftp_server_location DatasetBinarySftpServerLocationArgs
    A sftp_server_location 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 Binary Dataset with.
    additionalProperties Map<String>
    A map of additional properties to associate with the Data Factory Binary Dataset.
    annotations List<String>
    List of tags that can be used for describing the Data Factory Binary Dataset.
    azureBlobStorageLocation Property Map
    A azure_blob_storage_location block as defined below.
    compression Property Map
    A compression block as defined below.
    description String
    The description for the Data Factory Dataset.
    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 Binary Dataset. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    parameters Map<String>

    Specifies a list of parameters to associate with the Data Factory Binary Dataset.

    The following supported locations for a Binary Dataset. One of these should be specified:

    sftpServerLocation Property Map
    A sftp_server_location block as defined below.

    Outputs

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

    Get an existing DatasetBinary 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?: DatasetBinaryState, opts?: CustomResourceOptions): DatasetBinary
    @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[DatasetBinaryAzureBlobStorageLocationArgs] = None,
        compression: Optional[DatasetBinaryCompressionArgs] = None,
        data_factory_id: Optional[str] = None,
        description: Optional[str] = None,
        folder: Optional[str] = None,
        http_server_location: Optional[DatasetBinaryHttpServerLocationArgs] = None,
        linked_service_name: Optional[str] = None,
        name: Optional[str] = None,
        parameters: Optional[Mapping[str, str]] = None,
        sftp_server_location: Optional[DatasetBinarySftpServerLocationArgs] = None) -> DatasetBinary
    func GetDatasetBinary(ctx *Context, name string, id IDInput, state *DatasetBinaryState, opts ...ResourceOption) (*DatasetBinary, error)
    public static DatasetBinary Get(string name, Input<string> id, DatasetBinaryState? state, CustomResourceOptions? opts = null)
    public static DatasetBinary get(String name, Output<String> id, DatasetBinaryState 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 Binary Dataset.
    Annotations List<string>
    List of tags that can be used for describing the Data Factory Binary Dataset.
    AzureBlobStorageLocation DatasetBinaryAzureBlobStorageLocation
    A azure_blob_storage_location block as defined below.
    Compression DatasetBinaryCompression
    A compression block as defined below.
    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.
    Folder string
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    HttpServerLocation DatasetBinaryHttpServerLocation
    A http_server_location block as defined below.
    LinkedServiceName string
    The Data Factory Linked Service name in which to associate the Binary Dataset with.
    Name string
    Specifies the name of the Data Factory Binary 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>

    Specifies a list of parameters to associate with the Data Factory Binary Dataset.

    The following supported locations for a Binary Dataset. One of these should be specified:

    SftpServerLocation DatasetBinarySftpServerLocation
    A sftp_server_location block as defined below.
    AdditionalProperties map[string]string
    A map of additional properties to associate with the Data Factory Binary Dataset.
    Annotations []string
    List of tags that can be used for describing the Data Factory Binary Dataset.
    AzureBlobStorageLocation DatasetBinaryAzureBlobStorageLocationArgs
    A azure_blob_storage_location block as defined below.
    Compression DatasetBinaryCompressionArgs
    A compression block as defined below.
    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.
    Folder string
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    HttpServerLocation DatasetBinaryHttpServerLocationArgs
    A http_server_location block as defined below.
    LinkedServiceName string
    The Data Factory Linked Service name in which to associate the Binary Dataset with.
    Name string
    Specifies the name of the Data Factory Binary 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

    Specifies a list of parameters to associate with the Data Factory Binary Dataset.

    The following supported locations for a Binary Dataset. One of these should be specified:

    SftpServerLocation DatasetBinarySftpServerLocationArgs
    A sftp_server_location block as defined below.
    additionalProperties Map<String,String>
    A map of additional properties to associate with the Data Factory Binary Dataset.
    annotations List<String>
    List of tags that can be used for describing the Data Factory Binary Dataset.
    azureBlobStorageLocation DatasetBinaryAzureBlobStorageLocation
    A azure_blob_storage_location block as defined below.
    compression DatasetBinaryCompression
    A compression block as defined below.
    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.
    folder String
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    httpServerLocation DatasetBinaryHttpServerLocation
    A http_server_location block as defined below.
    linkedServiceName String
    The Data Factory Linked Service name in which to associate the Binary Dataset with.
    name String
    Specifies the name of the Data Factory Binary 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>

    Specifies a list of parameters to associate with the Data Factory Binary Dataset.

    The following supported locations for a Binary Dataset. One of these should be specified:

    sftpServerLocation DatasetBinarySftpServerLocation
    A sftp_server_location block as defined below.
    additionalProperties {[key: string]: string}
    A map of additional properties to associate with the Data Factory Binary Dataset.
    annotations string[]
    List of tags that can be used for describing the Data Factory Binary Dataset.
    azureBlobStorageLocation DatasetBinaryAzureBlobStorageLocation
    A azure_blob_storage_location block as defined below.
    compression DatasetBinaryCompression
    A compression block as defined below.
    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.
    folder string
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    httpServerLocation DatasetBinaryHttpServerLocation
    A http_server_location block as defined below.
    linkedServiceName string
    The Data Factory Linked Service name in which to associate the Binary Dataset with.
    name string
    Specifies the name of the Data Factory Binary 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}

    Specifies a list of parameters to associate with the Data Factory Binary Dataset.

    The following supported locations for a Binary Dataset. One of these should be specified:

    sftpServerLocation DatasetBinarySftpServerLocation
    A sftp_server_location block as defined below.
    additional_properties Mapping[str, str]
    A map of additional properties to associate with the Data Factory Binary Dataset.
    annotations Sequence[str]
    List of tags that can be used for describing the Data Factory Binary Dataset.
    azure_blob_storage_location DatasetBinaryAzureBlobStorageLocationArgs
    A azure_blob_storage_location block as defined below.
    compression DatasetBinaryCompressionArgs
    A compression 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.
    description str
    The description for the Data Factory Dataset.
    folder str
    The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
    http_server_location DatasetBinaryHttpServerLocationArgs
    A http_server_location block as defined below.
    linked_service_name str
    The Data Factory Linked Service name in which to associate the Binary Dataset with.
    name str
    Specifies the name of the Data Factory Binary 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]

    Specifies a list of parameters to associate with the Data Factory Binary Dataset.

    The following supported locations for a Binary Dataset. One of these should be specified:

    sftp_server_location DatasetBinarySftpServerLocationArgs
    A sftp_server_location block as defined below.
    additionalProperties Map<String>
    A map of additional properties to associate with the Data Factory Binary Dataset.
    annotations List<String>
    List of tags that can be used for describing the Data Factory Binary Dataset.
    azureBlobStorageLocation Property Map
    A azure_blob_storage_location block as defined below.
    compression Property Map
    A compression block as defined below.
    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.
    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 Binary Dataset with.
    name String
    Specifies the name of the Data Factory Binary Dataset. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    parameters Map<String>

    Specifies a list of parameters to associate with the Data Factory Binary Dataset.

    The following supported locations for a Binary Dataset. One of these should be specified:

    sftpServerLocation Property Map
    A sftp_server_location block as defined below.

    Supporting Types

    DatasetBinaryAzureBlobStorageLocation, DatasetBinaryAzureBlobStorageLocationArgs

    Container string
    The container on the Azure Blob Storage Account hosting the file.
    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.
    Filename string
    The filename of the file in the blob container.
    Path string
    The folder path to the file in the blob container.
    Container string
    The container on the Azure Blob Storage Account hosting the file.
    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.
    Filename string
    The filename of the file in the blob container.
    Path string
    The folder path to the file in the blob container.
    container String
    The container on the Azure Blob Storage Account hosting the file.
    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.
    filename String
    The filename of the file in the blob container.
    path String
    The folder path to the file in the blob container.
    container string
    The container on the Azure Blob Storage Account hosting the file.
    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.
    filename string
    The filename of the file in the blob container.
    path string
    The folder path to the file in the blob container.
    container str
    The container on the Azure Blob Storage Account hosting the file.
    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.
    filename str
    The filename of the file in the blob container.
    path str
    The folder path to the file in the blob container.
    container String
    The container on the Azure Blob Storage Account hosting the file.
    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.
    filename String
    The filename of the file in the blob container.
    path String
    The folder path to the file in the blob container.

    DatasetBinaryCompression, DatasetBinaryCompressionArgs

    Type string
    The type of compression used during transport. Possible values are BZip2, Deflate, GZip, Tar, TarGZip and ZipDeflate.
    Level string
    The level of compression. Possible values are Fastest and Optimal.
    Type string
    The type of compression used during transport. Possible values are BZip2, Deflate, GZip, Tar, TarGZip and ZipDeflate.
    Level string
    The level of compression. Possible values are Fastest and Optimal.
    type String
    The type of compression used during transport. Possible values are BZip2, Deflate, GZip, Tar, TarGZip and ZipDeflate.
    level String
    The level of compression. Possible values are Fastest and Optimal.
    type string
    The type of compression used during transport. Possible values are BZip2, Deflate, GZip, Tar, TarGZip and ZipDeflate.
    level string
    The level of compression. Possible values are Fastest and Optimal.
    type str
    The type of compression used during transport. Possible values are BZip2, Deflate, GZip, Tar, TarGZip and ZipDeflate.
    level str
    The level of compression. Possible values are Fastest and Optimal.
    type String
    The type of compression used during transport. Possible values are BZip2, Deflate, GZip, Tar, TarGZip and ZipDeflate.
    level String
    The level of compression. Possible values are Fastest and Optimal.

    DatasetBinaryHttpServerLocation, DatasetBinaryHttpServerLocationArgs

    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.

    DatasetBinarySftpServerLocation, DatasetBinarySftpServerLocationArgs

    Filename string
    The filename of the file on the SFTP server.
    Path string
    The folder path to the file on the SFTP server.
    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 SFTP server.
    Path string
    The folder path to the file on the SFTP server.
    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 SFTP server.
    path String
    The folder path to the file on the SFTP server.
    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 SFTP server.
    path string
    The folder path to the file on the SFTP server.
    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 SFTP server.
    path str
    The folder path to the file on the SFTP server.
    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 SFTP server.
    path String
    The folder path to the file on the SFTP server.
    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.

    Import

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

    $ pulumi import azure:datafactory/datasetBinary:DatasetBinary 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.73.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-azure