Registry class

Ссылка

Пакет:: azure-iothub

Класс Registry предоставляет доступ к Центр Интернета вещей службе удостоверений устройств. Пользователи пакета SDK должны создать экземпляр этого класса с помощью одного из фабричного метода: fromConnectionString или fromSharedAccessSignature.

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

Методы

addConfiguration(Configuration)
addConfiguration(Configuration, HttpResponseCallback<any>)	Добавление конфигурации в Центр Интернета вещей.
addDevices(DeviceDescription[])
addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)	Добавляет массив устройств.
addModule(Module)
addModule(Module, HttpResponseCallback<any>)	Добавьте заданный модуль в реестр.
applyConfigurationContentOnDevice(string, ConfigurationContent)
applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)	Применение заданной конфигурации к устройству на Центр Интернета вещей
cancelJob(string)
cancelJob(string, Callback<JobStatus>)	Отмена задания массового импорта и экспорта.
create(DeviceDescription)
create(DeviceDescription, HttpResponseCallback<Device>)	Создает новое удостоверение устройства в Центре Интернета вещей.
createQuery(string, number)	Создает запрос, который можно выполнить в экземпляре Центр Интернета вещей для поиска сведений об устройствах или заданиях.
delete(string)
delete(string, HttpResponseCallback<any>)	Удаляет существующее удостоверение устройства из Центра Интернета вещей.
exportDevicesToBlob(string, boolean)
exportDevicesToBlob(string, boolean, Callback<JobStatus>)	Экспорт устройств в большой двоичный объект в массовом задании.
exportDevicesToBlobByIdentity(string, boolean)
exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)	Экспорт устройств в большой двоичный объект в массовом задании с помощью настроенного удостоверения.
exportDevicesToBlobByIdentity(string, boolean, string)
exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)
fromConnectionString(string)	Создает объект Registry из заданной строки подключения.
fromSharedAccessSignature(string)	Создает объект Реестра на основе заданной подписанной URL-адреса.
fromTokenCredential(string, TokenCredential)	Создает объект Реестра из заданного объекта Azure TokenCredential.
get(string)
get(string, HttpResponseCallback<Device>)	Запрашивает сведения о существующем удостоверении устройства в Центре Интернета вещей.
getConfiguration(string)
getConfiguration(string, HttpResponseCallback<Configuration>)	Получение одной конфигурации из Центр Интернета вещей
getConfigurations()
getConfigurations(HttpResponseCallback<Configuration[]>)	Получение всех конфигураций в Центр Интернета вещей
getJob(string)
getJob(string, Callback<JobStatus>)	Получение состояния задания массового импорта и экспорта.
getModule(string, string)
getModule(string, string, HttpResponseCallback<Module>)	Получение одного модуля с устройства на Центр Интернета вещей
getModulesOnDevice(string)
getModulesOnDevice(string, HttpResponseCallback<Module[]>)	Получение списка всех модулей на устройстве Центр Интернета вещей
getModuleTwin(string, string)
getModuleTwin(string, string, HttpResponseCallback<Twin>)	Возвращает двойник модуля с указанным идентификатором модуля.
getRegistryStatistics()
getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)	Возвращает статистику об устройствах в реестре удостоверений устройств.
getTwin(string)
getTwin(string, HttpResponseCallback<Twin>)	Возвращает двойник устройства с указанным идентификатором устройства.
importDevicesFromBlob(string, string)
importDevicesFromBlob(string, string, Callback<JobStatus>)	Импорт устройств из большого двоичного объекта в массовом задании.
importDevicesFromBlobByIdentity(string, string)
importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)	Импорт устройств из большого двоичного объекта в массовом задании с помощью настроенного удостоверения.
importDevicesFromBlobByIdentity(string, string, string)
importDevicesFromBlobByIdentity(string, string, string, Callback<JobStatus>)
list()
list(HttpResponseCallback<Device[]>)	Запрашивает сведения о первых 1000 удостоверениях устройств в Центре Интернета вещей.
listJobs()
listJobs(HttpResponseCallback<any>)	Выведите список последних заданий импорта и экспорта (включая активное, если таковое есть).
removeConfiguration(string)
removeConfiguration(string, HttpResponseCallback<any>)	Удаление конфигурации с указанным идентификатором из Центр Интернета вещей
removeDevices(DeviceDescription[], boolean)
removeDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	Обновления массив устройств.
removeModule(Module, TripleValueCallback<any, any>)	Удаление заданного модуля из реестра
removeModule(string \| Module)
removeModule(string \| Module, string)
removeModule(string, string, TripleValueCallback<any, any>)
update(DeviceDescription)
update(DeviceDescription, HttpResponseCallback<Device>)	Обновления существующее удостоверение устройства в Центре Интернета вещей с указанными сведениями об устройстве. Параметр `deviceInfo` должен включать все обновляемые свойства. Например, при обновлении `status` свойства с `disabled` до `enabled`объект `deviceInfo` также должен иметь состояниеReason, проверка подлинности (и его вложенные свойства), возможности и deviceScope должны быть заданы для текущих значений устройств, иначе эти свойства будут сброшены. Прежде чем выполнять обновление, рекомендуется вызвать API get.
updateConfiguration(Configuration)
updateConfiguration(Configuration, boolean)
updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)
updateConfiguration(Configuration, HttpResponseCallback<any>)	Обновление конфигурации в Центре Интернета вещей
updateDevices(DeviceDescription[], boolean)
updateDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	Обновления массив устройств. Отдельные элементы `devices` параметра должны включать все обновляемые свойства. Например, при обновлении `status` свойства с `disabled` на `enabled`объект также должен иметь состояниеReason, проверка подлинности (и его вложенные свойства), возможности и deviceScope, заданные для текущих значений устройств, иначе эти свойства будут сброшены. Перед обновлением рекомендуется сначала вызвать API get.
updateModule(Module)
updateModule(Module, boolean)
updateModule(Module, boolean, HttpResponseCallback<any>)
updateModule(Module, TripleValueCallback<any, any>)	Обновление заданного объекта модуля в реестре
updateModuleTwin(string, string, any, string)
updateModuleTwin(string, string, any, string, HttpResponseCallback<Twin>)	Обновления двойник определенного модуля с заданным исправлением.
updateTwin(string, any, string)
updateTwin(string, any, string, HttpResponseCallback<Twin>)	Обновления двойник устройства определенного устройства с заданным исправлением.

Сведения о методе

addConfiguration(Configuration)

function addConfiguration(configuration: Configuration): Promise<ResultWithHttpResponse<any>>

Параметры

configuration: Configuration

Возвращаемое значение

Promise<ResultWithHttpResponse<any>>

addConfiguration(Configuration, HttpResponseCallback<any>)

Добавление конфигурации в Центр Интернета вещей.

function addConfiguration(configuration: Configuration, done?: HttpResponseCallback<any>)

Параметры

configuration: Configuration

Объект типа module:azure-iothub. Конфигурация для добавления в концентратор

done: HttpResponseCallback<any>

Необязательная функция, вызываемая по завершении операции. done будет вызываться с тремя аргументами: объект Error (может иметь значение NULL), текст ответа и объект ответа, зависящий от транспорта, полезный для ведения журнала или отладки.

addDevices(DeviceDescription[])

function addDevices(devices: DeviceDescription[]): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

Параметры

devices: DeviceDescription[]

Возвращаемое значение

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)

Добавляет массив устройств.

function addDevices(devices: DeviceDescription[], done?: HttpResponseCallback<BulkRegistryOperationResult>)

Параметры

devices: DeviceDescription[]

Массив объектов , который должен содержать deviceId свойство, значение которого является допустимым идентификатором устройства.

done: HttpResponseCallback<BulkRegistryOperationResult>

Необязательная функция, вызываемая по завершении операции. done будет вызываться с тремя аргументами: объект Error (может иметь значение NULL), BulkRegistryOperationResult и объект ответа, зависящий от транспорта, полезный для ведения журнала или отладки.

addModule(Module)

function addModule(module: Module): Promise<ResultWithHttpResponse<any>>

Параметры

module: Module

Возвращаемое значение

Promise<ResultWithHttpResponse<any>>

addModule(Module, HttpResponseCallback<any>)

Добавьте заданный модуль в реестр.

function addModule(module: Module, done?: HttpResponseCallback<any>)

Параметры

module: Module

Объект module, добавляемый в реестр.

done: HttpResponseCallback<any>

applyConfigurationContentOnDevice(string, ConfigurationContent)

function applyConfigurationContentOnDevice(deviceId: string, content: ConfigurationContent): Promise<ResultWithHttpResponse<any>>

Параметры

deviceId: string

content: ConfigurationContent

Возвращаемое значение

Promise<ResultWithHttpResponse<any>>

applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)

Применение заданной конфигурации к устройству на Центр Интернета вещей

function applyConfigurationContentOnDevice(deviceId: string, content: ConfigurationContent, done?: HttpResponseCallback<any>)

Параметры

deviceId: string

Идентификатор устройства для применения конфигурации

content: ConfigurationContent

Применяемая конфигурация

done: HttpResponseCallback<any>

Необязательная функция, вызываемая после завершения операции. done будет вызываться с тремя аргументами: объект Error (может иметь значение NULL), текст ответа и объект ответа, зависящий от транспорта, полезный для ведения журнала или отладки.

cancelJob(string)

function cancelJob(jobId: string): Promise<JobStatus>

Параметры

jobId: string

Возвращаемое значение

Promise<JobStatus>

cancelJob(string, Callback<JobStatus>)

Отмена задания массового импорта и экспорта.

function cancelJob(jobId: string, done?: Callback<JobStatus>)

Параметры

jobId: string

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

done: Callback<JobStatus>

Необязательная функция для вызова с двумя аргументами: объект ошибки, если произошла ошибка, (в противном случае — null) и состояние (отменено) задания, идентификатор которого был передан в качестве аргумента.

create(DeviceDescription)

function create(deviceInfo: DeviceDescription): Promise<ResultWithHttpResponse<Device>>

Параметры

deviceInfo: DeviceDescription

Возвращаемое значение

Promise<ResultWithHttpResponse<Device>>

create(DeviceDescription, HttpResponseCallback<Device>)

Создает новое удостоверение устройства в Центре Интернета вещей.

function create(deviceInfo: DeviceDescription, done?: HttpResponseCallback<Device>)

Параметры

deviceInfo: DeviceDescription

Объект должен содержать deviceId свойство с допустимым идентификатором устройства.

done: HttpResponseCallback<Device>

Необязательная функция, вызываемая после завершения операции. done будет вызываться с тремя аргументами: объект Error (может иметь значение NULL), объект Device , представляющий созданное удостоверение устройства, и объект ответа для транспорта, полезный для ведения журнала или отладки.

createQuery(string, number)

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

function createQuery(sqlQuery: string, pageSize?: number): Query

Параметры

sqlQuery: string

Запрос, написанный в виде строки SQL.

pageSize: number

Требуемое количество результатов на странице (необязательно. По умолчанию: 1000, максимум: 10000).

Возвращаемое значение

Query

delete(string)

function delete(deviceId: string): Promise<ResultWithHttpResponse<any>>

Параметры

deviceId: string

Возвращаемое значение

Promise<ResultWithHttpResponse<any>>

delete(string, HttpResponseCallback<any>)

Удаляет существующее удостоверение устройства из Центра Интернета вещей.

function delete(deviceId: string, done?: HttpResponseCallback<any>)

Параметры

deviceId: string

Идентификатор существующего удостоверения устройства.

done: HttpResponseCallback<any>

Необязательная функция, вызываемая после завершения операции. done будет вызываться с тремя аргументами: объект Error (может иметь значение NULL), аргумент always-NULL (для согласованности с другими методами) и объект ответа для транспорта, полезный для ведения журнала или отладки.

exportDevicesToBlob(string, boolean)

function exportDevicesToBlob(outputBlobContainerUri: string, excludeKeys: boolean): Promise<JobStatus>

Параметры

outputBlobContainerUri: string

excludeKeys: boolean

Возвращаемое значение

Promise<JobStatus>

exportDevicesToBlob(string, boolean, Callback<JobStatus>)

Экспорт устройств в большой двоичный объект в массовом задании.

function exportDevicesToBlob(outputBlobContainerUri: string, excludeKeys: boolean, done?: Callback<JobStatus>)

Параметры

outputBlobContainerUri: string

Универсальный код ресурса (URI) контейнера, в котором будет создан большой двоичный объект с именем "devices.txt", содержащий список устройств.

excludeKeys: boolean

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

done: Callback<JobStatus>

Необязательная функция, вызываемая при создании задания, с двумя аргументами: объект ошибки при возникновении ошибки (в противном случае — null) и состояние задания, которое можно использовать для отслеживания хода экспорта устройств.

exportDevicesToBlobByIdentity(string, boolean)

function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean): Promise<JobStatus>

Параметры

outputBlobContainerUri: string

excludeKeys: boolean

Возвращаемое значение

Promise<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)

Экспорт устройств в большой двоичный объект в массовом задании с помощью настроенного удостоверения.

function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean, done?: Callback<JobStatus>)

Параметры

outputBlobContainerUri: string

excludeKeys: boolean

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

done: Callback<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, string)

function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean, userAssignedIdentity: string): Promise<JobStatus>

Параметры

outputBlobContainerUri: string

excludeKeys: boolean

userAssignedIdentity: string

Возвращаемое значение

Promise<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)

function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean, userAssignedIdentity: string, done: Callback<JobStatus>)

Параметры

outputBlobContainerUri: string

excludeKeys: boolean

userAssignedIdentity: string

done: Callback<JobStatus>

fromConnectionString(string)

Создает объект Registry из заданной строки подключения.

static function fromConnectionString(value: string): Registry

Параметры

value: string

Строка подключения, которая инкапсулирует соответствующие разрешения реестра (на чтение и запись).

Возвращаемое значение

Registry

fromSharedAccessSignature(string)

Создает объект Реестра на основе заданной подписанной URL-адреса.

static function fromSharedAccessSignature(value: string): Registry

Параметры

value: string

Подписанный URL-адрес, который инкапсулирует соответствующие разрешения реестра (на чтение и запись).

Возвращаемое значение

Registry

fromTokenCredential(string, TokenCredential)

Создает объект Реестра из заданного объекта Azure TokenCredential.

static function fromTokenCredential(hostName: string, tokenCredential: TokenCredential): Registry

Параметры

hostName: string

Имя узла службы Azure.

tokenCredential: TokenCredential

Azure TokenCredential, используемый для проверки подлинности в службе Azure.

Возвращаемое значение

Registry

get(string)

function get(deviceId: string): Promise<ResultWithHttpResponse<Device>>

Параметры

deviceId: string

Возвращаемое значение

Promise<ResultWithHttpResponse<Device>>

get(string, HttpResponseCallback<Device>)

Запрашивает сведения о существующем удостоверении устройства в Центре Интернета вещей.

function get(deviceId: string, done?: HttpResponseCallback<Device>)

Параметры

deviceId: string

Идентификатор существующего удостоверения устройства.

done: HttpResponseCallback<Device>

getConfiguration(string)

function getConfiguration(configurationId: string): Promise<ResultWithHttpResponse<Configuration>>

Параметры

configurationId: string

Возвращаемое значение

Promise<ResultWithHttpResponse<Configuration>>

getConfiguration(string, HttpResponseCallback<Configuration>)

Получение одной конфигурации из Центр Интернета вещей

function getConfiguration(configurationId: string, done?: HttpResponseCallback<Configuration>)

Параметры

configurationId: string

Идентификатор извлекаемой конфигурации.

done: HttpResponseCallback<Configuration>

Необязательный обратный вызов, который будет вызываться с помощью объекта Error или module:azure-iothub. Объект конфигурации со сведениями о конфигурации.

getConfigurations()

function getConfigurations(): Promise<ResultWithHttpResponse<Configuration[]>>

Возвращаемое значение

Promise<ResultWithHttpResponse<Configuration[]>>

getConfigurations(HttpResponseCallback<Configuration[]>)

Получение всех конфигураций в Центр Интернета вещей

function getConfigurations(done?: HttpResponseCallback<Configuration[]>)

Параметры

done: HttpResponseCallback<Configuration[]>

Необязательный обратный вызов, который будет вызываться с помощью объекта Error или массива module:azure-iothub. Объекты конфигурации для всех конфигураций.

getJob(string)

function getJob(jobId: string): Promise<JobStatus>

Параметры

jobId: string

Возвращаемое значение

Promise<JobStatus>

getJob(string, Callback<JobStatus>)

Получение состояния задания массового импорта и экспорта.

function getJob(jobId: string, done?: Callback<JobStatus>)

Параметры

jobId: string

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

done: Callback<JobStatus>

Необязательная функция для вызова с двумя аргументами: объект ошибки, если произошла ошибка, (в противном случае — null) и состояние задания, идентификатор которого был передан в качестве аргумента.

getModule(string, string)

function getModule(deviceId: string, moduleId: string): Promise<ResultWithHttpResponse<Module>>

Параметры

deviceId: string

moduleId: string

Возвращаемое значение

Promise<ResultWithHttpResponse<Module>>

getModule(string, string, HttpResponseCallback<Module>)

Получение одного модуля с устройства на Центр Интернета вещей

function getModule(deviceId: string, moduleId: string, done?: HttpResponseCallback<Module>)

Параметры

deviceId: string

Идентификатор устройства, которому принадлежит модуль.

moduleId: string

Идентификатор модуля для извлечения

done: HttpResponseCallback<Module>

Необязательный обратный вызов, который будет вызываться с помощью объекта Error или module:azure-iothub. Объект module для запрошенного модуля

getModulesOnDevice(string)

function getModulesOnDevice(deviceId: string): Promise<ResultWithHttpResponse<Module[]>>

Параметры

deviceId: string

Возвращаемое значение

Promise<ResultWithHttpResponse<Module[]>>

getModulesOnDevice(string, HttpResponseCallback<Module[]>)

Получение списка всех модулей на устройстве Центр Интернета вещей

function getModulesOnDevice(deviceId: string, done?: HttpResponseCallback<Module[]>)

Параметры

deviceId: string

Идентификатор устройства, для который мы получаем модули

done: HttpResponseCallback<Module[]>

Необязательный обратный вызов, который будет вызываться с помощью объекта Error или массива module:azure-iothub. Объекты модуля для всех модулей.

getModuleTwin(string, string)

function getModuleTwin(deviceId: string, moduleId: string): Promise<ResultWithHttpResponse<Twin>>

Параметры

deviceId: string

moduleId: string

Возвращаемое значение

Promise<ResultWithHttpResponse<Twin>>

getModuleTwin(string, string, HttpResponseCallback<Twin>)

Возвращает двойник модуля с указанным идентификатором модуля.

function getModuleTwin(deviceId: string, moduleId: string, done?: HttpResponseCallback<Twin>)

Параметры

deviceId: string

Идентификатор устройства.

moduleId: string

Идентификатор модуля.

done: HttpResponseCallback<Twin>

Необязательный обратный вызов, который будет вызываться с помощью объекта Error или экземпляра двойника модуля.

getRegistryStatistics()

function getRegistryStatistics(): Promise<ResultWithHttpResponse<RegistryStatistics>>

Возвращаемое значение

Promise<ResultWithHttpResponse<RegistryStatistics>>

getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)

Возвращает статистику об устройствах в реестре удостоверений устройств.

function getRegistryStatistics(done?: HttpResponseCallback<RegistryStatistics>)

Параметры

done: HttpResponseCallback<RegistryStatistics>

Необязательный обратный вызов, который будет вызываться с помощью объекта Error или статистики реестра устройств.

getTwin(string)

function getTwin(deviceId: string): Promise<ResultWithHttpResponse<Twin>>

Параметры

deviceId: string

Возвращаемое значение

Promise<ResultWithHttpResponse<Twin>>

getTwin(string, HttpResponseCallback<Twin>)

Возвращает двойник устройства с указанным идентификатором устройства.

function getTwin(deviceId: string, done?: HttpResponseCallback<Twin>)

Параметры

deviceId: string

Идентификатор устройства.

done: HttpResponseCallback<Twin>

Необязательный обратный вызов, который будет вызываться с помощью объекта Error или экземпляра двойника устройства.

importDevicesFromBlob(string, string)

function importDevicesFromBlob(inputBlobContainerUri: string, outputBlobContainerUri: string): Promise<JobStatus>

Параметры

inputBlobContainerUri: string

outputBlobContainerUri: string

Возвращаемое значение

Promise<JobStatus>

importDevicesFromBlob(string, string, Callback<JobStatus>)

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

function importDevicesFromBlob(inputBlobContainerUri: string, outputBlobContainerUri: string, done?: Callback<JobStatus>)

Параметры

inputBlobContainerUri: string

Универсальный код ресурса (URI) контейнера с большим двоичным объектом с именем "devices.txt", содержащим список импортируемых устройств.

outputBlobContainerUri: string

Универсальный код ресурса (URI) контейнера, в котором будет создан большой двоичный объект с журналами процесса импорта.

done: Callback<JobStatus>

importDevicesFromBlobByIdentity(string, string)

function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string): Promise<JobStatus>

Параметры

inputBlobContainerUri: string

outputBlobContainerUri: string

Возвращаемое значение

Promise<JobStatus>

importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)

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

function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string, done?: Callback<JobStatus>)

Параметры

inputBlobContainerUri: string

outputBlobContainerUri: string

done: Callback<JobStatus>

importDevicesFromBlobByIdentity(string, string, string)

function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string, userAssignedIdentity: string): Promise<JobStatus>

Параметры

inputBlobContainerUri: string

outputBlobContainerUri: string

userAssignedIdentity: string

Возвращаемое значение

Promise<JobStatus>

importDevicesFromBlobByIdentity(string, string, string, Callback<JobStatus>)

function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string, userAssignedIdentity: string, done: Callback<JobStatus>)

Параметры

inputBlobContainerUri: string

outputBlobContainerUri: string

userAssignedIdentity: string

done: Callback<JobStatus>

list()

function list(): Promise<ResultWithHttpResponse<Device[]>>

Возвращаемое значение

Promise<ResultWithHttpResponse<Device[]>>

list(HttpResponseCallback<Device[]>)

Запрашивает сведения о первых 1000 удостоверениях устройств в Центре Интернета вещей.

function list(done?: HttpResponseCallback<Device[]>)

Параметры

done: HttpResponseCallback<Device[]>

Необязательная функция, вызываемая после завершения операции. done будет вызываться с тремя аргументами: объект Error (может иметь значение NULL), массив объектов Device , представляющих перечисленные удостоверения устройств, и объект ответа для транспорта, полезный для ведения журнала или отладки.

listJobs()

function listJobs(): Promise<ResultWithHttpResponse<any>>

Возвращаемое значение

Promise<ResultWithHttpResponse<any>>

listJobs(HttpResponseCallback<any>)

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

function listJobs(done?: HttpResponseCallback<any>)

Параметры

done: HttpResponseCallback<any>

Необязательная функция для вызова с двумя аргументами: объект ошибки, если произошла ошибка, (в противном случае — null) и список прошлых заданий в качестве аргумента.

removeConfiguration(string)

function removeConfiguration(configurationId: string): Promise<ResultWithHttpResponse<any>>

Параметры

configurationId: string

Возвращаемое значение

Promise<ResultWithHttpResponse<any>>

removeConfiguration(string, HttpResponseCallback<any>)

Удаление конфигурации с указанным идентификатором из Центр Интернета вещей

function removeConfiguration(configurationId: string, done?: HttpResponseCallback<any>)

Параметры

configurationId: string

Идентификатор удаляемой конфигурации

done: HttpResponseCallback<any>

removeDevices(DeviceDescription[], boolean)

function removeDevices(devices: DeviceDescription[], forceRemove: boolean): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

Параметры

devices: DeviceDescription[]

forceRemove: boolean

Возвращаемое значение

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

removeDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)

Обновления массив устройств.

function removeDevices(devices: DeviceDescription[], forceRemove: boolean, done?: HttpResponseCallback<BulkRegistryOperationResult>)

Параметры

devices: DeviceDescription[]

forceRemove: boolean

Если forceRemove имеет значение true, устройство будет удалено независимо от etag. В противном случае etags должны совпадать.

done: HttpResponseCallback<BulkRegistryOperationResult>

Необязательная функция, вызываемая после завершения операции. done будет вызываться с тремя аргументами: объект Error (может иметь значение NULL), BulkRegistryOperationResult и объект ответа для транспорта, полезный для ведения журнала или отладки.

removeModule(Module, TripleValueCallback<any, any>)

Удаление заданного модуля из реестра

function removeModule(module: Module, done?: TripleValueCallback<any, any>)

Параметры

module: Module

done: TripleValueCallback<any, any>

removeModule(string | Module)

function removeModule(moduleOrDeviceId: string | Module): Promise<ResultWithHttpResponse<any>>

Параметры

moduleOrDeviceId: string | Module

Возвращаемое значение

Promise<ResultWithHttpResponse<any>>

removeModule(string | Module, string)

function removeModule(moduleOrDeviceId: string | Module, moduleId: string): Promise<ResultWithHttpResponse<any>>

Параметры

moduleOrDeviceId: string | Module

moduleId: string

Возвращаемое значение

Promise<ResultWithHttpResponse<any>>

removeModule(string, string, TripleValueCallback<any, any>)

function removeModule(deviceId: string, moduleId: string, done: TripleValueCallback<any, any>)

Параметры

deviceId: string

moduleId: string

done: TripleValueCallback<any, any>

update(DeviceDescription)

function update(deviceInfo: DeviceDescription): Promise<ResultWithHttpResponse<Device>>

Параметры

deviceInfo: DeviceDescription

Возвращаемое значение

Promise<ResultWithHttpResponse<Device>>

update(DeviceDescription, HttpResponseCallback<Device>)

Обновления существующее удостоверение устройства в Центре Интернета вещей с указанными сведениями об устройстве. Параметр deviceInfo должен включать все обновляемые свойства. Например, при обновлении status свойства с disabled до enabledобъект deviceInfo также должен иметь состояниеReason, проверка подлинности (и его вложенные свойства), возможности и deviceScope должны быть заданы для текущих значений устройств, иначе эти свойства будут сброшены. Прежде чем выполнять обновление, рекомендуется вызвать API get.

function update(deviceInfo: DeviceDescription, done?: HttpResponseCallback<Device>)

Параметры

deviceInfo: DeviceDescription

Объект , который должен содержать deviceId свойство, значение которого является допустимым идентификатором устройства.

done: HttpResponseCallback<Device>

Необязательная функция, вызываемая после завершения операции. done будет вызываться с тремя аргументами: объект Error (может иметь значение NULL), объект Device , представляющий обновленное удостоверение устройства, и объект ответа для транспорта, полезный для ведения журнала или отладки.

updateConfiguration(Configuration)

function updateConfiguration(configuration: Configuration): Promise<ResultWithHttpResponse<any>>

Параметры

configuration: Configuration

Возвращаемое значение

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean)

function updateConfiguration(configuration: Configuration, forceUpdate: boolean): Promise<ResultWithHttpResponse<any>>

Параметры

configuration: Configuration

forceUpdate: boolean

Возвращаемое значение

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)

function updateConfiguration(configuration: Configuration, forceUpdate: boolean, done: HttpResponseCallback<any>)

Параметры

configuration: Configuration

forceUpdate: boolean

done: HttpResponseCallback<any>

updateConfiguration(Configuration, HttpResponseCallback<any>)

Обновление конфигурации в Центре Интернета вещей

function updateConfiguration(configuration: Configuration, done?: HttpResponseCallback<any>)

Параметры

configuration: Configuration

Объект типа module:azure-iothub. Конфигурация для добавления в концентратор

done: HttpResponseCallback<any>

updateDevices(DeviceDescription[], boolean)

function updateDevices(devices: DeviceDescription[], forceUpdate: boolean): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

Параметры

devices: DeviceDescription[]

forceUpdate: boolean

Возвращаемое значение

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

updateDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)

Обновления массив устройств. Отдельные элементы devices параметра должны включать все обновляемые свойства. Например, при обновлении status свойства с disabled на enabledобъект также должен иметь состояниеReason, проверка подлинности (и его вложенные свойства), возможности и deviceScope, заданные для текущих значений устройств, иначе эти свойства будут сброшены. Перед обновлением рекомендуется сначала вызвать API get.

function updateDevices(devices: DeviceDescription[], forceUpdate: boolean, done?: HttpResponseCallback<BulkRegistryOperationResult>)

Параметры

devices: DeviceDescription[]

forceUpdate: boolean

Если forceUpdate имеет значение true, устройство будет обновлено независимо от etag. В противном случае etags должны совпадать.

done: HttpResponseCallback<BulkRegistryOperationResult>

updateModule(Module)

function updateModule(module: Module): Promise<ResultWithHttpResponse<any>>

Параметры

module: Module

Возвращаемое значение

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean)

function updateModule(module: Module, forceUpdate: boolean): Promise<ResultWithHttpResponse<any>>

Параметры

module: Module

forceUpdate: boolean

Возвращаемое значение

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean, HttpResponseCallback<any>)

function updateModule(module: Module, forceUpdate: boolean, done: HttpResponseCallback<any>)

Параметры

module: Module

forceUpdate: boolean

done: HttpResponseCallback<any>

updateModule(Module, TripleValueCallback<any, any>)

Обновление заданного объекта модуля в реестре

function updateModule(module: Module, done?: TripleValueCallback<any, any>)

Параметры

module: Module

Объект модуля для обновления.

done: TripleValueCallback<any, any>

updateModuleTwin(string, string, any, string)

function updateModuleTwin(deviceId: string, moduleId: string, patch: any, etag: string): Promise<ResultWithHttpResponse<Twin>>

Параметры

deviceId: string

moduleId: string

patch: any

etag: string

Возвращаемое значение

Promise<ResultWithHttpResponse<Twin>>

updateModuleTwin(string, string, any, string, HttpResponseCallback<Twin>)

Обновления двойник определенного модуля с заданным исправлением.

function updateModuleTwin(deviceId: string, moduleId: string, patch: any, etag: string, done?: HttpResponseCallback<Twin>)

Параметры

deviceId: string

Идентификатор устройства.

moduleId: string

Идентификатор модуля

patch: any

Требуемые свойства и теги для исправления двойника модуля.

etag: string

Последний etag для этого двойника модуля или "*" для принудительного обновления, даже если двойник модуля был обновлен с момента получения etag.

done: HttpResponseCallback<Twin>

updateTwin(string, any, string)

function updateTwin(deviceId: string, patch: any, etag: string): Promise<ResultWithHttpResponse<Twin>>

Параметры

deviceId: string

patch: any

etag: string

Возвращаемое значение

Promise<ResultWithHttpResponse<Twin>>

updateTwin(string, any, string, HttpResponseCallback<Twin>)

Обновления двойник устройства определенного устройства с заданным исправлением.

function updateTwin(deviceId: string, patch: any, etag: string, done?: HttpResponseCallback<Twin>)

Параметры

deviceId: string

Идентификатор устройства.

patch: any

Требуемые свойства и теги для исправления двойника устройства.

etag: string

Последний etag для этого двойника устройства или "*" для принудительного обновления, даже если двойник устройства был обновлен с момента получения etag.

done: HttpResponseCallback<Twin>