Feedback Edit

MongoDbLinkedService Class

  • Reference

Linked service for MongoDb data source.

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

Inheritance
azure.synapse.artifacts.models._models_py3.LinkedService
MongoDbLinkedService

Constructor

MongoDbLinkedService(*, server: object, database_name: 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, authentication_type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.MongoDbAuthenticationType]] = None, username: Optional[object] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, auth_source: Optional[object] = None, port: Optional[object] = None, enable_ssl: Optional[object] = None, allow_self_signed_server_cert: Optional[object] = None, encrypted_credential: Optional[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.

server
object
Required

Required. The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string).

authentication_type
str or MongoDbAuthenticationType
Required

The authentication type to be used to connect to the MongoDB database. Possible values include: "Basic", "Anonymous".

database_name
object
Required

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

username
object
Required

Username for authentication. Type: string (or Expression with resultType string).

password
SecretBase
Required

Password for authentication.

auth_source
object
Required

Database to verify the username and password. Type: string (or Expression with resultType string).

port
object
Required

The TCP port number that the MongoDB server uses to listen for client connections. The default value is 27017. Type: integer (or Expression with resultType integer), minimum: 0.

enable_ssl
object
Required

Specifies whether the connections to the server are encrypted using SSL. The default value is false. Type: boolean (or Expression with resultType boolean).

allow_self_signed_server_cert
object
Required

Specifies whether to allow self-signed certificates from the server. The default value is false. Type: boolean (or Expression with resultType boolean).

encrypted_credential
object
Required

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).