Partilhar via


Jobs - DeleteJobs Add

Inicia uma tarefa que elimina todos os modelos, duplos e relações na instância. Não elimina outros tipos de entidades. Códigos de estado:

  • 202 Criado
  • 400 Pedido Incorreto
    • JobLimitReached – foi atingido o número máximo de tarefas de eliminação permitidas.
    • ValidationFailed - Operation-Id já existe.
POST https://digitaltwins-hostname/jobs/deletions?api-version=2023-10-31
POST https://digitaltwins-hostname/jobs/deletions?api-version=2023-10-31&timeoutInMinutes={timeoutInMinutes}

Parâmetros do URI

Name Em Necessário Tipo Description
api-version
query True

string

A versão da API pedida.

timeoutInMinutes
query

integer

int32

Tempo limite pretendido para a tarefa de eliminação. Assim que o tempo limite especificado for atingido, o serviço irá parar todas as operações de eliminação acionadas pela tarefa de eliminação atual em curso e aceder a um estado de falha. Tenha em atenção que isto deixará a sua instância num estado desconhecido, uma vez que não haverá nenhuma operação de reversão.

Cabeçalho do Pedido

Name Necessário Tipo Description
operation-id

string

ID do monitor de estado da operação. O ID é gerado se o cabeçalho não tiver sido transmitido pelo cliente.

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
202 Accepted

DeleteJob

Tarefa Aceite

Headers

Operation-Location: string

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

Add a job

Sample Request

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

Sample Response

Operation-Location: https://instance-name/jobs/deletions/{id}?api-version=2023-10-31
Operation-Id: {id}
{
  "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"
}

Definições

Name Description
delete-job-status

Estado da tarefa.

DeleteJob

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

Error

Definição de erro.

ErrorResponse

Resposta de erro.

InnerError

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

delete-job-status

Estado da tarefa.

Name Tipo Description
failed

string

notstarted

string

running

string

succeeded

string

DeleteJob

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 eliminação.

purgeDateTime

string

Tempo 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

delete-job-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 o subtatus para o código de erro HTTP.

details

Error[]

Detalhes de erro internos.

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.

InnerError

Uma descrição de erro mais específica do que a fornecida 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.