@azure/digital-twins-core
Version:
An isomorphic client library for Azure Digital Twins
47 lines • 2.33 kB
TypeScript
import { PagedAsyncIterableIterator } from "@azure/core-paging";
import { SimplePollerLike, OperationState } from "@azure/core-lro";
import { DeleteJob, DeleteJobsListOptionalParams, DeleteJobsAddOptionalParams, DeleteJobsAddResponse, DeleteJobsGetByIdOptionalParams, DeleteJobsGetByIdResponse } from "../models/index.js";
/** Interface representing a DeleteJobs. */
export interface DeleteJobs {
/**
* Retrieves all deletion jobs. This may be useful to find a delete job that was previously requested,
* or to view a history of delete jobs that have run or are currently running on the instance.
* Status codes:
* * 200 OK
* @param options The options parameters.
*/
list(options?: DeleteJobsListOptionalParams): PagedAsyncIterableIterator<DeleteJob>;
/**
* Initiates a job which deletes all models, twins, and relationships on the instance. Does not delete
* any other types of entities.
* Status codes:
* * 202 Created
* * 400 Bad Request
* * JobLimitReached - The maximum number of delete jobs allowed has been reached.
* * ValidationFailed - Operation-Id already exists.
* @param options The options parameters.
*/
beginAdd(options?: DeleteJobsAddOptionalParams): Promise<SimplePollerLike<OperationState<DeleteJobsAddResponse>, DeleteJobsAddResponse>>;
/**
* Initiates a job which deletes all models, twins, and relationships on the instance. Does not delete
* any other types of entities.
* Status codes:
* * 202 Created
* * 400 Bad Request
* * JobLimitReached - The maximum number of delete jobs allowed has been reached.
* * ValidationFailed - Operation-Id already exists.
* @param options The options parameters.
*/
beginAddAndWait(options?: DeleteJobsAddOptionalParams): Promise<DeleteJobsAddResponse>;
/**
* Retrieves a delete job.
* Status codes:
* * 200 OK
* * 404 Not Found
* * DeleteJobNotFound - The delete job was not found.
* @param id The id for the delete job. The id is unique within the service and case sensitive.
* @param options The options parameters.
*/
getById(id: string, options?: DeleteJobsGetByIdOptionalParams): Promise<DeleteJobsGetByIdResponse>;
}
//# sourceMappingURL=deleteJobs.d.ts.map