Jobs - DeleteJobs Add

Service:

Azure Digital Twins

API Version:

2023-10-31

Inicia um trabalho que exclui todos os modelos, gêmeos e relações na instância. Não exclui nenhum outro tipo de entidade. Códigos de status:

• 202 Criado
• 400 Solicitação Inválida
  • JobLimitReached - O número máximo de trabalhos de exclusão permitidos foi atingido.
  • ValidationFailed - Operation-Id já existe.

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}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
api-version	query	True	string	A versão da API solicitada.
timeoutInMinutes	query		integer int32	Tempo limite desejado para o trabalho de exclusão. Depois que o tempo limite especificado for atingido, o serviço interromperá todas as operações de exclusão disparadas pelo trabalho de exclusão atual que estão em andamento e irá para um estado de falha. Observe que isso deixará sua instância em um estado desconhecido, pois não haverá nenhuma operação de reversão.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
operation-id		string	ID do monitor status da operação. A ID será gerada se o cabeçalho não tiver sido passado pelo cliente.
traceparent		string	Identifica a solicitação em um sistema de rastreamento distribuído.
tracestate		string	Fornece informações de identificação de rastreamento específicas do fornecedor e é um complemento ao rastreamentoparente.

Respostas

Nome	Tipo	Description
202 Accepted	DeleteJob	Trabalho Aceito Headers Operation-Location: string
Other Status Codes	ErrorResponse	Resposta padrão. 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

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

Definições

Nome	Description
delete-job-status	Status do trabalho.
DeleteJob	Um trabalho que contém uma referência às operações a serem executadas, 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 foi fornecida pelo erro que o contém.

delete-job-status

Status do trabalho.

Nome	Tipo	Description
failed	string
notstarted	string
running	string
succeeded	string

DeleteJob

Um trabalho que contém uma referência às operações a serem executadas, resultados e metadados de execução.

Nome	Tipo	Description
createdDateTime	string	Hora de início do trabalho. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.
error	Error	Detalhes dos erros que ocorreram ao executar o trabalho de importação.
finishedDateTime	string	Hora de término do trabalho. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.
id	string	O identificador do trabalho de exclusão.
purgeDateTime	string	Hora em que o trabalho será limpo pelo serviço do sistema. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.
status	delete-job-status	Status do trabalho.

Error

Definição de erro.

Nome	Tipo	Description
code	string	Código de erro específico do serviço que serve como substatus para o código de erro HTTP.
details	Error[]	Detalhes do erro interno.
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 do erro.

ErrorResponse

Resposta de erro.

Nome	Tipo	Description
error	Error	Os detalhes do erro.

InnerError

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

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