Jobs - DeleteJobs Add

Service:

Azure Digital Twins

API Version:

2023-10-31

Lance un travail qui supprime tous les modèles, jumeaux et relations sur le instance. Ne supprime aucun autre type d’entité. Codes d’état :

• 202 Créé
• 400 Demande incorrecte
  • JobLimitReached : le nombre maximal de travaux de suppression autorisés a été atteint.
  • ValidationFailed : Operation-Id existe déjà.

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}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
api-version	query	True	string	Version de l’API demandée.
timeoutInMinutes	query		integer int32	Délai d’expiration souhaité pour le travail de suppression. Une fois le délai d’expiration spécifié atteint, le service arrête toutes les opérations de suppression déclenchées par le travail de suppression en cours et passe à un état d’échec. Notez que cela laissera votre instance dans un état inconnu, car il n’y aura pas d’opération de restauration.

En-tête de la demande

Nom	Obligatoire	Type	Description
operation-id		string	ID du moniteur status de l’opération. L’ID est généré si l’en-tête n’a pas été transmis par le client.
traceparent		string	Identifie la demande dans un système de suivi distribué.
tracestate		string	Fournit des informations d’identification de trace spécifiques au fournisseur et est un compagnon de traceparent.

Réponses

Nom	Type	Description
202 Accepted	DeleteJob	Travail accepté Headers Operation-Location: string
Other Status Codes	ErrorResponse	Réponse par défaut. Headers x-ms-error-code: string

Sécurité

oauth2

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

Exemples

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

Définitions

Nom	Description
delete-job-status	État du travail.
DeleteJob	Tâche qui contient une référence aux opérations à effectuer, aux résultats et aux métadonnées d’exécution.
Error	Définition de l’erreur.
ErrorResponse	Réponse d’erreur.
InnerError	Description d’erreur plus spécifique que celle fournie par l’erreur contenant.

delete-job-status

État du travail.

Nom	Type	Description
failed	string
notstarted	string
running	string
succeeded	string

DeleteJob

Tâche qui contient une référence aux opérations à effectuer, aux résultats et aux métadonnées d’exécution.

Nom	Type	Description
createdDateTime	string	Heure de début du travail. L’horodatage est au format RFC3339 : yyyy-MM-ddTHH:mm:ssZ.
error	Error	Détails des erreurs qui se sont produites lors de l’exécution du travail d’importation.
finishedDateTime	string	Heure de fin du travail. L’horodatage est au format RFC3339 : yyyy-MM-ddTHH:mm:ssZ.
id	string	Identificateur du travail de suppression.
purgeDateTime	string	Heure à laquelle le travail sera vidé du système par le service. L’horodatage est au format RFC3339 : yyyy-MM-ddTHH:mm:ssZ.
status	delete-job-status	État du travail.

Error

Définition de l’erreur.

Nom	Type	Description
code	string	Code d’erreur spécifique au service qui sert de sous-état pour le code d’erreur HTTP.
details	Error[]	Détails de l’erreur interne.
innererror	InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible de l’erreur.

ErrorResponse

Réponse d’erreur.

Nom	Type	Description
error	Error	Détails de l’erreur.

InnerError

Description d’erreur plus spécifique que celle fournie par l’erreur contenant.

Nom	Type	Description
code	string	Code d’erreur plus spécifique que celui fourni par l’erreur contenant.
innererror	InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.