CosmosDbMongoDbApiLinkedService Class

Linked service for CosmosDB (MongoDB API) data source.

All required parameters must be populated in order to send to Azure.

Inheritance

azure.synapse.artifacts.models._models_py3.LinkedService

CosmosDbMongoDbApiLinkedService

Constructor

CosmosDbMongoDbApiLinkedService(*, connection_string: object, database: object, additional_properties: Optional[Dict[str, object]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[object]] = None, **kwargs)

Parameters

additional_properties

dict[str, object]

Required

Unmatched properties from the message are deserialized to this collection.

type

str

Required

Required. Type of linked service.Constant filled by server.

connect_via

IntegrationRuntimeReference

Required

The integration runtime reference.

description

str

Required

Linked service description.

parameters

dict[str, ParameterSpecification]

Required

Parameters for linked service.

annotations

list[object]

Required

List of tags that can be used for describing the linked service.

connection_string

object

Required

Required. The CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.

database

object

Required

Required. The name of the CosmosDB (MongoDB API) database that you want to access. Type: string (or Expression with resultType string).