Freigeben über


Iot Hub Resource - Export Devices

Exportiert alle Geräteidentitäten in der IoT Hub-Identitätsregistrierung in einen Azure Storage-Blobcontainer. Weitere Informationen finden Sie unter 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

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
path True

string

Der Name der Ressourcengruppe, die den IoT Hub enthält.

resourceName
path True

string

Der Name des IoT-Hubs.

subscriptionId
path True

string

Die Abonnement-ID.

api-version
query True

string

Die Version der API.

Anforderungstext

Name Erforderlich Typ Beschreibung
excludeKeys True

boolean

Der Wert, der angibt, ob Schlüssel während des Exports ausgeschlossen werden sollen.

exportBlobContainerUri True

string

Der URI des Exportblobcontainers.

authenticationType

AuthenticationType

Gibt den Authentifizierungstyp an, der zum Herstellen einer Verbindung mit dem Speicherkonto verwendet wird.

configurationsBlobName

string

Der Name des Blobs, das im bereitgestellten Ausgabeblobcontainer erstellt wird. Dieses Blob enthält die exportierten Konfigurationen für iot Hub.

exportBlobName

string

Der Name des Blobs, das im bereitgestellten Ausgabeblobcontainer erstellt wird. Dieses Blob enthält die exportierten Geräteregistrierungsinformationen für die IoT Hub.

identity

ManagedIdentity

Eigenschaften der verwalteten Identität des Speicherendpunkts für Exportgeräte.

includeConfigurations

boolean

Der Wert, der angibt, ob Konfigurationen exportiert werden sollen.

Antworten

Name Typ Beschreibung
200 OK

JobResponse

OK

Other Status Codes

ErrorDetails

DefaultErrorResponse

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

IotHubResource_ExportDevices

Beispielanforderung

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
}

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
AuthenticationType

Gibt den Authentifizierungstyp an, der zum Herstellen einer Verbindung mit dem Speicherkonto verwendet wird.

ErrorDetails

Fehlerdetails.

ExportDevicesRequest

Verwenden Sie , um Parameter beim Anfordern eines Exports aller Geräte im IoT Hub bereitzustellen.

JobResponse

Die Eigenschaften des Auftragsantwortobjekts.

JobStatus

Der Status des Auftrags.

JobType

Der Typ des Auftrags.

ManagedIdentity

Die Eigenschaften der verwalteten Identität.

AuthenticationType

Gibt den Authentifizierungstyp an, der zum Herstellen einer Verbindung mit dem Speicherkonto verwendet wird.

Name Typ Beschreibung
identityBased

string

keyBased

string

ErrorDetails

Fehlerdetails.

Name Typ Beschreibung
code

string

Der Fehlercode.

details

string

Die Fehlerdetails.

httpStatusCode

string

Der HTTP-Statuscode.

message

string

Die Fehlermeldung.

ExportDevicesRequest

Verwenden Sie , um Parameter beim Anfordern eines Exports aller Geräte im IoT Hub bereitzustellen.

Name Typ Beschreibung
authenticationType

AuthenticationType

Gibt den Authentifizierungstyp an, der zum Herstellen einer Verbindung mit dem Speicherkonto verwendet wird.

configurationsBlobName

string

Der Name des Blobs, das im bereitgestellten Ausgabeblobcontainer erstellt wird. Dieses Blob enthält die exportierten Konfigurationen für iot Hub.

excludeKeys

boolean

Der Wert, der angibt, ob Schlüssel während des Exports ausgeschlossen werden sollen.

exportBlobContainerUri

string

Der URI des Exportblobcontainers.

exportBlobName

string

Der Name des Blobs, das im bereitgestellten Ausgabeblobcontainer erstellt wird. Dieses Blob enthält die exportierten Geräteregistrierungsinformationen für die IoT Hub.

identity

ManagedIdentity

Eigenschaften der verwalteten Identität des Speicherendpunkts für Exportgeräte.

includeConfigurations

boolean

Der Wert, der angibt, ob Konfigurationen exportiert werden sollen.

JobResponse

Die Eigenschaften des Auftragsantwortobjekts.

Name Typ Beschreibung
endTimeUtc

string

Die Zeit, zu der die Verarbeitung des Auftrags beendet wurde.

failureReason

string

Wenn status == fehlgeschlagen ist, enthält diese Zeichenfolge den Grund für den Fehler.

jobId

string

Der Auftragsbezeichner.

parentJobId

string

Der Auftragsbezeichner des übergeordneten Auftrags, falls vorhanden.

startTimeUtc

string

Die Startzeit des Auftrags.

status

JobStatus

Der Status des Auftrags.

statusMessage

string

Die status Meldung für den Auftrag.

type

JobType

Der Typ des Auftrags.

JobStatus

Der Status des Auftrags.

Name Typ Beschreibung
cancelled

string

completed

string

enqueued

string

failed

string

running

string

unknown

string

JobType

Der Typ des Auftrags.

Name Typ Beschreibung
backup

string

export

string

factoryResetDevice

string

firmwareUpdate

string

import

string

readDeviceProperties

string

rebootDevice

string

unknown

string

updateDeviceConfiguration

string

writeDeviceProperties

string

ManagedIdentity

Die Eigenschaften der verwalteten Identität.

Name Typ Beschreibung
userAssignedIdentity

string

Die vom Benutzer zugewiesene Identität.