Jobs - Create Import Export Job

Tjänst:

IoT Hub

API-version:

2021-04-12

Skapar ett nytt import- eller exportjobb på IoT Hub. Mer information finns i https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
api-version	query	True	string	Version av API:et.

Begärandetext

Name	Typ	Description
configurationsBlobName	string	Standardvärdet är configurations.txt. Anger namnet på bloben som ska användas vid export/import av konfigurationer.
endTimeUtc	string	Systemet genereras. Ignoreras vid skapande. Slutdatum och tid för jobbet i UTC.
excludeKeysInExport	boolean	Valfritt för exportjobb. ignoreras för andra jobb. Om det inte anges är tjänsten som standard false. Om det är falskt inkluderas auktoriseringsnycklar i exportutdata. Nycklar exporteras som null annars.
failureReason	string	System genererad. Ignoreras vid skapande. Orsaken till felet, om ett fel inträffade.
identity	ManagedIdentity
includeConfigurations	boolean	Standardvärdet är falskt. Om det är sant inkluderas konfigurationer i dataexporten/importen.
inputBlobContainerUri	string	URI:n som innehåller SAS-token till en blobcontainer som innehåller registerdata som ska synkroniseras.
inputBlobName	string	Det blobnamn som ska användas vid import från indatablobcontainern.
jobId	string	Den unika identifieraren för jobbet.
outputBlobContainerUri	string	SAS-token för åtkomst till blobcontainern. Detta används för att mata ut status och resultat för jobbet.
outputBlobName	string	Blobnamnet som ska skapas i blobcontainern för utdata. Den här bloben innehåller information om det exporterade enhetsregistret för IoT Hub.
progress	integer	Systemet genereras. Ignoreras vid skapande. Procentandelen av jobbets slutförande.
startTimeUtc	string	Systemet genereras. Ignoreras vid skapande. Startdatum och tid för jobbet i UTC.
status	enum: unknown enqueued running completed failed cancelled scheduled queued	Systemet genereras. Ignoreras vid skapande. Jobbets status.
storageAuthenticationType	enum: keyBased identityBased	Den autentiseringstyp som används för att ansluta till lagringskontot.
type	enum: unknown export import backup readDeviceProperties writeDeviceProperties updateDeviceConfiguration rebootDevice factoryResetDevice firmwareUpdate scheduleDeviceMethod scheduleUpdateTwin restoreFromBackup failoverDataCopy	Jobbtypen.

Svar

Name	Typ	Description
200 OK	JobProperties	OK.

Definitioner

Name	Description
JobProperties
ManagedIdentity

JobProperties

Name	Typ	Description
configurationsBlobName	string	Standardvärdet är configurations.txt. Anger namnet på bloben som ska användas vid export/import av konfigurationer.
endTimeUtc	string	Systemet genereras. Ignoreras vid skapande. Slutdatum och tid för jobbet i UTC.
excludeKeysInExport	boolean	Valfritt för exportjobb. ignoreras för andra jobb. Om det inte anges är tjänsten som standard false. Om det är falskt inkluderas auktoriseringsnycklar i exportutdata. Nycklar exporteras som null annars.
failureReason	string	System genererad. Ignoreras vid skapande. Orsaken till felet, om ett fel inträffade.
identity	ManagedIdentity
includeConfigurations	boolean	Standardvärdet är falskt. Om det är sant inkluderas konfigurationer i dataexporten/importen.
inputBlobContainerUri	string	URI:n som innehåller SAS-token till en blobcontainer som innehåller registerdata som ska synkroniseras.
inputBlobName	string	Det blobnamn som ska användas vid import från indatablobcontainern.
jobId	string	Den unika identifieraren för jobbet.
outputBlobContainerUri	string	SAS-token för åtkomst till blobcontainern. Detta används för att mata ut status och resultat för jobbet.
outputBlobName	string	Blobnamnet som ska skapas i blobcontainern för utdata. Den här bloben innehåller information om det exporterade enhetsregistret för IoT Hub.
progress	integer	Systemet genereras. Ignoreras vid skapande. Procentandelen av jobbets slutförande.
startTimeUtc	string	Systemet genereras. Ignoreras vid skapande. Startdatum och tid för jobbet i UTC.
status	enum: cancelled completed enqueued failed queued running scheduled unknown	Systemet genereras. Ignoreras vid skapande. Jobbets status.
storageAuthenticationType	enum: identityBased keyBased	Den autentiseringstyp som används för att ansluta till lagringskontot.
type	enum: backup export factoryResetDevice failoverDataCopy firmwareUpdate import readDeviceProperties rebootDevice restoreFromBackup scheduleDeviceMethod scheduleUpdateTwin unknown updateDeviceConfiguration writeDeviceProperties	Jobbtypen.

ManagedIdentity

Name	Typ	Description
userAssignedIdentity	string