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

We recommend using Azure Native.

Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi

azure.datafactory.IntegrationRuntimeSelfHosted

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi

    Manages a Data Factory Self-hosted 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-resources",
        location: "West Europe",
    });
    const exampleFactory = new azure.datafactory.Factory("example", {
        name: "example",
        location: example.location,
        resourceGroupName: example.name,
    });
    const exampleIntegrationRuntimeSelfHosted = new azure.datafactory.IntegrationRuntimeSelfHosted("example", {
        name: "example",
        dataFactoryId: exampleFactory.id,
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_factory = azure.datafactory.Factory("example",
        name="example",
        location=example.location,
        resource_group_name=example.name)
    example_integration_runtime_self_hosted = azure.datafactory.IntegrationRuntimeSelfHosted("example",
        name="example",
        data_factory_id=example_factory.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/datafactory"
    	"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-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleFactory, err := datafactory.NewFactory(ctx, "example", &datafactory.FactoryArgs{
    			Name:              pulumi.String("example"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    		})
    		if err != nil {
    			return err
    		}
    		_, err = datafactory.NewIntegrationRuntimeSelfHosted(ctx, "example", &datafactory.IntegrationRuntimeSelfHostedArgs{
    			Name:          pulumi.String("example"),
    			DataFactoryId: exampleFactory.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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-resources",
            Location = "West Europe",
        });
    
        var exampleFactory = new Azure.DataFactory.Factory("example", new()
        {
            Name = "example",
            Location = example.Location,
            ResourceGroupName = example.Name,
        });
    
        var exampleIntegrationRuntimeSelfHosted = new Azure.DataFactory.IntegrationRuntimeSelfHosted("example", new()
        {
            Name = "example",
            DataFactoryId = exampleFactory.Id,
        });
    
    });
    
    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.datafactory.Factory;
    import com.pulumi.azure.datafactory.FactoryArgs;
    import com.pulumi.azure.datafactory.IntegrationRuntimeSelfHosted;
    import com.pulumi.azure.datafactory.IntegrationRuntimeSelfHostedArgs;
    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-resources")
                .location("West Europe")
                .build());
    
            var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()        
                .name("example")
                .location(example.location())
                .resourceGroupName(example.name())
                .build());
    
            var exampleIntegrationRuntimeSelfHosted = new IntegrationRuntimeSelfHosted("exampleIntegrationRuntimeSelfHosted", IntegrationRuntimeSelfHostedArgs.builder()        
                .name("example")
                .dataFactoryId(exampleFactory.id())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleFactory:
        type: azure:datafactory:Factory
        name: example
        properties:
          name: example
          location: ${example.location}
          resourceGroupName: ${example.name}
      exampleIntegrationRuntimeSelfHosted:
        type: azure:datafactory:IntegrationRuntimeSelfHosted
        name: example
        properties:
          name: example
          dataFactoryId: ${exampleFactory.id}
    

    Create IntegrationRuntimeSelfHosted Resource

    new IntegrationRuntimeSelfHosted(name: string, args: IntegrationRuntimeSelfHostedArgs, opts?: CustomResourceOptions);
    @overload
    def IntegrationRuntimeSelfHosted(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     data_factory_id: Optional[str] = None,
                                     description: Optional[str] = None,
                                     name: Optional[str] = None,
                                     rbac_authorizations: Optional[Sequence[IntegrationRuntimeSelfHostedRbacAuthorizationArgs]] = None,
                                     self_contained_interactive_authoring_enabled: Optional[bool] = None)
    @overload
    def IntegrationRuntimeSelfHosted(resource_name: str,
                                     args: IntegrationRuntimeSelfHostedArgs,
                                     opts: Optional[ResourceOptions] = 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:datafactory:IntegrationRuntimeSelfHosted
    properties: # The arguments to resource properties.
    options: # 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.
    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.

    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

    The IntegrationRuntimeSelfHosted resource accepts the following input properties:

    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    Description string
    Integration runtime description.
    Name string
    The name which should be used for this Data Factory. Changing this forces a new Data Factory Self-hosted Integration Runtime to be created.
    RbacAuthorizations List<IntegrationRuntimeSelfHostedRbacAuthorization>
    A rbac_authorization block as defined below. Changing this forces a new resource to be created.
    SelfContainedInteractiveAuthoringEnabled bool
    Specifies whether enable interactive authoring function when your self-hosted integration runtime is unable to establish a connection with Azure Relay.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    Description string
    Integration runtime description.
    Name string
    The name which should be used for this Data Factory. Changing this forces a new Data Factory Self-hosted Integration Runtime to be created.
    RbacAuthorizations []IntegrationRuntimeSelfHostedRbacAuthorizationArgs
    A rbac_authorization block as defined below. Changing this forces a new resource to be created.
    SelfContainedInteractiveAuthoringEnabled bool
    Specifies whether enable interactive authoring function when your self-hosted integration runtime is unable to establish a connection with Azure Relay.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    description String
    Integration runtime description.
    name String
    The name which should be used for this Data Factory. Changing this forces a new Data Factory Self-hosted Integration Runtime to be created.
    rbacAuthorizations List<IntegrationRuntimeSelfHostedRbacAuthorization>
    A rbac_authorization block as defined below. Changing this forces a new resource to be created.
    selfContainedInteractiveAuthoringEnabled Boolean
    Specifies whether enable interactive authoring function when your self-hosted integration runtime is unable to establish a connection with Azure Relay.
    dataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    description string
    Integration runtime description.
    name string
    The name which should be used for this Data Factory. Changing this forces a new Data Factory Self-hosted Integration Runtime to be created.
    rbacAuthorizations IntegrationRuntimeSelfHostedRbacAuthorization[]
    A rbac_authorization block as defined below. Changing this forces a new resource to be created.
    selfContainedInteractiveAuthoringEnabled boolean
    Specifies whether enable interactive authoring function when your self-hosted integration runtime is unable to establish a connection with Azure Relay.
    data_factory_id str
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    description str
    Integration runtime description.
    name str
    The name which should be used for this Data Factory. Changing this forces a new Data Factory Self-hosted Integration Runtime to be created.
    rbac_authorizations Sequence[IntegrationRuntimeSelfHostedRbacAuthorizationArgs]
    A rbac_authorization block as defined below. Changing this forces a new resource to be created.
    self_contained_interactive_authoring_enabled bool
    Specifies whether enable interactive authoring function when your self-hosted integration runtime is unable to establish a connection with Azure Relay.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    description String
    Integration runtime description.
    name String
    The name which should be used for this Data Factory. Changing this forces a new Data Factory Self-hosted Integration Runtime to be created.
    rbacAuthorizations List<Property Map>
    A rbac_authorization block as defined below. Changing this forces a new resource to be created.
    selfContainedInteractiveAuthoringEnabled Boolean
    Specifies whether enable interactive authoring function when your self-hosted integration runtime is unable to establish a connection with Azure Relay.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    PrimaryAuthorizationKey string
    The primary integration runtime authentication key.
    SecondaryAuthorizationKey string
    The secondary integration runtime authentication key.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrimaryAuthorizationKey string
    The primary integration runtime authentication key.
    SecondaryAuthorizationKey string
    The secondary integration runtime authentication key.
    id String
    The provider-assigned unique ID for this managed resource.
    primaryAuthorizationKey String
    The primary integration runtime authentication key.
    secondaryAuthorizationKey String
    The secondary integration runtime authentication key.
    id string
    The provider-assigned unique ID for this managed resource.
    primaryAuthorizationKey string
    The primary integration runtime authentication key.
    secondaryAuthorizationKey string
    The secondary integration runtime authentication key.
    id str
    The provider-assigned unique ID for this managed resource.
    primary_authorization_key str
    The primary integration runtime authentication key.
    secondary_authorization_key str
    The secondary integration runtime authentication key.
    id String
    The provider-assigned unique ID for this managed resource.
    primaryAuthorizationKey String
    The primary integration runtime authentication key.
    secondaryAuthorizationKey String
    The secondary integration runtime authentication key.

    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,
            data_factory_id: Optional[str] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            primary_authorization_key: Optional[str] = None,
            rbac_authorizations: Optional[Sequence[IntegrationRuntimeSelfHostedRbacAuthorizationArgs]] = None,
            secondary_authorization_key: Optional[str] = None,
            self_contained_interactive_authoring_enabled: Optional[bool] = 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)
    Resource lookup is not supported in YAML
    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:
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    Description string
    Integration runtime description.
    Name string
    The name which should be used for this Data Factory. Changing this forces a new Data Factory Self-hosted Integration Runtime to be created.
    PrimaryAuthorizationKey string
    The primary integration runtime authentication key.
    RbacAuthorizations List<IntegrationRuntimeSelfHostedRbacAuthorization>
    A rbac_authorization block as defined below. Changing this forces a new resource to be created.
    SecondaryAuthorizationKey string
    The secondary integration runtime authentication key.
    SelfContainedInteractiveAuthoringEnabled bool
    Specifies whether enable interactive authoring function when your self-hosted integration runtime is unable to establish a connection with Azure Relay.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    Description string
    Integration runtime description.
    Name string
    The name which should be used for this Data Factory. Changing this forces a new Data Factory Self-hosted Integration Runtime to be created.
    PrimaryAuthorizationKey string
    The primary integration runtime authentication key.
    RbacAuthorizations []IntegrationRuntimeSelfHostedRbacAuthorizationArgs
    A rbac_authorization block as defined below. Changing this forces a new resource to be created.
    SecondaryAuthorizationKey string
    The secondary integration runtime authentication key.
    SelfContainedInteractiveAuthoringEnabled bool
    Specifies whether enable interactive authoring function when your self-hosted integration runtime is unable to establish a connection with Azure Relay.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    description String
    Integration runtime description.
    name String
    The name which should be used for this Data Factory. Changing this forces a new Data Factory Self-hosted Integration Runtime to be created.
    primaryAuthorizationKey String
    The primary integration runtime authentication key.
    rbacAuthorizations List<IntegrationRuntimeSelfHostedRbacAuthorization>
    A rbac_authorization block as defined below. Changing this forces a new resource to be created.
    secondaryAuthorizationKey String
    The secondary integration runtime authentication key.
    selfContainedInteractiveAuthoringEnabled Boolean
    Specifies whether enable interactive authoring function when your self-hosted integration runtime is unable to establish a connection with Azure Relay.
    dataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    description string
    Integration runtime description.
    name string
    The name which should be used for this Data Factory. Changing this forces a new Data Factory Self-hosted Integration Runtime to be created.
    primaryAuthorizationKey string
    The primary integration runtime authentication key.
    rbacAuthorizations IntegrationRuntimeSelfHostedRbacAuthorization[]
    A rbac_authorization block as defined below. Changing this forces a new resource to be created.
    secondaryAuthorizationKey string
    The secondary integration runtime authentication key.
    selfContainedInteractiveAuthoringEnabled boolean
    Specifies whether enable interactive authoring function when your self-hosted integration runtime is unable to establish a connection with Azure Relay.
    data_factory_id str
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    description str
    Integration runtime description.
    name str
    The name which should be used for this Data Factory. Changing this forces a new Data Factory Self-hosted Integration Runtime to be created.
    primary_authorization_key str
    The primary integration runtime authentication key.
    rbac_authorizations Sequence[IntegrationRuntimeSelfHostedRbacAuthorizationArgs]
    A rbac_authorization block as defined below. Changing this forces a new resource to be created.
    secondary_authorization_key str
    The secondary integration runtime authentication key.
    self_contained_interactive_authoring_enabled bool
    Specifies whether enable interactive authoring function when your self-hosted integration runtime is unable to establish a connection with Azure Relay.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    description String
    Integration runtime description.
    name String
    The name which should be used for this Data Factory. Changing this forces a new Data Factory Self-hosted Integration Runtime to be created.
    primaryAuthorizationKey String
    The primary integration runtime authentication key.
    rbacAuthorizations List<Property Map>
    A rbac_authorization block as defined below. Changing this forces a new resource to be created.
    secondaryAuthorizationKey String
    The secondary integration runtime authentication key.
    selfContainedInteractiveAuthoringEnabled Boolean
    Specifies whether enable interactive authoring function when your self-hosted integration runtime is unable to establish a connection with Azure Relay.

    Supporting Types

    IntegrationRuntimeSelfHostedRbacAuthorization, IntegrationRuntimeSelfHostedRbacAuthorizationArgs

    ResourceId string

    The resource identifier of the integration runtime to be shared.

    Please Note: RBAC Authorization creates a linked Self-hosted Integration Runtime targeting the Shared Self-hosted Integration Runtime in resource_id. The linked Self-hosted Integration Runtime needs Contributor access granted to the Shared Self-hosted Data Factory.

    For more information on the configuration, please check out the Azure documentation

    ResourceId string

    The resource identifier of the integration runtime to be shared.

    Please Note: RBAC Authorization creates a linked Self-hosted Integration Runtime targeting the Shared Self-hosted Integration Runtime in resource_id. The linked Self-hosted Integration Runtime needs Contributor access granted to the Shared Self-hosted Data Factory.

    For more information on the configuration, please check out the Azure documentation

    resourceId String

    The resource identifier of the integration runtime to be shared.

    Please Note: RBAC Authorization creates a linked Self-hosted Integration Runtime targeting the Shared Self-hosted Integration Runtime in resource_id. The linked Self-hosted Integration Runtime needs Contributor access granted to the Shared Self-hosted Data Factory.

    For more information on the configuration, please check out the Azure documentation

    resourceId string

    The resource identifier of the integration runtime to be shared.

    Please Note: RBAC Authorization creates a linked Self-hosted Integration Runtime targeting the Shared Self-hosted Integration Runtime in resource_id. The linked Self-hosted Integration Runtime needs Contributor access granted to the Shared Self-hosted Data Factory.

    For more information on the configuration, please check out the Azure documentation

    resource_id str

    The resource identifier of the integration runtime to be shared.

    Please Note: RBAC Authorization creates a linked Self-hosted Integration Runtime targeting the Shared Self-hosted Integration Runtime in resource_id. The linked Self-hosted Integration Runtime needs Contributor access granted to the Shared Self-hosted Data Factory.

    For more information on the configuration, please check out the Azure documentation

    resourceId String

    The resource identifier of the integration runtime to be shared.

    Please Note: RBAC Authorization creates a linked Self-hosted Integration Runtime targeting the Shared Self-hosted Integration Runtime in resource_id. The linked Self-hosted Integration Runtime needs Contributor access granted to the Shared Self-hosted Data Factory.

    For more information on the configuration, please check out the Azure documentation

    Import

    Data Factories can be imported using the resource id, e.g.

    $ pulumi import azure:datafactory/integrationRuntimeSelfHosted:IntegrationRuntimeSelfHosted example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/integrationruntimes/example
    

    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.

    Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi