Iot Hub Resource - Export Devices

Ссылка

Service:: IoT Hub

API Version:: 2018-04-01

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

Параметры 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 контейнера больших двоичных объектов экспорта.

Ответы

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

HTTP

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/exportDevices?api-version=2018-04-01

{
  "exportBlobContainerUri": "testBlob",
  "excludeKeys": true
}

Sample Response

Status code:: 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"
}

Определения

Имя	Описание
ErrorDetails	Сведения об ошибке.
ExportDevicesRequest	Используйте для предоставления параметров при запросе экспорта всех устройств в Центре Интернета вещей.
JobResponse	Свойства объекта Job Response.
JobStatus	Состояние задания.
JobType	Тип задания.

ErrorDetails

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

Имя	Тип	Описание
code	string	Код ошибки.
details	string	Сведения об ошибке.
httpStatusCode	string	Код состояния HTTP.
message	string	Сообщение об ошибке.

ExportDevicesRequest

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

Имя	Тип	Описание
excludeKeys	boolean	Значение, указывающее, следует ли исключать ключи во время экспорта.
exportBlobContainerUri	string	URI контейнера больших двоичных объектов экспорта.

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