MongoDbLinkedService Class

  • Reference

Definition

Namespace:
Azure.Analytics.Synapse.Artifacts.Models
Assembly:
Azure.Analytics.Synapse.Artifacts.dll
Package:
Azure.Analytics.Synapse.Artifacts v1.0.0-preview.20
Source:
MongoDbLinkedService.cs

Linked service for MongoDb data source.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService+MongoDbLinkedServiceConverter))]
public class MongoDbLinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService
[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService+MongoDbLinkedServiceConverter))>]
type MongoDbLinkedService = class
    inherit LinkedService
Public Class MongoDbLinkedService
Inherits LinkedService
Inheritance
Object
LinkedService
MongoDbLinkedService
Attributes
JsonConverterAttribute

Constructors

MongoDbLinkedService(Object, Object)

Initializes a new instance of MongoDbLinkedService.

Properties

AdditionalProperties

Additional Properties.

(Inherited from LinkedService)
AllowSelfSignedServerCert

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

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

(Inherited from LinkedService)
AuthenticationType

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

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

The integration runtime reference.

(Inherited from LinkedService)
DatabaseName

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

Linked service description.

(Inherited from LinkedService)
EnableSsl

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

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

Parameters for linked service.

(Inherited from LinkedService)
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.
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.
Server

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

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

Applies to