Linked
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
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 exampleLinkedServiceCosmosDbMongoApi = new azure.datafactory.LinkedServiceCosmosDbMongoApi("example", {
name: "example",
dataFactoryId: exampleFactory.id,
connectionString: "mongodb://testinstance:testkey@testinstance.documents.azure.com:10255/?ssl=true",
database: "foo",
});Content copied to clipboard
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_cosmos_db_mongo_api = azure.datafactory.LinkedServiceCosmosDbMongoApi("example",
name="example",
data_factory_id=example_factory.id,
connection_string="mongodb://testinstance:testkey@testinstance.documents.azure.com:10255/?ssl=true",
database="foo")Content copied to clipboard
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 exampleLinkedServiceCosmosDbMongoApi = new Azure.DataFactory.LinkedServiceCosmosDbMongoApi("example", new()
{
Name = "example",
DataFactoryId = exampleFactory.Id,
ConnectionString = "mongodb://testinstance:testkey@testinstance.documents.azure.com:10255/?ssl=true",
Database = "foo",
});
});Content copied to clipboard
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v6/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.NewLinkedServiceCosmosDbMongoApi(ctx, "example", &datafactory.LinkedServiceCosmosDbMongoApiArgs{
Name: pulumi.String("example"),
DataFactoryId: exampleFactory.ID(),
ConnectionString: pulumi.String("mongodb://testinstance:testkey@testinstance.documents.azure.com:10255/?ssl=true"),
Database: pulumi.String("foo"),
})
if err != nil {
return err
}
return nil
})
}Content copied to clipboard
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 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 exampleLinkedServiceCosmosDbMongoApi = new LinkedServiceCosmosDbMongoApi("exampleLinkedServiceCosmosDbMongoApi", LinkedServiceCosmosDbMongoApiArgs.builder()
.name("example")
.dataFactoryId(exampleFactory.id())
.connectionString("mongodb://testinstance:testkey@testinstance.documents.azure.com:10255/?ssl=true")
.database("foo")
.build());
}
}Content copied to clipboard
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}
exampleLinkedServiceCosmosDbMongoApi:
type: azure:datafactory:LinkedServiceCosmosDbMongoApi
name: example
properties:
name: example
dataFactoryId: ${exampleFactory.id}
connectionString: mongodb://testinstance:testkey@testinstance.documents.azure.com:10255/?ssl=true
database: fooContent copied to clipboard
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/exampleContent copied to clipboard
Constructors
Link copied to clipboard
constructor(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)
Properties
Link copied to clipboard
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
List of tags that can be used for describing the Data Factory Linked Service.
Link copied to clipboard
The connection string.
Link copied to clipboard
The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
Link copied to clipboard
The description for the Data Factory Linked Service.
Link copied to clipboard
The integration runtime reference to associate with the Data Factory Linked Service.
Link copied to clipboard
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
A map of parameters to associate with the Data Factory Linked Service.
Link copied to clipboard
Whether API server version is 3.2 or higher. Defaults to false.