Partager via


Iot Hub Resource - Export Devices

Exporte toutes les identités d’appareil dans le registre d’identités IoT Hub vers un conteneur d’objets blob stockage Azure. Pour plus d’informations, consultez https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/exportDevices?api-version=2023-06-30

Paramètres URI

Nom Dans Obligatoire Type Description
resourceGroupName
path True

string

Nom du groupe de ressources qui contient le hub IoT.

resourceName
path True

string

Nom du hub IoT.

subscriptionId
path True

string

Identificateur de l’abonnement.

api-version
query True

string

Version de l’API.

Corps de la demande

Nom Obligatoire Type Description
excludeKeys True

boolean

Valeur indiquant si les clés doivent être exclues lors de l’exportation.

exportBlobContainerUri True

string

URI de conteneur d’objets blob d’exportation.

authenticationType

AuthenticationType

Spécifie le type d’authentification utilisé pour la connexion au compte de stockage.

configurationsBlobName

string

Nom de l’objet blob qui sera créé dans le conteneur d’objets blob de sortie fourni. Cet objet blob contiendra les configurations exportées pour le hub Iot.

exportBlobName

string

Nom de l’objet blob qui sera créé dans le conteneur d’objets blob de sortie fourni. Cet objet blob contient les informations de registre d’appareils exportées pour le IoT Hub.

identity

ManagedIdentity

Propriétés d’identité managée du point de terminaison de stockage pour les appareils d’exportation.

includeConfigurations

boolean

Valeur indiquant si les configurations doivent être exportées.

Réponses

Nom Type Description
200 OK

JobResponse

Ok

Other Status Codes

ErrorDetails

DefaultErrorResponse

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

IotHubResource_ExportDevices

Exemple de requête

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/exportDevices?api-version=2023-06-30

{
  "exportBlobContainerUri": "testBlob",
  "excludeKeys": true
}

Exemple de réponse

{
  "jobId": "test",
  "startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT",
  "endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT",
  "type": "unknown",
  "status": "unknown"
}

Définitions

Nom Description
AuthenticationType

Spécifie le type d’authentification utilisé pour la connexion au compte de stockage.

ErrorDetails

Détails de l’erreur.

ExportDevicesRequest

Permet de fournir des paramètres lors de la demande d’exportation de tous les appareils dans le hub IoT.

JobResponse

Propriétés de l’objet Job Response.

JobStatus

État du travail.

JobType

Type du travail.

ManagedIdentity

Propriétés de l’identité managée.

AuthenticationType

Spécifie le type d’authentification utilisé pour la connexion au compte de stockage.

Nom Type Description
identityBased

string

keyBased

string

ErrorDetails

Détails de l’erreur.

Nom Type Description
code

string

Code d'erreur.

details

string

Détails de l’erreur.

httpStatusCode

string

Code d’état HTTP.

message

string

Message d’erreur.

ExportDevicesRequest

Permet de fournir des paramètres lors de la demande d’exportation de tous les appareils dans le hub IoT.

Nom Type Description
authenticationType

AuthenticationType

Spécifie le type d’authentification utilisé pour la connexion au compte de stockage.

configurationsBlobName

string

Nom de l’objet blob qui sera créé dans le conteneur d’objets blob de sortie fourni. Cet objet blob contiendra les configurations exportées pour le hub Iot.

excludeKeys

boolean

Valeur indiquant si les clés doivent être exclues lors de l’exportation.

exportBlobContainerUri

string

URI de conteneur d’objets blob d’exportation.

exportBlobName

string

Nom de l’objet blob qui sera créé dans le conteneur d’objets blob de sortie fourni. Cet objet blob contient les informations de registre d’appareils exportées pour le IoT Hub.

identity

ManagedIdentity

Propriétés d’identité managée du point de terminaison de stockage pour les appareils d’exportation.

includeConfigurations

boolean

Valeur indiquant si les configurations doivent être exportées.

JobResponse

Propriétés de l’objet Job Response.

Nom Type Description
endTimeUtc

string

Heure à laquelle le travail a cessé de traiter.

failureReason

string

Si status == a échoué, cette chaîne contenant la raison de l’échec.

jobId

string

Identificateur du travail.

parentJobId

string

Identificateur de travail du travail parent, le cas échéant.

startTimeUtc

string

Heure de début du travail.

status

JobStatus

État du travail.

statusMessage

string

Message status pour le travail.

type

JobType

Type du travail.

JobStatus

État du travail.

Nom Type Description
cancelled

string

completed

string

enqueued

string

failed

string

running

string

unknown

string

JobType

Type du travail.

Nom Type Description
backup

string

export

string

factoryResetDevice

string

firmwareUpdate

string

import

string

readDeviceProperties

string

rebootDevice

string

unknown

string

updateDeviceConfiguration

string

writeDeviceProperties

string

ManagedIdentity

Propriétés de l’identité managée.

Nom Type Description
userAssignedIdentity

string

Identité affectée par l’utilisateur.