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

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.datafactory.LinkedServiceCosmosDbMongoApi

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    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

    using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleFactory = new Azure.DataFactory.Factory("exampleFactory", new Azure.DataFactory.FactoryArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
        });
        var exampleLinkedServiceCosmosDbMongoApi = new Azure.DataFactory.LinkedServiceCosmosDbMongoApi("exampleLinkedServiceCosmosDbMongoApi", new Azure.DataFactory.LinkedServiceCosmosDbMongoApiArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            DataFactoryId = exampleFactory.Id,
            ConnectionString = "mongodb://testinstance:testkey@testinstance.documents.azure.com:10255/?ssl=true",
            Database = "foo",
        });
    }

}

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v4/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, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleFactory, err := datafactory.NewFactory(ctx, "exampleFactory", &datafactory.FactoryArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
		})
		if err != nil {
			return err
		}
		_, err = datafactory.NewLinkedServiceCosmosDbMongoApi(ctx, "exampleLinkedServiceCosmosDbMongoApi", &datafactory.LinkedServiceCosmosDbMongoApiArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			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
	})
}

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleFactory = new azure.datafactory.Factory("exampleFactory", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleLinkedServiceCosmosDbMongoApi = new azure.datafactory.LinkedServiceCosmosDbMongoApi("exampleLinkedServiceCosmosDbMongoApi", {
    resourceGroupName: exampleResourceGroup.name,
    dataFactoryId: exampleFactory.id,
    connectionString: "mongodb://testinstance:testkey@testinstance.documents.azure.com:10255/?ssl=true",
    database: "foo",
});

    import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_linked_service_cosmos_db_mongo_api = azure.datafactory.LinkedServiceCosmosDbMongoApi("exampleLinkedServiceCosmosDbMongoApi",
    resource_group_name=example_resource_group.name,
    data_factory_id=example_factory.id,
    connection_string="mongodb://testinstance:testkey@testinstance.documents.azure.com:10255/?ssl=true",
    database="foo")

    Example coming soon!

    Create LinkedServiceCosmosDbMongoApi Resource

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

    Constructor syntax

    new LinkedServiceCosmosDbMongoApi(name: string, args: LinkedServiceCosmosDbMongoApiArgs, opts?: CustomResourceOptions);
    @overload
def LinkedServiceCosmosDbMongoApi(resource_name: str,
                                  args: LinkedServiceCosmosDbMongoApiArgs,
                                  opts: Optional[ResourceOptions] = None)

@overload
def LinkedServiceCosmosDbMongoApi(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  resource_group_name: 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,
                                  data_factory_name: 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,
                                  server_version_is32_or_higher: Optional[bool] = None)
    func NewLinkedServiceCosmosDbMongoApi(ctx *Context, name string, args LinkedServiceCosmosDbMongoApiArgs, opts ...ResourceOption) (*LinkedServiceCosmosDbMongoApi, error)
    public LinkedServiceCosmosDbMongoApi(string name, LinkedServiceCosmosDbMongoApiArgs args, CustomResourceOptions? opts = null)
    public LinkedServiceCosmosDbMongoApi(String name, LinkedServiceCosmosDbMongoApiArgs args)
public LinkedServiceCosmosDbMongoApi(String name, LinkedServiceCosmosDbMongoApiArgs args, CustomResourceOptions options)

    type: azure:datafactory:LinkedServiceCosmosDbMongoApi
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 LinkedServiceCosmosDbMongoApiArgs
    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 LinkedServiceCosmosDbMongoApiArgs
    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 LinkedServiceCosmosDbMongoApiArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LinkedServiceCosmosDbMongoApiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LinkedServiceCosmosDbMongoApiArgs
    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 linkedServiceCosmosDbMongoApiResource = new Azure.DataFactory.LinkedServiceCosmosDbMongoApi("linkedServiceCosmosDbMongoApiResource", new()
{
    ResourceGroupName = "string",
    AdditionalProperties = 
    {
        { "string", "string" },
    },
    Annotations = new[]
    {
        "string",
    },
    ConnectionString = "string",
    DataFactoryId = "string",
    Database = "string",
    Description = "string",
    IntegrationRuntimeName = "string",
    Name = "string",
    Parameters = 
    {
        { "string", "string" },
    },
    ServerVersionIs32OrHigher = false,
});

    example, err := datafactory.NewLinkedServiceCosmosDbMongoApi(ctx, "linkedServiceCosmosDbMongoApiResource", &datafactory.LinkedServiceCosmosDbMongoApiArgs{
	ResourceGroupName: pulumi.String("string"),
	AdditionalProperties: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Annotations: pulumi.StringArray{
		pulumi.String("string"),
	},
	ConnectionString:       pulumi.String("string"),
	DataFactoryId:          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"),
	},
	ServerVersionIs32OrHigher: pulumi.Bool(false),
})

    var linkedServiceCosmosDbMongoApiResource = new LinkedServiceCosmosDbMongoApi("linkedServiceCosmosDbMongoApiResource", LinkedServiceCosmosDbMongoApiArgs.builder()
    .resourceGroupName("string")
    .additionalProperties(Map.of("string", "string"))
    .annotations("string")
    .connectionString("string")
    .dataFactoryId("string")
    .database("string")
    .description("string")
    .integrationRuntimeName("string")
    .name("string")
    .parameters(Map.of("string", "string"))
    .serverVersionIs32OrHigher(false)
    .build());

    linked_service_cosmos_db_mongo_api_resource = azure.datafactory.LinkedServiceCosmosDbMongoApi("linkedServiceCosmosDbMongoApiResource",
    resource_group_name="string",
    additional_properties={
        "string": "string",
    },
    annotations=["string"],
    connection_string="string",
    data_factory_id="string",
    database="string",
    description="string",
    integration_runtime_name="string",
    name="string",
    parameters={
        "string": "string",
    },
    server_version_is32_or_higher=False)

    const linkedServiceCosmosDbMongoApiResource = new azure.datafactory.LinkedServiceCosmosDbMongoApi("linkedServiceCosmosDbMongoApiResource", {
    resourceGroupName: "string",
    additionalProperties: {
        string: "string",
    },
    annotations: ["string"],
    connectionString: "string",
    dataFactoryId: "string",
    database: "string",
    description: "string",
    integrationRuntimeName: "string",
    name: "string",
    parameters: {
        string: "string",
    },
    serverVersionIs32OrHigher: false,
});

    type: azure:datafactory:LinkedServiceCosmosDbMongoApi
properties:
    additionalProperties:
        string: string
    annotations:
        - string
    connectionString: string
    dataFactoryId: string
    database: string
    description: string
    integrationRuntimeName: string
    name: string
    parameters:
        string: string
    resourceGroupName: string
    serverVersionIs32OrHigher: false

    LinkedServiceCosmosDbMongoApi Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The LinkedServiceCosmosDbMongoApi resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group in which to create the Data Factory Linked Service. Changing this forces a new resource
    AdditionalProperties Dictionary<string, string>
    A map of additional properties to associate with the Data Factory Linked Service.
    Annotations List<string>
    List of tags that can be used for describing the Data Factory Linked Service.
    ConnectionString string
    The connection string.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    DataFactoryName string
    The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.

    Deprecated: data_factory_name is deprecated in favour of data_factory_id and will be removed in version 3.0 of the AzureRM provider

    Database string
    The name of the database.
    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.
    ServerVersionIs32OrHigher bool
    Whether API server version is 3.2 or higher. Defaults to false.
    ResourceGroupName string
    The name of the resource group in which to create the Data Factory Linked Service. Changing this forces a new resource
    AdditionalProperties map[string]string
    A map of additional properties to associate with the Data Factory Linked Service.
    Annotations []string
    List of tags that can be used for describing the Data Factory Linked Service.
    ConnectionString string
    The connection string.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    DataFactoryName string
    The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.

    Deprecated: data_factory_name is deprecated in favour of data_factory_id and will be removed in version 3.0 of the AzureRM provider

    Database string
    The name of the database.
    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.
    ServerVersionIs32OrHigher bool
    Whether API server version is 3.2 or higher. Defaults to false.
    resourceGroupName String
    The name of the resource group in which to create the Data Factory Linked Service. Changing this forces a new resource
    additionalProperties Map<String,String>
    A map of additional properties to associate with the Data Factory Linked Service.
    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service.
    connectionString String
    The connection string.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    dataFactoryName String
    The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.

    Deprecated: data_factory_name is deprecated in favour of data_factory_id and will be removed in version 3.0 of the AzureRM provider

    database String
    The name of the database.
    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.
    serverVersionIs32OrHigher Boolean
    Whether API server version is 3.2 or higher. Defaults to false.
    resourceGroupName string
    The name of the resource group in which to create the Data Factory Linked Service. Changing this forces a new resource
    additionalProperties {[key: string]: string}
    A map of additional properties to associate with the Data Factory Linked Service.
    annotations string[]
    List of tags that can be used for describing the Data Factory Linked Service.
    connectionString string
    The connection string.
    dataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    dataFactoryName string
    The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.

    Deprecated: data_factory_name is deprecated in favour of data_factory_id and will be removed in version 3.0 of the AzureRM provider

    database string
    The name of the database.
    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.
    serverVersionIs32OrHigher boolean
    Whether API server version is 3.2 or higher. Defaults to false.
    resource_group_name str
    The name of the resource group in which to create the Data Factory Linked Service. Changing this forces a new resource
    additional_properties Mapping[str, str]
    A map of additional properties to associate with the Data Factory 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.
    data_factory_id str
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    data_factory_name str
    The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.

    Deprecated: data_factory_name is deprecated in favour of data_factory_id and will be removed in version 3.0 of the AzureRM provider

    database str
    The name of the database.
    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.
    server_version_is32_or_higher bool
    Whether API server version is 3.2 or higher. Defaults to false.
    resourceGroupName String
    The name of the resource group in which to create the Data Factory Linked Service. Changing this forces a new resource
    additionalProperties Map<String>
    A map of additional properties to associate with the Data Factory Linked Service.
    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service.
    connectionString String
    The connection string.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    dataFactoryName String
    The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.

    Deprecated: data_factory_name is deprecated in favour of data_factory_id and will be removed in version 3.0 of the AzureRM provider

    database String
    The name of the database.
    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.
    serverVersionIs32OrHigher Boolean
    Whether API server version is 3.2 or higher. Defaults to false.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LinkedServiceCosmosDbMongoApi 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 LinkedServiceCosmosDbMongoApi Resource

    Get an existing LinkedServiceCosmosDbMongoApi 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?: LinkedServiceCosmosDbMongoApiState, opts?: CustomResourceOptions): LinkedServiceCosmosDbMongoApi
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_properties: Optional[Mapping[str, str]] = None,
        annotations: Optional[Sequence[str]] = None,
        connection_string: Optional[str] = None,
        data_factory_id: Optional[str] = None,
        data_factory_name: 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,
        resource_group_name: Optional[str] = None,
        server_version_is32_or_higher: Optional[bool] = None) -> LinkedServiceCosmosDbMongoApi
    func GetLinkedServiceCosmosDbMongoApi(ctx *Context, name string, id IDInput, state *LinkedServiceCosmosDbMongoApiState, opts ...ResourceOption) (*LinkedServiceCosmosDbMongoApi, error)
    public static LinkedServiceCosmosDbMongoApi Get(string name, Input<string> id, LinkedServiceCosmosDbMongoApiState? state, CustomResourceOptions? opts = null)
    public static LinkedServiceCosmosDbMongoApi get(String name, Output<String> id, LinkedServiceCosmosDbMongoApiState state, CustomResourceOptions options)
    resources:  _:    type: azure:datafactory:LinkedServiceCosmosDbMongoApi    get:      id: ${id}
    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:
    AdditionalProperties Dictionary<string, string>
    A map of additional properties to associate with the Data Factory Linked Service.
    Annotations List<string>
    List of tags that can be used for describing the Data Factory Linked Service.
    ConnectionString string
    The connection string.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    DataFactoryName string
    The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.

    Deprecated: data_factory_name is deprecated in favour of data_factory_id and will be removed in version 3.0 of the AzureRM provider

    Database string
    The name of the database.
    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.
    ResourceGroupName string
    The name of the resource group in which to create the Data Factory Linked Service. Changing this forces a new resource
    ServerVersionIs32OrHigher bool
    Whether API server version is 3.2 or higher. Defaults to false.
    AdditionalProperties map[string]string
    A map of additional properties to associate with the Data Factory Linked Service.
    Annotations []string
    List of tags that can be used for describing the Data Factory Linked Service.
    ConnectionString string
    The connection string.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    DataFactoryName string
    The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.

    Deprecated: data_factory_name is deprecated in favour of data_factory_id and will be removed in version 3.0 of the AzureRM provider

    Database string
    The name of the database.
    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.
    ResourceGroupName string
    The name of the resource group in which to create the Data Factory Linked Service. Changing this forces a new resource
    ServerVersionIs32OrHigher bool
    Whether API server version is 3.2 or higher. Defaults to false.
    additionalProperties Map<String,String>
    A map of additional properties to associate with the Data Factory Linked Service.
    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service.
    connectionString String
    The connection string.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    dataFactoryName String
    The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.

    Deprecated: data_factory_name is deprecated in favour of data_factory_id and will be removed in version 3.0 of the AzureRM provider

    database String
    The name of the database.
    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.
    resourceGroupName String
    The name of the resource group in which to create the Data Factory Linked Service. Changing this forces a new resource
    serverVersionIs32OrHigher Boolean
    Whether API server version is 3.2 or higher. Defaults to false.
    additionalProperties {[key: string]: string}
    A map of additional properties to associate with the Data Factory Linked Service.
    annotations string[]
    List of tags that can be used for describing the Data Factory Linked Service.
    connectionString string
    The connection string.
    dataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    dataFactoryName string
    The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.

    Deprecated: data_factory_name is deprecated in favour of data_factory_id and will be removed in version 3.0 of the AzureRM provider

    database string
    The name of the database.
    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.
    resourceGroupName string
    The name of the resource group in which to create the Data Factory Linked Service. Changing this forces a new resource
    serverVersionIs32OrHigher boolean
    Whether API server version is 3.2 or higher. Defaults to false.
    additional_properties Mapping[str, str]
    A map of additional properties to associate with the Data Factory 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.
    data_factory_id str
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    data_factory_name str
    The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.

    Deprecated: data_factory_name is deprecated in favour of data_factory_id and will be removed in version 3.0 of the AzureRM provider

    database str
    The name of the database.
    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.
    resource_group_name str
    The name of the resource group in which to create the Data Factory Linked Service. Changing this forces a new resource
    server_version_is32_or_higher bool
    Whether API server version is 3.2 or higher. Defaults to false.
    additionalProperties Map<String>
    A map of additional properties to associate with the Data Factory Linked Service.
    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service.
    connectionString String
    The connection string.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    dataFactoryName String
    The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.

    Deprecated: data_factory_name is deprecated in favour of data_factory_id and will be removed in version 3.0 of the AzureRM provider

    database String
    The name of the database.
    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.
    resourceGroupName String
    The name of the resource group in which to create the Data Factory Linked Service. Changing this forces a new resource
    serverVersionIs32OrHigher Boolean
    Whether API server version is 3.2 or higher. Defaults to false.

    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

    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.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure
      Try Pulumi Cloud free. Your team will thank you.