Share via


CosmosDbMongoDbApiLinkedService Class

Definition

Linked service for CosmosDB (MongoDB API) data source.

[Microsoft.Rest.Serialization.JsonTransformation]
[Newtonsoft.Json.JsonObject("CosmosDbMongoDbApi")]
public class CosmosDbMongoDbApiLinkedService : Microsoft.Azure.Management.DataFactory.Models.LinkedService
[<Microsoft.Rest.Serialization.JsonTransformation>]
[<Newtonsoft.Json.JsonObject("CosmosDbMongoDbApi")>]
type CosmosDbMongoDbApiLinkedService = class
    inherit LinkedService
Public Class CosmosDbMongoDbApiLinkedService
Inherits LinkedService
Inheritance
CosmosDbMongoDbApiLinkedService
Attributes
JsonTransformationAttribute Newtonsoft.Json.JsonObjectAttribute

Constructors

CosmosDbMongoDbApiLinkedService()

Initializes a new instance of the CosmosDbMongoDbApiLinkedService class.

CosmosDbMongoDbApiLinkedService(Object, Object, IDictionary<String, Object>, IntegrationRuntimeReference, String, IDictionary<String, ParameterSpecification>, IList<Object>, Object)

Initializes a new instance of the CosmosDbMongoDbApiLinkedService class.

Properties

AdditionalProperties

Gets or sets unmatched properties from the message are deserialized this collection

(Inherited from LinkedService)
Annotations

Gets or sets list of tags that can be used for describing the linked service.

(Inherited from LinkedService)
ConnectionString

Gets or sets the CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.

ConnectVia

Gets or sets the integration runtime reference.

(Inherited from LinkedService)
Database

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

Description

Gets or sets linked service description.

(Inherited from LinkedService)
IsServerVersionAbove32

Gets or sets whether the CosmosDB (MongoDB API) server version is higher than 3.2. The default value is false. Type: boolean (or Expression with resultType boolean).

Parameters

Gets or sets parameters for linked service.

(Inherited from LinkedService)

Methods

Validate()

Validate the object.

Applies to