Azure Classic

v5.24.0 published on Wednesday, Nov 9, 2022 by Pulumi

IntegrationRuntimeRule

Manages a Data Factory Azure Integration Runtime.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleFactory = new Azure.DataFactory.Factory("exampleFactory", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
    });

    var exampleIntegrationRuntimeRule = new Azure.DataFactory.IntegrationRuntimeRule("exampleIntegrationRuntimeRule", new()
    {
        DataFactoryId = exampleFactory.Id,
        Location = exampleResourceGroup.Location,
    });

});
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 {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleFactory, err := datafactory.NewFactory(ctx, "exampleFactory", &datafactory.FactoryArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
		})
		if err != nil {
			return err
		}
		_, err = datafactory.NewIntegrationRuntimeRule(ctx, "exampleIntegrationRuntimeRule", &datafactory.IntegrationRuntimeRuleArgs{
			DataFactoryId: exampleFactory.ID(),
			Location:      exampleResourceGroup.Location,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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.IntegrationRuntimeRule;
import com.pulumi.azure.datafactory.IntegrationRuntimeRuleArgs;
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .build());

        var exampleIntegrationRuntimeRule = new IntegrationRuntimeRule("exampleIntegrationRuntimeRule", IntegrationRuntimeRuleArgs.builder()        
            .dataFactoryId(exampleFactory.id())
            .location(exampleResourceGroup.location())
            .build());

    }
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_integration_runtime_rule = azure.datafactory.IntegrationRuntimeRule("exampleIntegrationRuntimeRule",
    data_factory_id=example_factory.id,
    location=example_resource_group.location)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleFactory = new azure.datafactory.Factory("exampleFactory", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleIntegrationRuntimeRule = new azure.datafactory.IntegrationRuntimeRule("exampleIntegrationRuntimeRule", {
    dataFactoryId: exampleFactory.id,
    location: exampleResourceGroup.location,
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleFactory:
    type: azure:datafactory:Factory
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
  exampleIntegrationRuntimeRule:
    type: azure:datafactory:IntegrationRuntimeRule
    properties:
      dataFactoryId: ${exampleFactory.id}
      location: ${exampleResourceGroup.location}

Create IntegrationRuntimeRule Resource

new IntegrationRuntimeRule(name: string, args: IntegrationRuntimeRuleArgs, opts?: CustomResourceOptions);
@overload
def IntegrationRuntimeRule(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           cleanup_enabled: Optional[bool] = None,
                           compute_type: Optional[str] = None,
                           core_count: Optional[int] = None,
                           data_factory_id: Optional[str] = None,
                           description: Optional[str] = None,
                           location: Optional[str] = None,
                           name: Optional[str] = None,
                           time_to_live_min: Optional[int] = None,
                           virtual_network_enabled: Optional[bool] = None)
@overload
def IntegrationRuntimeRule(resource_name: str,
                           args: IntegrationRuntimeRuleArgs,
                           opts: Optional[ResourceOptions] = None)
func NewIntegrationRuntimeRule(ctx *Context, name string, args IntegrationRuntimeRuleArgs, opts ...ResourceOption) (*IntegrationRuntimeRule, error)
public IntegrationRuntimeRule(string name, IntegrationRuntimeRuleArgs args, CustomResourceOptions? opts = null)
public IntegrationRuntimeRule(String name, IntegrationRuntimeRuleArgs args)
public IntegrationRuntimeRule(String name, IntegrationRuntimeRuleArgs args, CustomResourceOptions options)
type: azure:datafactory:IntegrationRuntimeRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args IntegrationRuntimeRuleArgs
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 IntegrationRuntimeRuleArgs
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 IntegrationRuntimeRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args IntegrationRuntimeRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args IntegrationRuntimeRuleArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

IntegrationRuntimeRule 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 IntegrationRuntimeRule 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.

CleanupEnabled bool

Cluster will not be recycled and it will be used in next data flow activity run until TTL (time to live) is reached if this is set as false. Default is true.

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 string

Specifies the supported Azure location where the resource exists. Use AutoResolve to create an auto-resolve integration runtime. Changing this forces a new resource to be created.

Name string

Specifies the name of the Managed Integration Runtime. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

TimeToLiveMin int

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

VirtualNetworkEnabled bool

Is Integration Runtime compute provisioned within Managed Virtual Network? Changing this forces a new resource to be created.

DataFactoryId string

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

CleanupEnabled bool

Cluster will not be recycled and it will be used in next data flow activity run until TTL (time to live) is reached if this is set as false. Default is true.

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 string

Specifies the supported Azure location where the resource exists. Use AutoResolve to create an auto-resolve integration runtime. Changing this forces a new resource to be created.

Name string

Specifies the name of the Managed Integration Runtime. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

TimeToLiveMin int

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

VirtualNetworkEnabled bool

Is Integration Runtime compute provisioned within Managed Virtual Network? Changing this forces a new resource to be created.

dataFactoryId String

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

cleanupEnabled Boolean

Cluster will not be recycled and it will be used in next data flow activity run until TTL (time to live) is reached if this is set as false. Default is true.

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 String

Specifies the supported Azure location where the resource exists. Use AutoResolve to create an auto-resolve integration runtime. Changing this forces a new resource to be created.

name String

Specifies the name of the Managed Integration Runtime. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

timeToLiveMin Integer

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

virtualNetworkEnabled Boolean

Is Integration Runtime compute provisioned within Managed Virtual Network? Changing this forces a new resource to be created.

dataFactoryId string

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

cleanupEnabled boolean

Cluster will not be recycled and it will be used in next data flow activity run until TTL (time to live) is reached if this is set as false. Default is true.

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 string

Specifies the supported Azure location where the resource exists. Use AutoResolve to create an auto-resolve integration runtime. Changing this forces a new resource to be created.

name string

Specifies the name of the Managed Integration Runtime. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

timeToLiveMin number

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

virtualNetworkEnabled boolean

Is Integration Runtime compute provisioned within Managed Virtual Network? Changing this forces a new resource to be created.

data_factory_id str

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

cleanup_enabled bool

Cluster will not be recycled and it will be used in next data flow activity run until TTL (time to live) is reached if this is set as false. Default is true.

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 str

Specifies the supported Azure location where the resource exists. Use AutoResolve to create an auto-resolve integration runtime. Changing this forces a new resource to be created.

name str

Specifies the name of the Managed Integration Runtime. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

time_to_live_min int

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

virtual_network_enabled bool

Is Integration Runtime compute provisioned within Managed Virtual Network? Changing this forces a new resource to be created.

dataFactoryId String

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

cleanupEnabled Boolean

Cluster will not be recycled and it will be used in next data flow activity run until TTL (time to live) is reached if this is set as false. Default is true.

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 String

Specifies the supported Azure location where the resource exists. Use AutoResolve to create an auto-resolve integration runtime. Changing this forces a new resource to be created.

name String

Specifies the name of the Managed Integration Runtime. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

timeToLiveMin Number

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

virtualNetworkEnabled Boolean

Is Integration Runtime compute provisioned within Managed Virtual Network? Changing this forces a new resource to be created.

Outputs

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

Get an existing IntegrationRuntimeRule 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?: IntegrationRuntimeRuleState, opts?: CustomResourceOptions): IntegrationRuntimeRule
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cleanup_enabled: Optional[bool] = None,
        compute_type: Optional[str] = None,
        core_count: Optional[int] = None,
        data_factory_id: Optional[str] = None,
        description: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        time_to_live_min: Optional[int] = None,
        virtual_network_enabled: Optional[bool] = None) -> IntegrationRuntimeRule
func GetIntegrationRuntimeRule(ctx *Context, name string, id IDInput, state *IntegrationRuntimeRuleState, opts ...ResourceOption) (*IntegrationRuntimeRule, error)
public static IntegrationRuntimeRule Get(string name, Input<string> id, IntegrationRuntimeRuleState? state, CustomResourceOptions? opts = null)
public static IntegrationRuntimeRule get(String name, Output<String> id, IntegrationRuntimeRuleState 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:
CleanupEnabled bool

Cluster will not be recycled and it will be used in next data flow activity run until TTL (time to live) is reached if this is set as false. Default is true.

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.

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.

Location string

Specifies the supported Azure location where the resource exists. Use AutoResolve to create an auto-resolve integration runtime. Changing this forces a new resource to be created.

Name string

Specifies the name of the Managed Integration Runtime. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

TimeToLiveMin int

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

VirtualNetworkEnabled bool

Is Integration Runtime compute provisioned within Managed Virtual Network? Changing this forces a new resource to be created.

CleanupEnabled bool

Cluster will not be recycled and it will be used in next data flow activity run until TTL (time to live) is reached if this is set as false. Default is true.

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.

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.

Location string

Specifies the supported Azure location where the resource exists. Use AutoResolve to create an auto-resolve integration runtime. Changing this forces a new resource to be created.

Name string

Specifies the name of the Managed Integration Runtime. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

TimeToLiveMin int

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

VirtualNetworkEnabled bool

Is Integration Runtime compute provisioned within Managed Virtual Network? Changing this forces a new resource to be created.

cleanupEnabled Boolean

Cluster will not be recycled and it will be used in next data flow activity run until TTL (time to live) is reached if this is set as false. Default is true.

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.

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.

location String

Specifies the supported Azure location where the resource exists. Use AutoResolve to create an auto-resolve integration runtime. Changing this forces a new resource to be created.

name String

Specifies the name of the Managed Integration Runtime. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

timeToLiveMin Integer

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

virtualNetworkEnabled Boolean

Is Integration Runtime compute provisioned within Managed Virtual Network? Changing this forces a new resource to be created.

cleanupEnabled boolean

Cluster will not be recycled and it will be used in next data flow activity run until TTL (time to live) is reached if this is set as false. Default is true.

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.

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.

location string

Specifies the supported Azure location where the resource exists. Use AutoResolve to create an auto-resolve integration runtime. Changing this forces a new resource to be created.

name string

Specifies the name of the Managed Integration Runtime. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

timeToLiveMin number

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

virtualNetworkEnabled boolean

Is Integration Runtime compute provisioned within Managed Virtual Network? Changing this forces a new resource to be created.

cleanup_enabled bool

Cluster will not be recycled and it will be used in next data flow activity run until TTL (time to live) is reached if this is set as false. Default is true.

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.

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.

location str

Specifies the supported Azure location where the resource exists. Use AutoResolve to create an auto-resolve integration runtime. Changing this forces a new resource to be created.

name str

Specifies the name of the Managed Integration Runtime. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

time_to_live_min int

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

virtual_network_enabled bool

Is Integration Runtime compute provisioned within Managed Virtual Network? Changing this forces a new resource to be created.

cleanupEnabled Boolean

Cluster will not be recycled and it will be used in next data flow activity run until TTL (time to live) is reached if this is set as false. Default is true.

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.

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.

location String

Specifies the supported Azure location where the resource exists. Use AutoResolve to create an auto-resolve integration runtime. Changing this forces a new resource to be created.

name String

Specifies the name of the Managed Integration Runtime. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

timeToLiveMin Number

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

virtualNetworkEnabled Boolean

Is Integration Runtime compute provisioned within Managed Virtual Network? Changing this forces a new resource to be created.

Import

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

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

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.