Jobs - DeleteJobs Add

Service:

Azure Digital Twins

API Version:

2023-10-31

Avvia un processo che elimina tutti i modelli, i gemelli e le relazioni nell'istanza. Non elimina altri tipi di entità. Codici di stato:

• 202 Creato
• 400 - Richiesta non valida
  • JobLimitReached: è stato raggiunto il numero massimo di processi di eliminazione consentiti.
  • ValidationFailed: Operation-Id esiste già.

POST https://digitaltwins-hostname/jobs/deletions?api-version=2023-10-31

With optional parameters:

POST https://digitaltwins-hostname/jobs/deletions?api-version=2023-10-31&timeoutInMinutes={timeoutInMinutes}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
api-version	query	True	string	Versione dell'API richiesta.
timeoutInMinutes	query		integer int32	Timeout desiderato per il processo di eliminazione. Una volta raggiunto il timeout specificato, il servizio arresterà le operazioni di eliminazione attivate dal processo di eliminazione corrente in corso e passeranno a uno stato di errore. Si noti che questa operazione lascerà l'istanza in uno stato sconosciuto perché non sarà presente alcuna operazione di rollback.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
operation-id		string	ID per il monitoraggio dello stato dell'operazione. L'ID viene generato se l'intestazione non è stata passata dal client.
traceparent		string	Identifica la richiesta in un sistema di traccia distribuita.
tracestate		string	Fornisce informazioni di identificazione di traccia specifiche del fornitore ed è un compagno di traccia.

Risposte

Nome	Tipo	Descrizione
202 Accepted	DeleteJob	Processo accettato Headers Operation-Location: string
Other Status Codes	ErrorResponse	Risposta predefinita. Headers x-ms-error-code: string

Sicurezza

oauth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0

Esempio

Add a job

Sample Request

HTTP

POST https://digitaltwins-hostname/jobs/deletions?api-version=2023-10-31&timeoutInMinutes=60

Sample Response

Status code:

202

Operation-Location: https://instance-name/jobs/deletions/{id}?api-version=2023-10-31
Operation-Id: {id}

Response Body

{
  "id": "deletejob1",
  "createdDateTime": "2022-01-01T00:00:00.0000000+00:00",
  "finishedDateTime": "2022-01-01T00:01:00.0000000+00:00",
  "purgeDateTime": "2022-01-31T00:01:00.0000000+00:00",
  "status": "notstarted"
}

Definizioni

Nome	Descrizione
delete-job-status	Stato del processo.
DeleteJob	Processo che contiene un riferimento alle operazioni da eseguire, risultati e metadati di esecuzione.
Error	Definizione di errore.
ErrorResponse	Risposta di errore.
InnerError	Descrizione dell'errore più specifica di quella fornita dall'errore che lo contiene.

delete-job-status

Stato del processo.

Nome	Tipo	Descrizione
failed	string
notstarted	string
running	string
succeeded	string

DeleteJob

Processo che contiene un riferimento alle operazioni da eseguire, risultati e metadati di esecuzione.

Nome	Tipo	Descrizione
createdDateTime	string	Ora di inizio del processo. Il timestamp è in formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.
error	Error	Dettagli degli errori che si sono verificati durante l'esecuzione del processo di importazione.
finishedDateTime	string	Ora di fine del processo. Il timestamp è in formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.
id	string	Identificatore del processo di eliminazione.
purgeDateTime	string	Ora in cui il processo verrà eliminato dal servizio dal sistema. Il timestamp è in formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.
status	delete-job-status	Stato del processo.

Error

Definizione di errore.

Nome	Tipo	Descrizione
code	string	Codice di errore specifico del servizio che funge da sottostato per il codice di errore HTTP.
details	Error[]	Dettagli dell'errore interno.
innererror	InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.

ErrorResponse

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Dettagli dell'errore.

InnerError

Descrizione dell'errore più specifica di quella fornita dall'errore che lo contiene.

Nome	Tipo	Descrizione
code	string	Codice di errore più specifico di quello fornito dall'errore che lo contiene.
innererror	InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.