com.pulumi.azure.datafactory.kotlin.LinkedServiceAzureFunctionArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-azure-kotlin Show documentation
Show all versions of pulumi-azure-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azure.datafactory.kotlin
import com.pulumi.azure.datafactory.LinkedServiceAzureFunctionArgs.builder
import com.pulumi.azure.datafactory.kotlin.inputs.LinkedServiceAzureFunctionKeyVaultKeyArgs
import com.pulumi.azure.datafactory.kotlin.inputs.LinkedServiceAzureFunctionKeyVaultKeyArgsBuilder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* Manages a Linked Service (connection) between an Azure Function and Azure Data Factory.
* ## Example Usage
*
* ```typescript
* 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",
* });
* ```
* ```python
* 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")
* ```
* ```csharp
* 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",
* });
* });
* ```
* ```go
* 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
* })
* }
* ```
* ```java
* 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());
* }
* }
* ```
* ```yaml
* 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}
* ```
*
* ## Import
* Data Factory Linked Service's can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:datafactory/linkedServiceAzureFunction:LinkedServiceAzureFunction example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/linkedservices/example
* ```
* @property additionalProperties A map of additional properties to associate with the Data Factory Linked Service.
* The following supported arguments are specific to Azure Function Linked Service:
* @property annotations List of tags that can be used for describing the Data Factory Linked Service.
* @property dataFactoryId The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
* @property description The description for the Data Factory Linked Service.
* @property integrationRuntimeName The integration runtime reference to associate with the Data Factory Linked Service.
* @property key The system key of the Azure Function. Exactly one of either `key` or `key_vault_key` is required
* @property keyVaultKey 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.
* @property name 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](https://docs.microsoft.com/azure/data-factory/naming-rules) for all restrictions.
* @property parameters A map of parameters to associate with the Data Factory Linked Service.
* @property url The url of the Azure Function.
*/
public data class LinkedServiceAzureFunctionArgs(
public val additionalProperties: Output>? = null,
public val annotations: Output>? = null,
public val dataFactoryId: Output? = null,
public val description: Output? = null,
public val integrationRuntimeName: Output? = null,
public val key: Output? = null,
public val keyVaultKey: Output? = null,
public val name: Output? = null,
public val parameters: Output>? = null,
public val url: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.azure.datafactory.LinkedServiceAzureFunctionArgs =
com.pulumi.azure.datafactory.LinkedServiceAzureFunctionArgs.builder()
.additionalProperties(
additionalProperties?.applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}),
)
.annotations(annotations?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.dataFactoryId(dataFactoryId?.applyValue({ args0 -> args0 }))
.description(description?.applyValue({ args0 -> args0 }))
.integrationRuntimeName(integrationRuntimeName?.applyValue({ args0 -> args0 }))
.key(key?.applyValue({ args0 -> args0 }))
.keyVaultKey(keyVaultKey?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.name(name?.applyValue({ args0 -> args0 }))
.parameters(
parameters?.applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}),
)
.url(url?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [LinkedServiceAzureFunctionArgs].
*/
@PulumiTagMarker
public class LinkedServiceAzureFunctionArgsBuilder internal constructor() {
private var additionalProperties: Output>? = null
private var annotations: Output>? = null
private var dataFactoryId: Output? = null
private var description: Output? = null
private var integrationRuntimeName: Output? = null
private var key: Output? = null
private var keyVaultKey: Output? = null
private var name: Output? = null
private var parameters: Output>? = null
private var url: Output? = null
/**
* @param value A map of additional properties to associate with the Data Factory Linked Service.
* The following supported arguments are specific to Azure Function Linked Service:
*/
@JvmName("aayhofodhywmwehm")
public suspend fun additionalProperties(`value`: Output>) {
this.additionalProperties = value
}
/**
* @param value List of tags that can be used for describing the Data Factory Linked Service.
*/
@JvmName("hqymwhvnkfaqajai")
public suspend fun annotations(`value`: Output>) {
this.annotations = value
}
@JvmName("gpqnjmfdkrndtvfd")
public suspend fun annotations(vararg values: Output) {
this.annotations = Output.all(values.asList())
}
/**
* @param values List of tags that can be used for describing the Data Factory Linked Service.
*/
@JvmName("sryiplxlstjvydge")
public suspend fun annotations(values: List>) {
this.annotations = Output.all(values)
}
/**
* @param value The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
*/
@JvmName("doucovgfqbmhnkob")
public suspend fun dataFactoryId(`value`: Output) {
this.dataFactoryId = value
}
/**
* @param value The description for the Data Factory Linked Service.
*/
@JvmName("rvocjideunjlrwqn")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value The integration runtime reference to associate with the Data Factory Linked Service.
*/
@JvmName("cosnbgldwvxqejqs")
public suspend fun integrationRuntimeName(`value`: Output) {
this.integrationRuntimeName = value
}
/**
* @param value The system key of the Azure Function. Exactly one of either `key` or `key_vault_key` is required
*/
@JvmName("xgmrdebexypebqir")
public suspend fun key(`value`: Output) {
this.key = value
}
/**
* @param value 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.
*/
@JvmName("gnptvnfaiqohxtvi")
public suspend fun keyVaultKey(`value`: Output) {
this.keyVaultKey = value
}
/**
* @param value 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](https://docs.microsoft.com/azure/data-factory/naming-rules) for all restrictions.
*/
@JvmName("ifomhsxyapaybutj")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value A map of parameters to associate with the Data Factory Linked Service.
*/
@JvmName("oelyxblittqocfjw")
public suspend fun parameters(`value`: Output>) {
this.parameters = value
}
/**
* @param value The url of the Azure Function.
*/
@JvmName("llomjkbfttejbebu")
public suspend fun url(`value`: Output) {
this.url = value
}
/**
* @param value A map of additional properties to associate with the Data Factory Linked Service.
* The following supported arguments are specific to Azure Function Linked Service:
*/
@JvmName("cokvqrekipoauang")
public suspend fun additionalProperties(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.additionalProperties = mapped
}
/**
* @param values A map of additional properties to associate with the Data Factory Linked Service.
* The following supported arguments are specific to Azure Function Linked Service:
*/
@JvmName("yegeoweeqvoecncl")
public fun additionalProperties(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.additionalProperties = mapped
}
/**
* @param value List of tags that can be used for describing the Data Factory Linked Service.
*/
@JvmName("hqlogcboexxlqcci")
public suspend fun annotations(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.annotations = mapped
}
/**
* @param values List of tags that can be used for describing the Data Factory Linked Service.
*/
@JvmName("lovjkniivrmystit")
public suspend fun annotations(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.annotations = mapped
}
/**
* @param value The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
*/
@JvmName("jtgkhrxbrghummee")
public suspend fun dataFactoryId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.dataFactoryId = mapped
}
/**
* @param value The description for the Data Factory Linked Service.
*/
@JvmName("ljrowkfyibynjxwh")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value The integration runtime reference to associate with the Data Factory Linked Service.
*/
@JvmName("lkyefxahtyeutwur")
public suspend fun integrationRuntimeName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.integrationRuntimeName = mapped
}
/**
* @param value The system key of the Azure Function. Exactly one of either `key` or `key_vault_key` is required
*/
@JvmName("usxrvqyxksvnhijm")
public suspend fun key(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.key = mapped
}
/**
* @param value 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.
*/
@JvmName("vdaqhvsyotxxrhuu")
public suspend fun keyVaultKey(`value`: LinkedServiceAzureFunctionKeyVaultKeyArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.keyVaultKey = mapped
}
/**
* @param argument 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.
*/
@JvmName("hhgodclhqprsmssu")
public suspend fun keyVaultKey(argument: suspend LinkedServiceAzureFunctionKeyVaultKeyArgsBuilder.() -> Unit) {
val toBeMapped = LinkedServiceAzureFunctionKeyVaultKeyArgsBuilder().applySuspend {
argument()
}.build()
val mapped = of(toBeMapped)
this.keyVaultKey = mapped
}
/**
* @param value 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](https://docs.microsoft.com/azure/data-factory/naming-rules) for all restrictions.
*/
@JvmName("txiyqbtgkcxjauas")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value A map of parameters to associate with the Data Factory Linked Service.
*/
@JvmName("bkcehuphaekpwsoy")
public suspend fun parameters(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.parameters = mapped
}
/**
* @param values A map of parameters to associate with the Data Factory Linked Service.
*/
@JvmName("npvtgaqtjrgnkupn")
public fun parameters(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.parameters = mapped
}
/**
* @param value The url of the Azure Function.
*/
@JvmName("xjqgdghtfhtsbwln")
public suspend fun url(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.url = mapped
}
internal fun build(): LinkedServiceAzureFunctionArgs = LinkedServiceAzureFunctionArgs(
additionalProperties = additionalProperties,
annotations = annotations,
dataFactoryId = dataFactoryId,
description = description,
integrationRuntimeName = integrationRuntimeName,
key = key,
keyVaultKey = keyVaultKey,
name = name,
parameters = parameters,
url = url,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy