Share via


CosmosDBSqlApiSink Class

Definition

A copy activity Azure CosmosDB (SQL API) Collection sink.

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

Constructors

CosmosDBSqlApiSink()

Initializes a new instance of CosmosDBSqlApiSink.

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 CopySink)
DisableMetricsCollection

If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).

(Inherited from CopySink)
MaxConcurrentConnections

The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

(Inherited from CopySink)
SinkRetryCount

Sink retry count. Type: integer (or Expression with resultType integer).

(Inherited from CopySink)
SinkRetryWait

Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

(Inherited from CopySink)
WriteBatchSize

Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

(Inherited from CopySink)
WriteBatchTimeout

Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

(Inherited from CopySink)
WriteBehavior

Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert.

Methods

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

Explicit Interface Implementations

IJsonModel<CopySink>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

Writes the model to the provided Utf8JsonWriter.

(Inherited from CopySink)
IJsonModel<CosmosDBSqlApiSink>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<CosmosDBSqlApiSink>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<CopySink>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

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

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

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

Writes the model into a BinaryData.

(Inherited from CopySink)
IPersistableModel<CosmosDBSqlApiSink>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<CosmosDBSqlApiSink>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<CosmosDBSqlApiSink>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to