Azure Classic

v5.24.0 published on Wednesday, Nov 9, 2022 by Pulumi

LinkedServiceCosmosDbMongoApi

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 System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleFactory = new Azure.DataFactory.Factory("exampleFactory", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
    });

    var exampleLinkedServiceCosmosDbMongoApi = new Azure.DataFactory.LinkedServiceCosmosDbMongoApi("exampleLinkedServiceCosmosDbMongoApi", new()
    {
        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/v5/go/azure/core"
	"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, "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{
			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
	})
}
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 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",
    data_factory_id=example_factory.id,
    connection_string="mongodb://testinstance:testkey@testinstance.documents.azure.com:10255/?ssl=true",
    database="foo")
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", {
    dataFactoryId: exampleFactory.id,
    connectionString: "mongodb://testinstance:testkey@testinstance.documents.azure.com:10255/?ssl=true",
    database: "foo",
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleFactory:
    type: azure:datafactory:Factory
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
  exampleLinkedServiceCosmosDbMongoApi:
    type: azure:datafactory:LinkedServiceCosmosDbMongoApi
    properties:
      dataFactoryId: ${exampleFactory.id}
      connectionString: mongodb://testinstance:testkey@testinstance.documents.azure.com:10255/?ssl=true
      database: foo

Create LinkedServiceCosmosDbMongoApi Resource

new LinkedServiceCosmosDbMongoApi(name: string, args: LinkedServiceCosmosDbMongoApiArgs, opts?: CustomResourceOptions);
@overload
def LinkedServiceCosmosDbMongoApi(resource_name: 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,
                                  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)
@overload
def LinkedServiceCosmosDbMongoApi(resource_name: str,
                                  args: LinkedServiceCosmosDbMongoApiArgs,
                                  opts: Optional[ResourceOptions] = 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.

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.

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

The LinkedServiceCosmosDbMongoApi 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.

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.

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.

DataFactoryId string

The Data Factory ID in which to associate the Linked Service with. 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.

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.

dataFactoryId String

The Data Factory ID in which to associate the Linked Service with. 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.

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.

dataFactoryId string

The Data Factory ID in which to associate the Linked Service with. 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.

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.

data_factory_id str

The Data Factory ID in which to associate the Linked Service with. 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.

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.

dataFactoryId String

The Data Factory ID in which to associate the Linked Service with. 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.

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,
        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) -> 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)
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:
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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.