CosmosDBMongoDBApiLinkedService Class

Definition

Namespace:

Azure.ResourceManager.DataFactory.Models

Assembly:

Azure.ResourceManager.DataFactory.dll

Package:

Azure.ResourceManager.DataFactory v1.6.0

Source:

CosmosDBMongoDBApiLinkedService.cs

Linked service for CosmosDB (MongoDB API) data source.

public class CosmosDBMongoDBApiLinkedService : Azure.ResourceManager.DataFactory.Models.DataFactoryLinkedServiceProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.CosmosDBMongoDBApiLinkedService>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.CosmosDBMongoDBApiLinkedService>

type CosmosDBMongoDBApiLinkedService = class
    inherit DataFactoryLinkedServiceProperties
    interface IJsonModel<CosmosDBMongoDBApiLinkedService>
    interface IPersistableModel<CosmosDBMongoDBApiLinkedService>

Public Class CosmosDBMongoDBApiLinkedService
Inherits DataFactoryLinkedServiceProperties
Implements IJsonModel(Of CosmosDBMongoDBApiLinkedService), IPersistableModel(Of CosmosDBMongoDBApiLinkedService)

Inheritance

Object

DataFactoryLinkedServiceProperties

CosmosDBMongoDBApiLinkedService

Implements

IJsonModel<CosmosDBMongoDBApiLinkedService> IPersistableModel<CosmosDBMongoDBApiLinkedService> IPersistableModel<T>

Constructors

CosmosDBMongoDBApiLinkedService(DataFactoryElement<String>, DataFactoryElement<String>)

Initializes a new instance of CosmosDBMongoDBApiLinkedService.

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)
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)
ConnectionString	The CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.
ConnectVia	The integration runtime reference. (Inherited from DataFactoryLinkedServiceProperties)
Database	The name of the CosmosDB (MongoDB API) database that you want to access. Type: string (or Expression with resultType string).
Description	Linked service description. (Inherited from DataFactoryLinkedServiceProperties)
IsServerVersionAbove32	Whether the CosmosDB (MongoDB API) server version is higher than 3.2. The default value is false. Type: boolean (or Expression with resultType boolean).
LinkedServiceVersion	Version of the linked service. (Inherited from DataFactoryLinkedServiceProperties)
Parameters	Parameters for linked service. (Inherited from DataFactoryLinkedServiceProperties)

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<CosmosDBMongoDBApiLinkedService>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<CosmosDBMongoDBApiLinkedService>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
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)
IPersistableModel<CosmosDBMongoDBApiLinkedService>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<CosmosDBMongoDBApiLinkedService>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<CosmosDBMongoDBApiLinkedService>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.
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)