Top / Microsoft Azure / Azure Data Factory / Dataset Binary

Azure Data Factory Dataset Binary

This page shows how to write Terraform and Azure Resource Manager for Data Factory Dataset Binary and write them securely.

terraform-logo

Review your .tf file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

azurerm_data_factory_dataset_binary (Terraform)

The Dataset Binary in Data Factory can be configured in Terraform with the resource name azurerm_data_factory_dataset_binary. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Review your Terraform file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

The following arguments are supported:

  • name - (Required) 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.

  • data_factory_name - (Required) The Data Factory name in which to associate the Binary Dataset with. Changing this forces a new resource.

  • linked_service_name - (Required) The Data Factory Linked Service name in which to associate the Binary Dataset with.

  • resource_group_name - (Required) The name of the Resource Group where the Data Factory should exist. Changing this forces a new Data Factory Binary Dataset to be created.

  • additional_properties - (Optional) A map of additional properties to associate with the Data Factory Binary Dataset.

  • annotations - (Optional) List of tags that can be used for describing the Data Factory Binary Dataset.

  • compression - (Optional) A compression block as defined below.

  • description - (Optional) The description for the Data Factory Dataset.

  • folder - (Optional) The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.

  • parameters - (Optional) 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:

  • http_server_location - (Optional) A http_server_location block as defined below.

  • azure_blob_storage_location - (Optional) A azure_blob_storage_location block as defined below.

  • sftp_server_location - (Optional) A sftp_server_location block as defined below.

A compression block supports the following:

  • type - (Required) The type of compression used during transport.

  • level - (Optional) The level of compression. Possible values are Fastest and Optimal.

A http_server_location block supports the following:

  • relative_url - (Required) The base URL to the web server hosting the file.

  • path - (Required) The folder path to the file on the web server.

  • filename - (Required) The filename of the file on the web server.

  • dynamic_path_enabled - (Optional) Is the path using dynamic expression, function or system variables? Defaults to false.

  • dynamic_filename_enabled - (Optional) Is the filename using dynamic expression, function or system variables? Defaults to false.

A azure_blob_storage_location block supports the following:

  • container - (Required) The container on the Azure Blob Storage Account hosting the file.

  • path - (Optional) The folder path to the file in the blob container.

  • filename - (Optional) The filename of the file in the blob container.

  • dynamic_path_enabled - (Optional) Is the path using dynamic expression, function or system variables? Defaults to false.

  • dynamic_filename_enabled - (Optional) Is the filename using dynamic expression, function or system variables? Defaults to false.

A sftp_server_location block supports the following:

  • path - (Required) The folder path to the file on the SFTP server.

  • filename - (Required) The filename of the file on the SFTP server.

  • dynamic_path_enabled - (Optional) Is the path using dynamic expression, function or system variables? Defaults to false.

  • dynamic_filename_enabled - (Optional) Is the filename using dynamic expression, function or system variables? Defaults to false.

In addition to the Arguments listed above - the following Attributes are exported:

  • id - The ID of the Data Factory Dataset.

>> from Terraform Registry

Explanation in Terraform Registry

Manages a Data Factory Binary Dataset inside an Azure Data Factory.

>> from Terraform Registry

Tips: Best Practices for The Other Azure Data Factory Resources

In addition to the azurerm_data_factory, Azure Data Factory has the other resources that should be configured for security reasons. Please check some examples of those resources and precautions.

risk-label

azurerm_data_factory

Ensure to disable public access

It is better to disable public access for Data Factory, which is enabled as default.

Review your Azure Data Factory settings

In addition to the above, there are other security points you should be aware of making sure that your .tf files are protected in Shisho Cloud.

Microsoft.DataFactory/factories/datasets (Azure Resource Manager)

The factories/datasets in Microsoft.DataFactory can be configured in Azure Resource Manager with the resource name Microsoft.DataFactory/factories/datasets. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Parameters

  • apiVersion required - string
  • name required - string

    The dataset name.

  • properties required
      • additionalProperties optional - object

        Unmatched properties from the message are deserialized this collection

      • annotations optional - array

        List of tags that can be used for describing the Dataset.

      • description optional - string

        Dataset description.

      • folder optional
          • name optional - string

            The name of the folder that this Dataset is in.

      • linkedServiceName required
          • parameters optional - object

            An object mapping parameter names to argument values.

          • referenceName required - string

            Reference LinkedService name.

          • type required - string

            Linked service reference type.

      • parameters optional - undefined

        Definition of all parameters for an entity.

      • schema optional - object

        Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

      • structure optional - object

        Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

  • type required - string

>> from Azure Resource Manager Documentation

The Other Related Azure Data Factory Resources

Frequently asked questions

What is Azure Data Factory Dataset Binary?

Azure Data Factory Dataset Binary is a resource for Data Factory of Microsoft Azure. Settings can be wrote in Terraform.

security-icon

Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.

Table of Contents