Azure Synapse Integration Runtime Azure

This page shows how to write Terraform and Azure Resource Manager for Synapse Integration Runtime Azure and write them securely.

azurerm_synapse_integration_runtime_azure (Terraform)

The Integration Runtime Azure in Synapse can be configured in Terraform with the resource name azurerm_synapse_integration_runtime_azure. 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) The name which should be used for this Synapse Azure Integration Runtime. Changing this forces a new Synapse Azure Integration Runtime to be created.

  • synapse_workspace_id - (Required) The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Azure Integration Runtime to be created.

  • location - (Required) The Azure Region where the Synapse Azure Integration Runtime should exist. Changing this forces a new Synapse Azure Integration Runtime to be created.


  • compute_type - (Optional) Compute type of the cluster which will execute data flow job. Valid values are General, ComputeOptimized and MemoryOptimized. Defaults to General.

  • core_count - (Optional) Core count of the cluster which will execute data flow job. Valid values are 8, 16, 32, 48, 80, 144 and 272. Defaults to 8.

  • description - (Optional) Integration runtime description.

  • time_to_live_min - (Optional) Time to live (in minutes) setting of the cluster which will execute data flow job. Defaults to 0.

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

  • id - The ID of the Synapse Azure Integration Runtime.

Explanation in Terraform Registry

Manages a Synapse Azure Integration Runtime.

Tips: Best Practices for The Other Azure Synapse Resources

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

risk-label

azurerm_synapse_workspace

Ensure to enable the managed virtual network

It is better to enable the managed virtual network, which is disabled as the default.

Review your Azure Synapse 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.Synapse/workspaces/integrationruntimes (Azure Resource Manager)

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

Example Usage from GitHub

TestList.json#L36
            "type": "Microsoft.Synapse/workspaces/integrationruntimes",
            "properties": {
              "type": "SelfHosted",
              "typeProperties": {}
            },
            "etag": "01008934-0000-0100-0000-5f6059030000"
TestListAsync.json#L36
            "type": "Microsoft.Synapse/workspaces/integrationruntimes",
            "properties": {
              "type": "SelfHosted",
              "typeProperties": {}
            },
            "etag": "01008934-0000-0100-0000-5f6059030000"
TestGet.json#L36
            "type": "Microsoft.Synapse/workspaces/integrationruntimes",
            "properties": {
              "type": "SelfHosted",
              "typeProperties": {}
            },
            "etag": "01008934-0000-0100-0000-5f6059030000"
TestGetAsync.json#L36
            "type": "Microsoft.Synapse/workspaces/integrationruntimes",
            "properties": {
              "type": "SelfHosted",
              "typeProperties": {}
            },
            "etag": "01008934-0000-0100-0000-5f6059030000"
IntegrationRuntimes_List.json#L13
            "type": "Microsoft.Synapse/workspaces/integrationruntimes",
            "properties": {
              "type": "SelfHosted",
              "description": "A selfhosted integration runtime"
            },
            "etag": "0400f1a1-0000-0000-0000-5b2188640000"
IntegrationRuntimes_ListByWorkspace.json#L23
            "type": "Microsoft.Synapse/workspaces/integrationruntimes",
            "properties": {
              "type": "SelfHosted",
              "description": "A selfhosted integration runtime"
            },
            "etag": "0400f1a1-0000-0000-0000-5b2188640000"
IntegrationRuntimes_Get.json#L12
        "type": "Microsoft.Synapse/workspaces/integrationruntimes",
        "properties": {
          "type": "Managed",
          "typeProperties": {
            "computeProperties": {
              "location": "Australia Southeast",
IntegrationRuntimes_Update.json#L25
        "type": "Microsoft.Synapse/workspaces/integrationruntimes",
        "properties": {
          "type": "SelfHosted",
          "description": "A selfhosted integration runtime"
        },
        "etag": "0400f1a1-0000-0000-0000-5b2188640000"
IntegrationRuntimes_Create.json#L28
        "type": "Microsoft.Synapse/workspaces/integrationruntimes",
        "properties": {
          "type": "SelfHosted",
          "description": "A selfhosted integration runtime"
        },
        "etag": "000046c4-0000-0000-0000-5b2198bf0000"
Template.json
{
    "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "workspaceName": {

Frequently asked questions

What is Azure Synapse Integration Runtime Azure?

Azure Synapse Integration Runtime Azure is a resource for Synapse of Microsoft Azure. Settings can be wrote in Terraform.