Compartilhar via


CosmosDBMongoDBApiCollectionDataset Class

Definition

The CosmosDB (MongoDB API) database dataset.

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

Constructors

CosmosDBMongoDBApiCollectionDataset(DataFactoryLinkedServiceReference, DataFactoryElement<String>)

Initializes a new instance of CosmosDBMongoDBApiCollectionDataset.

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 DataFactoryDatasetProperties)
Annotations

List of tags that can be used for describing the Dataset.

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 DataFactoryDatasetProperties)
Collection

The collection name of the CosmosDB (MongoDB API) database. Type: string (or Expression with resultType string).

Description

Dataset description.

(Inherited from DataFactoryDatasetProperties)
FolderName

The name of the folder that this Dataset is in.

(Inherited from DataFactoryDatasetProperties)
LinkedServiceName

Linked service reference.

(Inherited from DataFactoryDatasetProperties)
Parameters

Parameters for dataset.

(Inherited from DataFactoryDatasetProperties)
Schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

(Inherited from DataFactoryDatasetProperties)
Structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

(Inherited from DataFactoryDatasetProperties)

Methods

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

Explicit Interface Implementations

IJsonModel<CosmosDBMongoDBApiCollectionDataset>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<CosmosDBMongoDBApiCollectionDataset>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<DataFactoryDatasetProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

Writes the model to the provided Utf8JsonWriter.

(Inherited from DataFactoryDatasetProperties)
IPersistableModel<CosmosDBMongoDBApiCollectionDataset>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<CosmosDBMongoDBApiCollectionDataset>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<CosmosDBMongoDBApiCollectionDataset>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<DataFactoryDatasetProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

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

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

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

Writes the model into a BinaryData.

(Inherited from DataFactoryDatasetProperties)

Applies to