Share via


MongoDBLinkedService Class

Definition

Linked service for MongoDb data source.

public class MongoDBLinkedService : Azure.ResourceManager.DataFactory.Models.DataFactoryLinkedServiceProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.MongoDBLinkedService>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.MongoDBLinkedService>
public class MongoDBLinkedService : Azure.ResourceManager.DataFactory.Models.DataFactoryLinkedServiceProperties
type MongoDBLinkedService = class
    inherit DataFactoryLinkedServiceProperties
    interface IJsonModel<MongoDBLinkedService>
    interface IPersistableModel<MongoDBLinkedService>
type MongoDBLinkedService = class
    inherit DataFactoryLinkedServiceProperties
Public Class MongoDBLinkedService
Inherits DataFactoryLinkedServiceProperties
Implements IJsonModel(Of MongoDBLinkedService), IPersistableModel(Of MongoDBLinkedService)
Public Class MongoDBLinkedService
Inherits DataFactoryLinkedServiceProperties
Inheritance
Implements

Constructors

MongoDBLinkedService(DataFactoryElement<String>, DataFactoryElement<String>)

Initializes a new instance of MongoDBLinkedService.

Properties

AdditionalProperties

Additional Properties

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

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

To assign an object to the element of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

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

LinkedServiceVersion

Version of the linked service.

(Inherited from DataFactoryLinkedServiceProperties)
Parameters

Parameters for linked service.

(Inherited from DataFactoryLinkedServiceProperties)
Password

Password for authentication.

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).

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from DataFactoryLinkedServiceProperties)

Explicit Interface Implementations

IJsonModel<DataFactoryLinkedServiceProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from DataFactoryLinkedServiceProperties)
IJsonModel<DataFactoryLinkedServiceProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from DataFactoryLinkedServiceProperties)
IJsonModel<MongoDBLinkedService>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<MongoDBLinkedService>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<DataFactoryLinkedServiceProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from DataFactoryLinkedServiceProperties)
IPersistableModel<DataFactoryLinkedServiceProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from DataFactoryLinkedServiceProperties)
IPersistableModel<DataFactoryLinkedServiceProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from DataFactoryLinkedServiceProperties)
IPersistableModel<MongoDBLinkedService>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<MongoDBLinkedService>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<MongoDBLinkedService>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to