DatasetsOperations interface

Package:

@azure/ai-projects

Interface representing a Datasets operations.

Properties

createOrUpdate	Create a new or update an existing DatasetVersion with the given version id
delete
get	Get the specific version of the DatasetVersion
getCredentials	Get the SAS credential to access the storage account associated with a Dataset version.
list	List the latest version of each DatasetVersion
listVersions	List all versions of the given DatasetVersion
pendingUpload	Start a new or get an existing pending upload of a dataset for a specific version.
uploadFile	Upload a file to the DatasetVersion
uploadFolder	Upload a folder to the DatasetVersion

Property Details

createOrUpdate

Create a new or update an existing DatasetVersion with the given version id

createOrUpdate: (name: string, version: string, datasetVersion: DatasetVersionUnion, options?: DatasetsCreateOrUpdateOptionalParams) => Promise<DatasetVersionUnion>

Property Value

(name: string, version: string, datasetVersion: DatasetVersionUnion, options?: DatasetsCreateOrUpdateOptionalParams) => Promise<DatasetVersionUnion>

delete

delete: (name: string, version: string, options?: DatasetsDeleteOptionalParams) => Promise<void>

Property Value

(name: string, version: string, options?: DatasetsDeleteOptionalParams) => Promise<void>

get

Get the specific version of the DatasetVersion

get: (name: string, version: string, options?: DatasetsGetOptionalParams) => Promise<DatasetVersionUnion>

Property Value

(name: string, version: string, options?: DatasetsGetOptionalParams) => Promise<DatasetVersionUnion>

getCredentials

Get the SAS credential to access the storage account associated with a Dataset version.

getCredentials: (name: string, version: string, options?: DatasetsGetCredentialsOptionalParams) => Promise<AssetCredentialResponse>

Property Value

(name: string, version: string, options?: DatasetsGetCredentialsOptionalParams) => Promise<AssetCredentialResponse>

list

List the latest version of each DatasetVersion

list: (options?: DatasetsListOptionalParams) => PagedAsyncIterableIterator<DatasetVersionUnion, DatasetVersionUnion[], PageSettings>

Property Value

(options?: DatasetsListOptionalParams) => PagedAsyncIterableIterator<DatasetVersionUnion, DatasetVersionUnion[], PageSettings>

listVersions

List all versions of the given DatasetVersion

listVersions: (name: string, options?: DatasetsListVersionsOptionalParams) => PagedAsyncIterableIterator<DatasetVersionUnion, DatasetVersionUnion[], PageSettings>

Property Value

(name: string, options?: DatasetsListVersionsOptionalParams) => PagedAsyncIterableIterator<DatasetVersionUnion, DatasetVersionUnion[], PageSettings>

pendingUpload

Start a new or get an existing pending upload of a dataset for a specific version.

pendingUpload: (name: string, version: string, pendingUploadRequest: PendingUploadRequest, options?: DatasetsPendingUploadOptionalParams) => Promise<PendingUploadResponse>

Property Value

(name: string, version: string, pendingUploadRequest: PendingUploadRequest, options?: DatasetsPendingUploadOptionalParams) => Promise<PendingUploadResponse>

uploadFile

Upload a file to the DatasetVersion

uploadFile: (name: string, version: string, filePath: string, options?: DatasetUploadOptions) => Promise<DatasetVersionUnion>

Property Value

(name: string, version: string, filePath: string, options?: DatasetUploadOptions) => Promise<DatasetVersionUnion>

uploadFolder

Upload a folder to the DatasetVersion

uploadFolder: (name: string, version: string, folderPath: string, options?: DatasetUploadOptions) => Promise<DatasetVersionUnion>

Property Value

(name: string, version: string, folderPath: string, options?: DatasetUploadOptions) => Promise<DatasetVersionUnion>