Class MongoDbLinkedService

Linked service for MongoDb data source.

Inheritance
System.Object
LinkedService
MongoDbLinkedService
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Analytics.Synapse.Artifacts.dll
Syntax
[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService/MongoDbLinkedServiceConverter))]
public class MongoDbLinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService

Constructors

MongoDbLinkedService(Object, Object)

Initializes a new instance of MongoDbLinkedService.

Declaration
public MongoDbLinkedService (object server, object databaseName);
Parameters
System.Object server

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

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

server or databaseName is null.

Properties

AllowSelfSignedServerCert

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

Declaration
public object AllowSelfSignedServerCert { get; set; }
Property Value
System.Object

AuthenticationType

The authentication type to be used to connect to the MongoDB database.

Declaration
public Nullable<Azure.Analytics.Synapse.Artifacts.Models.MongoDbAuthenticationType> AuthenticationType { get; set; }
Property Value
System.Nullable<MongoDbAuthenticationType>

AuthSource

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

Declaration
public object AuthSource { get; set; }
Property Value
System.Object

DatabaseName

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

Declaration
public object DatabaseName { get; set; }
Property Value
System.Object

EnableSsl

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

Declaration
public object EnableSsl { get; set; }
Property Value
System.Object

EncryptedCredential

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

Declaration
public object EncryptedCredential { get; set; }
Property Value
System.Object

Password

Password for authentication. Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase Password { get; set; }
Property Value
SecretBase

Port

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.

Declaration
public object Port { get; set; }
Property Value
System.Object

Server

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

Declaration
public object Server { get; set; }
Property Value
System.Object

Username

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

Declaration
public object Username { get; set; }
Property Value
System.Object