Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. datafactory
  5. LinkedCustomService

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-azure

azure.datafactory.LinkedCustomService

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Linked Service (connection) between a resource and Azure Data Factory. This is a generic resource that supports all different Linked Service Types.

    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,
    identity: {
        type: "SystemAssigned",
    },
});
const exampleAccount = new azure.storage.Account("example", {
    name: "example",
    resourceGroupName: example.name,
    location: example.location,
    accountKind: "BlobStorage",
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleLinkedCustomService = new azure.datafactory.LinkedCustomService("example", {
    name: "example",
    dataFactoryId: exampleFactory.id,
    type: "AzureBlobStorage",
    description: "test description",
    typePropertiesJson: pulumi.interpolate`{
  "connectionString":"${exampleAccount.primaryConnectionString}"
}
`,
    parameters: {
        foo: "bar",
        Env: "Test",
    },
    annotations: [
        "test1",
        "test2",
        "test3",
    ],
});

    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,
    identity={
        "type": "SystemAssigned",
    })
example_account = azure.storage.Account("example",
    name="example",
    resource_group_name=example.name,
    location=example.location,
    account_kind="BlobStorage",
    account_tier="Standard",
    account_replication_type="LRS")
example_linked_custom_service = azure.datafactory.LinkedCustomService("example",
    name="example",
    data_factory_id=example_factory.id,
    type="AzureBlobStorage",
    description="test description",
    type_properties_json=example_account.primary_connection_string.apply(lambda primary_connection_string: f"""{{
  "connectionString":"{primary_connection_string}"
}}
"""),
    parameters={
        "foo": "bar",
        "Env": "Test",
    },
    annotations=[
        "test1",
        "test2",
        "test3",
    ])

    package main

import (
	"fmt"

	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/datafactory"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/storage"
	"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,
			Identity: &datafactory.FactoryIdentityArgs{
				Type: pulumi.String("SystemAssigned"),
			},
		})
		if err != nil {
			return err
		}
		exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
			Name:                   pulumi.String("example"),
			ResourceGroupName:      example.Name,
			Location:               example.Location,
			AccountKind:            pulumi.String("BlobStorage"),
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
		})
		if err != nil {
			return err
		}
		_, err = datafactory.NewLinkedCustomService(ctx, "example", &datafactory.LinkedCustomServiceArgs{
			Name:          pulumi.String("example"),
			DataFactoryId: exampleFactory.ID(),
			Type:          pulumi.String("AzureBlobStorage"),
			Description:   pulumi.String("test description"),
			TypePropertiesJson: exampleAccount.PrimaryConnectionString.ApplyT(func(primaryConnectionString string) (string, error) {
				return fmt.Sprintf("{\n  \"connectionString\":\"%v\"\n}\n", primaryConnectionString), nil
			}).(pulumi.StringOutput),
			Parameters: pulumi.StringMap{
				"foo": pulumi.String("bar"),
				"Env": pulumi.String("Test"),
			},
			Annotations: pulumi.StringArray{
				pulumi.String("test1"),
				pulumi.String("test2"),
				pulumi.String("test3"),
			},
		})
		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,
        Identity = new Azure.DataFactory.Inputs.FactoryIdentityArgs
        {
            Type = "SystemAssigned",
        },
    });

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

    var exampleLinkedCustomService = new Azure.DataFactory.LinkedCustomService("example", new()
    {
        Name = "example",
        DataFactoryId = exampleFactory.Id,
        Type = "AzureBlobStorage",
        Description = "test description",
        TypePropertiesJson = exampleAccount.PrimaryConnectionString.Apply(primaryConnectionString => @$"{{
  ""connectionString"":""{primaryConnectionString}""
}}
"),
        Parameters = 
        {
            { "foo", "bar" },
            { "Env", "Test" },
        },
        Annotations = new[]
        {
            "test1",
            "test2",
            "test3",
        },
    });

});

    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.inputs.FactoryIdentityArgs;
import com.pulumi.azure.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.datafactory.LinkedCustomService;
import com.pulumi.azure.datafactory.LinkedCustomServiceArgs;
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())
            .identity(FactoryIdentityArgs.builder()
                .type("SystemAssigned")
                .build())
            .build());

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

        var exampleLinkedCustomService = new LinkedCustomService("exampleLinkedCustomService", LinkedCustomServiceArgs.builder()
            .name("example")
            .dataFactoryId(exampleFactory.id())
            .type("AzureBlobStorage")
            .description("test description")
            .typePropertiesJson(exampleAccount.primaryConnectionString().applyValue(primaryConnectionString -> """
{
  "connectionString":"%s"
}
", primaryConnectionString)))
            .parameters(Map.ofEntries(
                Map.entry("foo", "bar"),
                Map.entry("Env", "Test")
            ))
            .annotations(            
                "test1",
                "test2",
                "test3")
            .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}
      identity:
        type: SystemAssigned
  exampleAccount:
    type: azure:storage:Account
    name: example
    properties:
      name: example
      resourceGroupName: ${example.name}
      location: ${example.location}
      accountKind: BlobStorage
      accountTier: Standard
      accountReplicationType: LRS
  exampleLinkedCustomService:
    type: azure:datafactory:LinkedCustomService
    name: example
    properties:
      name: example
      dataFactoryId: ${exampleFactory.id}
      type: AzureBlobStorage
      description: test description
      typePropertiesJson: |
        {
          "connectionString":"${exampleAccount.primaryConnectionString}"
        }        
      parameters:
        foo: bar
        Env: Test
      annotations:
        - test1
        - test2
        - test3

    Create LinkedCustomService Resource

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

    Constructor syntax

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

@overload
def LinkedCustomService(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        data_factory_id: Optional[str] = None,
                        type: Optional[str] = None,
                        type_properties_json: Optional[str] = None,
                        additional_properties: Optional[Mapping[str, str]] = None,
                        annotations: Optional[Sequence[str]] = None,
                        description: Optional[str] = None,
                        integration_runtime: Optional[LinkedCustomServiceIntegrationRuntimeArgs] = None,
                        name: Optional[str] = None,
                        parameters: Optional[Mapping[str, str]] = None)
    func NewLinkedCustomService(ctx *Context, name string, args LinkedCustomServiceArgs, opts ...ResourceOption) (*LinkedCustomService, error)
    public LinkedCustomService(string name, LinkedCustomServiceArgs args, CustomResourceOptions? opts = null)
    public LinkedCustomService(String name, LinkedCustomServiceArgs args)
public LinkedCustomService(String name, LinkedCustomServiceArgs args, CustomResourceOptions options)

    type: azure:datafactory:LinkedCustomService
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 LinkedCustomServiceArgs
    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 LinkedCustomServiceArgs
    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 LinkedCustomServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LinkedCustomServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LinkedCustomServiceArgs
    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 linkedCustomServiceResource = new Azure.DataFactory.LinkedCustomService("linkedCustomServiceResource", new()
{
    DataFactoryId = "string",
    Type = "string",
    TypePropertiesJson = "string",
    AdditionalProperties = 
    {
        { "string", "string" },
    },
    Annotations = new[]
    {
        "string",
    },
    Description = "string",
    IntegrationRuntime = new Azure.DataFactory.Inputs.LinkedCustomServiceIntegrationRuntimeArgs
    {
        Name = "string",
        Parameters = 
        {
            { "string", "string" },
        },
    },
    Name = "string",
    Parameters = 
    {
        { "string", "string" },
    },
});

    example, err := datafactory.NewLinkedCustomService(ctx, "linkedCustomServiceResource", &datafactory.LinkedCustomServiceArgs{
	DataFactoryId:      pulumi.String("string"),
	Type:               pulumi.String("string"),
	TypePropertiesJson: pulumi.String("string"),
	AdditionalProperties: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Annotations: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	IntegrationRuntime: &datafactory.LinkedCustomServiceIntegrationRuntimeArgs{
		Name: pulumi.String("string"),
		Parameters: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
	Parameters: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var linkedCustomServiceResource = new LinkedCustomService("linkedCustomServiceResource", LinkedCustomServiceArgs.builder()
    .dataFactoryId("string")
    .type("string")
    .typePropertiesJson("string")
    .additionalProperties(Map.of("string", "string"))
    .annotations("string")
    .description("string")
    .integrationRuntime(LinkedCustomServiceIntegrationRuntimeArgs.builder()
        .name("string")
        .parameters(Map.of("string", "string"))
        .build())
    .name("string")
    .parameters(Map.of("string", "string"))
    .build());

    linked_custom_service_resource = azure.datafactory.LinkedCustomService("linkedCustomServiceResource",
    data_factory_id="string",
    type="string",
    type_properties_json="string",
    additional_properties={
        "string": "string",
    },
    annotations=["string"],
    description="string",
    integration_runtime={
        "name": "string",
        "parameters": {
            "string": "string",
        },
    },
    name="string",
    parameters={
        "string": "string",
    })

    const linkedCustomServiceResource = new azure.datafactory.LinkedCustomService("linkedCustomServiceResource", {
    dataFactoryId: "string",
    type: "string",
    typePropertiesJson: "string",
    additionalProperties: {
        string: "string",
    },
    annotations: ["string"],
    description: "string",
    integrationRuntime: {
        name: "string",
        parameters: {
            string: "string",
        },
    },
    name: "string",
    parameters: {
        string: "string",
    },
});

    type: azure:datafactory:LinkedCustomService
properties:
    additionalProperties:
        string: string
    annotations:
        - string
    dataFactoryId: string
    description: string
    integrationRuntime:
        name: string
        parameters:
            string: string
    name: string
    parameters:
        string: string
    type: string
    typePropertiesJson: string

    LinkedCustomService 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 LinkedCustomService 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.
    Type string
    The type of data stores that will be connected to Data Factory. For full list of supported data stores, please refer to Azure Data Factory connector. Please refer to Microsoft.DataFactory factories/linkedservices for the type values syntax. Changing this forces a new resource to be created.
    TypePropertiesJson string
    A JSON object that contains the properties of the Data Factory Linked Service.
    AdditionalProperties Dictionary<string, string>
    A map of additional properties to associate with the Data Factory Linked Service.
    Annotations List<string>
    List of tags that can be used for describing the Data Factory Linked Service.
    Description string
    The description for the Data Factory Linked Service.
    IntegrationRuntime LinkedCustomServiceIntegrationRuntime
    An integration_runtime block as defined below.
    Name string
    Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
    Parameters Dictionary<string, string>
    A map of parameters to associate with the Data Factory Linked Service.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    Type string
    The type of data stores that will be connected to Data Factory. For full list of supported data stores, please refer to Azure Data Factory connector. Please refer to Microsoft.DataFactory factories/linkedservices for the type values syntax. Changing this forces a new resource to be created.
    TypePropertiesJson string
    A JSON object that contains the properties of the Data Factory Linked Service.
    AdditionalProperties map[string]string
    A map of additional properties to associate with the Data Factory Linked Service.
    Annotations []string
    List of tags that can be used for describing the Data Factory Linked Service.
    Description string
    The description for the Data Factory Linked Service.
    IntegrationRuntime LinkedCustomServiceIntegrationRuntimeArgs
    An integration_runtime block as defined below.
    Name string
    Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
    Parameters map[string]string
    A map of parameters to associate with the Data Factory Linked Service.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    type String
    The type of data stores that will be connected to Data Factory. For full list of supported data stores, please refer to Azure Data Factory connector. Please refer to Microsoft.DataFactory factories/linkedservices for the type values syntax. Changing this forces a new resource to be created.
    typePropertiesJson String
    A JSON object that contains the properties of the Data Factory Linked Service.
    additionalProperties Map<String,String>
    A map of additional properties to associate with the Data Factory Linked Service.
    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service.
    description String
    The description for the Data Factory Linked Service.
    integrationRuntime LinkedCustomServiceIntegrationRuntime
    An integration_runtime block as defined below.
    name String
    Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
    parameters Map<String,String>
    A map of parameters to associate with the Data Factory Linked Service.
    dataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    type string
    The type of data stores that will be connected to Data Factory. For full list of supported data stores, please refer to Azure Data Factory connector. Please refer to Microsoft.DataFactory factories/linkedservices for the type values syntax. Changing this forces a new resource to be created.
    typePropertiesJson string
    A JSON object that contains the properties of the Data Factory Linked Service.
    additionalProperties {[key: string]: string}
    A map of additional properties to associate with the Data Factory Linked Service.
    annotations string[]
    List of tags that can be used for describing the Data Factory Linked Service.
    description string
    The description for the Data Factory Linked Service.
    integrationRuntime LinkedCustomServiceIntegrationRuntime
    An integration_runtime block as defined below.
    name string
    Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
    parameters {[key: string]: string}
    A map of parameters to associate with the Data Factory Linked Service.
    data_factory_id str
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    type str
    The type of data stores that will be connected to Data Factory. For full list of supported data stores, please refer to Azure Data Factory connector. Please refer to Microsoft.DataFactory factories/linkedservices for the type values syntax. Changing this forces a new resource to be created.
    type_properties_json str
    A JSON object that contains the properties of the Data Factory Linked Service.
    additional_properties Mapping[str, str]
    A map of additional properties to associate with the Data Factory Linked Service.
    annotations Sequence[str]
    List of tags that can be used for describing the Data Factory Linked Service.
    description str
    The description for the Data Factory Linked Service.
    integration_runtime LinkedCustomServiceIntegrationRuntimeArgs
    An integration_runtime block as defined below.
    name str
    Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
    parameters Mapping[str, str]
    A map of parameters to associate with the Data Factory Linked Service.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    type String
    The type of data stores that will be connected to Data Factory. For full list of supported data stores, please refer to Azure Data Factory connector. Please refer to Microsoft.DataFactory factories/linkedservices for the type values syntax. Changing this forces a new resource to be created.
    typePropertiesJson String
    A JSON object that contains the properties of the Data Factory Linked Service.
    additionalProperties Map<String>
    A map of additional properties to associate with the Data Factory Linked Service.
    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service.
    description String
    The description for the Data Factory Linked Service.
    integrationRuntime Property Map
    An integration_runtime block as defined below.
    name String
    Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
    parameters Map<String>
    A map of parameters to associate with the Data Factory Linked Service.

    Outputs

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

    Get an existing LinkedCustomService 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?: LinkedCustomServiceState, opts?: CustomResourceOptions): LinkedCustomService
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_properties: Optional[Mapping[str, str]] = None,
        annotations: Optional[Sequence[str]] = None,
        data_factory_id: Optional[str] = None,
        description: Optional[str] = None,
        integration_runtime: Optional[LinkedCustomServiceIntegrationRuntimeArgs] = None,
        name: Optional[str] = None,
        parameters: Optional[Mapping[str, str]] = None,
        type: Optional[str] = None,
        type_properties_json: Optional[str] = None) -> LinkedCustomService
    func GetLinkedCustomService(ctx *Context, name string, id IDInput, state *LinkedCustomServiceState, opts ...ResourceOption) (*LinkedCustomService, error)
    public static LinkedCustomService Get(string name, Input<string> id, LinkedCustomServiceState? state, CustomResourceOptions? opts = null)
    public static LinkedCustomService get(String name, Output<String> id, LinkedCustomServiceState 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:
    AdditionalProperties Dictionary<string, string>
    A map of additional properties to associate with the Data Factory Linked Service.
    Annotations List<string>
    List of tags that can be used for describing the Data Factory Linked Service.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    Description string
    The description for the Data Factory Linked Service.
    IntegrationRuntime LinkedCustomServiceIntegrationRuntime
    An integration_runtime block as defined below.
    Name string
    Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
    Parameters Dictionary<string, string>
    A map of parameters to associate with the Data Factory Linked Service.
    Type string
    The type of data stores that will be connected to Data Factory. For full list of supported data stores, please refer to Azure Data Factory connector. Please refer to Microsoft.DataFactory factories/linkedservices for the type values syntax. Changing this forces a new resource to be created.
    TypePropertiesJson string
    A JSON object that contains the properties of the Data Factory Linked Service.
    AdditionalProperties map[string]string
    A map of additional properties to associate with the Data Factory Linked Service.
    Annotations []string
    List of tags that can be used for describing the Data Factory Linked Service.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    Description string
    The description for the Data Factory Linked Service.
    IntegrationRuntime LinkedCustomServiceIntegrationRuntimeArgs
    An integration_runtime block as defined below.
    Name string
    Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
    Parameters map[string]string
    A map of parameters to associate with the Data Factory Linked Service.
    Type string
    The type of data stores that will be connected to Data Factory. For full list of supported data stores, please refer to Azure Data Factory connector. Please refer to Microsoft.DataFactory factories/linkedservices for the type values syntax. Changing this forces a new resource to be created.
    TypePropertiesJson string
    A JSON object that contains the properties of the Data Factory Linked Service.
    additionalProperties Map<String,String>
    A map of additional properties to associate with the Data Factory Linked Service.
    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    description String
    The description for the Data Factory Linked Service.
    integrationRuntime LinkedCustomServiceIntegrationRuntime
    An integration_runtime block as defined below.
    name String
    Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
    parameters Map<String,String>
    A map of parameters to associate with the Data Factory Linked Service.
    type String
    The type of data stores that will be connected to Data Factory. For full list of supported data stores, please refer to Azure Data Factory connector. Please refer to Microsoft.DataFactory factories/linkedservices for the type values syntax. Changing this forces a new resource to be created.
    typePropertiesJson String
    A JSON object that contains the properties of the Data Factory Linked Service.
    additionalProperties {[key: string]: string}
    A map of additional properties to associate with the Data Factory Linked Service.
    annotations string[]
    List of tags that can be used for describing the Data Factory Linked Service.
    dataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    description string
    The description for the Data Factory Linked Service.
    integrationRuntime LinkedCustomServiceIntegrationRuntime
    An integration_runtime block as defined below.
    name string
    Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
    parameters {[key: string]: string}
    A map of parameters to associate with the Data Factory Linked Service.
    type string
    The type of data stores that will be connected to Data Factory. For full list of supported data stores, please refer to Azure Data Factory connector. Please refer to Microsoft.DataFactory factories/linkedservices for the type values syntax. Changing this forces a new resource to be created.
    typePropertiesJson string
    A JSON object that contains the properties of the Data Factory Linked Service.
    additional_properties Mapping[str, str]
    A map of additional properties to associate with the Data Factory Linked Service.
    annotations Sequence[str]
    List of tags that can be used for describing the Data Factory Linked Service.
    data_factory_id str
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    description str
    The description for the Data Factory Linked Service.
    integration_runtime LinkedCustomServiceIntegrationRuntimeArgs
    An integration_runtime block as defined below.
    name str
    Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
    parameters Mapping[str, str]
    A map of parameters to associate with the Data Factory Linked Service.
    type str
    The type of data stores that will be connected to Data Factory. For full list of supported data stores, please refer to Azure Data Factory connector. Please refer to Microsoft.DataFactory factories/linkedservices for the type values syntax. Changing this forces a new resource to be created.
    type_properties_json str
    A JSON object that contains the properties of the Data Factory Linked Service.
    additionalProperties Map<String>
    A map of additional properties to associate with the Data Factory Linked Service.
    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    description String
    The description for the Data Factory Linked Service.
    integrationRuntime Property Map
    An integration_runtime block as defined below.
    name String
    Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
    parameters Map<String>
    A map of parameters to associate with the Data Factory Linked Service.
    type String
    The type of data stores that will be connected to Data Factory. For full list of supported data stores, please refer to Azure Data Factory connector. Please refer to Microsoft.DataFactory factories/linkedservices for the type values syntax. Changing this forces a new resource to be created.
    typePropertiesJson String
    A JSON object that contains the properties of the Data Factory Linked Service.

    Supporting Types

    LinkedCustomServiceIntegrationRuntime, LinkedCustomServiceIntegrationRuntimeArgs

    Name string
    The integration runtime reference to associate with the Data Factory Linked Service.
    Parameters Dictionary<string, string>
    A map of parameters to associate with the integration runtime.
    Name string
    The integration runtime reference to associate with the Data Factory Linked Service.
    Parameters map[string]string
    A map of parameters to associate with the integration runtime.
    name String
    The integration runtime reference to associate with the Data Factory Linked Service.
    parameters Map<String,String>
    A map of parameters to associate with the integration runtime.
    name string
    The integration runtime reference to associate with the Data Factory Linked Service.
    parameters {[key: string]: string}
    A map of parameters to associate with the integration runtime.
    name str
    The integration runtime reference to associate with the Data Factory Linked Service.
    parameters Mapping[str, str]
    A map of parameters to associate with the integration runtime.
    name String
    The integration runtime reference to associate with the Data Factory Linked Service.
    parameters Map<String>
    A map of parameters to associate with the integration runtime.

    Import

    Data Factory Linked Service’s can be imported using the resource id, e.g.

    $ pulumi import azure:datafactory/linkedCustomService:LinkedCustomService example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/linkedservices/example

    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.

    Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-azure