We recommend using Azure Native.
azure.datafactory.CustomDataset
Explore with Pulumi AI
Manages a Dataset inside an Azure Data Factory. This is a generic resource that supports all different Dataset Types.
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,
    identity: {
        type: "SystemAssigned",
    },
});
const exampleAccount = new azure.storage.Account("example", {
    name: "example",
    resourceGroupName: example.name,
    location: example.location,
    accountKind: "BlobStorage",
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleLinkedCustomService = new azure.datafactory.LinkedCustomService("example", {
    name: "example",
    dataFactoryId: exampleFactory.id,
    type: "AzureBlobStorage",
    typePropertiesJson: pulumi.interpolate`{
  "connectionString":"${exampleAccount.primaryConnectionString}"
}
`,
});
const exampleContainer = new azure.storage.Container("example", {
    name: "content",
    storageAccountName: exampleAccount.name,
    containerAccessType: "private",
});
const exampleCustomDataset = new azure.datafactory.CustomDataset("example", {
    name: "example",
    dataFactoryId: exampleFactory.id,
    type: "Json",
    linkedService: {
        name: exampleLinkedCustomService.name,
        parameters: {
            key1: "value1",
        },
    },
    typePropertiesJson: pulumi.interpolate`{
  "location": {
    "container":"${exampleContainer.name}",
    "fileName":"foo.txt",
    "folderPath": "foo/bar/",
    "type":"AzureBlobStorageLocation"
  },
  "encodingName":"UTF-8"
}
`,
    description: "test description",
    annotations: [
        "test1",
        "test2",
        "test3",
    ],
    folder: "testFolder",
    parameters: {
        foo: "test1",
        Bar: "Test2",
    },
    additionalProperties: {
        foo: "test1",
        bar: "test2",
    },
    schemaJson: `{
  "type": "object",
  "properties": {
    "name": {
      "type": "object",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        }
      }
    },
    "age": {
      "type": "integer"
    }
  }
}
`,
});
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,
    identity={
        "type": "SystemAssigned",
    })
example_account = azure.storage.Account("example",
    name="example",
    resource_group_name=example.name,
    location=example.location,
    account_kind="BlobStorage",
    account_tier="Standard",
    account_replication_type="LRS")
example_linked_custom_service = azure.datafactory.LinkedCustomService("example",
    name="example",
    data_factory_id=example_factory.id,
    type="AzureBlobStorage",
    type_properties_json=example_account.primary_connection_string.apply(lambda primary_connection_string: f"""{{
  "connectionString":"{primary_connection_string}"
}}
"""))
example_container = azure.storage.Container("example",
    name="content",
    storage_account_name=example_account.name,
    container_access_type="private")
example_custom_dataset = azure.datafactory.CustomDataset("example",
    name="example",
    data_factory_id=example_factory.id,
    type="Json",
    linked_service={
        "name": example_linked_custom_service.name,
        "parameters": {
            "key1": "value1",
        },
    },
    type_properties_json=example_container.name.apply(lambda name: f"""{{
  "location": {{
    "container":"{name}",
    "fileName":"foo.txt",
    "folderPath": "foo/bar/",
    "type":"AzureBlobStorageLocation"
  }},
  "encodingName":"UTF-8"
}}
"""),
    description="test description",
    annotations=[
        "test1",
        "test2",
        "test3",
    ],
    folder="testFolder",
    parameters={
        "foo": "test1",
        "Bar": "Test2",
    },
    additional_properties={
        "foo": "test1",
        "bar": "test2",
    },
    schema_json="""{
  "type": "object",
  "properties": {
    "name": {
      "type": "object",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        }
      }
    },
    "age": {
      "type": "integer"
    }
  }
}
""")
package main
import (
	"fmt"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/datafactory"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/storage"
	"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,
			Identity: &datafactory.FactoryIdentityArgs{
				Type: pulumi.String("SystemAssigned"),
			},
		})
		if err != nil {
			return err
		}
		exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
			Name:                   pulumi.String("example"),
			ResourceGroupName:      example.Name,
			Location:               example.Location,
			AccountKind:            pulumi.String("BlobStorage"),
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
		})
		if err != nil {
			return err
		}
		exampleLinkedCustomService, err := datafactory.NewLinkedCustomService(ctx, "example", &datafactory.LinkedCustomServiceArgs{
			Name:          pulumi.String("example"),
			DataFactoryId: exampleFactory.ID(),
			Type:          pulumi.String("AzureBlobStorage"),
			TypePropertiesJson: exampleAccount.PrimaryConnectionString.ApplyT(func(primaryConnectionString string) (string, error) {
				return fmt.Sprintf("{\n  \"connectionString\":\"%v\"\n}\n", primaryConnectionString), nil
			}).(pulumi.StringOutput),
		})
		if err != nil {
			return err
		}
		exampleContainer, err := storage.NewContainer(ctx, "example", &storage.ContainerArgs{
			Name:                pulumi.String("content"),
			StorageAccountName:  exampleAccount.Name,
			ContainerAccessType: pulumi.String("private"),
		})
		if err != nil {
			return err
		}
		_, err = datafactory.NewCustomDataset(ctx, "example", &datafactory.CustomDatasetArgs{
			Name:          pulumi.String("example"),
			DataFactoryId: exampleFactory.ID(),
			Type:          pulumi.String("Json"),
			LinkedService: &datafactory.CustomDatasetLinkedServiceArgs{
				Name: exampleLinkedCustomService.Name,
				Parameters: pulumi.StringMap{
					"key1": pulumi.String("value1"),
				},
			},
			TypePropertiesJson: exampleContainer.Name.ApplyT(func(name string) (string, error) {
				return fmt.Sprintf(`{
  "location": {
    "container":"%v",
    "fileName":"foo.txt",
    "folderPath": "foo/bar/",
    "type":"AzureBlobStorageLocation"
  },
  "encodingName":"UTF-8"
}
`, name), nil
			}).(pulumi.StringOutput),
			Description: pulumi.String("test description"),
			Annotations: pulumi.StringArray{
				pulumi.String("test1"),
				pulumi.String("test2"),
				pulumi.String("test3"),
			},
			Folder: pulumi.String("testFolder"),
			Parameters: pulumi.StringMap{
				"foo": pulumi.String("test1"),
				"Bar": pulumi.String("Test2"),
			},
			AdditionalProperties: pulumi.StringMap{
				"foo": pulumi.String("test1"),
				"bar": pulumi.String("test2"),
			},
			SchemaJson: pulumi.String(`{
  "type": "object",
  "properties": {
    "name": {
      "type": "object",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        }
      }
    },
    "age": {
      "type": "integer"
    }
  }
}
`),
		})
		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,
        Identity = new Azure.DataFactory.Inputs.FactoryIdentityArgs
        {
            Type = "SystemAssigned",
        },
    });
    var exampleAccount = new Azure.Storage.Account("example", new()
    {
        Name = "example",
        ResourceGroupName = example.Name,
        Location = example.Location,
        AccountKind = "BlobStorage",
        AccountTier = "Standard",
        AccountReplicationType = "LRS",
    });
    var exampleLinkedCustomService = new Azure.DataFactory.LinkedCustomService("example", new()
    {
        Name = "example",
        DataFactoryId = exampleFactory.Id,
        Type = "AzureBlobStorage",
        TypePropertiesJson = exampleAccount.PrimaryConnectionString.Apply(primaryConnectionString => @$"{{
  ""connectionString"":""{primaryConnectionString}""
}}
"),
    });
    var exampleContainer = new Azure.Storage.Container("example", new()
    {
        Name = "content",
        StorageAccountName = exampleAccount.Name,
        ContainerAccessType = "private",
    });
    var exampleCustomDataset = new Azure.DataFactory.CustomDataset("example", new()
    {
        Name = "example",
        DataFactoryId = exampleFactory.Id,
        Type = "Json",
        LinkedService = new Azure.DataFactory.Inputs.CustomDatasetLinkedServiceArgs
        {
            Name = exampleLinkedCustomService.Name,
            Parameters = 
            {
                { "key1", "value1" },
            },
        },
        TypePropertiesJson = exampleContainer.Name.Apply(name => @$"{{
  ""location"": {{
    ""container"":""{name}"",
    ""fileName"":""foo.txt"",
    ""folderPath"": ""foo/bar/"",
    ""type"":""AzureBlobStorageLocation""
  }},
  ""encodingName"":""UTF-8""
}}
"),
        Description = "test description",
        Annotations = new[]
        {
            "test1",
            "test2",
            "test3",
        },
        Folder = "testFolder",
        Parameters = 
        {
            { "foo", "test1" },
            { "Bar", "Test2" },
        },
        AdditionalProperties = 
        {
            { "foo", "test1" },
            { "bar", "test2" },
        },
        SchemaJson = @"{
  ""type"": ""object"",
  ""properties"": {
    ""name"": {
      ""type"": ""object"",
      ""properties"": {
        ""firstName"": {
          ""type"": ""string""
        },
        ""lastName"": {
          ""type"": ""string""
        }
      }
    },
    ""age"": {
      ""type"": ""integer""
    }
  }
}
",
    });
});
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.inputs.FactoryIdentityArgs;
import com.pulumi.azure.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.datafactory.LinkedCustomService;
import com.pulumi.azure.datafactory.LinkedCustomServiceArgs;
import com.pulumi.azure.storage.Container;
import com.pulumi.azure.storage.ContainerArgs;
import com.pulumi.azure.datafactory.CustomDataset;
import com.pulumi.azure.datafactory.CustomDatasetArgs;
import com.pulumi.azure.datafactory.inputs.CustomDatasetLinkedServiceArgs;
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())
            .identity(FactoryIdentityArgs.builder()
                .type("SystemAssigned")
                .build())
            .build());
        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .name("example")
            .resourceGroupName(example.name())
            .location(example.location())
            .accountKind("BlobStorage")
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .build());
        var exampleLinkedCustomService = new LinkedCustomService("exampleLinkedCustomService", LinkedCustomServiceArgs.builder()
            .name("example")
            .dataFactoryId(exampleFactory.id())
            .type("AzureBlobStorage")
            .typePropertiesJson(exampleAccount.primaryConnectionString().applyValue(primaryConnectionString -> """
{
  "connectionString":"%s"
}
", primaryConnectionString)))
            .build());
        var exampleContainer = new Container("exampleContainer", ContainerArgs.builder()
            .name("content")
            .storageAccountName(exampleAccount.name())
            .containerAccessType("private")
            .build());
        var exampleCustomDataset = new CustomDataset("exampleCustomDataset", CustomDatasetArgs.builder()
            .name("example")
            .dataFactoryId(exampleFactory.id())
            .type("Json")
            .linkedService(CustomDatasetLinkedServiceArgs.builder()
                .name(exampleLinkedCustomService.name())
                .parameters(Map.of("key1", "value1"))
                .build())
            .typePropertiesJson(exampleContainer.name().applyValue(name -> """
{
  "location": {
    "container":"%s",
    "fileName":"foo.txt",
    "folderPath": "foo/bar/",
    "type":"AzureBlobStorageLocation"
  },
  "encodingName":"UTF-8"
}
", name)))
            .description("test description")
            .annotations(            
                "test1",
                "test2",
                "test3")
            .folder("testFolder")
            .parameters(Map.ofEntries(
                Map.entry("foo", "test1"),
                Map.entry("Bar", "Test2")
            ))
            .additionalProperties(Map.ofEntries(
                Map.entry("foo", "test1"),
                Map.entry("bar", "test2")
            ))
            .schemaJson("""
{
  "type": "object",
  "properties": {
    "name": {
      "type": "object",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        }
      }
    },
    "age": {
      "type": "integer"
    }
  }
}
            """)
            .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}
      identity:
        type: SystemAssigned
  exampleAccount:
    type: azure:storage:Account
    name: example
    properties:
      name: example
      resourceGroupName: ${example.name}
      location: ${example.location}
      accountKind: BlobStorage
      accountTier: Standard
      accountReplicationType: LRS
  exampleLinkedCustomService:
    type: azure:datafactory:LinkedCustomService
    name: example
    properties:
      name: example
      dataFactoryId: ${exampleFactory.id}
      type: AzureBlobStorage
      typePropertiesJson: |
        {
          "connectionString":"${exampleAccount.primaryConnectionString}"
        }        
  exampleContainer:
    type: azure:storage:Container
    name: example
    properties:
      name: content
      storageAccountName: ${exampleAccount.name}
      containerAccessType: private
  exampleCustomDataset:
    type: azure:datafactory:CustomDataset
    name: example
    properties:
      name: example
      dataFactoryId: ${exampleFactory.id}
      type: Json
      linkedService:
        name: ${exampleLinkedCustomService.name}
        parameters:
          key1: value1
      typePropertiesJson: |
        {
          "location": {
            "container":"${exampleContainer.name}",
            "fileName":"foo.txt",
            "folderPath": "foo/bar/",
            "type":"AzureBlobStorageLocation"
          },
          "encodingName":"UTF-8"
        }        
      description: test description
      annotations:
        - test1
        - test2
        - test3
      folder: testFolder
      parameters:
        foo: test1
        Bar: Test2
      additionalProperties:
        foo: test1
        bar: test2
      schemaJson: |
        {
          "type": "object",
          "properties": {
            "name": {
              "type": "object",
              "properties": {
                "firstName": {
                  "type": "string"
                },
                "lastName": {
                  "type": "string"
                }
              }
            },
            "age": {
              "type": "integer"
            }
          }
        }        
Create CustomDataset Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CustomDataset(name: string, args: CustomDatasetArgs, opts?: CustomResourceOptions);@overload
def CustomDataset(resource_name: str,
                  args: CustomDatasetArgs,
                  opts: Optional[ResourceOptions] = None)
@overload
def CustomDataset(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  data_factory_id: Optional[str] = None,
                  linked_service: Optional[CustomDatasetLinkedServiceArgs] = None,
                  type: Optional[str] = None,
                  type_properties_json: Optional[str] = None,
                  additional_properties: Optional[Mapping[str, str]] = None,
                  annotations: Optional[Sequence[str]] = None,
                  description: Optional[str] = None,
                  folder: Optional[str] = None,
                  name: Optional[str] = None,
                  parameters: Optional[Mapping[str, str]] = None,
                  schema_json: Optional[str] = None)func NewCustomDataset(ctx *Context, name string, args CustomDatasetArgs, opts ...ResourceOption) (*CustomDataset, error)public CustomDataset(string name, CustomDatasetArgs args, CustomResourceOptions? opts = null)
public CustomDataset(String name, CustomDatasetArgs args)
public CustomDataset(String name, CustomDatasetArgs args, CustomResourceOptions options)
type: azure:datafactory:CustomDataset
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 CustomDatasetArgs
- 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 CustomDatasetArgs
- 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 CustomDatasetArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CustomDatasetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CustomDatasetArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var customDatasetResource = new Azure.DataFactory.CustomDataset("customDatasetResource", new()
{
    DataFactoryId = "string",
    LinkedService = new Azure.DataFactory.Inputs.CustomDatasetLinkedServiceArgs
    {
        Name = "string",
        Parameters = 
        {
            { "string", "string" },
        },
    },
    Type = "string",
    TypePropertiesJson = "string",
    AdditionalProperties = 
    {
        { "string", "string" },
    },
    Annotations = new[]
    {
        "string",
    },
    Description = "string",
    Folder = "string",
    Name = "string",
    Parameters = 
    {
        { "string", "string" },
    },
    SchemaJson = "string",
});
example, err := datafactory.NewCustomDataset(ctx, "customDatasetResource", &datafactory.CustomDatasetArgs{
	DataFactoryId: pulumi.String("string"),
	LinkedService: &datafactory.CustomDatasetLinkedServiceArgs{
		Name: pulumi.String("string"),
		Parameters: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
	},
	Type:               pulumi.String("string"),
	TypePropertiesJson: pulumi.String("string"),
	AdditionalProperties: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Annotations: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Folder:      pulumi.String("string"),
	Name:        pulumi.String("string"),
	Parameters: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	SchemaJson: pulumi.String("string"),
})
var customDatasetResource = new CustomDataset("customDatasetResource", CustomDatasetArgs.builder()
    .dataFactoryId("string")
    .linkedService(CustomDatasetLinkedServiceArgs.builder()
        .name("string")
        .parameters(Map.of("string", "string"))
        .build())
    .type("string")
    .typePropertiesJson("string")
    .additionalProperties(Map.of("string", "string"))
    .annotations("string")
    .description("string")
    .folder("string")
    .name("string")
    .parameters(Map.of("string", "string"))
    .schemaJson("string")
    .build());
custom_dataset_resource = azure.datafactory.CustomDataset("customDatasetResource",
    data_factory_id="string",
    linked_service={
        "name": "string",
        "parameters": {
            "string": "string",
        },
    },
    type="string",
    type_properties_json="string",
    additional_properties={
        "string": "string",
    },
    annotations=["string"],
    description="string",
    folder="string",
    name="string",
    parameters={
        "string": "string",
    },
    schema_json="string")
const customDatasetResource = new azure.datafactory.CustomDataset("customDatasetResource", {
    dataFactoryId: "string",
    linkedService: {
        name: "string",
        parameters: {
            string: "string",
        },
    },
    type: "string",
    typePropertiesJson: "string",
    additionalProperties: {
        string: "string",
    },
    annotations: ["string"],
    description: "string",
    folder: "string",
    name: "string",
    parameters: {
        string: "string",
    },
    schemaJson: "string",
});
type: azure:datafactory:CustomDataset
properties:
    additionalProperties:
        string: string
    annotations:
        - string
    dataFactoryId: string
    description: string
    folder: string
    linkedService:
        name: string
        parameters:
            string: string
    name: string
    parameters:
        string: string
    schemaJson: string
    type: string
    typePropertiesJson: string
CustomDataset Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The CustomDataset resource accepts the following input properties:
- DataFactory stringId 
- The Data Factory ID in which to associate the Dataset with. Changing this forces a new resource.
- LinkedService CustomDataset Linked Service 
- A linked_serviceblock as defined below.
- Type string
- The type of dataset that will be associated with Data Factory. Changing this forces a new resource to be created.
- TypeProperties stringJson 
- A JSON object that contains the properties of the Data Factory Dataset.
- AdditionalProperties Dictionary<string, string>
- A map of additional properties to associate with the Data Factory Dataset.
- Annotations List<string>
- List of tags that can be used for describing the Data Factory Dataset.
- Description string
- The description for the Data Factory Dataset.
- Folder string
- The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
- Name string
- Specifies the name of the Data Factory Dataset. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
- Parameters Dictionary<string, string>
- A map of parameters to associate with the Data Factory Dataset.
- SchemaJson string
- A JSON object that contains the schema of the Data Factory Dataset.
- DataFactory stringId 
- The Data Factory ID in which to associate the Dataset with. Changing this forces a new resource.
- LinkedService CustomDataset Linked Service Args 
- A linked_serviceblock as defined below.
- Type string
- The type of dataset that will be associated with Data Factory. Changing this forces a new resource to be created.
- TypeProperties stringJson 
- A JSON object that contains the properties of the Data Factory Dataset.
- AdditionalProperties map[string]string
- A map of additional properties to associate with the Data Factory Dataset.
- Annotations []string
- List of tags that can be used for describing the Data Factory Dataset.
- Description string
- The description for the Data Factory Dataset.
- Folder string
- The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
- Name string
- Specifies the name of the Data Factory Dataset. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
- Parameters map[string]string
- A map of parameters to associate with the Data Factory Dataset.
- SchemaJson string
- A JSON object that contains the schema of the Data Factory Dataset.
- dataFactory StringId 
- The Data Factory ID in which to associate the Dataset with. Changing this forces a new resource.
- linkedService CustomDataset Linked Service 
- A linked_serviceblock as defined below.
- type String
- The type of dataset that will be associated with Data Factory. Changing this forces a new resource to be created.
- typeProperties StringJson 
- A JSON object that contains the properties of the Data Factory Dataset.
- additionalProperties Map<String,String>
- A map of additional properties to associate with the Data Factory Dataset.
- annotations List<String>
- List of tags that can be used for describing the Data Factory Dataset.
- description String
- The description for the Data Factory Dataset.
- folder String
- The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
- name String
- Specifies the name of the Data Factory Dataset. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
- parameters Map<String,String>
- A map of parameters to associate with the Data Factory Dataset.
- schemaJson String
- A JSON object that contains the schema of the Data Factory Dataset.
- dataFactory stringId 
- The Data Factory ID in which to associate the Dataset with. Changing this forces a new resource.
- linkedService CustomDataset Linked Service 
- A linked_serviceblock as defined below.
- type string
- The type of dataset that will be associated with Data Factory. Changing this forces a new resource to be created.
- typeProperties stringJson 
- A JSON object that contains the properties of the Data Factory Dataset.
- additionalProperties {[key: string]: string}
- A map of additional properties to associate with the Data Factory Dataset.
- annotations string[]
- List of tags that can be used for describing the Data Factory Dataset.
- description string
- The description for the Data Factory Dataset.
- folder string
- The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
- name string
- Specifies the name of the Data Factory Dataset. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
- parameters {[key: string]: string}
- A map of parameters to associate with the Data Factory Dataset.
- schemaJson string
- A JSON object that contains the schema of the Data Factory Dataset.
- data_factory_ strid 
- The Data Factory ID in which to associate the Dataset with. Changing this forces a new resource.
- linked_service CustomDataset Linked Service Args 
- A linked_serviceblock as defined below.
- type str
- The type of dataset that will be associated with Data Factory. Changing this forces a new resource to be created.
- type_properties_ strjson 
- A JSON object that contains the properties of the Data Factory Dataset.
- additional_properties Mapping[str, str]
- A map of additional properties to associate with the Data Factory Dataset.
- annotations Sequence[str]
- List of tags that can be used for describing the Data Factory Dataset.
- description str
- The description for the Data Factory Dataset.
- folder str
- The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
- name str
- Specifies the name of the Data Factory Dataset. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
- parameters Mapping[str, str]
- A map of parameters to associate with the Data Factory Dataset.
- schema_json str
- A JSON object that contains the schema of the Data Factory Dataset.
- dataFactory StringId 
- The Data Factory ID in which to associate the Dataset with. Changing this forces a new resource.
- linkedService Property Map
- A linked_serviceblock as defined below.
- type String
- The type of dataset that will be associated with Data Factory. Changing this forces a new resource to be created.
- typeProperties StringJson 
- A JSON object that contains the properties of the Data Factory Dataset.
- additionalProperties Map<String>
- A map of additional properties to associate with the Data Factory Dataset.
- annotations List<String>
- List of tags that can be used for describing the Data Factory Dataset.
- description String
- The description for the Data Factory Dataset.
- folder String
- The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
- name String
- Specifies the name of the Data Factory Dataset. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
- parameters Map<String>
- A map of parameters to associate with the Data Factory Dataset.
- schemaJson String
- A JSON object that contains the schema of the Data Factory Dataset.
Outputs
All input properties are implicitly available as output properties. Additionally, the CustomDataset 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 CustomDataset Resource
Get an existing CustomDataset 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?: CustomDatasetState, opts?: CustomResourceOptions): CustomDataset@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_properties: Optional[Mapping[str, str]] = None,
        annotations: Optional[Sequence[str]] = None,
        data_factory_id: Optional[str] = None,
        description: Optional[str] = None,
        folder: Optional[str] = None,
        linked_service: Optional[CustomDatasetLinkedServiceArgs] = None,
        name: Optional[str] = None,
        parameters: Optional[Mapping[str, str]] = None,
        schema_json: Optional[str] = None,
        type: Optional[str] = None,
        type_properties_json: Optional[str] = None) -> CustomDatasetfunc GetCustomDataset(ctx *Context, name string, id IDInput, state *CustomDatasetState, opts ...ResourceOption) (*CustomDataset, error)public static CustomDataset Get(string name, Input<string> id, CustomDatasetState? state, CustomResourceOptions? opts = null)public static CustomDataset get(String name, Output<String> id, CustomDatasetState state, CustomResourceOptions options)resources:  _:    type: azure:datafactory:CustomDataset    get:      id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- AdditionalProperties Dictionary<string, string>
- A map of additional properties to associate with the Data Factory Dataset.
- Annotations List<string>
- List of tags that can be used for describing the Data Factory Dataset.
- DataFactory stringId 
- The Data Factory ID in which to associate the Dataset 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.
- LinkedService CustomDataset Linked Service 
- A linked_serviceblock 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.
- SchemaJson string
- A JSON object that contains the schema of the Data Factory Dataset.
- Type string
- The type of dataset that will be associated with Data Factory. Changing this forces a new resource to be created.
- TypeProperties stringJson 
- A JSON object that contains the properties of the Data Factory Dataset.
- AdditionalProperties map[string]string
- A map of additional properties to associate with the Data Factory Dataset.
- Annotations []string
- List of tags that can be used for describing the Data Factory Dataset.
- DataFactory stringId 
- The Data Factory ID in which to associate the Dataset 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.
- LinkedService CustomDataset Linked Service Args 
- A linked_serviceblock 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.
- SchemaJson string
- A JSON object that contains the schema of the Data Factory Dataset.
- Type string
- The type of dataset that will be associated with Data Factory. Changing this forces a new resource to be created.
- TypeProperties stringJson 
- A JSON object that contains the properties of the Data Factory Dataset.
- additionalProperties Map<String,String>
- A map of additional properties to associate with the Data Factory Dataset.
- annotations List<String>
- List of tags that can be used for describing the Data Factory Dataset.
- dataFactory StringId 
- The Data Factory ID in which to associate the Dataset 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.
- linkedService CustomDataset Linked Service 
- A linked_serviceblock 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.
- schemaJson String
- A JSON object that contains the schema of the Data Factory Dataset.
- type String
- The type of dataset that will be associated with Data Factory. Changing this forces a new resource to be created.
- typeProperties StringJson 
- A JSON object that contains the properties of the Data Factory Dataset.
- additionalProperties {[key: string]: string}
- A map of additional properties to associate with the Data Factory Dataset.
- annotations string[]
- List of tags that can be used for describing the Data Factory Dataset.
- dataFactory stringId 
- The Data Factory ID in which to associate the Dataset 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.
- linkedService CustomDataset Linked Service 
- A linked_serviceblock 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.
- schemaJson string
- A JSON object that contains the schema of the Data Factory Dataset.
- type string
- The type of dataset that will be associated with Data Factory. Changing this forces a new resource to be created.
- typeProperties stringJson 
- A JSON object that contains the properties of the Data Factory Dataset.
- additional_properties Mapping[str, str]
- A map of additional properties to associate with the Data Factory Dataset.
- annotations Sequence[str]
- List of tags that can be used for describing the Data Factory Dataset.
- data_factory_ strid 
- The Data Factory ID in which to associate the Dataset 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.
- linked_service CustomDataset Linked Service Args 
- A linked_serviceblock 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_json str
- A JSON object that contains the schema of the Data Factory Dataset.
- type str
- The type of dataset that will be associated with Data Factory. Changing this forces a new resource to be created.
- type_properties_ strjson 
- A JSON object that contains the properties of the Data Factory Dataset.
- additionalProperties Map<String>
- A map of additional properties to associate with the Data Factory Dataset.
- annotations List<String>
- List of tags that can be used for describing the Data Factory Dataset.
- dataFactory StringId 
- The Data Factory ID in which to associate the Dataset 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.
- linkedService Property Map
- A linked_serviceblock 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.
- schemaJson String
- A JSON object that contains the schema of the Data Factory Dataset.
- type String
- The type of dataset that will be associated with Data Factory. Changing this forces a new resource to be created.
- typeProperties StringJson 
- A JSON object that contains the properties of the Data Factory Dataset.
Supporting Types
CustomDatasetLinkedService, CustomDatasetLinkedServiceArgs        
- Name string
- The name of the Data Factory Linked Service.
- Parameters Dictionary<string, string>
- A map of parameters to associate with the Data Factory Linked Service.
- Name string
- The name of the Data Factory Linked Service.
- Parameters map[string]string
- A map of parameters to associate with the Data Factory Linked Service.
- name String
- The name of the Data Factory Linked Service.
- parameters Map<String,String>
- A map of parameters to associate with the Data Factory Linked Service.
- name string
- The name of the Data Factory Linked Service.
- parameters {[key: string]: string}
- A map of parameters to associate with the Data Factory Linked Service.
- name str
- The name of the Data Factory Linked Service.
- parameters Mapping[str, str]
- A map of parameters to associate with the Data Factory Linked Service.
- name String
- The name of the Data Factory Linked Service.
- parameters Map<String>
- A map of parameters to associate with the Data Factory Linked Service.
Import
Data Factory Datasets can be imported using the resource id, e.g.
$ pulumi import azure:datafactory/customDataset:CustomDataset 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 azurermTerraform Provider.