1. Packages
  2. Azure Classic
  3. API Docs
  4. datafactory
  5. LinkedServiceCosmosDb

We recommend using Azure Native.

Azure Classic v5.83.0 published on Monday, Jul 8, 2024 by Pulumi

azure.datafactory.LinkedServiceCosmosDb

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.83.0 published on Monday, Jul 8, 2024 by Pulumi

    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",
    });
    
    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")
    
    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
    	})
    }
    
    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",
        });
    
    });
    
    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());
    
        }
    }
    
    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
    

    Create LinkedServiceCosmosDb Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LinkedServiceCosmosDb(name: string, args: LinkedServiceCosmosDbArgs, opts?: CustomResourceOptions);
    @overload
    def LinkedServiceCosmosDb(resource_name: str,
                              args: LinkedServiceCosmosDbArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def LinkedServiceCosmosDb(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              data_factory_id: Optional[str] = None,
                              account_endpoint: Optional[str] = None,
                              account_key: Optional[str] = None,
                              additional_properties: Optional[Mapping[str, str]] = None,
                              annotations: Optional[Sequence[str]] = None,
                              connection_string: Optional[str] = None,
                              database: Optional[str] = None,
                              description: Optional[str] = None,
                              integration_runtime_name: Optional[str] = None,
                              name: Optional[str] = None,
                              parameters: Optional[Mapping[str, str]] = None)
    func NewLinkedServiceCosmosDb(ctx *Context, name string, args LinkedServiceCosmosDbArgs, opts ...ResourceOption) (*LinkedServiceCosmosDb, error)
    public LinkedServiceCosmosDb(string name, LinkedServiceCosmosDbArgs args, CustomResourceOptions? opts = null)
    public LinkedServiceCosmosDb(String name, LinkedServiceCosmosDbArgs args)
    public LinkedServiceCosmosDb(String name, LinkedServiceCosmosDbArgs args, CustomResourceOptions options)
    
    type: azure:datafactory:LinkedServiceCosmosDb
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args LinkedServiceCosmosDbArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args LinkedServiceCosmosDbArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args LinkedServiceCosmosDbArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LinkedServiceCosmosDbArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LinkedServiceCosmosDbArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var linkedServiceCosmosDbResource = new Azure.DataFactory.LinkedServiceCosmosDb("linkedServiceCosmosDbResource", new()
    {
        DataFactoryId = "string",
        AccountEndpoint = "string",
        AccountKey = "string",
        AdditionalProperties = 
        {
            { "string", "string" },
        },
        Annotations = new[]
        {
            "string",
        },
        ConnectionString = "string",
        Database = "string",
        Description = "string",
        IntegrationRuntimeName = "string",
        Name = "string",
        Parameters = 
        {
            { "string", "string" },
        },
    });
    
    example, err := datafactory.NewLinkedServiceCosmosDb(ctx, "linkedServiceCosmosDbResource", &datafactory.LinkedServiceCosmosDbArgs{
    	DataFactoryId:   pulumi.String("string"),
    	AccountEndpoint: pulumi.String("string"),
    	AccountKey:      pulumi.String("string"),
    	AdditionalProperties: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Annotations: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ConnectionString:       pulumi.String("string"),
    	Database:               pulumi.String("string"),
    	Description:            pulumi.String("string"),
    	IntegrationRuntimeName: pulumi.String("string"),
    	Name:                   pulumi.String("string"),
    	Parameters: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var linkedServiceCosmosDbResource = new LinkedServiceCosmosDb("linkedServiceCosmosDbResource", LinkedServiceCosmosDbArgs.builder()
        .dataFactoryId("string")
        .accountEndpoint("string")
        .accountKey("string")
        .additionalProperties(Map.of("string", "string"))
        .annotations("string")
        .connectionString("string")
        .database("string")
        .description("string")
        .integrationRuntimeName("string")
        .name("string")
        .parameters(Map.of("string", "string"))
        .build());
    
    linked_service_cosmos_db_resource = azure.datafactory.LinkedServiceCosmosDb("linkedServiceCosmosDbResource",
        data_factory_id="string",
        account_endpoint="string",
        account_key="string",
        additional_properties={
            "string": "string",
        },
        annotations=["string"],
        connection_string="string",
        database="string",
        description="string",
        integration_runtime_name="string",
        name="string",
        parameters={
            "string": "string",
        })
    
    const linkedServiceCosmosDbResource = new azure.datafactory.LinkedServiceCosmosDb("linkedServiceCosmosDbResource", {
        dataFactoryId: "string",
        accountEndpoint: "string",
        accountKey: "string",
        additionalProperties: {
            string: "string",
        },
        annotations: ["string"],
        connectionString: "string",
        database: "string",
        description: "string",
        integrationRuntimeName: "string",
        name: "string",
        parameters: {
            string: "string",
        },
    });
    
    type: azure:datafactory:LinkedServiceCosmosDb
    properties:
        accountEndpoint: string
        accountKey: string
        additionalProperties:
            string: string
        annotations:
            - string
        connectionString: string
        dataFactoryId: string
        database: string
        description: string
        integrationRuntimeName: string
        name: string
        parameters:
            string: string
    

    LinkedServiceCosmosDb Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The LinkedServiceCosmosDb resource accepts the following input properties:

    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    AccountEndpoint string
    The endpoint of the Azure CosmosDB account. Required if connection_string is unspecified.
    AccountKey string
    The account key of the Azure Cosmos DB account. Required if connection_string is unspecified.
    AdditionalProperties Dictionary<string, string>

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

    The following supported arguments are specific to CosmosDB Linked Service:

    Annotations List<string>
    List of tags that can be used for describing the Data Factory Linked Service.
    ConnectionString string
    The connection string. Required if account_endpoint, account_key, and database are unspecified.
    Database string
    The name of the database. Required if connection_string is unspecified.
    Description string
    The description for the Data Factory Linked Service.
    IntegrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service.
    Name string
    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.
    Parameters Dictionary<string, string>
    A map of parameters to associate with the Data Factory Linked Service.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    AccountEndpoint string
    The endpoint of the Azure CosmosDB account. Required if connection_string is unspecified.
    AccountKey string
    The account key of the Azure Cosmos DB account. Required if connection_string is unspecified.
    AdditionalProperties map[string]string

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

    The following supported arguments are specific to CosmosDB Linked Service:

    Annotations []string
    List of tags that can be used for describing the Data Factory Linked Service.
    ConnectionString string
    The connection string. Required if account_endpoint, account_key, and database are unspecified.
    Database string
    The name of the database. Required if connection_string is unspecified.
    Description string
    The description for the Data Factory Linked Service.
    IntegrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service.
    Name string
    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.
    Parameters map[string]string
    A map of parameters to associate with the Data Factory Linked Service.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    accountEndpoint String
    The endpoint of the Azure CosmosDB account. Required if connection_string is unspecified.
    accountKey String
    The account key of the Azure Cosmos DB account. Required if connection_string is unspecified.
    additionalProperties Map<String,String>

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

    The following supported arguments are specific to CosmosDB Linked Service:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service.
    connectionString String
    The connection string. Required if account_endpoint, account_key, and database are unspecified.
    database String
    The name of the database. Required if connection_string is unspecified.
    description String
    The description for the Data Factory Linked Service.
    integrationRuntimeName String
    The integration runtime reference to associate with the Data Factory Linked Service.
    name String
    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.
    parameters Map<String,String>
    A map of parameters to associate with the Data Factory Linked Service.
    dataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    accountEndpoint string
    The endpoint of the Azure CosmosDB account. Required if connection_string is unspecified.
    accountKey string
    The account key of the Azure Cosmos DB account. Required if connection_string is unspecified.
    additionalProperties {[key: string]: string}

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

    The following supported arguments are specific to CosmosDB Linked Service:

    annotations string[]
    List of tags that can be used for describing the Data Factory Linked Service.
    connectionString string
    The connection string. Required if account_endpoint, account_key, and database are unspecified.
    database string
    The name of the database. Required if connection_string is unspecified.
    description string
    The description for the Data Factory Linked Service.
    integrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service.
    name string
    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.
    parameters {[key: string]: string}
    A map of parameters to associate with the Data Factory Linked Service.
    data_factory_id str
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    account_endpoint str
    The endpoint of the Azure CosmosDB account. Required if connection_string is unspecified.
    account_key str
    The account key of the Azure Cosmos DB account. Required if connection_string is unspecified.
    additional_properties Mapping[str, str]

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

    The following supported arguments are specific to CosmosDB Linked Service:

    annotations Sequence[str]
    List of tags that can be used for describing the Data Factory Linked Service.
    connection_string str
    The connection string. Required if account_endpoint, account_key, and database are unspecified.
    database str
    The name of the database. Required if connection_string is unspecified.
    description str
    The description for the Data Factory Linked Service.
    integration_runtime_name str
    The integration runtime reference to associate with the Data Factory Linked Service.
    name str
    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.
    parameters Mapping[str, str]
    A map of parameters to associate with the Data Factory Linked Service.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    accountEndpoint String
    The endpoint of the Azure CosmosDB account. Required if connection_string is unspecified.
    accountKey String
    The account key of the Azure Cosmos DB account. Required if connection_string is unspecified.
    additionalProperties Map<String>

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

    The following supported arguments are specific to CosmosDB Linked Service:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service.
    connectionString String
    The connection string. Required if account_endpoint, account_key, and database are unspecified.
    database String
    The name of the database. Required if connection_string is unspecified.
    description String
    The description for the Data Factory Linked Service.
    integrationRuntimeName String
    The integration runtime reference to associate with the Data Factory Linked Service.
    name String
    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.
    parameters Map<String>
    A map of parameters to associate with the Data Factory Linked Service.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LinkedServiceCosmosDb resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing LinkedServiceCosmosDb Resource

    Get an existing LinkedServiceCosmosDb resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: LinkedServiceCosmosDbState, opts?: CustomResourceOptions): LinkedServiceCosmosDb
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_endpoint: Optional[str] = None,
            account_key: Optional[str] = None,
            additional_properties: Optional[Mapping[str, str]] = None,
            annotations: Optional[Sequence[str]] = None,
            connection_string: Optional[str] = None,
            data_factory_id: Optional[str] = None,
            database: Optional[str] = None,
            description: Optional[str] = None,
            integration_runtime_name: Optional[str] = None,
            name: Optional[str] = None,
            parameters: Optional[Mapping[str, str]] = None) -> LinkedServiceCosmosDb
    func GetLinkedServiceCosmosDb(ctx *Context, name string, id IDInput, state *LinkedServiceCosmosDbState, opts ...ResourceOption) (*LinkedServiceCosmosDb, error)
    public static LinkedServiceCosmosDb Get(string name, Input<string> id, LinkedServiceCosmosDbState? state, CustomResourceOptions? opts = null)
    public static LinkedServiceCosmosDb get(String name, Output<String> id, LinkedServiceCosmosDbState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountEndpoint string
    The endpoint of the Azure CosmosDB account. Required if connection_string is unspecified.
    AccountKey string
    The account key of the Azure Cosmos DB account. Required if connection_string is unspecified.
    AdditionalProperties Dictionary<string, string>

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

    The following supported arguments are specific to CosmosDB Linked Service:

    Annotations List<string>
    List of tags that can be used for describing the Data Factory Linked Service.
    ConnectionString string
    The connection string. Required if account_endpoint, account_key, and database are unspecified.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    Database string
    The name of the database. Required if connection_string is unspecified.
    Description string
    The description for the Data Factory Linked Service.
    IntegrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service.
    Name string
    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.
    Parameters Dictionary<string, string>
    A map of parameters to associate with the Data Factory Linked Service.
    AccountEndpoint string
    The endpoint of the Azure CosmosDB account. Required if connection_string is unspecified.
    AccountKey string
    The account key of the Azure Cosmos DB account. Required if connection_string is unspecified.
    AdditionalProperties map[string]string

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

    The following supported arguments are specific to CosmosDB Linked Service:

    Annotations []string
    List of tags that can be used for describing the Data Factory Linked Service.
    ConnectionString string
    The connection string. Required if account_endpoint, account_key, and database are unspecified.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    Database string
    The name of the database. Required if connection_string is unspecified.
    Description string
    The description for the Data Factory Linked Service.
    IntegrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service.
    Name string
    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.
    Parameters map[string]string
    A map of parameters to associate with the Data Factory Linked Service.
    accountEndpoint String
    The endpoint of the Azure CosmosDB account. Required if connection_string is unspecified.
    accountKey String
    The account key of the Azure Cosmos DB account. Required if connection_string is unspecified.
    additionalProperties Map<String,String>

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

    The following supported arguments are specific to CosmosDB Linked Service:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service.
    connectionString String
    The connection string. Required if account_endpoint, account_key, and database are unspecified.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    database String
    The name of the database. Required if connection_string is unspecified.
    description String
    The description for the Data Factory Linked Service.
    integrationRuntimeName String
    The integration runtime reference to associate with the Data Factory Linked Service.
    name String
    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.
    parameters Map<String,String>
    A map of parameters to associate with the Data Factory Linked Service.
    accountEndpoint string
    The endpoint of the Azure CosmosDB account. Required if connection_string is unspecified.
    accountKey string
    The account key of the Azure Cosmos DB account. Required if connection_string is unspecified.
    additionalProperties {[key: string]: string}

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

    The following supported arguments are specific to CosmosDB Linked Service:

    annotations string[]
    List of tags that can be used for describing the Data Factory Linked Service.
    connectionString string
    The connection string. Required if account_endpoint, account_key, and database are unspecified.
    dataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    database string
    The name of the database. Required if connection_string is unspecified.
    description string
    The description for the Data Factory Linked Service.
    integrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service.
    name string
    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.
    parameters {[key: string]: string}
    A map of parameters to associate with the Data Factory Linked Service.
    account_endpoint str
    The endpoint of the Azure CosmosDB account. Required if connection_string is unspecified.
    account_key str
    The account key of the Azure Cosmos DB account. Required if connection_string is unspecified.
    additional_properties Mapping[str, str]

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

    The following supported arguments are specific to CosmosDB Linked Service:

    annotations Sequence[str]
    List of tags that can be used for describing the Data Factory Linked Service.
    connection_string str
    The connection string. Required if account_endpoint, account_key, and database are unspecified.
    data_factory_id str
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    database str
    The name of the database. Required if connection_string is unspecified.
    description str
    The description for the Data Factory Linked Service.
    integration_runtime_name str
    The integration runtime reference to associate with the Data Factory Linked Service.
    name str
    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.
    parameters Mapping[str, str]
    A map of parameters to associate with the Data Factory Linked Service.
    accountEndpoint String
    The endpoint of the Azure CosmosDB account. Required if connection_string is unspecified.
    accountKey String
    The account key of the Azure Cosmos DB account. Required if connection_string is unspecified.
    additionalProperties Map<String>

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

    The following supported arguments are specific to CosmosDB Linked Service:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service.
    connectionString String
    The connection string. Required if account_endpoint, account_key, and database are unspecified.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    database String
    The name of the database. Required if connection_string is unspecified.
    description String
    The description for the Data Factory Linked Service.
    integrationRuntimeName String
    The integration runtime reference to associate with the Data Factory Linked Service.
    name String
    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.
    parameters Map<String>
    A map of parameters to associate with the Data Factory Linked Service.

    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/example
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.83.0 published on Monday, Jul 8, 2024 by Pulumi