com.pulumi.azure.datafactory.kotlin.LinkedServiceCosmosDbArgs.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.LinkedServiceCosmosDbArgs.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 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
* ```
* @property accountEndpoint The endpoint of the Azure CosmosDB account. Required if `connection_string` is unspecified.
* @property accountKey The account key of the Azure Cosmos DB account. Required if `connection_string` is unspecified.
* @property additionalProperties A map of additional properties to associate with the Data Factory Linked Service.
* The following supported arguments are specific to CosmosDB Linked Service:
* @property annotations List of tags that can be used for describing the Data Factory Linked Service.
* @property connectionString The connection string. Required if `account_endpoint`, `account_key`, and `database` are unspecified.
* @property dataFactoryId The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
* @property database The name of the database. Required if `connection_string` is unspecified.
* @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.
*/
public data class LinkedServiceCosmosDbArgs(
public val accountEndpoint: Output? = null,
public val accountKey: Output? = null,
public val additionalProperties: Output>? = null,
public val annotations: Output>? = null,
public val connectionString: Output? = null,
public val dataFactoryId: Output? = null,
public val database: Output? = null,
public val description: Output? = null,
public val integrationRuntimeName: Output? = null,
public val name: Output? = null,
public val parameters: Output>? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.azure.datafactory.LinkedServiceCosmosDbArgs =
com.pulumi.azure.datafactory.LinkedServiceCosmosDbArgs.builder()
.accountEndpoint(accountEndpoint?.applyValue({ args0 -> args0 }))
.accountKey(accountKey?.applyValue({ args0 -> args0 }))
.additionalProperties(
additionalProperties?.applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}),
)
.annotations(annotations?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.connectionString(connectionString?.applyValue({ args0 -> args0 }))
.dataFactoryId(dataFactoryId?.applyValue({ args0 -> args0 }))
.database(database?.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()
}),
).build()
}
/**
* Builder for [LinkedServiceCosmosDbArgs].
*/
@PulumiTagMarker
public class LinkedServiceCosmosDbArgsBuilder internal constructor() {
private var accountEndpoint: Output? = null
private var accountKey: Output? = null
private var additionalProperties: Output>? = null
private var annotations: Output>? = null
private var connectionString: Output? = null
private var dataFactoryId: Output? = null
private var database: Output? = null
private var description: Output? = null
private var integrationRuntimeName: Output? = null
private var name: Output? = null
private var parameters: Output>? = null
/**
* @param value The endpoint of the Azure CosmosDB account. Required if `connection_string` is unspecified.
*/
@JvmName("ixcvsrkhmerbwakp")
public suspend fun accountEndpoint(`value`: Output) {
this.accountEndpoint = value
}
/**
* @param value The account key of the Azure Cosmos DB account. Required if `connection_string` is unspecified.
*/
@JvmName("fokiivmrjuliqiri")
public suspend fun accountKey(`value`: Output) {
this.accountKey = value
}
/**
* @param value A map of additional properties to associate with the Data Factory Linked Service.
* The following supported arguments are specific to CosmosDB Linked Service:
*/
@JvmName("xlbeqgvekuaxbybo")
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("ersbfiftdfyrlryt")
public suspend fun annotations(`value`: Output>) {
this.annotations = value
}
@JvmName("lwgrhkdocqquortp")
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("konhyqwvryonpaww")
public suspend fun annotations(values: List>) {
this.annotations = Output.all(values)
}
/**
* @param value The connection string. Required if `account_endpoint`, `account_key`, and `database` are unspecified.
*/
@JvmName("saoovsumtkrmqmso")
public suspend fun connectionString(`value`: Output) {
this.connectionString = value
}
/**
* @param value The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
*/
@JvmName("uiyofjichoxevjlq")
public suspend fun dataFactoryId(`value`: Output) {
this.dataFactoryId = value
}
/**
* @param value The name of the database. Required if `connection_string` is unspecified.
*/
@JvmName("kmomgogctbrklhal")
public suspend fun database(`value`: Output) {
this.database = value
}
/**
* @param value The description for the Data Factory Linked Service.
*/
@JvmName("ibqlkylsreglwjss")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value The integration runtime reference to associate with the Data Factory Linked Service.
*/
@JvmName("vaehuihcjndhsqqq")
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("xpiiirsxqeboxxew")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value A map of parameters to associate with the Data Factory Linked Service.
*/
@JvmName("rdrxykegsbdgsjxk")
public suspend fun parameters(`value`: Output>) {
this.parameters = value
}
/**
* @param value The endpoint of the Azure CosmosDB account. Required if `connection_string` is unspecified.
*/
@JvmName("fsfrvpsmqcyhjfme")
public suspend fun accountEndpoint(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.accountEndpoint = mapped
}
/**
* @param value The account key of the Azure Cosmos DB account. Required if `connection_string` is unspecified.
*/
@JvmName("qiyncivyniglqkxn")
public suspend fun accountKey(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.accountKey = mapped
}
/**
* @param value A map of additional properties to associate with the Data Factory Linked Service.
* The following supported arguments are specific to CosmosDB Linked Service:
*/
@JvmName("lhnysoxwbrrdjffx")
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 CosmosDB Linked Service:
*/
@JvmName("mlsodijuppmgehhu")
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("mgagjrihqblfptwj")
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("orljmtuusugpblxp")
public suspend fun annotations(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.annotations = mapped
}
/**
* @param value The connection string. Required if `account_endpoint`, `account_key`, and `database` are unspecified.
*/
@JvmName("aqluuhgwyaklbhgw")
public suspend fun connectionString(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.connectionString = mapped
}
/**
* @param value The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
*/
@JvmName("aclqduabqobhauxn")
public suspend fun dataFactoryId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.dataFactoryId = mapped
}
/**
* @param value The name of the database. Required if `connection_string` is unspecified.
*/
@JvmName("lyyakyfepimaonyn")
public suspend fun database(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.database = mapped
}
/**
* @param value The description for the Data Factory Linked Service.
*/
@JvmName("iaosohaxhdapdcne")
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("gkdfepknykdunhcb")
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("fgotbrpowhfbvjic")
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("ntlwwlxbggckatop")
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("skdshawrmjkqdkol")
public fun parameters(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.parameters = mapped
}
internal fun build(): LinkedServiceCosmosDbArgs = LinkedServiceCosmosDbArgs(
accountEndpoint = accountEndpoint,
accountKey = accountKey,
additionalProperties = additionalProperties,
annotations = annotations,
connectionString = connectionString,
dataFactoryId = dataFactoryId,
database = database,
description = description,
integrationRuntimeName = integrationRuntimeName,
name = name,
parameters = parameters,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy