Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. synapse
  5. IntegrationRuntimeAzure

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.synapse.IntegrationRuntimeAzure

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages a Synapse Azure Integration Runtime.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example",
    location: "West Europe",
});
const exampleAccount = new azure.storage.Account("example", {
    name: "example",
    location: example.location,
    resourceGroupName: example.name,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleContainer = new azure.storage.Container("example", {
    name: "content",
    storageAccountName: exampleAccount.name,
    containerAccessType: "private",
});
const exampleDataLakeGen2Filesystem = new azure.storage.DataLakeGen2Filesystem("example", {
    name: "example",
    storageAccountId: exampleAccount.id,
});
const exampleWorkspace = new azure.synapse.Workspace("example", {
    name: "example",
    location: example.location,
    resourceGroupName: example.name,
    storageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.id,
    sqlAdministratorLogin: "sqladminuser",
    sqlAdministratorLoginPassword: "H@Sh1CoR3!",
    managedVirtualNetworkEnabled: true,
    identity: {
        type: "SystemAssigned",
    },
});
const exampleFirewallRule = new azure.synapse.FirewallRule("example", {
    name: "AllowAll",
    synapseWorkspaceId: exampleWorkspace.id,
    startIpAddress: "0.0.0.0",
    endIpAddress: "255.255.255.255",
});
const exampleIntegrationRuntimeAzure = new azure.synapse.IntegrationRuntimeAzure("example", {
    name: "example",
    synapseWorkspaceId: exampleWorkspace.id,
    location: example.location,
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example",
    location="West Europe")
example_account = azure.storage.Account("example",
    name="example",
    location=example.location,
    resource_group_name=example.name,
    account_tier="Standard",
    account_replication_type="LRS")
example_container = azure.storage.Container("example",
    name="content",
    storage_account_name=example_account.name,
    container_access_type="private")
example_data_lake_gen2_filesystem = azure.storage.DataLakeGen2Filesystem("example",
    name="example",
    storage_account_id=example_account.id)
example_workspace = azure.synapse.Workspace("example",
    name="example",
    location=example.location,
    resource_group_name=example.name,
    storage_data_lake_gen2_filesystem_id=example_data_lake_gen2_filesystem.id,
    sql_administrator_login="sqladminuser",
    sql_administrator_login_password="H@Sh1CoR3!",
    managed_virtual_network_enabled=True,
    identity={
        "type": "SystemAssigned",
    })
example_firewall_rule = azure.synapse.FirewallRule("example",
    name="AllowAll",
    synapse_workspace_id=example_workspace.id,
    start_ip_address="0.0.0.0",
    end_ip_address="255.255.255.255")
example_integration_runtime_azure = azure.synapse.IntegrationRuntimeAzure("example",
    name="example",
    synapse_workspace_id=example_workspace.id,
    location=example.location)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/storage"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/synapse"
	"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"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
			Name:                   pulumi.String("example"),
			Location:               example.Location,
			ResourceGroupName:      example.Name,
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
		})
		if err != nil {
			return err
		}
		_, err = storage.NewContainer(ctx, "example", &storage.ContainerArgs{
			Name:                pulumi.String("content"),
			StorageAccountName:  exampleAccount.Name,
			ContainerAccessType: pulumi.String("private"),
		})
		if err != nil {
			return err
		}
		exampleDataLakeGen2Filesystem, err := storage.NewDataLakeGen2Filesystem(ctx, "example", &storage.DataLakeGen2FilesystemArgs{
			Name:             pulumi.String("example"),
			StorageAccountId: exampleAccount.ID(),
		})
		if err != nil {
			return err
		}
		exampleWorkspace, err := synapse.NewWorkspace(ctx, "example", &synapse.WorkspaceArgs{
			Name:                            pulumi.String("example"),
			Location:                        example.Location,
			ResourceGroupName:               example.Name,
			StorageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.ID(),
			SqlAdministratorLogin:           pulumi.String("sqladminuser"),
			SqlAdministratorLoginPassword:   pulumi.String("H@Sh1CoR3!"),
			ManagedVirtualNetworkEnabled:    pulumi.Bool(true),
			Identity: &synapse.WorkspaceIdentityArgs{
				Type: pulumi.String("SystemAssigned"),
			},
		})
		if err != nil {
			return err
		}
		_, err = synapse.NewFirewallRule(ctx, "example", &synapse.FirewallRuleArgs{
			Name:               pulumi.String("AllowAll"),
			SynapseWorkspaceId: exampleWorkspace.ID(),
			StartIpAddress:     pulumi.String("0.0.0.0"),
			EndIpAddress:       pulumi.String("255.255.255.255"),
		})
		if err != nil {
			return err
		}
		_, err = synapse.NewIntegrationRuntimeAzure(ctx, "example", &synapse.IntegrationRuntimeAzureArgs{
			Name:               pulumi.String("example"),
			SynapseWorkspaceId: exampleWorkspace.ID(),
			Location:           example.Location,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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",
        Location = "West Europe",
    });

    var exampleAccount = new Azure.Storage.Account("example", new()
    {
        Name = "example",
        Location = example.Location,
        ResourceGroupName = example.Name,
        AccountTier = "Standard",
        AccountReplicationType = "LRS",
    });

    var exampleContainer = new Azure.Storage.Container("example", new()
    {
        Name = "content",
        StorageAccountName = exampleAccount.Name,
        ContainerAccessType = "private",
    });

    var exampleDataLakeGen2Filesystem = new Azure.Storage.DataLakeGen2Filesystem("example", new()
    {
        Name = "example",
        StorageAccountId = exampleAccount.Id,
    });

    var exampleWorkspace = new Azure.Synapse.Workspace("example", new()
    {
        Name = "example",
        Location = example.Location,
        ResourceGroupName = example.Name,
        StorageDataLakeGen2FilesystemId = exampleDataLakeGen2Filesystem.Id,
        SqlAdministratorLogin = "sqladminuser",
        SqlAdministratorLoginPassword = "H@Sh1CoR3!",
        ManagedVirtualNetworkEnabled = true,
        Identity = new Azure.Synapse.Inputs.WorkspaceIdentityArgs
        {
            Type = "SystemAssigned",
        },
    });

    var exampleFirewallRule = new Azure.Synapse.FirewallRule("example", new()
    {
        Name = "AllowAll",
        SynapseWorkspaceId = exampleWorkspace.Id,
        StartIpAddress = "0.0.0.0",
        EndIpAddress = "255.255.255.255",
    });

    var exampleIntegrationRuntimeAzure = new Azure.Synapse.IntegrationRuntimeAzure("example", new()
    {
        Name = "example",
        SynapseWorkspaceId = exampleWorkspace.Id,
        Location = example.Location,
    });

});
Copy
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.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.storage.Container;
import com.pulumi.azure.storage.ContainerArgs;
import com.pulumi.azure.storage.DataLakeGen2Filesystem;
import com.pulumi.azure.storage.DataLakeGen2FilesystemArgs;
import com.pulumi.azure.synapse.Workspace;
import com.pulumi.azure.synapse.WorkspaceArgs;
import com.pulumi.azure.synapse.inputs.WorkspaceIdentityArgs;
import com.pulumi.azure.synapse.FirewallRule;
import com.pulumi.azure.synapse.FirewallRuleArgs;
import com.pulumi.azure.synapse.IntegrationRuntimeAzure;
import com.pulumi.azure.synapse.IntegrationRuntimeAzureArgs;
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")
            .location("West Europe")
            .build());

        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .name("example")
            .location(example.location())
            .resourceGroupName(example.name())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .build());

        var exampleContainer = new Container("exampleContainer", ContainerArgs.builder()
            .name("content")
            .storageAccountName(exampleAccount.name())
            .containerAccessType("private")
            .build());

        var exampleDataLakeGen2Filesystem = new DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", DataLakeGen2FilesystemArgs.builder()
            .name("example")
            .storageAccountId(exampleAccount.id())
            .build());

        var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()
            .name("example")
            .location(example.location())
            .resourceGroupName(example.name())
            .storageDataLakeGen2FilesystemId(exampleDataLakeGen2Filesystem.id())
            .sqlAdministratorLogin("sqladminuser")
            .sqlAdministratorLoginPassword("H@Sh1CoR3!")
            .managedVirtualNetworkEnabled(true)
            .identity(WorkspaceIdentityArgs.builder()
                .type("SystemAssigned")
                .build())
            .build());

        var exampleFirewallRule = new FirewallRule("exampleFirewallRule", FirewallRuleArgs.builder()
            .name("AllowAll")
            .synapseWorkspaceId(exampleWorkspace.id())
            .startIpAddress("0.0.0.0")
            .endIpAddress("255.255.255.255")
            .build());

        var exampleIntegrationRuntimeAzure = new IntegrationRuntimeAzure("exampleIntegrationRuntimeAzure", IntegrationRuntimeAzureArgs.builder()
            .name("example")
            .synapseWorkspaceId(exampleWorkspace.id())
            .location(example.location())
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example
      location: West Europe
  exampleAccount:
    type: azure:storage:Account
    name: example
    properties:
      name: example
      location: ${example.location}
      resourceGroupName: ${example.name}
      accountTier: Standard
      accountReplicationType: LRS
  exampleContainer:
    type: azure:storage:Container
    name: example
    properties:
      name: content
      storageAccountName: ${exampleAccount.name}
      containerAccessType: private
  exampleDataLakeGen2Filesystem:
    type: azure:storage:DataLakeGen2Filesystem
    name: example
    properties:
      name: example
      storageAccountId: ${exampleAccount.id}
  exampleWorkspace:
    type: azure:synapse:Workspace
    name: example
    properties:
      name: example
      location: ${example.location}
      resourceGroupName: ${example.name}
      storageDataLakeGen2FilesystemId: ${exampleDataLakeGen2Filesystem.id}
      sqlAdministratorLogin: sqladminuser
      sqlAdministratorLoginPassword: H@Sh1CoR3!
      managedVirtualNetworkEnabled: true
      identity:
        type: SystemAssigned
  exampleFirewallRule:
    type: azure:synapse:FirewallRule
    name: example
    properties:
      name: AllowAll
      synapseWorkspaceId: ${exampleWorkspace.id}
      startIpAddress: 0.0.0.0
      endIpAddress: 255.255.255.255
  exampleIntegrationRuntimeAzure:
    type: azure:synapse:IntegrationRuntimeAzure
    name: example
    properties:
      name: example
      synapseWorkspaceId: ${exampleWorkspace.id}
      location: ${example.location}
Copy

Create IntegrationRuntimeAzure Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new IntegrationRuntimeAzure(name: string, args: IntegrationRuntimeAzureArgs, opts?: CustomResourceOptions);
@overload
def IntegrationRuntimeAzure(resource_name: str,
                            args: IntegrationRuntimeAzureArgs,
                            opts: Optional[ResourceOptions] = None)

@overload
def IntegrationRuntimeAzure(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            synapse_workspace_id: Optional[str] = None,
                            compute_type: Optional[str] = None,
                            core_count: Optional[int] = None,
                            description: Optional[str] = None,
                            location: Optional[str] = None,
                            name: Optional[str] = None,
                            time_to_live_min: Optional[int] = None)
func NewIntegrationRuntimeAzure(ctx *Context, name string, args IntegrationRuntimeAzureArgs, opts ...ResourceOption) (*IntegrationRuntimeAzure, error)
public IntegrationRuntimeAzure(string name, IntegrationRuntimeAzureArgs args, CustomResourceOptions? opts = null)
public IntegrationRuntimeAzure(String name, IntegrationRuntimeAzureArgs args)
public IntegrationRuntimeAzure(String name, IntegrationRuntimeAzureArgs args, CustomResourceOptions options)

type: azure:synapse:IntegrationRuntimeAzure
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. IntegrationRuntimeAzureArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. IntegrationRuntimeAzureArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. IntegrationRuntimeAzureArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. IntegrationRuntimeAzureArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IntegrationRuntimeAzureArgs
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 integrationRuntimeAzureResource = new Azure.Synapse.IntegrationRuntimeAzure("integrationRuntimeAzureResource", new()
{
    SynapseWorkspaceId = "string",
    ComputeType = "string",
    CoreCount = 0,
    Description = "string",
    Location = "string",
    Name = "string",
    TimeToLiveMin = 0,
});
Copy
example, err := synapse.NewIntegrationRuntimeAzure(ctx, "integrationRuntimeAzureResource", &synapse.IntegrationRuntimeAzureArgs{
	SynapseWorkspaceId: pulumi.String("string"),
	ComputeType:        pulumi.String("string"),
	CoreCount:          pulumi.Int(0),
	Description:        pulumi.String("string"),
	Location:           pulumi.String("string"),
	Name:               pulumi.String("string"),
	TimeToLiveMin:      pulumi.Int(0),
})
Copy
var integrationRuntimeAzureResource = new IntegrationRuntimeAzure("integrationRuntimeAzureResource", IntegrationRuntimeAzureArgs.builder()
    .synapseWorkspaceId("string")
    .computeType("string")
    .coreCount(0)
    .description("string")
    .location("string")
    .name("string")
    .timeToLiveMin(0)
    .build());
Copy
integration_runtime_azure_resource = azure.synapse.IntegrationRuntimeAzure("integrationRuntimeAzureResource",
    synapse_workspace_id="string",
    compute_type="string",
    core_count=0,
    description="string",
    location="string",
    name="string",
    time_to_live_min=0)
Copy
const integrationRuntimeAzureResource = new azure.synapse.IntegrationRuntimeAzure("integrationRuntimeAzureResource", {
    synapseWorkspaceId: "string",
    computeType: "string",
    coreCount: 0,
    description: "string",
    location: "string",
    name: "string",
    timeToLiveMin: 0,
});
Copy
type: azure:synapse:IntegrationRuntimeAzure
properties:
    computeType: string
    coreCount: 0
    description: string
    location: string
    name: string
    synapseWorkspaceId: string
    timeToLiveMin: 0
Copy

IntegrationRuntimeAzure 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 IntegrationRuntimeAzure resource accepts the following input properties:

SynapseWorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Azure Integration Runtime to be created.
ComputeType string
Compute type of the cluster which will execute data flow job. Valid values are General, ComputeOptimized and MemoryOptimized. Defaults to General.
CoreCount int
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 string
Integration runtime description.
Location Changes to this property will trigger replacement. string
The Azure Region where the Synapse Azure Integration Runtime should exist. Use AutoResolve to create an auto-resolve integration runtime. Changing this forces a new Synapse Azure Integration Runtime to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Synapse Azure Integration Runtime. Changing this forces a new Synapse Azure Integration Runtime to be created.
TimeToLiveMin int
Time to live (in minutes) setting of the cluster which will execute data flow job. Defaults to 0.
SynapseWorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Azure Integration Runtime to be created.
ComputeType string
Compute type of the cluster which will execute data flow job. Valid values are General, ComputeOptimized and MemoryOptimized. Defaults to General.
CoreCount int
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 string
Integration runtime description.
Location Changes to this property will trigger replacement. string
The Azure Region where the Synapse Azure Integration Runtime should exist. Use AutoResolve to create an auto-resolve integration runtime. Changing this forces a new Synapse Azure Integration Runtime to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Synapse Azure Integration Runtime. Changing this forces a new Synapse Azure Integration Runtime to be created.
TimeToLiveMin int
Time to live (in minutes) setting of the cluster which will execute data flow job. Defaults to 0.
synapseWorkspaceId
This property is required.
Changes to this property will trigger replacement.
String
The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Azure Integration Runtime to be created.
computeType String
Compute type of the cluster which will execute data flow job. Valid values are General, ComputeOptimized and MemoryOptimized. Defaults to General.
coreCount Integer
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 String
Integration runtime description.
location Changes to this property will trigger replacement. String
The Azure Region where the Synapse Azure Integration Runtime should exist. Use AutoResolve to create an auto-resolve integration runtime. Changing this forces a new Synapse Azure Integration Runtime to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Synapse Azure Integration Runtime. Changing this forces a new Synapse Azure Integration Runtime to be created.
timeToLiveMin Integer
Time to live (in minutes) setting of the cluster which will execute data flow job. Defaults to 0.
synapseWorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Azure Integration Runtime to be created.
computeType string
Compute type of the cluster which will execute data flow job. Valid values are General, ComputeOptimized and MemoryOptimized. Defaults to General.
coreCount number
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 string
Integration runtime description.
location Changes to this property will trigger replacement. string
The Azure Region where the Synapse Azure Integration Runtime should exist. Use AutoResolve to create an auto-resolve integration runtime. Changing this forces a new Synapse Azure Integration Runtime to be created.
name Changes to this property will trigger replacement. string
The name which should be used for this Synapse Azure Integration Runtime. Changing this forces a new Synapse Azure Integration Runtime to be created.
timeToLiveMin number
Time to live (in minutes) setting of the cluster which will execute data flow job. Defaults to 0.
synapse_workspace_id
This property is required.
Changes to this property will trigger replacement.
str
The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Azure Integration Runtime to be created.
compute_type str
Compute type of the cluster which will execute data flow job. Valid values are General, ComputeOptimized and MemoryOptimized. Defaults to General.
core_count int
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 str
Integration runtime description.
location Changes to this property will trigger replacement. str
The Azure Region where the Synapse Azure Integration Runtime should exist. Use AutoResolve to create an auto-resolve integration runtime. Changing this forces a new Synapse Azure Integration Runtime to be created.
name Changes to this property will trigger replacement. str
The name which should be used for this Synapse Azure Integration Runtime. Changing this forces a new Synapse Azure Integration Runtime to be created.
time_to_live_min int
Time to live (in minutes) setting of the cluster which will execute data flow job. Defaults to 0.
synapseWorkspaceId
This property is required.
Changes to this property will trigger replacement.
String
The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Azure Integration Runtime to be created.
computeType String
Compute type of the cluster which will execute data flow job. Valid values are General, ComputeOptimized and MemoryOptimized. Defaults to General.
coreCount Number
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 String
Integration runtime description.
location Changes to this property will trigger replacement. String
The Azure Region where the Synapse Azure Integration Runtime should exist. Use AutoResolve to create an auto-resolve integration runtime. Changing this forces a new Synapse Azure Integration Runtime to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Synapse Azure Integration Runtime. Changing this forces a new Synapse Azure Integration Runtime to be created.
timeToLiveMin Number
Time to live (in minutes) setting of the cluster which will execute data flow job. Defaults to 0.

Outputs

All input properties are implicitly available as output properties. Additionally, the IntegrationRuntimeAzure 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 IntegrationRuntimeAzure Resource

Get an existing IntegrationRuntimeAzure 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?: IntegrationRuntimeAzureState, opts?: CustomResourceOptions): IntegrationRuntimeAzure
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compute_type: Optional[str] = None,
        core_count: Optional[int] = None,
        description: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        synapse_workspace_id: Optional[str] = None,
        time_to_live_min: Optional[int] = None) -> IntegrationRuntimeAzure
func GetIntegrationRuntimeAzure(ctx *Context, name string, id IDInput, state *IntegrationRuntimeAzureState, opts ...ResourceOption) (*IntegrationRuntimeAzure, error)
public static IntegrationRuntimeAzure Get(string name, Input<string> id, IntegrationRuntimeAzureState? state, CustomResourceOptions? opts = null)
public static IntegrationRuntimeAzure get(String name, Output<String> id, IntegrationRuntimeAzureState state, CustomResourceOptions options)
resources:  _:    type: azure:synapse:IntegrationRuntimeAzure    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
ComputeType string
Compute type of the cluster which will execute data flow job. Valid values are General, ComputeOptimized and MemoryOptimized. Defaults to General.
CoreCount int
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 string
Integration runtime description.
Location Changes to this property will trigger replacement. string
The Azure Region where the Synapse Azure Integration Runtime should exist. Use AutoResolve to create an auto-resolve integration runtime. Changing this forces a new Synapse Azure Integration Runtime to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Synapse Azure Integration Runtime. Changing this forces a new Synapse Azure Integration Runtime to be created.
SynapseWorkspaceId Changes to this property will trigger replacement. string
The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Azure Integration Runtime to be created.
TimeToLiveMin int
Time to live (in minutes) setting of the cluster which will execute data flow job. Defaults to 0.
ComputeType string
Compute type of the cluster which will execute data flow job. Valid values are General, ComputeOptimized and MemoryOptimized. Defaults to General.
CoreCount int
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 string
Integration runtime description.
Location Changes to this property will trigger replacement. string
The Azure Region where the Synapse Azure Integration Runtime should exist. Use AutoResolve to create an auto-resolve integration runtime. Changing this forces a new Synapse Azure Integration Runtime to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Synapse Azure Integration Runtime. Changing this forces a new Synapse Azure Integration Runtime to be created.
SynapseWorkspaceId Changes to this property will trigger replacement. string
The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Azure Integration Runtime to be created.
TimeToLiveMin int
Time to live (in minutes) setting of the cluster which will execute data flow job. Defaults to 0.
computeType String
Compute type of the cluster which will execute data flow job. Valid values are General, ComputeOptimized and MemoryOptimized. Defaults to General.
coreCount Integer
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 String
Integration runtime description.
location Changes to this property will trigger replacement. String
The Azure Region where the Synapse Azure Integration Runtime should exist. Use AutoResolve to create an auto-resolve integration runtime. Changing this forces a new Synapse Azure Integration Runtime to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Synapse Azure Integration Runtime. Changing this forces a new Synapse Azure Integration Runtime to be created.
synapseWorkspaceId Changes to this property will trigger replacement. String
The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Azure Integration Runtime to be created.
timeToLiveMin Integer
Time to live (in minutes) setting of the cluster which will execute data flow job. Defaults to 0.
computeType string
Compute type of the cluster which will execute data flow job. Valid values are General, ComputeOptimized and MemoryOptimized. Defaults to General.
coreCount number
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 string
Integration runtime description.
location Changes to this property will trigger replacement. string
The Azure Region where the Synapse Azure Integration Runtime should exist. Use AutoResolve to create an auto-resolve integration runtime. Changing this forces a new Synapse Azure Integration Runtime to be created.
name Changes to this property will trigger replacement. string
The name which should be used for this Synapse Azure Integration Runtime. Changing this forces a new Synapse Azure Integration Runtime to be created.
synapseWorkspaceId Changes to this property will trigger replacement. string
The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Azure Integration Runtime to be created.
timeToLiveMin number
Time to live (in minutes) setting of the cluster which will execute data flow job. Defaults to 0.
compute_type str
Compute type of the cluster which will execute data flow job. Valid values are General, ComputeOptimized and MemoryOptimized. Defaults to General.
core_count int
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 str
Integration runtime description.
location Changes to this property will trigger replacement. str
The Azure Region where the Synapse Azure Integration Runtime should exist. Use AutoResolve to create an auto-resolve integration runtime. Changing this forces a new Synapse Azure Integration Runtime to be created.
name Changes to this property will trigger replacement. str
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 Changes to this property will trigger replacement. str
The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Azure Integration Runtime to be created.
time_to_live_min int
Time to live (in minutes) setting of the cluster which will execute data flow job. Defaults to 0.
computeType String
Compute type of the cluster which will execute data flow job. Valid values are General, ComputeOptimized and MemoryOptimized. Defaults to General.
coreCount Number
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 String
Integration runtime description.
location Changes to this property will trigger replacement. String
The Azure Region where the Synapse Azure Integration Runtime should exist. Use AutoResolve to create an auto-resolve integration runtime. Changing this forces a new Synapse Azure Integration Runtime to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Synapse Azure Integration Runtime. Changing this forces a new Synapse Azure Integration Runtime to be created.
synapseWorkspaceId Changes to this property will trigger replacement. String
The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Azure Integration Runtime to be created.
timeToLiveMin Number
Time to live (in minutes) setting of the cluster which will execute data flow job. Defaults to 0.

Import

Synapse Azure Integration Runtimes can be imported using the resource id, e.g.

$ pulumi import azure:synapse/integrationRuntimeAzure:IntegrationRuntimeAzure example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resGroup1/providers/Microsoft.Synapse/workspaces/workspace1/integrationRuntimes/IntegrationRuntime1
Copy

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 azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure