All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.azure.datafactory.kotlin.LinkedServiceWebArgs.kt Maven / Gradle / Ivy

@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.datafactory.kotlin

import com.pulumi.azure.datafactory.LinkedServiceWebArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List
import kotlin.collections.Map
import kotlin.jvm.JvmName

/**
 * Manages a Linked Service (connection) between a Web Server and Azure Data Factory.
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azure from "@pulumi/azure";
 * const example = new azure.core.ResourceGroup("example", {
 *     name: "example-resources",
 *     location: "West Europe",
 * });
 * const exampleFactory = new azure.datafactory.Factory("example", {
 *     name: "example",
 *     location: example.location,
 *     resourceGroupName: example.name,
 * });
 * const exampleLinkedServiceWeb = new azure.datafactory.LinkedServiceWeb("example", {
 *     name: "example",
 *     dataFactoryId: exampleFactory.id,
 *     authenticationType: "Anonymous",
 *     url: "http://www.bing.com",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_azure as azure
 * example = azure.core.ResourceGroup("example",
 *     name="example-resources",
 *     location="West Europe")
 * example_factory = azure.datafactory.Factory("example",
 *     name="example",
 *     location=example.location,
 *     resource_group_name=example.name)
 * example_linked_service_web = azure.datafactory.LinkedServiceWeb("example",
 *     name="example",
 *     data_factory_id=example_factory.id,
 *     authentication_type="Anonymous",
 *     url="http://www.bing.com")
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Azure = Pulumi.Azure;
 * return await Deployment.RunAsync(() =>
 * {
 *     var example = new Azure.Core.ResourceGroup("example", new()
 *     {
 *         Name = "example-resources",
 *         Location = "West Europe",
 *     });
 *     var exampleFactory = new Azure.DataFactory.Factory("example", new()
 *     {
 *         Name = "example",
 *         Location = example.Location,
 *         ResourceGroupName = example.Name,
 *     });
 *     var exampleLinkedServiceWeb = new Azure.DataFactory.LinkedServiceWeb("example", new()
 *     {
 *         Name = "example",
 *         DataFactoryId = exampleFactory.Id,
 *         AuthenticationType = "Anonymous",
 *         Url = "http://www.bing.com",
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/datafactory"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
 * 			Name:     pulumi.String("example-resources"),
 * 			Location: pulumi.String("West Europe"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		exampleFactory, err := datafactory.NewFactory(ctx, "example", &datafactory.FactoryArgs{
 * 			Name:              pulumi.String("example"),
 * 			Location:          example.Location,
 * 			ResourceGroupName: example.Name,
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = datafactory.NewLinkedServiceWeb(ctx, "example", &datafactory.LinkedServiceWebArgs{
 * 			Name:               pulumi.String("example"),
 * 			DataFactoryId:      exampleFactory.ID(),
 * 			AuthenticationType: pulumi.String("Anonymous"),
 * 			Url:                pulumi.String("http://www.bing.com"),
 * 		})
 * 		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.datafactory.Factory;
 * import com.pulumi.azure.datafactory.FactoryArgs;
 * import com.pulumi.azure.datafactory.LinkedServiceWeb;
 * import com.pulumi.azure.datafactory.LinkedServiceWebArgs;
 * import java.util.List;
 * import java.util.ArrayList;
 * import java.util.Map;
 * import java.io.File;
 * import java.nio.file.Files;
 * import java.nio.file.Paths;
 * public class App {
 *     public static void main(String[] args) {
 *         Pulumi.run(App::stack);
 *     }
 *     public static void stack(Context ctx) {
 *         var example = new ResourceGroup("example", ResourceGroupArgs.builder()
 *             .name("example-resources")
 *             .location("West Europe")
 *             .build());
 *         var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
 *             .name("example")
 *             .location(example.location())
 *             .resourceGroupName(example.name())
 *             .build());
 *         var exampleLinkedServiceWeb = new LinkedServiceWeb("exampleLinkedServiceWeb", LinkedServiceWebArgs.builder()
 *             .name("example")
 *             .dataFactoryId(exampleFactory.id())
 *             .authenticationType("Anonymous")
 *             .url("http://www.bing.com")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * 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}
 *   exampleLinkedServiceWeb:
 *     type: azure:datafactory:LinkedServiceWeb
 *     name: example
 *     properties:
 *       name: example
 *       dataFactoryId: ${exampleFactory.id}
 *       authenticationType: Anonymous
 *       url: http://www.bing.com
 * ```
 * 
 * ## Import
 * Data Factory Linked Service's can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:datafactory/linkedServiceWeb:LinkedServiceWeb 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 Web Linked Service:
 * @property annotations List of tags that can be used for describing the Data Factory Linked Service.
 * @property authenticationType The type of authentication used to connect to the web table source. Valid options are `Anonymous`, `Basic` and `ClientCertificate`.
 * @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 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 password The password for Basic authentication. Required if `authentication_type` sets to `Basic`.
 * @property url The URL of the web service endpoint (e.g. ).
 * @property username The username for Basic authentication. Required if `authentication_type` sets to `Basic`.
 */
public data class LinkedServiceWebArgs(
    public val additionalProperties: Output>? = null,
    public val annotations: Output>? = null,
    public val authenticationType: Output? = null,
    public val dataFactoryId: Output? = null,
    public val description: Output? = null,
    public val integrationRuntimeName: Output? = null,
    public val name: Output? = null,
    public val parameters: Output>? = null,
    public val password: Output? = null,
    public val url: Output? = null,
    public val username: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.azure.datafactory.LinkedServiceWebArgs =
        com.pulumi.azure.datafactory.LinkedServiceWebArgs.builder()
            .additionalProperties(
                additionalProperties?.applyValue({ args0 ->
                    args0.map({ args0 ->
                        args0.key.to(args0.value)
                    }).toMap()
                }),
            )
            .annotations(annotations?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
            .authenticationType(authenticationType?.applyValue({ args0 -> args0 }))
            .dataFactoryId(dataFactoryId?.applyValue({ args0 -> args0 }))
            .description(description?.applyValue({ args0 -> args0 }))
            .integrationRuntimeName(integrationRuntimeName?.applyValue({ args0 -> args0 }))
            .name(name?.applyValue({ args0 -> args0 }))
            .parameters(
                parameters?.applyValue({ args0 ->
                    args0.map({ args0 ->
                        args0.key.to(args0.value)
                    }).toMap()
                }),
            )
            .password(password?.applyValue({ args0 -> args0 }))
            .url(url?.applyValue({ args0 -> args0 }))
            .username(username?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [LinkedServiceWebArgs].
 */
@PulumiTagMarker
public class LinkedServiceWebArgsBuilder internal constructor() {
    private var additionalProperties: Output>? = null

    private var annotations: Output>? = null

    private var authenticationType: Output? = null

    private var dataFactoryId: Output? = null

    private var description: Output? = null

    private var integrationRuntimeName: Output? = null

    private var name: Output? = null

    private var parameters: Output>? = null

    private var password: Output? = null

    private var url: Output? = null

    private var username: Output? = null

    /**
     * @param value A map of additional properties to associate with the Data Factory Linked Service.
     * The following supported arguments are specific to Web Linked Service:
     */
    @JvmName("htwixnfssuirfscm")
    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("olngldbkmujqyjnv")
    public suspend fun annotations(`value`: Output>) {
        this.annotations = value
    }

    @JvmName("rgqgetcrvfwrcgmi")
    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("hbcfguaubyywsvrp")
    public suspend fun annotations(values: List>) {
        this.annotations = Output.all(values)
    }

    /**
     * @param value The type of authentication used to connect to the web table source. Valid options are `Anonymous`, `Basic` and `ClientCertificate`.
     */
    @JvmName("vdiuqsorxbasvtue")
    public suspend fun authenticationType(`value`: Output) {
        this.authenticationType = value
    }

    /**
     * @param value The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
     */
    @JvmName("qbkruckbjsakllch")
    public suspend fun dataFactoryId(`value`: Output) {
        this.dataFactoryId = value
    }

    /**
     * @param value The description for the Data Factory Linked Service.
     */
    @JvmName("bnedejitjkjnbxds")
    public suspend fun description(`value`: Output) {
        this.description = value
    }

    /**
     * @param value The integration runtime reference to associate with the Data Factory Linked Service.
     */
    @JvmName("dtrpnhhnkxdyujom")
    public suspend fun integrationRuntimeName(`value`: Output) {
        this.integrationRuntimeName = 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("isrkdddxdkgwqyut")
    public suspend fun name(`value`: Output) {
        this.name = value
    }

    /**
     * @param value A map of parameters to associate with the Data Factory Linked Service.
     */
    @JvmName("frhiaqujpybqcskg")
    public suspend fun parameters(`value`: Output>) {
        this.parameters = value
    }

    /**
     * @param value The password for Basic authentication. Required if `authentication_type` sets to `Basic`.
     */
    @JvmName("knugrnftmstvechu")
    public suspend fun password(`value`: Output) {
        this.password = value
    }

    /**
     * @param value The URL of the web service endpoint (e.g. ).
     */
    @JvmName("kkxsnpasejrulbrk")
    public suspend fun url(`value`: Output) {
        this.url = value
    }

    /**
     * @param value The username for Basic authentication. Required if `authentication_type` sets to `Basic`.
     */
    @JvmName("adfwvfuqdgomyfja")
    public suspend fun username(`value`: Output) {
        this.username = value
    }

    /**
     * @param value A map of additional properties to associate with the Data Factory Linked Service.
     * The following supported arguments are specific to Web Linked Service:
     */
    @JvmName("yscpsftpddgunxfc")
    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 Web Linked Service:
     */
    @JvmName("mwqlnygfgcqlxomm")
    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("cqmdwiyqilsbxfan")
    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("pviigemivfpccfft")
    public suspend fun annotations(vararg values: String) {
        val toBeMapped = values.toList()
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.annotations = mapped
    }

    /**
     * @param value The type of authentication used to connect to the web table source. Valid options are `Anonymous`, `Basic` and `ClientCertificate`.
     */
    @JvmName("chvslqhpnqwgamko")
    public suspend fun authenticationType(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.authenticationType = mapped
    }

    /**
     * @param value The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
     */
    @JvmName("llubptvbpqhehgrx")
    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("tdmkojhmujiheijq")
    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("lnsfiifsiekfvivr")
    public suspend fun integrationRuntimeName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.integrationRuntimeName = 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("gjqsxdbefqnekufb")
    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("uoccupekcdmeqkdc")
    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("sjvrfqjtwdudxysp")
    public fun parameters(vararg values: Pair) {
        val toBeMapped = values.toMap()
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.parameters = mapped
    }

    /**
     * @param value The password for Basic authentication. Required if `authentication_type` sets to `Basic`.
     */
    @JvmName("vlkkbxnviolmbcya")
    public suspend fun password(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.password = mapped
    }

    /**
     * @param value The URL of the web service endpoint (e.g. ).
     */
    @JvmName("mvipwfpsfdcnnhja")
    public suspend fun url(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.url = mapped
    }

    /**
     * @param value The username for Basic authentication. Required if `authentication_type` sets to `Basic`.
     */
    @JvmName("duchlmkvhgfcbrpl")
    public suspend fun username(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.username = mapped
    }

    internal fun build(): LinkedServiceWebArgs = LinkedServiceWebArgs(
        additionalProperties = additionalProperties,
        annotations = annotations,
        authenticationType = authenticationType,
        dataFactoryId = dataFactoryId,
        description = description,
        integrationRuntimeName = integrationRuntimeName,
        name = name,
        parameters = parameters,
        password = password,
        url = url,
        username = username,
    )
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy