CosmosDbMongoDbApiLinkedService Class

Linked service for CosmosDB (MongoDB API) data source.

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

Inheritance

azure.mgmt.datafactory.models._models_py3.LinkedService

CosmosDbMongoDbApiLinkedService

Constructor

CosmosDbMongoDbApiLinkedService(*, connection_string: Any, database: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[_models.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, _models.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, is_server_version_above32: Optional[Any] = None, **kwargs)

Variables

additional_properties

dict[str, any]

Unmatched properties from the message are deserialized to this collection.

type

str

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

connect_via

IntegrationRuntimeReference

The integration runtime reference.

description

str

Linked service description.

parameters

dict[str, ParameterSpecification]

Parameters for linked service.

annotations

list[any]

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

is_server_version_above32

any

Whether the CosmosDB (MongoDB API) server version is higher than 3.2. The default value is false. Type: boolean (or Expression with resultType boolean).

connection_string

any

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

database

any

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