Jobs - DeleteJobs Add

Service:

Azure Digital Twins

API Version:

2023-10-31

Örnekteki tüm modelleri, ikizleri ve ilişkileri silen bir iş başlatır. Diğer varlık türlerini silmez. Durum kodları:

• 202 Oluşturuldu
• 400 Hatalı İstek
  • JobLimitReached - İzin verilen silme işi sayısı üst sınırına ulaşıldı.
  • ValidationFailed - Operation-Id zaten var.

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}

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
api-version	query	True	string	İstenen API sürümü.
timeoutInMinutes	query		integer int32	Silme işi için istenen zaman aşımı. Belirtilen zaman aşımına ulaşıldığında, hizmet devam eden geçerli silme işinin tetiklediği silme işlemlerini durdurur ve başarısız duruma geçer. Geri alma işlemi olmayacağı için bunun örneğinizi bilinmeyen bir durumda bırakacağını lütfen unutmayın.

İstek Başlığı

Name	Gerekli	Tür	Description
operation-id		string	İşlemin durum izleyicisinin kimliği. Üst bilgi istemci tarafından geçirilmediyse kimlik oluşturulur.
traceparent		string	Dağıtılmış izleme sistemindeki isteği tanımlar.
tracestate		string	Satıcıya özgü izleme tanımlama bilgilerini sağlar ve izlemeparent için yardımcıdır.

Yanıtlar

Name	Tür	Description
202 Accepted	DeleteJob	kabul edilen iş Headers Operation-Location: string
Other Status Codes	ErrorResponse	Varsayılan yanıt. Headers x-ms-error-code: string

Güvenlik

oauth2

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

Örnekler

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

Tanımlar

Name	Description
delete-job-status	İşin durumu.
DeleteJob	Gerçekleştirilecek işlemlere, sonuçlara ve yürütme meta verilerine başvuru içeren bir iş.
Error	Hata tanımı.
ErrorResponse	Hata yanıtı.
InnerError	İçeren hata tarafından sağlanandan daha belirgin bir hata açıklaması.

delete-job-status

İşin durumu.

Name	Tür	Description
failed	string
notstarted	string
running	string
succeeded	string

DeleteJob

Gerçekleştirilecek işlemlere, sonuçlara ve yürütme meta verilerine başvuru içeren bir iş.

Name	Tür	Description
createdDateTime	string	İşin başlangıç saati. Zaman damgası RFC3339 biçimdedir: yyyy-MM-ddTHH:mm:ssZ.
error	Error	İçeri aktarma işi yürütülürken oluşan hataların ayrıntıları.
finishedDateTime	string	İşin bitiş saati. Zaman damgası RFC3339 biçimdedir: yyyy-MM-ddTHH:mm:ssZ.
id	string	Silme işinin tanımlayıcısı.
purgeDateTime	string	İşin hizmet tarafından sistemden temizlenme zamanı. Zaman damgası RFC3339 biçimdedir: yyyy-MM-ddTHH:mm:ssZ.
status	delete-job-status	İşin durumu.

Error

Hata tanımı.

Name	Tür	Description
code	string	HTTP hata kodu için alt durum olarak hizmet veren hizmete özgü hata kodu.
details	Error[]	İç hata ayrıntıları.
innererror	InnerError	Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne.
message	string	Hatanın insan tarafından okunabilen bir gösterimi.

ErrorResponse

Hata yanıtı.

Name	Tür	Description
error	Error	Hata ayrıntıları.

InnerError

İçeren hata tarafından sağlanandan daha belirgin bir hata açıklaması.

Name	Tür	Description
code	string	İçeren hata tarafından sağlanandan daha özel bir hata kodu.
innererror	InnerError	Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne.