Iot Hub Resource - Import Devices

Импорт, обновление или удаление удостоверений устройств в реестре удостоверений Центра Интернета вещей из большого двоичного объекта. Дополнительные сведения см. на странице 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}/importDevices?api-version=2023-06-30

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
path True

string

Имя группы ресурсов, содержащей Центр Интернета вещей.

resourceName
path True

string

Имя Центра Интернета вещей.

subscriptionId
path True

string

Идентификатор подписки.

api-version
query True

string

Версия API.

Текст запроса

Имя Обязательно Тип Описание
inputBlobContainerUri True

string

URI контейнера входных BLOB-объектов.

outputBlobContainerUri True

string

Выходной URI контейнера BLOB-объектов.

authenticationType

AuthenticationType

Указывает тип проверки подлинности, используемый для подключения к учетной записи хранения.

configurationsBlobName

string

Имя большого двоичного объекта, используемое при импорте конфигураций из предоставленного контейнера входных BLOB-объектов.

identity

ManagedIdentity

Свойства управляемого удостоверения конечной точки хранилища для импортируемых устройств.

includeConfigurations

boolean

Значение, указывающее, следует ли импортировать конфигурации.

inputBlobName

string

Имя большого двоичного объекта, используемое при импорте из предоставленного входного контейнера BLOB-объектов.

outputBlobName

string

Имя большого двоичного объекта, используемого для хранения состояния задания импорта.

Ответы

Имя Тип Описание
200 OK

JobResponse

ОК

Other Status Codes

ErrorDetails

DefaultErrorResponse

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

IotHubResource_ImportDevices

Образец запроса

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

{
  "inputBlobContainerUri": "testBlob",
  "outputBlobContainerUri": "testBlob"
}

Пример ответа

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

Определения

Имя Описание
AuthenticationType

Указывает тип проверки подлинности, используемый для подключения к учетной записи хранения.

ErrorDetails

Сведения об ошибке.

ImportDevicesRequest

Используйте для предоставления параметров при запросе импорта всех устройств в концентраторе.

JobResponse

Свойства объекта Job Response.

JobStatus

Состояние задания.

JobType

Тип задания.

ManagedIdentity

Свойства управляемого удостоверения.

AuthenticationType

Указывает тип проверки подлинности, используемый для подключения к учетной записи хранения.

Имя Тип Описание
identityBased

string

keyBased

string

ErrorDetails

Сведения об ошибке.

Имя Тип Описание
code

string

Код ошибки.

details

string

Сведения об ошибке.

httpStatusCode

string

Код состояния HTTP.

message

string

Сообщение об ошибке.

ImportDevicesRequest

Используйте для предоставления параметров при запросе импорта всех устройств в концентраторе.

Имя Тип Описание
authenticationType

AuthenticationType

Указывает тип проверки подлинности, используемый для подключения к учетной записи хранения.

configurationsBlobName

string

Имя большого двоичного объекта, используемое при импорте конфигураций из предоставленного контейнера входных BLOB-объектов.

identity

ManagedIdentity

Свойства управляемого удостоверения конечной точки хранилища для импортируемых устройств.

includeConfigurations

boolean

Значение, указывающее, следует ли импортировать конфигурации.

inputBlobContainerUri

string

URI контейнера входных BLOB-объектов.

inputBlobName

string

Имя большого двоичного объекта, используемое при импорте из предоставленного входного контейнера BLOB-объектов.

outputBlobContainerUri

string

Выходной URI контейнера BLOB-объектов.

outputBlobName

string

Имя большого двоичного объекта, используемого для хранения состояния задания импорта.

JobResponse

Свойства объекта Job Response.

Имя Тип Описание
endTimeUtc

string

Время остановки обработки задания.

failureReason

string

Если status == failed, эта строка содержит причину сбоя.

jobId

string

Идентификатор задания.

parentJobId

string

Идентификатор родительского задания, если таковой есть.

startTimeUtc

string

Время начала задания.

status

JobStatus

Состояние задания.

statusMessage

string

Сообщение о состоянии задания.

type

JobType

Тип задания.

JobStatus

Состояние задания.

Имя Тип Описание
cancelled

string

completed

string

enqueued

string

failed

string

running

string

unknown

string

JobType

Тип задания.

Имя Тип Описание
backup

string

export

string

factoryResetDevice

string

firmwareUpdate

string

import

string

readDeviceProperties

string

rebootDevice

string

unknown

string

updateDeviceConfiguration

string

writeDeviceProperties

string

ManagedIdentity

Свойства управляемого удостоверения.

Имя Тип Описание
userAssignedIdentity

string

Удостоверение, назначаемое пользователем.