Package version:

Interface CosmosDbMongoDbApiCollectionDataset

The CosmosDB (MongoDB API) database dataset.

interface CosmosDbMongoDbApiCollectionDataset {
    annotations?: any[];
    collection: any;
    description?: string;
    folder?: DatasetFolder;
    linkedServiceName: LinkedServiceReference;
    parameters?: {
        [propertyName: string]: ParameterSpecification;
    };
    schema?: any;
    structure?: any;
    type: "CosmosDbMongoDbApiCollection";
}

Hierarchy (view full)

  • Dataset
    • CosmosDbMongoDbApiCollectionDataset

Properties

annotations? collection description? folder? linkedServiceName parameters? schema? structure? type

Properties

Optionalannotations

annotations?: any[]

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

collection

collection: any

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

Optionaldescription

description?: string

Dataset description.

Optionalfolder

folder?: DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference

Linked service reference.

Optionalparameters

parameters?: {
    [propertyName: string]: ParameterSpecification;
}

Parameters for dataset.

Optionalschema

schema?: any

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

Optionalstructure

structure?: any

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

type

type

Polymorphic discriminator, which specifies the different types this object can be

Settings

Member Visibility