Jobs - DeleteJobs Add

Service:

Azure Digital Twins

API Version:

2023-10-31

instance 모든 모델, 트윈 및 관계를 삭제하는 작업을 시작합니다. 다른 형식의 엔터티는 삭제하지 않습니다. 상태 코드:

• 202 생성됨
• 400 잘못된 요청
  • JobLimitReached - 허용되는 최대 삭제 작업 수에 도달했습니다.
  • ValidationFailed - Operation-Id 이미 있습니다.

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 매개 변수

Name	In(다음 안에)	필수	형식	Description
api-version	query	True	string	요청된 API 버전입니다.
timeoutInMinutes	query		integer int32	삭제 작업에 필요한 시간 제한입니다. 지정된 시간 제한에 도달하면 서비스는 진행 중인 현재 삭제 작업에 의해 트리거되는 모든 삭제 작업을 중지하고 실패한 상태로 이동합니다. 롤백 작업이 없으면 instance 알 수 없는 상태로 남게 됩니다.

요청 헤더

Name	필수	형식	Description
operation-id		string	작업의 상태 모니터에 대한 ID입니다. 헤더가 클라이언트에서 전달되지 않은 경우 ID가 생성됩니다.
traceparent		string	분산 추적 시스템에서 요청을 식별합니다.
tracestate		string	공급업체별 추적 식별 정보를 제공하며 추적 매개 변수의 도우미입니다.

응답

Name	형식	Description
202 Accepted	DeleteJob	수락된 작업 Headers Operation-Location: string
Other Status Codes	ErrorResponse	기본 응답입니다. Headers x-ms-error-code: string

보안

oauth2

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

예제

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

정의

Name	Description
delete-job-status	작업의 상태.
DeleteJob	수행할 작업, 결과 및 실행 메타데이터에 대한 참조가 포함된 작업입니다.
Error	오류 정의.
ErrorResponse	오류 응답입니다.
InnerError	포함된 오류에서 제공한 것보다 더 구체적인 오류 설명입니다.

delete-job-status

작업의 상태.

Name	형식	Description
failed	string
notstarted	string
running	string
succeeded	string

DeleteJob

수행할 작업, 결과 및 실행 메타데이터에 대한 참조가 포함된 작업입니다.

Name	형식	Description
createdDateTime	string	작업의 시작 시간입니다. 타임스탬프는 RFC3339 형식 yyyy-MM-ddTHH:mm:ssZ입니다.
error	Error	가져오기 작업을 실행하여 발생한 오류에 대한 세부 정보입니다.
finishedDateTime	string	작업의 종료 시간입니다. 타임스탬프는 RFC3339 형식 yyyy-MM-ddTHH:mm:ssZ입니다.
id	string	삭제 작업의 식별자입니다.
purgeDateTime	string	시스템에서 서비스에 의해 작업이 제거되는 시간입니다. 타임스탬프는 RFC3339 형식 yyyy-MM-ddTHH:mm:ssZ입니다.
status	delete-job-status	작업의 상태.

Error

오류 정의.

Name	형식	Description
code	string	HTTP 오류 코드의 하위 상태 역할을 하는 서비스별 오류 코드입니다.
details	Error[]	내부 오류 세부 정보입니다.
innererror	InnerError	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.

ErrorResponse

오류 응답입니다.

Name	형식	Description
error	Error	오류 세부 정보입니다.

InnerError

포함된 오류에서 제공한 것보다 더 구체적인 오류 설명입니다.

Name	형식	Description
code	string	포함하는 오류에서 제공한 것보다 더 구체적인 오류 코드입니다.
innererror	InnerError	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.