azurermDataFactoryDatasetAzureBlob
Manages an Azure Blob Dataset inside an Azure Data Factory.
Example Usage
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
this,
"example",
{
location: "West Europe",
name: "example-resources",
}
);
const dataAzurermStorageAccountExample =
new azurerm.dataAzurermStorageAccount.DataAzurermStorageAccount(
this,
"example_1",
{
name: "storageaccountname",
resource_group_name: azurermResourceGroupExample.name,
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
dataAzurermStorageAccountExample.overrideLogicalId("example");
const azurermDataFactoryExample = new azurerm.dataFactory.DataFactory(
this,
"example_2",
{
location: azurermResourceGroupExample.location,
name: "example",
resource_group_name: azurermResourceGroupExample.name,
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermDataFactoryExample.overrideLogicalId("example");
const azurermDataFactoryLinkedServiceAzureBlobStorageExample =
new azurerm.dataFactoryLinkedServiceAzureBlobStorage.DataFactoryLinkedServiceAzureBlobStorage(
this,
"example_3",
{
connection_string:
dataAzurermStorageAccountExample.primaryConnectionString,
data_factory_id: azurermDataFactoryExample.id,
name: "example",
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermDataFactoryLinkedServiceAzureBlobStorageExample.overrideLogicalId(
"example"
);
const azurermDataFactoryDatasetAzureBlobExample =
new azurerm.dataFactoryDatasetAzureBlob.DataFactoryDatasetAzureBlob(
this,
"example_4",
{
data_factory_id: azurermDataFactoryExample.id,
filename: "bar.png",
linked_service_name:
azurermDataFactoryLinkedServiceAzureBlobStorageExample.name,
name: "example",
path: "foo",
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermDataFactoryDatasetAzureBlobExample.overrideLogicalId("example");
Argument Reference
The following supported arguments are common across all Azure Data Factory Datasets:
-
name
- (Required) 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. -
dataFactoryId
- (Required) The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource. -
linkedServiceName
- (Required) The Data Factory Linked Service name in which to associate the Dataset with. -
folder
- (Optional) The folder that this Dataset is in. If not specified, the Dataset will appear at the root level. -
schemaColumn
- (Optional) AschemaColumn
block as defined below. -
description
- (Optional) The description for the Data Factory Dataset. -
annotations
- (Optional) List of tags that can be used for describing the Data Factory Dataset. -
parameters
- (Optional) A map of parameters to associate with the Data Factory Dataset. -
additionalProperties
- (Optional) A map of additional properties to associate with the Data Factory Dataset.
The following supported arguments are specific to Azure Blob Dataset:
-
path
- (Optional) The path of the Azure Blob. -
filename
- (Optional) The filename of the Azure Blob. -
dynamicPathEnabled
- (Optional) Is thepath
using dynamic expression, function or system variables? Defaults tofalse
. -
dynamicFilenameEnabled
- (Optional) Is thefilename
using dynamic expression, function or system variables? Defaults tofalse
.
A schemaColumn
block supports the following:
-
name
- (Required) The name of the column. -
type
- (Optional) Type of the column. Valid values arebyte
,byte[]
,boolean
,date
,dateTime
,dateTimeOffset
,decimal
,double
,guid
,int16
,int32
,int64
,single
,string
,timeSpan
. Please note these values are case sensitive. -
description
- (Optional) The description of the column.
Attributes Reference
The following attributes are exported:
id
- The ID of the Data Factory Dataset.
Timeouts
The timeouts
block allows you to specify timeouts for certain actions:
create
- (Defaults to 30 minutes) Used when creating the Data Factory Dataset.update
- (Defaults to 30 minutes) Used when updating the Data Factory Dataset.read
- (Defaults to 5 minutes) Used when retrieving the Data Factory Dataset.delete
- (Defaults to 30 minutes) Used when deleting the Data Factory Dataset.
Import
Data Factory Datasets can be imported using the resourceId
, e.g.