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

We recommend using Azure Native.

Azure Classic v5.83.0 published on Monday, Jul 8, 2024 by Pulumi

azure.datafactory.LinkedServiceAzureFunction

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.83.0 published on Monday, Jul 8, 2024 by Pulumi

    Manages a Linked Service (connection) between an Azure Function and Azure Data Factory.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const exampleResourceGroup = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const example = azure.appservice.getFunctionAppOutput({
        name: "test-azure-functions",
        resourceGroupName: exampleResourceGroup.name,
    });
    const exampleFactory = new azure.datafactory.Factory("example", {
        name: "example",
        location: exampleResourceGroup.location,
        resourceGroupName: exampleResourceGroup.name,
    });
    const exampleLinkedServiceAzureFunction = new azure.datafactory.LinkedServiceAzureFunction("example", {
        name: "example",
        dataFactoryId: exampleFactory.id,
        url: example.apply(example => `https://${example.defaultHostname}`),
        key: "foo",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example_resource_group = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example = azure.appservice.get_function_app_output(name="test-azure-functions",
        resource_group_name=example_resource_group.name)
    example_factory = azure.datafactory.Factory("example",
        name="example",
        location=example_resource_group.location,
        resource_group_name=example_resource_group.name)
    example_linked_service_azure_function = azure.datafactory.LinkedServiceAzureFunction("example",
        name="example",
        data_factory_id=example_factory.id,
        url=example.apply(lambda example: f"https://{example.default_hostname}"),
        key="foo")
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/appservice"
    	"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, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		example := appservice.LookupFunctionAppOutput(ctx, appservice.GetFunctionAppOutputArgs{
    			Name:              pulumi.String("test-azure-functions"),
    			ResourceGroupName: exampleResourceGroup.Name,
    		}, nil)
    		exampleFactory, err := datafactory.NewFactory(ctx, "example", &datafactory.FactoryArgs{
    			Name:              pulumi.String("example"),
    			Location:          exampleResourceGroup.Location,
    			ResourceGroupName: exampleResourceGroup.Name,
    		})
    		if err != nil {
    			return err
    		}
    		_, err = datafactory.NewLinkedServiceAzureFunction(ctx, "example", &datafactory.LinkedServiceAzureFunctionArgs{
    			Name:          pulumi.String("example"),
    			DataFactoryId: exampleFactory.ID(),
    			Url: example.ApplyT(func(example appservice.GetFunctionAppResult) (string, error) {
    				return fmt.Sprintf("https://%v", example.DefaultHostname), nil
    			}).(pulumi.StringOutput),
    			Key: pulumi.String("foo"),
    		})
    		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 exampleResourceGroup = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var example = Azure.AppService.GetFunctionApp.Invoke(new()
        {
            Name = "test-azure-functions",
            ResourceGroupName = exampleResourceGroup.Name,
        });
    
        var exampleFactory = new Azure.DataFactory.Factory("example", new()
        {
            Name = "example",
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
        });
    
        var exampleLinkedServiceAzureFunction = new Azure.DataFactory.LinkedServiceAzureFunction("example", new()
        {
            Name = "example",
            DataFactoryId = exampleFactory.Id,
            Url = $"https://{example.Apply(getFunctionAppResult => getFunctionAppResult.DefaultHostname)}",
            Key = "foo",
        });
    
    });
    
    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.appservice.AppserviceFunctions;
    import com.pulumi.azure.appservice.inputs.GetFunctionAppArgs;
    import com.pulumi.azure.datafactory.Factory;
    import com.pulumi.azure.datafactory.FactoryArgs;
    import com.pulumi.azure.datafactory.LinkedServiceAzureFunction;
    import com.pulumi.azure.datafactory.LinkedServiceAzureFunctionArgs;
    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()
                .name("example-resources")
                .location("West Europe")
                .build());
    
            final var example = AppserviceFunctions.getFunctionApp(GetFunctionAppArgs.builder()
                .name("test-azure-functions")
                .resourceGroupName(exampleResourceGroup.name())
                .build());
    
            var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
                .name("example")
                .location(exampleResourceGroup.location())
                .resourceGroupName(exampleResourceGroup.name())
                .build());
    
            var exampleLinkedServiceAzureFunction = new LinkedServiceAzureFunction("exampleLinkedServiceAzureFunction", LinkedServiceAzureFunctionArgs.builder()
                .name("example")
                .dataFactoryId(exampleFactory.id())
                .url(example.applyValue(getFunctionAppResult -> getFunctionAppResult).applyValue(example -> String.format("https://%s", example.applyValue(getFunctionAppResult -> getFunctionAppResult.defaultHostname()))))
                .key("foo")
                .build());
    
        }
    }
    
    resources:
      exampleResourceGroup:
        type: azure:core:ResourceGroup
        name: example
        properties:
          name: example-resources
          location: West Europe
      exampleFactory:
        type: azure:datafactory:Factory
        name: example
        properties:
          name: example
          location: ${exampleResourceGroup.location}
          resourceGroupName: ${exampleResourceGroup.name}
      exampleLinkedServiceAzureFunction:
        type: azure:datafactory:LinkedServiceAzureFunction
        name: example
        properties:
          name: example
          dataFactoryId: ${exampleFactory.id}
          url: https://${example.defaultHostname}
          key: foo
    variables:
      example:
        fn::invoke:
          Function: azure:appservice:getFunctionApp
          Arguments:
            name: test-azure-functions
            resourceGroupName: ${exampleResourceGroup.name}
    

    Create LinkedServiceAzureFunction Resource

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

    Constructor syntax

    new LinkedServiceAzureFunction(name: string, args: LinkedServiceAzureFunctionArgs, opts?: CustomResourceOptions);
    @overload
    def LinkedServiceAzureFunction(resource_name: str,
                                   args: LinkedServiceAzureFunctionArgs,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def LinkedServiceAzureFunction(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   data_factory_id: Optional[str] = None,
                                   url: Optional[str] = None,
                                   additional_properties: Optional[Mapping[str, str]] = None,
                                   annotations: Optional[Sequence[str]] = None,
                                   description: Optional[str] = None,
                                   integration_runtime_name: Optional[str] = None,
                                   key: Optional[str] = None,
                                   key_vault_key: Optional[LinkedServiceAzureFunctionKeyVaultKeyArgs] = None,
                                   name: Optional[str] = None,
                                   parameters: Optional[Mapping[str, str]] = None)
    func NewLinkedServiceAzureFunction(ctx *Context, name string, args LinkedServiceAzureFunctionArgs, opts ...ResourceOption) (*LinkedServiceAzureFunction, error)
    public LinkedServiceAzureFunction(string name, LinkedServiceAzureFunctionArgs args, CustomResourceOptions? opts = null)
    public LinkedServiceAzureFunction(String name, LinkedServiceAzureFunctionArgs args)
    public LinkedServiceAzureFunction(String name, LinkedServiceAzureFunctionArgs args, CustomResourceOptions options)
    
    type: azure:datafactory:LinkedServiceAzureFunction
    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 LinkedServiceAzureFunctionArgs
    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 LinkedServiceAzureFunctionArgs
    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 LinkedServiceAzureFunctionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LinkedServiceAzureFunctionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LinkedServiceAzureFunctionArgs
    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 linkedServiceAzureFunctionResource = new Azure.DataFactory.LinkedServiceAzureFunction("linkedServiceAzureFunctionResource", new()
    {
        DataFactoryId = "string",
        Url = "string",
        AdditionalProperties = 
        {
            { "string", "string" },
        },
        Annotations = new[]
        {
            "string",
        },
        Description = "string",
        IntegrationRuntimeName = "string",
        Key = "string",
        KeyVaultKey = new Azure.DataFactory.Inputs.LinkedServiceAzureFunctionKeyVaultKeyArgs
        {
            LinkedServiceName = "string",
            SecretName = "string",
        },
        Name = "string",
        Parameters = 
        {
            { "string", "string" },
        },
    });
    
    example, err := datafactory.NewLinkedServiceAzureFunction(ctx, "linkedServiceAzureFunctionResource", &datafactory.LinkedServiceAzureFunctionArgs{
    	DataFactoryId: pulumi.String("string"),
    	Url:           pulumi.String("string"),
    	AdditionalProperties: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Annotations: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Description:            pulumi.String("string"),
    	IntegrationRuntimeName: pulumi.String("string"),
    	Key:                    pulumi.String("string"),
    	KeyVaultKey: &datafactory.LinkedServiceAzureFunctionKeyVaultKeyArgs{
    		LinkedServiceName: pulumi.String("string"),
    		SecretName:        pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    	Parameters: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var linkedServiceAzureFunctionResource = new LinkedServiceAzureFunction("linkedServiceAzureFunctionResource", LinkedServiceAzureFunctionArgs.builder()
        .dataFactoryId("string")
        .url("string")
        .additionalProperties(Map.of("string", "string"))
        .annotations("string")
        .description("string")
        .integrationRuntimeName("string")
        .key("string")
        .keyVaultKey(LinkedServiceAzureFunctionKeyVaultKeyArgs.builder()
            .linkedServiceName("string")
            .secretName("string")
            .build())
        .name("string")
        .parameters(Map.of("string", "string"))
        .build());
    
    linked_service_azure_function_resource = azure.datafactory.LinkedServiceAzureFunction("linkedServiceAzureFunctionResource",
        data_factory_id="string",
        url="string",
        additional_properties={
            "string": "string",
        },
        annotations=["string"],
        description="string",
        integration_runtime_name="string",
        key="string",
        key_vault_key={
            "linkedServiceName": "string",
            "secretName": "string",
        },
        name="string",
        parameters={
            "string": "string",
        })
    
    const linkedServiceAzureFunctionResource = new azure.datafactory.LinkedServiceAzureFunction("linkedServiceAzureFunctionResource", {
        dataFactoryId: "string",
        url: "string",
        additionalProperties: {
            string: "string",
        },
        annotations: ["string"],
        description: "string",
        integrationRuntimeName: "string",
        key: "string",
        keyVaultKey: {
            linkedServiceName: "string",
            secretName: "string",
        },
        name: "string",
        parameters: {
            string: "string",
        },
    });
    
    type: azure:datafactory:LinkedServiceAzureFunction
    properties:
        additionalProperties:
            string: string
        annotations:
            - string
        dataFactoryId: string
        description: string
        integrationRuntimeName: string
        key: string
        keyVaultKey:
            linkedServiceName: string
            secretName: string
        name: string
        parameters:
            string: string
        url: string
    

    LinkedServiceAzureFunction 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 LinkedServiceAzureFunction 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.
    Url string
    The url of the Azure Function.
    AdditionalProperties Dictionary<string, string>

    A map of additional properties to associate with the Data Factory Linked Service.

    The following supported arguments are specific to Azure Function 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.
    IntegrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service.
    Key string
    The system key of the Azure Function. Exactly one of either key or key_vault_key is required
    KeyVaultKey LinkedServiceAzureFunctionKeyVaultKey
    A key_vault_key block as defined below. Use this Argument to store the system key of the Azure Function in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. Exactly one of either key or key_vault_key is required.
    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.
    Url string
    The url of the Azure Function.
    AdditionalProperties map[string]string

    A map of additional properties to associate with the Data Factory Linked Service.

    The following supported arguments are specific to Azure Function 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.
    IntegrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service.
    Key string
    The system key of the Azure Function. Exactly one of either key or key_vault_key is required
    KeyVaultKey LinkedServiceAzureFunctionKeyVaultKeyArgs
    A key_vault_key block as defined below. Use this Argument to store the system key of the Azure Function in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. Exactly one of either key or key_vault_key is required.
    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.
    url String
    The url of the Azure Function.
    additionalProperties Map<String,String>

    A map of additional properties to associate with the Data Factory Linked Service.

    The following supported arguments are specific to Azure Function 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.
    integrationRuntimeName String
    The integration runtime reference to associate with the Data Factory Linked Service.
    key String
    The system key of the Azure Function. Exactly one of either key or key_vault_key is required
    keyVaultKey LinkedServiceAzureFunctionKeyVaultKey
    A key_vault_key block as defined below. Use this Argument to store the system key of the Azure Function in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. Exactly one of either key or key_vault_key is required.
    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.
    url string
    The url of the Azure Function.
    additionalProperties {[key: string]: string}

    A map of additional properties to associate with the Data Factory Linked Service.

    The following supported arguments are specific to Azure Function 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.
    integrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service.
    key string
    The system key of the Azure Function. Exactly one of either key or key_vault_key is required
    keyVaultKey LinkedServiceAzureFunctionKeyVaultKey
    A key_vault_key block as defined below. Use this Argument to store the system key of the Azure Function in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. Exactly one of either key or key_vault_key is required.
    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.
    url str
    The url of the Azure Function.
    additional_properties Mapping[str, str]

    A map of additional properties to associate with the Data Factory Linked Service.

    The following supported arguments are specific to Azure Function 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_name str
    The integration runtime reference to associate with the Data Factory Linked Service.
    key str
    The system key of the Azure Function. Exactly one of either key or key_vault_key is required
    key_vault_key LinkedServiceAzureFunctionKeyVaultKeyArgs
    A key_vault_key block as defined below. Use this Argument to store the system key of the Azure Function in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. Exactly one of either key or key_vault_key is required.
    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.
    url String
    The url of the Azure Function.
    additionalProperties Map<String>

    A map of additional properties to associate with the Data Factory Linked Service.

    The following supported arguments are specific to Azure Function 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.
    integrationRuntimeName String
    The integration runtime reference to associate with the Data Factory Linked Service.
    key String
    The system key of the Azure Function. Exactly one of either key or key_vault_key is required
    keyVaultKey Property Map
    A key_vault_key block as defined below. Use this Argument to store the system key of the Azure Function in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. Exactly one of either key or key_vault_key is required.
    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 LinkedServiceAzureFunction 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 LinkedServiceAzureFunction Resource

    Get an existing LinkedServiceAzureFunction 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?: LinkedServiceAzureFunctionState, opts?: CustomResourceOptions): LinkedServiceAzureFunction
    @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_name: Optional[str] = None,
            key: Optional[str] = None,
            key_vault_key: Optional[LinkedServiceAzureFunctionKeyVaultKeyArgs] = None,
            name: Optional[str] = None,
            parameters: Optional[Mapping[str, str]] = None,
            url: Optional[str] = None) -> LinkedServiceAzureFunction
    func GetLinkedServiceAzureFunction(ctx *Context, name string, id IDInput, state *LinkedServiceAzureFunctionState, opts ...ResourceOption) (*LinkedServiceAzureFunction, error)
    public static LinkedServiceAzureFunction Get(string name, Input<string> id, LinkedServiceAzureFunctionState? state, CustomResourceOptions? opts = null)
    public static LinkedServiceAzureFunction get(String name, Output<String> id, LinkedServiceAzureFunctionState 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.

    The following supported arguments are specific to Azure Function 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.
    IntegrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service.
    Key string
    The system key of the Azure Function. Exactly one of either key or key_vault_key is required
    KeyVaultKey LinkedServiceAzureFunctionKeyVaultKey
    A key_vault_key block as defined below. Use this Argument to store the system key of the Azure Function in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. Exactly one of either key or key_vault_key is required.
    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.
    Url string
    The url of the Azure Function.
    AdditionalProperties map[string]string

    A map of additional properties to associate with the Data Factory Linked Service.

    The following supported arguments are specific to Azure Function 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.
    IntegrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service.
    Key string
    The system key of the Azure Function. Exactly one of either key or key_vault_key is required
    KeyVaultKey LinkedServiceAzureFunctionKeyVaultKeyArgs
    A key_vault_key block as defined below. Use this Argument to store the system key of the Azure Function in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. Exactly one of either key or key_vault_key is required.
    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.
    Url string
    The url of the Azure Function.
    additionalProperties Map<String,String>

    A map of additional properties to associate with the Data Factory Linked Service.

    The following supported arguments are specific to Azure Function 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.
    integrationRuntimeName String
    The integration runtime reference to associate with the Data Factory Linked Service.
    key String
    The system key of the Azure Function. Exactly one of either key or key_vault_key is required
    keyVaultKey LinkedServiceAzureFunctionKeyVaultKey
    A key_vault_key block as defined below. Use this Argument to store the system key of the Azure Function in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. Exactly one of either key or key_vault_key is required.
    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.
    url String
    The url of the Azure Function.
    additionalProperties {[key: string]: string}

    A map of additional properties to associate with the Data Factory Linked Service.

    The following supported arguments are specific to Azure Function 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.
    integrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service.
    key string
    The system key of the Azure Function. Exactly one of either key or key_vault_key is required
    keyVaultKey LinkedServiceAzureFunctionKeyVaultKey
    A key_vault_key block as defined below. Use this Argument to store the system key of the Azure Function in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. Exactly one of either key or key_vault_key is required.
    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.
    url string
    The url of the Azure Function.
    additional_properties Mapping[str, str]

    A map of additional properties to associate with the Data Factory Linked Service.

    The following supported arguments are specific to Azure Function 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_name str
    The integration runtime reference to associate with the Data Factory Linked Service.
    key str
    The system key of the Azure Function. Exactly one of either key or key_vault_key is required
    key_vault_key LinkedServiceAzureFunctionKeyVaultKeyArgs
    A key_vault_key block as defined below. Use this Argument to store the system key of the Azure Function in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. Exactly one of either key or key_vault_key is required.
    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.
    url str
    The url of the Azure Function.
    additionalProperties Map<String>

    A map of additional properties to associate with the Data Factory Linked Service.

    The following supported arguments are specific to Azure Function 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.
    integrationRuntimeName String
    The integration runtime reference to associate with the Data Factory Linked Service.
    key String
    The system key of the Azure Function. Exactly one of either key or key_vault_key is required
    keyVaultKey Property Map
    A key_vault_key block as defined below. Use this Argument to store the system key of the Azure Function in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. Exactly one of either key or key_vault_key is required.
    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.
    url String
    The url of the Azure Function.

    Supporting Types

    LinkedServiceAzureFunctionKeyVaultKey, LinkedServiceAzureFunctionKeyVaultKeyArgs

    LinkedServiceName string
    Specifies the name of an existing Key Vault Data Factory Linked Service.
    SecretName string
    Specifies the secret name in Azure Key Vault that stores the system key of the Azure Function.
    LinkedServiceName string
    Specifies the name of an existing Key Vault Data Factory Linked Service.
    SecretName string
    Specifies the secret name in Azure Key Vault that stores the system key of the Azure Function.
    linkedServiceName String
    Specifies the name of an existing Key Vault Data Factory Linked Service.
    secretName String
    Specifies the secret name in Azure Key Vault that stores the system key of the Azure Function.
    linkedServiceName string
    Specifies the name of an existing Key Vault Data Factory Linked Service.
    secretName string
    Specifies the secret name in Azure Key Vault that stores the system key of the Azure Function.
    linked_service_name str
    Specifies the name of an existing Key Vault Data Factory Linked Service.
    secret_name str
    Specifies the secret name in Azure Key Vault that stores the system key of the Azure Function.
    linkedServiceName String
    Specifies the name of an existing Key Vault Data Factory Linked Service.
    secretName String
    Specifies the secret name in Azure Key Vault that stores the system key of the Azure Function.

    Import

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

    $ pulumi import azure:datafactory/linkedServiceAzureFunction:LinkedServiceAzureFunction 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 v5.83.0 published on Monday, Jul 8, 2024 by Pulumi