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


Iot Hub Resource - Export Devices

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

authenticationType

AuthenticationType

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

configurationsBlobName

string

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

exportBlobName

string

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

identity

ManagedIdentity

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

includeConfigurations

boolean

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

Ответы

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

JobResponse

ОК

Other Status Codes

ErrorDetails

DefaultErrorResponse

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

azure_auth

Поток OAuth2 в Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Примеры

IotHubResource_ExportDevices

Sample Request

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
}

Sample Response

{
  "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

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

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

string

keyBased

string

ErrorDetails

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

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

string

Код ошибки.

details

string

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

httpStatusCode

string

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

message

string

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

ExportDevicesRequest

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

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

AuthenticationType

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

configurationsBlobName

string

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

excludeKeys

boolean

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

exportBlobContainerUri

string

URI контейнера больших двоичных объектов экспорта.

exportBlobName

string

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

identity

ManagedIdentity

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

includeConfigurations

boolean

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

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

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