Jobs - ImportJobs Cancel

Service:

Azure Digital Twins

API Version:

2023-10-31

Cancela uma tarefa de importação que está atualmente em execução. O serviço irá parar todas as operações de importação acionadas pela tarefa de importação atual em curso e passar para um estado cancelado. Tenha em atenção que isto deixará a instância num estado desconhecido, uma vez que não haverá nenhuma operação de reversão. Códigos de estado:

• 200 Pedido Aceite
• 400 Pedido Incorreto
  • ValidationFailed - O pedido de tarefa de importação não é válido.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
id	path	True	string	O ID da tarefa de importação. O ID é exclusivo no serviço e sensível às maiúsculas e minúsculas.
api-version	query	True	string	A versão da API pedida.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
traceparent		string	Identifica o pedido num sistema de rastreio distribuído.
tracestate		string	Fornece informações de identificação de rastreio específicas do fornecedor e é um complemento para o traceparent.

Respostas

Name	Tipo	Description
200 OK	ImportJob	Com êxito
Other Status Codes	ErrorResponse	Resposta predefinida. Headers x-ms-error-code: string

Segurança

oauth2

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

Exemplos

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"
}

Definições

Name	Description
Error	Definição de erro.
ErrorResponse	Resposta de erro.
ImportJob	Uma tarefa que contém uma referência às operações a executar, resultados e metadados de execução.
InnerError	Uma descrição de erro mais específica do que a indicada pelo erro que contém.
status	Estado da tarefa.

Error

Definição de erro.

Name	Tipo	Description
code	string	Código de erro específico do serviço que serve como subestado para o código de erro HTTP.
details	Error[]	Detalhes internos do erro.
innererror	InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.

ErrorResponse

Resposta de erro.

Name	Tipo	Description
error	Error	Os detalhes do erro.

ImportJob

Uma tarefa que contém uma referência às operações a executar, resultados e metadados de execução.

Name	Tipo	Description
createdDateTime	string	Hora de início da tarefa. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.
error	Error	Detalhes dos erros que ocorreram ao executar a tarefa de importação.
finishedDateTime	string	Hora de fim do trabalho. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.
id	string	O identificador da tarefa de importação.
inputBlobUri	string	O caminho para o blob de armazenamento do Azure de entrada que contém ficheiros que descrevem as operações a executar na tarefa.
lastActionDateTime	string	Da última vez que o serviço efetuou qualquer ação da tarefa. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.
outputBlobUri	string	O caminho para o blob de armazenamento do Azure de saída que irá conter os erros e os registos de progresso da tarefa de importação.
purgeDateTime	string	Hora em que a tarefa será removida pelo serviço do sistema. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.
status	status	Estado da tarefa.

InnerError

Uma descrição de erro mais específica do que a indicada pelo erro que contém.

Name	Tipo	Description
code	string	Um código de erro mais específico do que o fornecido pelo erro que contém.
innererror	InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

status

Estado da tarefa.

Name	Tipo	Description
cancelled	string
cancelling	string
failed	string
notstarted	string
running	string
succeeded	string