Поделиться через

Iot Hub Resource - Export Devices

Служба:
IoT Hub
Версия API:
2023-06-30

Экспортирует все удостоверения устройств в реестре удостоверений Центра Интернета вещей в контейнер BLOB-объектов службы хранилища Azure. Дополнительные сведения см. в статье 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

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

string

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

string

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

string

Идентификатор подписки.
api-version
 query True

string

Версия API.

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

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

boolean

Значение, указывающее, следует ли исключать ключи во время экспорта.
exportBlobContainerUri True

string

Универсальный код ресурса (URI) контейнера BLOB-объектов экспорта.
authenticationType

AuthenticationType

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

string

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

string

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

ManagedIdentity

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

boolean

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

Ответы

Имя Тип Описание
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_ExportDevices

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

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
}

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

Код состояния:
200 
{
  "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

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

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

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

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

Тип задания.
ManagedIdentity

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

AuthenticationType

Перечисление

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

Значение Описание
keyBased
identityBased

ErrorDetails

Object

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

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

string

Код ошибки.
details

string

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

string

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

string

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

ExportDevicesRequest

Object

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

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

AuthenticationType

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

string

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

boolean

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

string

Универсальный код ресурса (URI) контейнера BLOB-объектов экспорта.
exportBlobName

string

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

ManagedIdentity

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

boolean

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

JobResponse

Object

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

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

string (date-time-rfc1123)

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

string

Если состояние == завершилось ошибкой, эта строка содержит причину сбоя.
jobId

string

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

string

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

string (date-time-rfc1123)

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

JobStatus

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

string

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

JobType

Тип задания.

JobStatus

Перечисление

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

Значение Описание
unknown
enqueued
running
completed
failed
cancelled

JobType

Перечисление

Тип задания.

Значение Описание
unknown
export
import
backup
readDeviceProperties
writeDeviceProperties
updateDeviceConfiguration
rebootDevice
factoryResetDevice
firmwareUpdate

ManagedIdentity

Object

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

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

string

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