LinkedServiceCosmosDbMongoApiArgs

data class LinkedServiceCosmosDbMongoApiArgs(val additionalProperties: Output<Map<String, String>>? = null, val annotations: Output<List<String>>? = null, val connectionString: Output<String>? = null, val dataFactoryId: Output<String>? = null, val database: Output<String>? = null, val description: Output<String>? = null, val integrationRuntimeName: Output<String>? = null, val name: Output<String>? = null, val parameters: Output<Map<String, String>>? = null, val serverVersionIs32OrHigher: Output<Boolean>? = null) : ConvertibleToJava<LinkedServiceCosmosDbMongoApiArgs>

Manages a Linked Service (connection) between a CosmosDB and Azure Data Factory using Mongo API.

Note: All arguments including the client secret will be stored in the raw state as plain-text. Read more about sensitive data in state.

Example Usage

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.LinkedServiceCosmosDbMongoApi;
import com.pulumi.azure.datafactory.LinkedServiceCosmosDbMongoApiArgs;
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()
.location("West Europe")
.build());
var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.build());
var exampleLinkedServiceCosmosDbMongoApi = new LinkedServiceCosmosDbMongoApi("exampleLinkedServiceCosmosDbMongoApi", LinkedServiceCosmosDbMongoApiArgs.builder()
.dataFactoryId(exampleFactory.id())
.connectionString("mongodb://testinstance:testkey@testinstance.documents.azure.com:10255/?ssl=true")
.database("foo")
.build());
}
}

Import

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

$ pulumi import azure:datafactory/linkedServiceCosmosDbMongoApi:LinkedServiceCosmosDbMongoApi example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/linkedservices/example

Constructors

Link copied to clipboard
fun LinkedServiceCosmosDbMongoApiArgs(additionalProperties: Output<Map<String, String>>? = null, annotations: Output<List<String>>? = null, connectionString: Output<String>? = null, dataFactoryId: Output<String>? = null, database: Output<String>? = null, description: Output<String>? = null, integrationRuntimeName: Output<String>? = null, name: Output<String>? = null, parameters: Output<Map<String, String>>? = null, serverVersionIs32OrHigher: Output<Boolean>? = null)

Functions

Link copied to clipboard
open override fun toJava(): LinkedServiceCosmosDbMongoApiArgs

Properties

Link copied to clipboard
val additionalProperties: Output<Map<String, String>>? = null

A map of additional properties to associate with the Data Factory Linked Service. The following supported arguments are specific to CosmosDB Linked Service:

Link copied to clipboard
val annotations: Output<List<String>>? = null

List of tags that can be used for describing the Data Factory Linked Service.

Link copied to clipboard
val connectionString: Output<String>? = null

The connection string.

Link copied to clipboard
val database: Output<String>? = null

The name of the database.

Link copied to clipboard
val dataFactoryId: Output<String>? = null

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

Link copied to clipboard
val description: Output<String>? = null

The description for the Data Factory Linked Service.

Link copied to clipboard
val integrationRuntimeName: Output<String>? = null

The integration runtime reference to associate with the Data Factory Linked Service.

Link copied to clipboard
val name: Output<String>? = 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 for all restrictions.

Link copied to clipboard
val parameters: Output<Map<String, String>>? = null

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

Link copied to clipboard
val serverVersionIs32OrHigher: Output<Boolean>? = null

Whether API server version is 3.2 or higher. Defaults to false.