Jobs - Create Import Export Job

Serviço:

IoT Hub

Versão da API:

2021-04-12

Cria uma nova tarefa de importação ou exportação no Hub IoT. Consulte https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities para obter mais informações.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
api-version	query	True	string	Versão da API.

Corpo do Pedido

Name	Tipo	Description
configurationsBlobName	string	A predefinição é configurations.txt. Especifica o nome do blob a utilizar ao exportar/importar configurações.
endTimeUtc	string	Sistema gerado. Ignorado na criação. A data e hora de fim da tarefa em UTC.
excludeKeysInExport	boolean	Opcional para tarefas de exportação; ignorado para outros trabalhos. Se não for especificado, o serviço é predefinido como falso. Se for falso, as chaves de autorização são incluídas na saída de exportação. As chaves são exportadas como nulas.
failureReason	string	Sistema genereado. Ignorado na criação. O motivo da falha, se tiver ocorrido uma falha.
identity	ManagedIdentity
includeConfigurations	boolean	O valor predefinido é falso. Se for verdadeiro, as configurações são incluídas na exportação/importação de dados.
inputBlobContainerUri	string	O URI que contém o token de SAS para um contentor de blobs que contém dados de registo a sincronizar.
inputBlobName	string	O nome do blob a utilizar ao importar do contentor de blobs de entrada.
jobId	string	O identificador exclusivo da tarefa.
outputBlobContainerUri	string	O token de SAS para aceder ao contentor de blobs. Isto é utilizado para exportar o estado e os resultados da tarefa.
outputBlobName	string	O nome do blob que será criado no contentor de blobs de saída. Este blob irá conter as informações de registo de dispositivos exportadas para o Hub IoT.
progress	integer	Sistema gerado. Ignorado na criação. A percentagem de conclusão da tarefa.
startTimeUtc	string	Sistema gerado. Ignorado na criação. A data e hora de início da tarefa em UTC.
status	enum: unknown enqueued running completed failed cancelled scheduled queued	Sistema gerado. Ignorado na criação. O estado da tarefa.
storageAuthenticationType	enum: keyBased identityBased	O tipo de autenticação utilizado para ligar à conta de armazenamento.
type	enum: unknown export import backup readDeviceProperties writeDeviceProperties updateDeviceConfiguration rebootDevice factoryResetDevice firmwareUpdate scheduleDeviceMethod scheduleUpdateTwin restoreFromBackup failoverDataCopy	O tipo de tarefa.

Respostas

Name	Tipo	Description
200 OK	JobProperties	OK.

Definições

Name	Description
JobProperties
ManagedIdentity

JobProperties

Name	Tipo	Description
configurationsBlobName	string	A predefinição é configurations.txt. Especifica o nome do blob a utilizar ao exportar/importar configurações.
endTimeUtc	string	Sistema gerado. Ignorado na criação. A data e hora de fim da tarefa em UTC.
excludeKeysInExport	boolean	Opcional para tarefas de exportação; ignorado para outros trabalhos. Se não for especificado, o serviço é predefinido como falso. Se for falso, as chaves de autorização são incluídas na saída de exportação. As chaves são exportadas como nulas.
failureReason	string	Sistema genereado. Ignorado na criação. O motivo da falha, se tiver ocorrido uma falha.
identity	ManagedIdentity
includeConfigurations	boolean	O valor predefinido é falso. Se for verdadeiro, as configurações são incluídas na exportação/importação de dados.
inputBlobContainerUri	string	O URI que contém o token de SAS para um contentor de blobs que contém dados de registo a sincronizar.
inputBlobName	string	O nome do blob a utilizar ao importar do contentor de blobs de entrada.
jobId	string	O identificador exclusivo da tarefa.
outputBlobContainerUri	string	O token de SAS para aceder ao contentor de blobs. Isto é utilizado para exportar o estado e os resultados da tarefa.
outputBlobName	string	O nome do blob que será criado no contentor de blobs de saída. Este blob irá conter as informações de registo de dispositivos exportadas para o Hub IoT.
progress	integer	Sistema gerado. Ignorado na criação. A percentagem de conclusão da tarefa.
startTimeUtc	string	Sistema gerado. Ignorado na criação. A data e hora de início da tarefa em UTC.
status	enum: cancelled completed enqueued failed queued running scheduled unknown	Sistema gerado. Ignorado na criação. O estado da tarefa.
storageAuthenticationType	enum: identityBased keyBased	O tipo de autenticação utilizado para ligar à conta de armazenamento.
type	enum: backup export factoryResetDevice failoverDataCopy firmwareUpdate import readDeviceProperties rebootDevice restoreFromBackup scheduleDeviceMethod scheduleUpdateTwin unknown updateDeviceConfiguration writeDeviceProperties	O tipo de tarefa.

ManagedIdentity

Name	Tipo	Description
userAssignedIdentity	string