DocumentDbCollectionDataset Class

Microsoft Azure Document Database Collection dataset.

All required parameters must be populated in order to send to Azure.

Inheritance

azure.mgmt.datafactory.models._models_py3.Dataset

DocumentDbCollectionDataset

Constructor

DocumentDbCollectionDataset(*, linked_service_name: _models.LinkedServiceReference, collection_name: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, _models.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[_models.DatasetFolder] = None, **kwargs)

Variables

additional_properties

dict[str, any]

Unmatched properties from the message are deserialized to this collection.

type

str

Required. Type of dataset.Constant filled by server.

description

str

Dataset description.

structure

any

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

schema

any

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

linked_service_name

LinkedServiceReference

Required. Linked service reference.

parameters

dict[str, ParameterSpecification]

Parameters for dataset.

annotations

list[any]

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

folder

DatasetFolder

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

collection_name

any

Required. Document Database collection name. Type: string (or Expression with resultType string).