Jobs - Create Import Export Job

Référence

Service:: IoT Hub

Version d'API:: 2021-04-12

Crée un travail d’importation ou d’exportation sur le IoT Hub. Consultez la rubrique https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities (éventuellement en anglais) pour plus d'informations.

POST https://fully-qualified-iothubname.azure-devices.net/jobs/create?api-version=2021-04-12

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
api-version	query	True	string	Version de l’API.

Corps de la demande

Nom	Type	Description
configurationsBlobName	string	Par défaut, configurations.txt. Spécifie le nom de l’objet blob à utiliser lors de l’exportation/importation de configurations.
endTimeUtc	string	Généré par le système. Ignoré lors de la création. Date et heure de fin du travail en UTC.
excludeKeysInExport	boolean	Facultatif pour les travaux d’exportation ; ignoré pour d’autres travaux. S’il n’est pas spécifié, le service a la valeur par défaut false. Si la valeur est false, les clés d’autorisation sont incluses dans la sortie d’exportation. Dans le cas contraire, les clés sont exportées sous la forme null.
failureReason	string	Système generé. Ignoré lors de la création. Raison de l’échec, si un échec s’est produit.
identity	ManagedIdentity
includeConfigurations	boolean	La valeur par défaut est false. Si la valeur est true, les configurations sont incluses dans l’exportation/importation des données.
inputBlobContainerUri	string	URI contenant le jeton SAS à un conteneur d’objets blob qui contient des données de Registre à synchroniser.
inputBlobName	string	Nom de l’objet blob à utiliser lors de l’importation à partir du conteneur d’objets blob d’entrée.
jobId	string	Identificateur unique du travail.
outputBlobContainerUri	string	Jeton SAP pour accéder au conteneur d’objets blob. Il est utilisé pour générer le status et les résultats du travail.
outputBlobName	string	Nom de l’objet blob qui sera créé dans le conteneur d’objets blob de sortie. Cet objet blob contient les informations de registre d’appareils exportées pour le IoT Hub.
progress	integer	Généré par le système. Ignoré lors de la création. Pourcentage d’achèvement du travail.
startTimeUtc	string	Généré par le système. Ignoré lors de la création. Date et heure de début du travail en UTC.
status	enum: unknown enqueued running completed failed cancelled scheduled queued	Généré par le système. Ignoré lors de la création. État du travail.
storageAuthenticationType	enum: keyBased identityBased	Type d’authentification utilisé pour la connexion au compte de stockage.
type	enum: unknown export import backup readDeviceProperties writeDeviceProperties updateDeviceConfiguration rebootDevice factoryResetDevice firmwareUpdate scheduleDeviceMethod scheduleUpdateTwin restoreFromBackup failoverDataCopy	Type de travail.

Réponses

Nom	Type	Description
200 OK	JobProperties	OK.

Définitions

Nom	Description
JobProperties
ManagedIdentity

JobProperties

Nom	Type	Description
configurationsBlobName	string	Par défaut, configurations.txt. Spécifie le nom de l’objet blob à utiliser lors de l’exportation/importation de configurations.
endTimeUtc	string	Généré par le système. Ignoré lors de la création. Date et heure de fin du travail en UTC.
excludeKeysInExport	boolean	Facultatif pour les travaux d’exportation ; ignoré pour d’autres travaux. S’il n’est pas spécifié, le service a la valeur par défaut false. Si la valeur est false, les clés d’autorisation sont incluses dans la sortie d’exportation. Dans le cas contraire, les clés sont exportées sous la forme null.
failureReason	string	Système generé. Ignoré lors de la création. Raison de l’échec, si un échec s’est produit.
identity	ManagedIdentity
includeConfigurations	boolean	La valeur par défaut est false. Si la valeur est true, les configurations sont incluses dans l’exportation/importation des données.
inputBlobContainerUri	string	URI contenant le jeton SAS à un conteneur d’objets blob qui contient des données de Registre à synchroniser.
inputBlobName	string	Nom de l’objet blob à utiliser lors de l’importation à partir du conteneur d’objets blob d’entrée.
jobId	string	Identificateur unique du travail.
outputBlobContainerUri	string	Jeton SAP pour accéder au conteneur d’objets blob. Il est utilisé pour générer le status et les résultats du travail.
outputBlobName	string	Nom de l’objet blob qui sera créé dans le conteneur d’objets blob de sortie. Cet objet blob contient les informations de registre d’appareils exportées pour le IoT Hub.
progress	integer	Généré par le système. Ignoré lors de la création. Pourcentage d’achèvement du travail.
startTimeUtc	string	Généré par le système. Ignoré lors de la création. Date et heure de début du travail en UTC.
status	enum: cancelled completed enqueued failed queued running scheduled unknown	Généré par le système. Ignoré lors de la création. État du travail.
storageAuthenticationType	enum: identityBased keyBased	Type d’authentification utilisé pour la connexion au compte de stockage.
type	enum: backup export factoryResetDevice failoverDataCopy firmwareUpdate import readDeviceProperties rebootDevice restoreFromBackup scheduleDeviceMethod scheduleUpdateTwin unknown updateDeviceConfiguration writeDeviceProperties	Type de travail.

ManagedIdentity

Nom	Type	Description
userAssignedIdentity	string

Partager via