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

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

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

package com.pulumi.azure.datafactory.kotlin

import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map

/**
 * Builder for [LinkedServiceCosmosDb].
 */
@PulumiTagMarker
public class LinkedServiceCosmosDbResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: LinkedServiceCosmosDbArgs = LinkedServiceCosmosDbArgs()

    public var opts: CustomResourceOptions = CustomResourceOptions()

    /**
     * @param name The _unique_ name of the resulting resource.
     */
    public fun name(`value`: String) {
        this.name = value
    }

    /**
     * @param block The arguments to use to populate this resource's properties.
     */
    public suspend fun args(block: suspend LinkedServiceCosmosDbArgsBuilder.() -> Unit) {
        val builder = LinkedServiceCosmosDbArgsBuilder()
        block(builder)
        this.args = builder.build()
    }

    /**
     * @param block A bag of options that control this resource's behavior.
     */
    public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
        this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
    }

    internal fun build(): LinkedServiceCosmosDb {
        val builtJavaResource =
            com.pulumi.azure.datafactory.LinkedServiceCosmosDb(
                this.name,
                this.args.toJava(),
                this.opts.toJava(),
            )
        return LinkedServiceCosmosDb(builtJavaResource)
    }
}

/**
 * Manages a Linked Service (connection) between a CosmosDB and Azure Data Factory using SQL API.
 * ## 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.cosmosdb.getAccount({
 *     name: "tfex-cosmosdb-account",
 *     resourceGroupName: "tfex-cosmosdb-account-rg",
 * });
 * const exampleFactory = new azure.datafactory.Factory("example", {
 *     name: "example",
 *     location: exampleResourceGroup.location,
 *     resourceGroupName: exampleResourceGroup.name,
 * });
 * const exampleLinkedServiceCosmosDb = new azure.datafactory.LinkedServiceCosmosDb("example", {
 *     name: "example",
 *     dataFactoryId: exampleFactory.id,
 *     accountEndpoint: example.then(example => example.endpoint),
 *     accountKey: example.then(example => example.primaryKey),
 *     database: "foo",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_azure as azure
 * example_resource_group = azure.core.ResourceGroup("example",
 *     name="example-resources",
 *     location="West Europe")
 * example = azure.cosmosdb.get_account(name="tfex-cosmosdb-account",
 *     resource_group_name="tfex-cosmosdb-account-rg")
 * example_factory = azure.datafactory.Factory("example",
 *     name="example",
 *     location=example_resource_group.location,
 *     resource_group_name=example_resource_group.name)
 * example_linked_service_cosmos_db = azure.datafactory.LinkedServiceCosmosDb("example",
 *     name="example",
 *     data_factory_id=example_factory.id,
 *     account_endpoint=example.endpoint,
 *     account_key=example.primary_key,
 *     database="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.CosmosDB.GetAccount.Invoke(new()
 *     {
 *         Name = "tfex-cosmosdb-account",
 *         ResourceGroupName = "tfex-cosmosdb-account-rg",
 *     });
 *     var exampleFactory = new Azure.DataFactory.Factory("example", new()
 *     {
 *         Name = "example",
 *         Location = exampleResourceGroup.Location,
 *         ResourceGroupName = exampleResourceGroup.Name,
 *     });
 *     var exampleLinkedServiceCosmosDb = new Azure.DataFactory.LinkedServiceCosmosDb("example", new()
 *     {
 *         Name = "example",
 *         DataFactoryId = exampleFactory.Id,
 *         AccountEndpoint = example.Apply(getAccountResult => getAccountResult.Endpoint),
 *         AccountKey = example.Apply(getAccountResult => getAccountResult.PrimaryKey),
 *         Database = "foo",
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/cosmosdb"
 * 	"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, err := cosmosdb.LookupAccount(ctx, &cosmosdb.LookupAccountArgs{
 * 			Name:              "tfex-cosmosdb-account",
 * 			ResourceGroupName: "tfex-cosmosdb-account-rg",
 * 		}, nil)
 * 		if err != nil {
 * 			return err
 * 		}
 * 		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.NewLinkedServiceCosmosDb(ctx, "example", &datafactory.LinkedServiceCosmosDbArgs{
 * 			Name:            pulumi.String("example"),
 * 			DataFactoryId:   exampleFactory.ID(),
 * 			AccountEndpoint: pulumi.String(example.Endpoint),
 * 			AccountKey:      pulumi.String(example.PrimaryKey),
 * 			Database:        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.cosmosdb.CosmosdbFunctions;
 * import com.pulumi.azure.cosmosdb.inputs.GetAccountArgs;
 * import com.pulumi.azure.datafactory.Factory;
 * import com.pulumi.azure.datafactory.FactoryArgs;
 * import com.pulumi.azure.datafactory.LinkedServiceCosmosDb;
 * import com.pulumi.azure.datafactory.LinkedServiceCosmosDbArgs;
 * 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 = CosmosdbFunctions.getAccount(GetAccountArgs.builder()
 *             .name("tfex-cosmosdb-account")
 *             .resourceGroupName("tfex-cosmosdb-account-rg")
 *             .build());
 *         var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
 *             .name("example")
 *             .location(exampleResourceGroup.location())
 *             .resourceGroupName(exampleResourceGroup.name())
 *             .build());
 *         var exampleLinkedServiceCosmosDb = new LinkedServiceCosmosDb("exampleLinkedServiceCosmosDb", LinkedServiceCosmosDbArgs.builder()
 *             .name("example")
 *             .dataFactoryId(exampleFactory.id())
 *             .accountEndpoint(example.applyValue(getAccountResult -> getAccountResult.endpoint()))
 *             .accountKey(example.applyValue(getAccountResult -> getAccountResult.primaryKey()))
 *             .database("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}
 *   exampleLinkedServiceCosmosDb:
 *     type: azure:datafactory:LinkedServiceCosmosDb
 *     name: example
 *     properties:
 *       name: example
 *       dataFactoryId: ${exampleFactory.id}
 *       accountEndpoint: ${example.endpoint}
 *       accountKey: ${example.primaryKey}
 *       database: foo
 * variables:
 *   example:
 *     fn::invoke:
 *       Function: azure:cosmosdb:getAccount
 *       Arguments:
 *         name: tfex-cosmosdb-account
 *         resourceGroupName: tfex-cosmosdb-account-rg
 * ```
 * 
 * ## Import
 * Data Factory Linked Service's can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:datafactory/linkedServiceCosmosDb:LinkedServiceCosmosDb example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/linkedservices/example
 * ```
 */
public class LinkedServiceCosmosDb internal constructor(
    override val javaResource: com.pulumi.azure.datafactory.LinkedServiceCosmosDb,
) : KotlinCustomResource(javaResource, LinkedServiceCosmosDbMapper) {
    /**
     * The endpoint of the Azure CosmosDB account. Required if `connection_string` is unspecified.
     */
    public val accountEndpoint: Output?
        get() = javaResource.accountEndpoint().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * The account key of the Azure Cosmos DB account. Required if `connection_string` is unspecified.
     */
    public val accountKey: Output?
        get() = javaResource.accountKey().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * A map of additional properties to associate with the Data Factory Linked Service.
     * The following supported arguments are specific to CosmosDB Linked Service:
     */
    public val additionalProperties: Output>?
        get() = javaResource.additionalProperties().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 -> args0.key.to(args0.value) }).toMap()
            }).orElse(null)
        })

    /**
     * List of tags that can be used for describing the Data Factory Linked Service.
     */
    public val annotations: Output>?
        get() = javaResource.annotations().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0
                })
            }).orElse(null)
        })

    /**
     * The connection string. Required if `account_endpoint`, `account_key`, and `database` are unspecified.
     */
    public val connectionString: Output?
        get() = javaResource.connectionString().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
     */
    public val dataFactoryId: Output
        get() = javaResource.dataFactoryId().applyValue({ args0 -> args0 })

    /**
     * The name of the database. Required if `connection_string` is unspecified.
     */
    public val database: Output?
        get() = javaResource.database().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * The description for the Data Factory Linked Service.
     */
    public val description: Output?
        get() = javaResource.description().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * The integration runtime reference to associate with the Data Factory Linked Service.
     */
    public val integrationRuntimeName: Output?
        get() = javaResource.integrationRuntimeName().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * 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.
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * A map of parameters to associate with the Data Factory Linked Service.
     */
    public val parameters: Output>?
        get() = javaResource.parameters().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.key.to(args0.value)
                }).toMap()
            }).orElse(null)
        })
}

public object LinkedServiceCosmosDbMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.azure.datafactory.LinkedServiceCosmosDb::class == javaResource::class

    override fun map(javaResource: Resource): LinkedServiceCosmosDb =
        LinkedServiceCosmosDb(javaResource as com.pulumi.azure.datafactory.LinkedServiceCosmosDb)
}

/**
 * @see [LinkedServiceCosmosDb].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [LinkedServiceCosmosDb].
 */
public suspend fun linkedServiceCosmosDb(
    name: String,
    block: suspend LinkedServiceCosmosDbResourceBuilder.() -> Unit,
): LinkedServiceCosmosDb {
    val builder = LinkedServiceCosmosDbResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [LinkedServiceCosmosDb].
 * @param name The _unique_ name of the resulting resource.
 */
public fun linkedServiceCosmosDb(name: String): LinkedServiceCosmosDb {
    val builder = LinkedServiceCosmosDbResourceBuilder()
    builder.name(name)
    return builder.build()
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy