Linked
data class LinkedServiceCosmosDbArgs(val accountEndpoint: Output<String>? = null, val accountKey: Output<String>? = null, 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) : ConvertibleToJava<LinkedServiceCosmosDbArgs>
Manages a Linked Service (connection) between a CosmosDB and Azure Data Factory using SQL API.
Example Usage
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",
});Content copied to clipboard
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")Content copied to clipboard
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",
});
});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/cosmosdb"
"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 {
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
})
}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.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.endpoint())
.accountKey(example.primaryKey())
.database("foo")
.build());
}
}Content copied to clipboard
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-rgContent copied to clipboard
Import
Data Factory Linked Service's can be imported using the resource id, e.g.
$ pulumi import azure:datafactory/linkedServiceCosmosDb:LinkedServiceCosmosDb 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(accountEndpoint: Output<String>? = null, accountKey: Output<String>? = null, 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)
Properties
Link copied to clipboard
The endpoint of the Azure CosmosDB account. Required if connection_string is unspecified.
Link copied to clipboard
The account key of the Azure Cosmos DB account. Required if connection_string is unspecified.
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. Required if account_endpoint, account_key, and database are unspecified.
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.