1. Packages
  2. Azure Classic
  3. API Docs
  4. synapse
  5. IntegrationRuntimeSelfHosted

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.synapse.IntegrationRuntimeSelfHosted

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    Manages a Synapse Self-hosted Integration Runtime.

    Example Usage

    using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleAccount = new Azure.Storage.Account("exampleAccount", new Azure.Storage.AccountArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
        });
        var exampleContainer = new Azure.Storage.Container("exampleContainer", new Azure.Storage.ContainerArgs
        {
            StorageAccountName = exampleAccount.Name,
            ContainerAccessType = "private",
        });
        var exampleDataLakeGen2Filesystem = new Azure.Storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", new Azure.Storage.DataLakeGen2FilesystemArgs
        {
            StorageAccountId = exampleAccount.Id,
        });
        var exampleWorkspace = new Azure.Synapse.Workspace("exampleWorkspace", new Azure.Synapse.WorkspaceArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            StorageDataLakeGen2FilesystemId = exampleDataLakeGen2Filesystem.Id,
            SqlAdministratorLogin = "sqladminuser",
            SqlAdministratorLoginPassword = "H@Sh1CoR3!",
            ManagedVirtualNetworkEnabled = true,
        });
        var exampleFirewallRule = new Azure.Synapse.FirewallRule("exampleFirewallRule", new Azure.Synapse.FirewallRuleArgs
        {
            SynapseWorkspaceId = exampleWorkspace.Id,
            StartIpAddress = "0.0.0.0",
            EndIpAddress = "255.255.255.255",
        });
        var exampleIntegrationRuntimeSelfHosted = new Azure.Synapse.IntegrationRuntimeSelfHosted("exampleIntegrationRuntimeSelfHosted", new Azure.Synapse.IntegrationRuntimeSelfHostedArgs
        {
            SynapseWorkspaceId = exampleWorkspace.Id,
        });
    }

}

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/storage"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/synapse"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
			Location:               exampleResourceGroup.Location,
			ResourceGroupName:      exampleResourceGroup.Name,
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
		})
		if err != nil {
			return err
		}
		_, err = storage.NewContainer(ctx, "exampleContainer", &storage.ContainerArgs{
			StorageAccountName:  exampleAccount.Name,
			ContainerAccessType: pulumi.String("private"),
		})
		if err != nil {
			return err
		}
		exampleDataLakeGen2Filesystem, err := storage.NewDataLakeGen2Filesystem(ctx, "exampleDataLakeGen2Filesystem", &storage.DataLakeGen2FilesystemArgs{
			StorageAccountId: exampleAccount.ID(),
		})
		if err != nil {
			return err
		}
		exampleWorkspace, err := synapse.NewWorkspace(ctx, "exampleWorkspace", &synapse.WorkspaceArgs{
			Location:                        exampleResourceGroup.Location,
			ResourceGroupName:               exampleResourceGroup.Name,
			StorageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.ID(),
			SqlAdministratorLogin:           pulumi.String("sqladminuser"),
			SqlAdministratorLoginPassword:   pulumi.String("H@Sh1CoR3!"),
			ManagedVirtualNetworkEnabled:    pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = synapse.NewFirewallRule(ctx, "exampleFirewallRule", &synapse.FirewallRuleArgs{
			SynapseWorkspaceId: exampleWorkspace.ID(),
			StartIpAddress:     pulumi.String("0.0.0.0"),
			EndIpAddress:       pulumi.String("255.255.255.255"),
		})
		if err != nil {
			return err
		}
		_, err = synapse.NewIntegrationRuntimeSelfHosted(ctx, "exampleIntegrationRuntimeSelfHosted", &synapse.IntegrationRuntimeSelfHostedArgs{
			SynapseWorkspaceId: exampleWorkspace.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleContainer = new azure.storage.Container("exampleContainer", {
    storageAccountName: exampleAccount.name,
    containerAccessType: "private",
});
const exampleDataLakeGen2Filesystem = new azure.storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", {storageAccountId: exampleAccount.id});
const exampleWorkspace = new azure.synapse.Workspace("exampleWorkspace", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    storageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.id,
    sqlAdministratorLogin: "sqladminuser",
    sqlAdministratorLoginPassword: "H@Sh1CoR3!",
    managedVirtualNetworkEnabled: true,
});
const exampleFirewallRule = new azure.synapse.FirewallRule("exampleFirewallRule", {
    synapseWorkspaceId: exampleWorkspace.id,
    startIpAddress: "0.0.0.0",
    endIpAddress: "255.255.255.255",
});
const exampleIntegrationRuntimeSelfHosted = new azure.synapse.IntegrationRuntimeSelfHosted("exampleIntegrationRuntimeSelfHosted", {synapseWorkspaceId: exampleWorkspace.id});

    import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.storage.Account("exampleAccount",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    account_tier="Standard",
    account_replication_type="LRS")
example_container = azure.storage.Container("exampleContainer",
    storage_account_name=example_account.name,
    container_access_type="private")
example_data_lake_gen2_filesystem = azure.storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", storage_account_id=example_account.id)
example_workspace = azure.synapse.Workspace("exampleWorkspace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.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)
example_firewall_rule = azure.synapse.FirewallRule("exampleFirewallRule",
    synapse_workspace_id=example_workspace.id,
    start_ip_address="0.0.0.0",
    end_ip_address="255.255.255.255")
example_integration_runtime_self_hosted = azure.synapse.IntegrationRuntimeSelfHosted("exampleIntegrationRuntimeSelfHosted", synapse_workspace_id=example_workspace.id)

    Example coming soon!

    Create IntegrationRuntimeSelfHosted Resource

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

    Constructor syntax

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

@overload
def IntegrationRuntimeSelfHosted(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 synapse_workspace_id: Optional[str] = None,
                                 description: Optional[str] = None,
                                 name: Optional[str] = None)
    func NewIntegrationRuntimeSelfHosted(ctx *Context, name string, args IntegrationRuntimeSelfHostedArgs, opts ...ResourceOption) (*IntegrationRuntimeSelfHosted, error)
    public IntegrationRuntimeSelfHosted(string name, IntegrationRuntimeSelfHostedArgs args, CustomResourceOptions? opts = null)
    public IntegrationRuntimeSelfHosted(String name, IntegrationRuntimeSelfHostedArgs args)
public IntegrationRuntimeSelfHosted(String name, IntegrationRuntimeSelfHostedArgs args, CustomResourceOptions options)

    type: azure:synapse:IntegrationRuntimeSelfHosted
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 IntegrationRuntimeSelfHostedArgs
    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 IntegrationRuntimeSelfHostedArgs
    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 IntegrationRuntimeSelfHostedArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IntegrationRuntimeSelfHostedArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IntegrationRuntimeSelfHostedArgs
    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 azureIntegrationRuntimeSelfHostedResource = new Azure.Synapse.IntegrationRuntimeSelfHosted("azureIntegrationRuntimeSelfHostedResource", new()
{
    SynapseWorkspaceId = "string",
    Description = "string",
    Name = "string",
});

    example, err := synapse.NewIntegrationRuntimeSelfHosted(ctx, "azureIntegrationRuntimeSelfHostedResource", &synapse.IntegrationRuntimeSelfHostedArgs{
	SynapseWorkspaceId: pulumi.String("string"),
	Description:        pulumi.String("string"),
	Name:               pulumi.String("string"),
})

    var azureIntegrationRuntimeSelfHostedResource = new com.pulumi.azure.synapse.IntegrationRuntimeSelfHosted("azureIntegrationRuntimeSelfHostedResource", com.pulumi.azure.synapse.IntegrationRuntimeSelfHostedArgs.builder()
    .synapseWorkspaceId("string")
    .description("string")
    .name("string")
    .build());

    azure_integration_runtime_self_hosted_resource = azure.synapse.IntegrationRuntimeSelfHosted("azureIntegrationRuntimeSelfHostedResource",
    synapse_workspace_id="string",
    description="string",
    name="string")

    const azureIntegrationRuntimeSelfHostedResource = new azure.synapse.IntegrationRuntimeSelfHosted("azureIntegrationRuntimeSelfHostedResource", {
    synapseWorkspaceId: "string",
    description: "string",
    name: "string",
});

    type: azure:synapse:IntegrationRuntimeSelfHosted
properties:
    description: string
    name: string
    synapseWorkspaceId: string

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

    SynapseWorkspaceId string
    The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Self-hosted Integration Runtime to be created.
    Description string
    Integration runtime description.
    Name string
    The name which should be used for this Synapse Self-hosted Integration Runtime. Changing this forces a new Synapse Self-hosted Integration Runtime to be created.
    SynapseWorkspaceId string
    The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Self-hosted Integration Runtime to be created.
    Description string
    Integration runtime description.
    Name string
    The name which should be used for this Synapse Self-hosted Integration Runtime. Changing this forces a new Synapse Self-hosted Integration Runtime to be created.
    synapseWorkspaceId String
    The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Self-hosted Integration Runtime to be created.
    description String
    Integration runtime description.
    name String
    The name which should be used for this Synapse Self-hosted Integration Runtime. Changing this forces a new Synapse Self-hosted Integration Runtime to be created.
    synapseWorkspaceId string
    The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Self-hosted Integration Runtime to be created.
    description string
    Integration runtime description.
    name string
    The name which should be used for this Synapse Self-hosted Integration Runtime. Changing this forces a new Synapse Self-hosted Integration Runtime to be created.
    synapse_workspace_id str
    The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Self-hosted Integration Runtime to be created.
    description str
    Integration runtime description.
    name str
    The name which should be used for this Synapse Self-hosted Integration Runtime. Changing this forces a new Synapse Self-hosted Integration Runtime to be created.
    synapseWorkspaceId String
    The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Self-hosted Integration Runtime to be created.
    description String
    Integration runtime description.
    name String
    The name which should be used for this Synapse Self-hosted Integration Runtime. Changing this forces a new Synapse Self-hosted Integration Runtime to be created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IntegrationRuntimeSelfHosted resource produces the following output properties:

    AuthorizationKeyPrimary string
    The primary integration runtime authentication key.
    AuthorizationKeySecondary string
    The secondary integration runtime authentication key.
    Id string
    The provider-assigned unique ID for this managed resource.
    AuthorizationKeyPrimary string
    The primary integration runtime authentication key.
    AuthorizationKeySecondary string
    The secondary integration runtime authentication key.
    Id string
    The provider-assigned unique ID for this managed resource.
    authorizationKeyPrimary String
    The primary integration runtime authentication key.
    authorizationKeySecondary String
    The secondary integration runtime authentication key.
    id String
    The provider-assigned unique ID for this managed resource.
    authorizationKeyPrimary string
    The primary integration runtime authentication key.
    authorizationKeySecondary string
    The secondary integration runtime authentication key.
    id string
    The provider-assigned unique ID for this managed resource.
    authorization_key_primary str
    The primary integration runtime authentication key.
    authorization_key_secondary str
    The secondary integration runtime authentication key.
    id str
    The provider-assigned unique ID for this managed resource.
    authorizationKeyPrimary String
    The primary integration runtime authentication key.
    authorizationKeySecondary String
    The secondary integration runtime authentication key.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing IntegrationRuntimeSelfHosted Resource

    Get an existing IntegrationRuntimeSelfHosted 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?: IntegrationRuntimeSelfHostedState, opts?: CustomResourceOptions): IntegrationRuntimeSelfHosted
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authorization_key_primary: Optional[str] = None,
        authorization_key_secondary: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        synapse_workspace_id: Optional[str] = None) -> IntegrationRuntimeSelfHosted
    func GetIntegrationRuntimeSelfHosted(ctx *Context, name string, id IDInput, state *IntegrationRuntimeSelfHostedState, opts ...ResourceOption) (*IntegrationRuntimeSelfHosted, error)
    public static IntegrationRuntimeSelfHosted Get(string name, Input<string> id, IntegrationRuntimeSelfHostedState? state, CustomResourceOptions? opts = null)
    public static IntegrationRuntimeSelfHosted get(String name, Output<String> id, IntegrationRuntimeSelfHostedState state, CustomResourceOptions options)
    resources:  _:    type: azure:synapse:IntegrationRuntimeSelfHosted    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.
    The following state arguments are supported:
    AuthorizationKeyPrimary string
    The primary integration runtime authentication key.
    AuthorizationKeySecondary string
    The secondary integration runtime authentication key.
    Description string
    Integration runtime description.
    Name string
    The name which should be used for this Synapse Self-hosted Integration Runtime. Changing this forces a new Synapse Self-hosted Integration Runtime to be created.
    SynapseWorkspaceId string
    The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Self-hosted Integration Runtime to be created.
    AuthorizationKeyPrimary string
    The primary integration runtime authentication key.
    AuthorizationKeySecondary string
    The secondary integration runtime authentication key.
    Description string
    Integration runtime description.
    Name string
    The name which should be used for this Synapse Self-hosted Integration Runtime. Changing this forces a new Synapse Self-hosted Integration Runtime to be created.
    SynapseWorkspaceId string
    The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Self-hosted Integration Runtime to be created.
    authorizationKeyPrimary String
    The primary integration runtime authentication key.
    authorizationKeySecondary String
    The secondary integration runtime authentication key.
    description String
    Integration runtime description.
    name String
    The name which should be used for this Synapse Self-hosted Integration Runtime. Changing this forces a new Synapse Self-hosted Integration Runtime to be created.
    synapseWorkspaceId String
    The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Self-hosted Integration Runtime to be created.
    authorizationKeyPrimary string
    The primary integration runtime authentication key.
    authorizationKeySecondary string
    The secondary integration runtime authentication key.
    description string
    Integration runtime description.
    name string
    The name which should be used for this Synapse Self-hosted Integration Runtime. Changing this forces a new Synapse Self-hosted Integration Runtime to be created.
    synapseWorkspaceId string
    The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Self-hosted Integration Runtime to be created.
    authorization_key_primary str
    The primary integration runtime authentication key.
    authorization_key_secondary str
    The secondary integration runtime authentication key.
    description str
    Integration runtime description.
    name str
    The name which should be used for this Synapse Self-hosted Integration Runtime. Changing this forces a new Synapse Self-hosted Integration Runtime to be created.
    synapse_workspace_id str
    The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Self-hosted Integration Runtime to be created.
    authorizationKeyPrimary String
    The primary integration runtime authentication key.
    authorizationKeySecondary String
    The secondary integration runtime authentication key.
    description String
    Integration runtime description.
    name String
    The name which should be used for this Synapse Self-hosted Integration Runtime. Changing this forces a new Synapse Self-hosted Integration Runtime to be created.
    synapseWorkspaceId String
    The Synapse Workspace ID in which to associate the Integration Runtime with. Changing this forces a new Synapse Self-hosted Integration Runtime to be created.

    Import

    Synapse Self-hosted Integration Runtimes can be imported using the resource id, e.g.

     $ pulumi import azure:synapse/integrationRuntimeSelfHosted:IntegrationRuntimeSelfHosted example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resGroup1/providers/Microsoft.Synapse/workspaces/workspace1/integrationruntimes/IntegrationRuntime1

    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.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure
      Try Pulumi Cloud free. Your team will thank you.