DatasetsOperations interface
Interface representing a Datasets operations.
Properties
| cancel |
Cancels the specified data generation job if it is still in progress. |
| create |
Submits a new data generation job for asynchronous execution. |
| create |
Create a new or update an existing DatasetVersion with the given version id |
| delete | Delete the specific version of the DatasetVersion. The service returns 204 No Content if the DatasetVersion was deleted successfully or if the DatasetVersion does not exist. |
| delete |
Removes the specified data generation job and its associated output. |
| get | Get the specific version of the DatasetVersion. The service returns 404 Not Found error if the DatasetVersion does not exist. |
| get |
Get the SAS credential to access the storage account associated with a Dataset version. |
| get |
Retrieves the specified data generation job and its current status. |
| list | List the latest version of each DatasetVersion |
| list |
Returns a list of data generation jobs. |
| list |
List all versions of the given DatasetVersion |
| pending |
Start a new or get an existing pending upload of a dataset for a specific version. |
| upload |
Upload a file to the DatasetVersion. Only supported in Node.js. |
| upload |
Upload a folder to the DatasetVersion. Only supported in Node.js. |
Property Details
cancelGenerationJob
Cancels the specified data generation job if it is still in progress.
cancelGenerationJob: (jobId: string, options?: DatasetsCancelGenerationJobOptionalParams) => Promise<DataGenerationJobUnion>Property Value
(jobId: string, options?: DatasetsCancelGenerationJobOptionalParams) => Promise<DataGenerationJobUnion>
createGenerationJob
Submits a new data generation job for asynchronous execution.
createGenerationJob: (job: DataGenerationJobInputsUnion, options?: DatasetsCreateGenerationJobOptionalParams) => JobPoller<DataGenerationJobResult>Property Value
(job: DataGenerationJobInputsUnion, options?: DatasetsCreateGenerationJobOptionalParams) => JobPoller<DataGenerationJobResult>
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 the specific version of the DatasetVersion. The service returns 204 No Content if the DatasetVersion was deleted successfully or if the DatasetVersion does not exist.
delete: (name: string, version: string, options?: DatasetsDeleteOptionalParams) => Promise<void>Property Value
(name: string, version: string, options?: DatasetsDeleteOptionalParams) => Promise<void>
deleteGenerationJob
Removes the specified data generation job and its associated output.
deleteGenerationJob: (jobId: string, options?: DatasetsDeleteGenerationJobOptionalParams) => Promise<void>Property Value
(jobId: string, options?: DatasetsDeleteGenerationJobOptionalParams) => Promise<void>
get
Get the specific version of the DatasetVersion. The service returns 404 Not Found error if the DatasetVersion does not exist.
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<DatasetCredential>Property Value
(name: string, version: string, options?: DatasetsGetCredentialsOptionalParams) => Promise<DatasetCredential>
getGenerationJob
Retrieves the specified data generation job and its current status.
getGenerationJob: (jobId: string, options?: DatasetsGetGenerationJobOptionalParams) => Promise<DataGenerationJobUnion>Property Value
(jobId: string, options?: DatasetsGetGenerationJobOptionalParams) => Promise<DataGenerationJobUnion>
list
List the latest version of each DatasetVersion
list: (options?: DatasetsListOptionalParams) => PagedAsyncIterableIterator<DatasetVersionUnion, DatasetVersionUnion[], PageSettings>Property Value
(options?: DatasetsListOptionalParams) => PagedAsyncIterableIterator<DatasetVersionUnion, DatasetVersionUnion[], PageSettings>
listGenerationJobs
Returns a list of data generation jobs.
listGenerationJobs: (options?: DatasetsListGenerationJobsOptionalParams) => PagedAsyncIterableIterator<DataGenerationJobUnion, DataGenerationJobUnion[], PageSettings>Property Value
(options?: DatasetsListGenerationJobsOptionalParams) => PagedAsyncIterableIterator<DataGenerationJobUnion, DataGenerationJobUnion[], 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. Only supported in Node.js.
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. Only supported in Node.js.
uploadFolder: (name: string, version: string, folderPath: string, options?: DatasetUploadOptions) => Promise<DatasetVersionUnion>Property Value
(name: string, version: string, folderPath: string, options?: DatasetUploadOptions) => Promise<DatasetVersionUnion>