We recommend using Azure Native.
azure.datafactory.DatasetBinary
Explore with Pulumi AI
Manages a Data Factory Binary Dataset inside an Azure Data Factory.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
{
Location = "West Europe",
});
var exampleFactory = new Azure.DataFactory.Factory("exampleFactory", new()
{
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
});
var exampleLinkedServiceSftp = new Azure.DataFactory.LinkedServiceSftp("exampleLinkedServiceSftp", new()
{
DataFactoryId = exampleFactory.Id,
AuthenticationType = "Basic",
Host = "http://www.bing.com",
Port = 22,
Username = "foo",
Password = "bar",
});
var exampleDatasetBinary = new Azure.DataFactory.DatasetBinary("exampleDatasetBinary", new()
{
DataFactoryId = exampleFactory.Id,
LinkedServiceName = exampleLinkedServiceSftp.Name,
SftpServerLocation = new Azure.DataFactory.Inputs.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 {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleFactory, err := datafactory.NewFactory(ctx, "exampleFactory", &datafactory.FactoryArgs{
Location: exampleResourceGroup.Location,
ResourceGroupName: exampleResourceGroup.Name,
})
if err != nil {
return err
}
exampleLinkedServiceSftp, err := datafactory.NewLinkedServiceSftp(ctx, "exampleLinkedServiceSftp", &datafactory.LinkedServiceSftpArgs{
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, "exampleDatasetBinary", &datafactory.DatasetBinaryArgs{
DataFactoryId: exampleFactory.ID(),
LinkedServiceName: exampleLinkedServiceSftp.Name,
SftpServerLocation: &datafactory.DatasetBinarySftpServerLocationArgs{
Path: pulumi.String("/test/"),
Filename: pulumi.String("**"),
},
})
if err != nil {
return err
}
return nil
})
}
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
.location("West Europe")
.build());
var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.build());
var exampleLinkedServiceSftp = new LinkedServiceSftp("exampleLinkedServiceSftp", LinkedServiceSftpArgs.builder()
.dataFactoryId(exampleFactory.id())
.authenticationType("Basic")
.host("http://www.bing.com")
.port(22)
.username("foo")
.password("bar")
.build());
var exampleDatasetBinary = new DatasetBinary("exampleDatasetBinary", DatasetBinaryArgs.builder()
.dataFactoryId(exampleFactory.id())
.linkedServiceName(exampleLinkedServiceSftp.name())
.sftpServerLocation(DatasetBinarySftpServerLocationArgs.builder()
.path("/test/")
.filename("**")
.build())
.build());
}
}
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_factory = azure.datafactory.Factory("exampleFactory",
location=example_resource_group.location,
resource_group_name=example_resource_group.name)
example_linked_service_sftp = azure.datafactory.LinkedServiceSftp("exampleLinkedServiceSftp",
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("exampleDatasetBinary",
data_factory_id=example_factory.id,
linked_service_name=example_linked_service_sftp.name,
sftp_server_location=azure.datafactory.DatasetBinarySftpServerLocationArgs(
path="/test/",
filename="**",
))
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleFactory = new azure.datafactory.Factory("exampleFactory", {
location: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
});
const exampleLinkedServiceSftp = new azure.datafactory.LinkedServiceSftp("exampleLinkedServiceSftp", {
dataFactoryId: exampleFactory.id,
authenticationType: "Basic",
host: "http://www.bing.com",
port: 22,
username: "foo",
password: "bar",
});
const exampleDatasetBinary = new azure.datafactory.DatasetBinary("exampleDatasetBinary", {
dataFactoryId: exampleFactory.id,
linkedServiceName: exampleLinkedServiceSftp.name,
sftpServerLocation: {
path: "/test/",
filename: "**",
},
});
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
properties:
location: West Europe
exampleFactory:
type: azure:datafactory:Factory
properties:
location: ${exampleResourceGroup.location}
resourceGroupName: ${exampleResourceGroup.name}
exampleLinkedServiceSftp:
type: azure:datafactory:LinkedServiceSftp
properties:
dataFactoryId: ${exampleFactory.id}
authenticationType: Basic
host: http://www.bing.com
port: 22
username: foo
password: bar
exampleDatasetBinary:
type: azure:datafactory:DatasetBinary
properties:
dataFactoryId: ${exampleFactory.id}
linkedServiceName: ${exampleLinkedServiceSftp.name}
sftpServerLocation:
path: /test/
filename: '**'
Create DatasetBinary Resource
new DatasetBinary(name: string, args: DatasetBinaryArgs, opts?: CustomResourceOptions);
@overload
def DatasetBinary(resource_name: 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)
@overload
def DatasetBinary(resource_name: str,
args: DatasetBinaryArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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:
- Data
Factory stringId The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
- Linked
Service stringName The Data Factory Linked Service name in which to associate the Binary Dataset with.
- Additional
Properties 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.
- Azure
Blob DatasetStorage Location Binary Azure Blob Storage Location A
azure_blob_storage_location
block as defined below.- Compression
Dataset
Binary Compression 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.
- Http
Server DatasetLocation Binary Http Server Location 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:
- Sftp
Server DatasetLocation Binary Sftp Server Location A
sftp_server_location
block as defined below.
- Data
Factory stringId The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
- Linked
Service stringName The Data Factory Linked Service name in which to associate the Binary Dataset with.
- Additional
Properties 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.
- Azure
Blob DatasetStorage Location Binary Azure Blob Storage Location Args A
azure_blob_storage_location
block as defined below.- Compression
Dataset
Binary Compression Args 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.
- Http
Server DatasetLocation Binary Http Server Location Args 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:
- Sftp
Server DatasetLocation Binary Sftp Server Location Args A
sftp_server_location
block as defined below.
- data
Factory StringId The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
- linked
Service StringName The Data Factory Linked Service name in which to associate the Binary Dataset with.
- additional
Properties 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.
- azure
Blob DatasetStorage Location Binary Azure Blob Storage Location A
azure_blob_storage_location
block as defined below.- compression
Dataset
Binary Compression 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.
- http
Server DatasetLocation Binary Http Server Location 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:
- sftp
Server DatasetLocation Binary Sftp Server Location A
sftp_server_location
block as defined below.
- data
Factory stringId The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
- linked
Service stringName The Data Factory Linked Service name in which to associate the Binary Dataset with.
- additional
Properties {[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.
- azure
Blob DatasetStorage Location Binary Azure Blob Storage Location A
azure_blob_storage_location
block as defined below.- compression
Dataset
Binary Compression 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.
- http
Server DatasetLocation Binary Http Server Location 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:
- sftp
Server DatasetLocation Binary Sftp Server Location A
sftp_server_location
block as defined below.
- data_
factory_ strid The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
- linked_
service_ strname 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_ Datasetstorage_ location Binary Azure Blob Storage Location Args A
azure_blob_storage_location
block as defined below.- compression
Dataset
Binary Compression Args 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_ Datasetlocation Binary Http Server Location Args 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_ Datasetlocation Binary Sftp Server Location Args A
sftp_server_location
block as defined below.
- data
Factory StringId The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
- linked
Service StringName The Data Factory Linked Service name in which to associate the Binary Dataset with.
- additional
Properties 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.
- azure
Blob Property MapStorage Location 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.
- http
Server Property MapLocation 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:
- sftp
Server Property MapLocation 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.
- Additional
Properties 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.
- Azure
Blob DatasetStorage Location Binary Azure Blob Storage Location A
azure_blob_storage_location
block as defined below.- Compression
Dataset
Binary Compression A
compression
block as defined below.- Data
Factory stringId 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.
- Http
Server DatasetLocation Binary Http Server Location A
http_server_location
block as defined below.- Linked
Service stringName 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:
- Sftp
Server DatasetLocation Binary Sftp Server Location A
sftp_server_location
block as defined below.
- Additional
Properties 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.
- Azure
Blob DatasetStorage Location Binary Azure Blob Storage Location Args A
azure_blob_storage_location
block as defined below.- Compression
Dataset
Binary Compression Args A
compression
block as defined below.- Data
Factory stringId 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.
- Http
Server DatasetLocation Binary Http Server Location Args A
http_server_location
block as defined below.- Linked
Service stringName 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:
- Sftp
Server DatasetLocation Binary Sftp Server Location Args A
sftp_server_location
block as defined below.
- additional
Properties 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.
- azure
Blob DatasetStorage Location Binary Azure Blob Storage Location A
azure_blob_storage_location
block as defined below.- compression
Dataset
Binary Compression A
compression
block as defined below.- data
Factory StringId 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.
- http
Server DatasetLocation Binary Http Server Location A
http_server_location
block as defined below.- linked
Service StringName 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:
- sftp
Server DatasetLocation Binary Sftp Server Location A
sftp_server_location
block as defined below.
- additional
Properties {[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.
- azure
Blob DatasetStorage Location Binary Azure Blob Storage Location A
azure_blob_storage_location
block as defined below.- compression
Dataset
Binary Compression A
compression
block as defined below.- data
Factory stringId 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.
- http
Server DatasetLocation Binary Http Server Location A
http_server_location
block as defined below.- linked
Service stringName 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:
- sftp
Server DatasetLocation Binary Sftp Server Location 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_ Datasetstorage_ location Binary Azure Blob Storage Location Args A
azure_blob_storage_location
block as defined below.- compression
Dataset
Binary Compression Args A
compression
block as defined below.- data_
factory_ strid 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_ Datasetlocation Binary Http Server Location Args A
http_server_location
block as defined below.- linked_
service_ strname 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_ Datasetlocation Binary Sftp Server Location Args A
sftp_server_location
block as defined below.
- additional
Properties 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.
- azure
Blob Property MapStorage Location A
azure_blob_storage_location
block as defined below.- compression Property Map
A
compression
block as defined below.- data
Factory StringId 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.
- http
Server Property MapLocation A
http_server_location
block as defined below.- linked
Service StringName 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:
- sftp
Server Property MapLocation 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.
- Dynamic
Container boolEnabled Is the
container
using dynamic expression, function or system variables? Defaults tofalse
.- Dynamic
Filename boolEnabled Is the
filename
using dynamic expression, function or system variables? Defaults tofalse
.- Dynamic
Path boolEnabled Is the
path
using dynamic expression, function or system variables? Defaults tofalse
.- 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.
- Dynamic
Container boolEnabled Is the
container
using dynamic expression, function or system variables? Defaults tofalse
.- Dynamic
Filename boolEnabled Is the
filename
using dynamic expression, function or system variables? Defaults tofalse
.- Dynamic
Path boolEnabled Is the
path
using dynamic expression, function or system variables? Defaults tofalse
.- 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.
- dynamic
Container BooleanEnabled Is the
container
using dynamic expression, function or system variables? Defaults tofalse
.- dynamic
Filename BooleanEnabled Is the
filename
using dynamic expression, function or system variables? Defaults tofalse
.- dynamic
Path BooleanEnabled Is the
path
using dynamic expression, function or system variables? Defaults tofalse
.- 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.
- dynamic
Container booleanEnabled Is the
container
using dynamic expression, function or system variables? Defaults tofalse
.- dynamic
Filename booleanEnabled Is the
filename
using dynamic expression, function or system variables? Defaults tofalse
.- dynamic
Path booleanEnabled Is the
path
using dynamic expression, function or system variables? Defaults tofalse
.- 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_ boolenabled Is the
container
using dynamic expression, function or system variables? Defaults tofalse
.- dynamic_
filename_ boolenabled Is the
filename
using dynamic expression, function or system variables? Defaults tofalse
.- dynamic_
path_ boolenabled Is the
path
using dynamic expression, function or system variables? Defaults tofalse
.- 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.
- dynamic
Container BooleanEnabled Is the
container
using dynamic expression, function or system variables? Defaults tofalse
.- dynamic
Filename BooleanEnabled Is the
filename
using dynamic expression, function or system variables? Defaults tofalse
.- dynamic
Path BooleanEnabled Is the
path
using dynamic expression, function or system variables? Defaults tofalse
.- 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
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.
- Relative
Url string The base URL to the web server hosting the file.
- Dynamic
Filename boolEnabled Is the
filename
using dynamic expression, function or system variables? Defaults tofalse
.- Dynamic
Path boolEnabled Is the
path
using dynamic expression, function or system variables? Defaults tofalse
.
- Filename string
The filename of the file on the web server.
- Path string
The folder path to the file on the web server.
- Relative
Url string The base URL to the web server hosting the file.
- Dynamic
Filename boolEnabled Is the
filename
using dynamic expression, function or system variables? Defaults tofalse
.- Dynamic
Path boolEnabled Is the
path
using dynamic expression, function or system variables? Defaults tofalse
.
- filename String
The filename of the file on the web server.
- path String
The folder path to the file on the web server.
- relative
Url String The base URL to the web server hosting the file.
- dynamic
Filename BooleanEnabled Is the
filename
using dynamic expression, function or system variables? Defaults tofalse
.- dynamic
Path BooleanEnabled Is the
path
using dynamic expression, function or system variables? Defaults tofalse
.
- filename string
The filename of the file on the web server.
- path string
The folder path to the file on the web server.
- relative
Url string The base URL to the web server hosting the file.
- dynamic
Filename booleanEnabled Is the
filename
using dynamic expression, function or system variables? Defaults tofalse
.- dynamic
Path booleanEnabled Is the
path
using dynamic expression, function or system variables? Defaults tofalse
.
- 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_ boolenabled Is the
filename
using dynamic expression, function or system variables? Defaults tofalse
.- dynamic_
path_ boolenabled Is the
path
using dynamic expression, function or system variables? Defaults tofalse
.
- filename String
The filename of the file on the web server.
- path String
The folder path to the file on the web server.
- relative
Url String The base URL to the web server hosting the file.
- dynamic
Filename BooleanEnabled Is the
filename
using dynamic expression, function or system variables? Defaults tofalse
.- dynamic
Path BooleanEnabled Is the
path
using dynamic expression, function or system variables? Defaults tofalse
.
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.
- Dynamic
Filename boolEnabled Is the
filename
using dynamic expression, function or system variables? Defaults tofalse
.- Dynamic
Path boolEnabled Is the
path
using dynamic expression, function or system variables? Defaults tofalse
.
- Filename string
The filename of the file on the SFTP server.
- Path string
The folder path to the file on the SFTP server.
- Dynamic
Filename boolEnabled Is the
filename
using dynamic expression, function or system variables? Defaults tofalse
.- Dynamic
Path boolEnabled Is the
path
using dynamic expression, function or system variables? Defaults tofalse
.
- filename String
The filename of the file on the SFTP server.
- path String
The folder path to the file on the SFTP server.
- dynamic
Filename BooleanEnabled Is the
filename
using dynamic expression, function or system variables? Defaults tofalse
.- dynamic
Path BooleanEnabled Is the
path
using dynamic expression, function or system variables? Defaults tofalse
.
- filename string
The filename of the file on the SFTP server.
- path string
The folder path to the file on the SFTP server.
- dynamic
Filename booleanEnabled Is the
filename
using dynamic expression, function or system variables? Defaults tofalse
.- dynamic
Path booleanEnabled Is the
path
using dynamic expression, function or system variables? Defaults tofalse
.
- 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_ boolenabled Is the
filename
using dynamic expression, function or system variables? Defaults tofalse
.- dynamic_
path_ boolenabled Is the
path
using dynamic expression, function or system variables? Defaults tofalse
.
- filename String
The filename of the file on the SFTP server.
- path String
The folder path to the file on the SFTP server.
- dynamic
Filename BooleanEnabled Is the
filename
using dynamic expression, function or system variables? Defaults tofalse
.- dynamic
Path BooleanEnabled Is the
path
using dynamic expression, function or system variables? Defaults tofalse
.
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
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurerm
Terraform Provider.