MongoDbLinkedService Class
Linked service for MongoDb data source.
All required parameters must be populated in order to send to server.
Constructor
MongoDbLinkedService(*, server: MutableMapping[str, Any], database_name: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, version: str | None = None, connect_via: _models.IntegrationRuntimeReference | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str, Any]] | None = None, authentication_type: str | _models.MongoDbAuthenticationType | None = None, username: MutableMapping[str, Any] | None = None, password: _models.SecretBase | None = None, auth_source: MutableMapping[str, Any] | None = None, port: MutableMapping[str, Any] | None = None, enable_ssl: MutableMapping[str, Any] | None = None, allow_self_signed_server_cert: MutableMapping[str, Any] | None = None, encrypted_credential: str | None = None, **kwargs: Any)Keyword-Only Parameters
| Name | Description |
|---|---|
|
additional_properties
|
Unmatched properties from the message are deserialized to this collection. Default value: None
|
|
version
|
Version of the linked service. Default value: None
|
|
connect_via
|
The integration runtime reference. Default value: None
|
|
description
|
Linked service description. Default value: None
|
|
parameters
|
Parameters for linked service. Default value: None
|
|
annotations
|
list[<xref:JSON>]
List of tags that can be used for describing the linked service. Default value: None
|
|
server
|
<xref:JSON>
The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string). Required. |
|
authentication_type
|
The authentication type to be used to connect to the MongoDB database. Known values are: "Basic" and "Anonymous". Default value: None
|
|
database_name
|
<xref:JSON>
The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string). Required. |
|
username
|
<xref:JSON>
Username for authentication. Type: string (or Expression with resultType string). Default value: None
|
|
password
|
Password for authentication. Default value: None
|
|
auth_source
|
<xref:JSON>
Database to verify the username and password. Type: string (or Expression with resultType string). Default value: None
|
|
port
|
<xref:JSON>
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. Default value: None
|
|
enable_ssl
|
<xref:JSON>
Specifies whether the connections to the server are encrypted using SSL. The default value is false. Type: boolean (or Expression with resultType boolean). Default value: None
|
|
allow_self_signed_server_cert
|
<xref:JSON>
Specifies whether to allow self-signed certificates from the server. The default value is false. Type: boolean (or Expression with resultType boolean). Default value: None
|
|
encrypted_credential
|
The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. Default value: None
|
Variables
| Name | Description |
|---|---|
|
additional_properties
|
Unmatched properties from the message are deserialized to this collection. |
|
type
|
Type of linked service. Required. |
|
version
|
Version of the linked service. |
|
connect_via
|
The integration runtime reference. |
|
description
|
Linked service description. |
|
parameters
|
Parameters for linked service. |
|
annotations
|
list[<xref:JSON>]
List of tags that can be used for describing the linked service. |
|
server
|
<xref:JSON>
The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string). Required. |
|
authentication_type
|
The authentication type to be used to connect to the MongoDB database. Known values are: "Basic" and "Anonymous". |
|
database_name
|
<xref:JSON>
The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string). Required. |
|
username
|
<xref:JSON>
Username for authentication. Type: string (or Expression with resultType string). |
|
password
|
Password for authentication. |
|
auth_source
|
<xref:JSON>
Database to verify the username and password. Type: string (or Expression with resultType string). |
|
port
|
<xref:JSON>
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
|
<xref:JSON>
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
|
<xref:JSON>
Specifies whether to allow self-signed certificates from the server. The default value is false. Type: boolean (or Expression with resultType boolean). |
|
encrypted_credential
|
The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. |
