DatasetOperations interface

Package:

@azure/synapse-artifacts

Interface representing a DatasetOperations.

Methods

beginCreateOrUpdateDataset(string, DatasetResource, DatasetCreateOrUpdateDatasetOptionalParams)	Creates or updates a dataset.
beginCreateOrUpdateDatasetAndWait(string, DatasetResource, DatasetCreateOrUpdateDatasetOptionalParams)	Creates or updates a dataset.
beginDeleteDataset(string, DatasetDeleteDatasetOptionalParams)	Deletes a dataset.
beginDeleteDatasetAndWait(string, DatasetDeleteDatasetOptionalParams)	Deletes a dataset.
beginRenameDataset(string, ArtifactRenameRequest, DatasetRenameDatasetOptionalParams)	Renames a dataset.
beginRenameDatasetAndWait(string, ArtifactRenameRequest, DatasetRenameDatasetOptionalParams)	Renames a dataset.
getDataset(string, DatasetGetDatasetOptionalParams)	Gets a dataset.
listDatasetsByWorkspace(DatasetGetDatasetsByWorkspaceOptionalParams)	Lists datasets.

Method Details

beginCreateOrUpdateDataset(string, DatasetResource, DatasetCreateOrUpdateDatasetOptionalParams)

Creates or updates a dataset.

function beginCreateOrUpdateDataset(datasetName: string, dataset: DatasetResource, options?: DatasetCreateOrUpdateDatasetOptionalParams): Promise<SimplePollerLike<OperationState<DatasetResource>, DatasetResource>>

Parameters

datasetName

string

The dataset name.

dataset

DatasetResource

Dataset resource definition.

options

DatasetCreateOrUpdateDatasetOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DatasetResource>, DatasetResource>>

beginCreateOrUpdateDatasetAndWait(string, DatasetResource, DatasetCreateOrUpdateDatasetOptionalParams)

Creates or updates a dataset.

function beginCreateOrUpdateDatasetAndWait(datasetName: string, dataset: DatasetResource, options?: DatasetCreateOrUpdateDatasetOptionalParams): Promise<DatasetResource>

Parameters

datasetName

string

The dataset name.

dataset

DatasetResource

Dataset resource definition.

options

DatasetCreateOrUpdateDatasetOptionalParams

The options parameters.

Returns

Promise<DatasetResource>

beginDeleteDataset(string, DatasetDeleteDatasetOptionalParams)

Deletes a dataset.

function beginDeleteDataset(datasetName: string, options?: DatasetDeleteDatasetOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

datasetName

string

The dataset name.

options

DatasetDeleteDatasetOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteDatasetAndWait(string, DatasetDeleteDatasetOptionalParams)

Deletes a dataset.

function beginDeleteDatasetAndWait(datasetName: string, options?: DatasetDeleteDatasetOptionalParams): Promise<void>

Parameters

datasetName

string

The dataset name.

options

DatasetDeleteDatasetOptionalParams

The options parameters.

Returns

Promise<void>

beginRenameDataset(string, ArtifactRenameRequest, DatasetRenameDatasetOptionalParams)

Renames a dataset.

function beginRenameDataset(datasetName: string, request: ArtifactRenameRequest, options?: DatasetRenameDatasetOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

datasetName

string

The dataset name.

request

ArtifactRenameRequest

proposed new name.

options

DatasetRenameDatasetOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginRenameDatasetAndWait(string, ArtifactRenameRequest, DatasetRenameDatasetOptionalParams)

Renames a dataset.

function beginRenameDatasetAndWait(datasetName: string, request: ArtifactRenameRequest, options?: DatasetRenameDatasetOptionalParams): Promise<void>

Parameters

datasetName

string

The dataset name.

request

ArtifactRenameRequest

proposed new name.

options

DatasetRenameDatasetOptionalParams

The options parameters.

Returns

Promise<void>

getDataset(string, DatasetGetDatasetOptionalParams)

Gets a dataset.

function getDataset(datasetName: string, options?: DatasetGetDatasetOptionalParams): Promise<DatasetResource>

Parameters

datasetName

string

The dataset name.

options

DatasetGetDatasetOptionalParams

The options parameters.

Returns

Promise<DatasetResource>

listDatasetsByWorkspace(DatasetGetDatasetsByWorkspaceOptionalParams)

Lists datasets.

function listDatasetsByWorkspace(options?: DatasetGetDatasetsByWorkspaceOptionalParams): PagedAsyncIterableIterator<DatasetResource, DatasetResource[], PageSettings>

Parameters

options

DatasetGetDatasetsByWorkspaceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DatasetResource, DatasetResource[], PageSettings>