Jobs - ImportJobs Cancel

Service:

Azure Digital Twins

API Version:

2023-10-31

Annulla un processo di importazione attualmente in esecuzione. Il servizio arresta tutte le operazioni di importazione attivate dal processo di importazione corrente in corso e passa a uno stato annullato. Si noti che questa operazione lascerà l'istanza in uno stato sconosciuto perché non sarà presente alcuna operazione di rollback. Codici di stato:

• 200 Richiesta accettata
• 400 - Richiesta non valida
  • ValidationFailed: la richiesta di processo di importazione non è valida.

POST https://digitaltwins-hostname/jobs/imports/{id}/cancel?api-version=2023-10-31

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
id	path	True	string	ID del processo di importazione. L'ID è univoco all'interno del servizio e fa distinzione tra maiuscole e minuscole.
api-version	query	True	string	Versione dell'API richiesta.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
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
200 OK	ImportJob	Operazione riuscita
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

Cancel a job

Sample Request

HTTP

POST https://digitaltwins-hostname/jobs/imports/importjob1/cancel?api-version=2023-10-31

Sample Response

Status code:

200

{
  "id": "importjob1",
  "inputBlobUri": "path to input blob",
  "outputBlobUri": "path to output blob",
  "createdDateTime": "2022-01-01T00:00:00.0000000+00:00",
  "lastActionDateTime": "2022-01-01T00:01:00.0000000+00:00",
  "purgeDateTime": "2022-01-31T00:01:00.0000000+00:00",
  "status": "cancelling"
}

Definizioni

Nome	Descrizione
Error	Definizione di errore.
ErrorResponse	Risposta di errore.
ImportJob	Processo che contiene un riferimento alle operazioni da eseguire, risultati e metadati di esecuzione.
InnerError	Descrizione dell'errore più specifica di quella fornita dall'errore che lo contiene.
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.

ImportJob

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 importazione.
inputBlobUri	string	Percorso del BLOB di archiviazione di Azure di input che contiene i file che descrivono le operazioni da eseguire nel processo.
lastActionDateTime	string	Ultima volta che il servizio ha eseguito qualsiasi azione dal processo. Il timestamp è in formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.
outputBlobUri	string	Percorso del BLOB di archiviazione di Azure di output che conterrà gli errori e i log di stato del processo di importazione.
purgeDateTime	string	Ora in cui il processo verrà eliminato dal servizio dal sistema. Il timestamp è in formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.
status	status	Stato del processo.

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.

status

Stato del processo.

Nome	Tipo	Descrizione
cancelled	string
cancelling	string
failed	string
notstarted	string
running	string
succeeded	string