Registry class

Pakiet:

azure-iothub

Klasa Registry zapewnia dostęp do usługi tożsamości urządzeń IoT Hub. Użytkownicy zestawu SDK powinni utworzyć wystąpienie tej klasy przy użyciu jednej z metod fabrycznych: fromConnectionString lub fromSharedAccessSignature.

Protokół używany do operacji rejestru tożsamości urządzeń to HTTPS.

Metody

addConfiguration(Configuration)
addConfiguration(Configuration, HttpResponseCallback<any>)	Dodaj konfigurację do centrum IoT.
addDevices(DeviceDescription[])
addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)	Dodaje tablicę urządzeń.
addModule(Module)
addModule(Module, HttpResponseCallback<any>)	Dodaj dany moduł do rejestru.
applyConfigurationContentOnDevice(string, ConfigurationContent)
applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)	Stosowanie danej konfiguracji do urządzenia na IoT Hub
cancelJob(string)
cancelJob(string, Callback<JobStatus>)	Anuluj zadanie importowania/eksportowania zbiorczego.
create(DeviceDescription)
create(DeviceDescription, HttpResponseCallback<Device>)	Tworzy nową tożsamość urządzenia w centrum IoT Hub.
createQuery(string, number)	Tworzy zapytanie, które można uruchomić w wystąpieniu IoT Hub, aby znaleźć informacje o urządzeniach lub zadaniach.
delete(string)
delete(string, HttpResponseCallback<any>)	Usuwa istniejącą tożsamość urządzenia z centrum IoT Hub.
exportDevicesToBlob(string, boolean)
exportDevicesToBlob(string, boolean, Callback<JobStatus>)	Eksportowanie urządzeń do obiektu blob w zadaniu zbiorczym.
exportDevicesToBlobByIdentity(string, boolean)
exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)	Eksportowanie urządzeń do obiektu blob w zadaniu zbiorczym przy użyciu skonfigurowanej tożsamości.
exportDevicesToBlobByIdentity(string, boolean, string)
exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)
fromConnectionString(string)	Tworzy obiekt rejestru z podanych parametrów połączenia.
fromSharedAccessSignature(string)	Tworzy obiekt rejestru z danego sygnatury dostępu współdzielonego.
fromTokenCredential(string, TokenCredential)	Tworzy obiekt Rejestru z danego obiektu Azure TokenCredential.
get(string)
get(string, HttpResponseCallback<Device>)	Żąda informacji o istniejącej tożsamości urządzenia w centrum IoT.
getConfiguration(string)
getConfiguration(string, HttpResponseCallback<Configuration>)	Pobieranie pojedynczej konfiguracji z IoT Hub
getConfigurations()
getConfigurations(HttpResponseCallback<Configuration[]>)	Pobieranie wszystkich konfiguracji w IoT Hub
getJob(string)
getJob(string, Callback<JobStatus>)	Pobierz stan zadania importu/eksportu zbiorczego.
getModule(string, string)
getModule(string, string, HttpResponseCallback<Module>)	Pobieranie pojedynczego modułu z urządzenia na IoT Hub
getModulesOnDevice(string)
getModulesOnDevice(string, HttpResponseCallback<Module[]>)	Pobieranie listy wszystkich modułów na urządzeniu IoT Hub
getModuleTwin(string, string)
getModuleTwin(string, string, HttpResponseCallback<Twin>)	Pobiera bliźniaczą reprezentację modułu z określonym identyfikatorem modułu.
getRegistryStatistics()
getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)	Pobiera statystyki dotyczące urządzeń w rejestrze tożsamości urządzeń.
getTwin(string)
getTwin(string, HttpResponseCallback<Twin>)	Pobiera bliźniaczą reprezentację urządzenia z określonym identyfikatorem urządzenia.
importDevicesFromBlob(string, string)
importDevicesFromBlob(string, string, Callback<JobStatus>)	Importuje urządzenia z obiektu blob w zadaniu zbiorczym.
importDevicesFromBlobByIdentity(string, string)
importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)	Importuje urządzenia z obiektu blob w zadaniu zbiorczym przy użyciu skonfigurowanej tożsamości.
importDevicesFromBlobByIdentity(string, string, string)
importDevicesFromBlobByIdentity(string, string, string, Callback<JobStatus>)
list()
list(HttpResponseCallback<Device[]>)	Żąda informacji o pierwszych 1000 tożsamościach urządzeń w centrum IoT.
listJobs()
listJobs(HttpResponseCallback<any>)	Wyświetl listę ostatnich zadań importu/eksportu (w tym aktywnych, jeśli istnieje).
removeConfiguration(string)
removeConfiguration(string, HttpResponseCallback<any>)	Usuwanie konfiguracji z danym identyfikatorem z IoT Hub
removeDevices(DeviceDescription[], boolean)
removeDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	Aktualizacje tablicę urządzeń.
removeModule(Module, TripleValueCallback<any, any>)	Usuń dany moduł z rejestru
removeModule(string | Module)
removeModule(string | Module, string)
removeModule(string, string, TripleValueCallback<any, any>)
update(DeviceDescription)
update(DeviceDescription, HttpResponseCallback<Device>)	Aktualizacje istniejącą tożsamość urządzenia w centrum IoT z podanymi informacjami o urządzeniu. Parametr deviceInfo musi zawierać wszystkie właściwości, które można aktualizować. Jeśli na przykład aktualizacja status właściwości z disabled do enabled, deviceInfo obiekt powinien mieć również stanReason, uwierzytelnianie (i jego właściwości podrzędne), możliwości i deviceScope ustawione na bieżące wartości urządzeń lub te właściwości zostaną zresetowane. Zaleca się, aby przed wykonaniem aktualizacji wywołać interfejs API get.
updateConfiguration(Configuration)
updateConfiguration(Configuration, boolean)
updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)
updateConfiguration(Configuration, HttpResponseCallback<any>)	Aktualizowanie konfiguracji w centrum IoT
updateDevices(DeviceDescription[], boolean)
updateDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	Aktualizacje tablicę urządzeń. Poszczególne elementy parametru devices muszą zawierać wszystkie właściwości, które można aktualizować. Jeśli na przykład zaktualizujesz status właściwość z disabled do enabled, obiekt powinien mieć również stanReason, uwierzytelnianie (i jego właściwości podrzędne), możliwości i urządzenieScope ustawione na bieżące wartości urządzeń lub te właściwości zostaną zresetowane. Przed wykonaniem aktualizacji zaleca się wywołanie interfejsu API get.
updateModule(Module)
updateModule(Module, boolean)
updateModule(Module, boolean, HttpResponseCallback<any>)
updateModule(Module, TripleValueCallback<any, any>)	Aktualizowanie danego obiektu modułu w rejestrze
updateModuleTwin(string, string, any, string)
updateModuleTwin(string, string, any, string, HttpResponseCallback<Twin>)	Aktualizacje bliźniaczego modułu z daną poprawką.
updateTwin(string, any, string)
updateTwin(string, any, string, HttpResponseCallback<Twin>)	Aktualizacje bliźniaczej reprezentacji urządzenia z daną poprawką.

Szczegóły metody

addConfiguration(Configuration)

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

Parametry

configuration

Configuration

Zwraca

Promise<ResultWithHttpResponse<any>>

addConfiguration(Configuration, HttpResponseCallback<any>)

Dodaj konfigurację do centrum IoT.

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

Parametry

configuration

Configuration

Obiekt typu module:azure-iothub. Konfiguracja dodawania do centrum

done

HttpResponseCallback<any>

Opcjonalna funkcja wywoływana po zakończeniu operacji. done będzie wywoływana z trzema argumentami: obiekt Error (może mieć wartość null), treść odpowiedzi i obiekt odpowiedzi specyficzny dla transportu przydatny do rejestrowania lub debugowania.

addDevices(DeviceDescription[])

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

Parametry

devices

DeviceDescription[]

Zwraca

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)

Dodaje tablicę urządzeń.

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

Parametry

devices

DeviceDescription[]

Tablica obiektów, które muszą zawierać deviceId właściwość, której wartość jest prawidłowym identyfikatorem urządzenia.

done

HttpResponseCallback<BulkRegistryOperationResult>

Opcjonalna funkcja wywoływana po zakończeniu operacji. done będzie wywoływana z trzema argumentami: obiekt Error (może mieć wartość null), BulkRegistryOperationResult i obiekt odpowiedzi specyficzny dla transportu przydatny do rejestrowania lub debugowania.

addModule(Module)

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

Parametry

module

Module

Zwraca

Promise<ResultWithHttpResponse<any>>

addModule(Module, HttpResponseCallback<any>)

Dodaj dany moduł do rejestru.

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

Parametry

module

Module

Obiekt modułu, który ma zostać dodany do rejestru.

done

HttpResponseCallback<any>

Opcjonalna funkcja wywoływana po zakończeniu operacji. done będzie wywoływana z trzema argumentami: obiekt Error (może mieć wartość null), treść odpowiedzi i obiekt odpowiedzi specyficzny dla transportu przydatny do rejestrowania lub debugowania.

applyConfigurationContentOnDevice(string, ConfigurationContent)

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

Parametry

deviceId

string

content

ConfigurationContent

Zwraca

Promise<ResultWithHttpResponse<any>>

applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)

Stosowanie danej konfiguracji do urządzenia na IoT Hub

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

Parametry

deviceId

string

Identyfikator urządzenia, do których ma być zastosowana konfiguracja

content

ConfigurationContent

Konfiguracja do zastosowania

done

HttpResponseCallback<any>

Opcjonalna funkcja wywoływana po zakończeniu operacji. done element zostanie wywołany z trzema argumentami: obiekt Error (może mieć wartość null), treść odpowiedzi i obiekt odpowiedzi specyficzny dla transportu przydatny do rejestrowania lub debugowania.

cancelJob(string)

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

Parametry

jobId

string

Zwraca

Promise<JobStatus>

cancelJob(string, Callback<JobStatus>)

Anuluj zadanie importowania/eksportowania zbiorczego.

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

Parametry

jobId

string

Identyfikator zadania, dla którego użytkownik chce uzyskać informacje o stanie.

done

Callback<JobStatus>

Opcjonalna funkcja wywoływana z dwoma argumentami: obiekt błędu, jeśli wystąpił błąd (w przeciwnym razie ma wartość null) i (anulowany) stan zadania, którego identyfikator został przekazany jako argument.

create(DeviceDescription)

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

Parametry

deviceInfo

DeviceDescription

Zwraca

Promise<ResultWithHttpResponse<Device>>

create(DeviceDescription, HttpResponseCallback<Device>)

Tworzy nową tożsamość urządzenia w centrum IoT Hub.

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

Parametry

deviceInfo

DeviceDescription

Obiekt musi zawierać deviceId właściwość z prawidłowym identyfikatorem urządzenia.

done

HttpResponseCallback<Device>

Opcjonalna funkcja wywoływana po zakończeniu operacji. done element zostanie wywołany z trzema argumentami: obiekt Błędu (może mieć wartość null), obiekt Urządzenia reprezentujący utworzoną tożsamość urządzenia oraz obiekt odpowiedzi specyficzny dla transportu przydatny do rejestrowania lub debugowania.

createQuery(string, number)

Tworzy zapytanie, które można uruchomić w wystąpieniu IoT Hub, aby znaleźć informacje o urządzeniach lub zadaniach.

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

Parametry

sqlQuery

string

Zapytanie napisane jako ciąg SQL.

pageSize

number

Żądana liczba wyników na stronę (opcjonalnie. wartość domyślna: 1000, wartość maksymalna: 10000).

Zwraca

Query

delete(string)

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

Parametry

deviceId

string

Zwraca

Promise<ResultWithHttpResponse<any>>

delete(string, HttpResponseCallback<any>)

Usuwa istniejącą tożsamość urządzenia z centrum IoT Hub.

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

Parametry

deviceId

string

Identyfikator istniejącej tożsamości urządzenia.

done

HttpResponseCallback<any>

Opcjonalna funkcja wywoływana po zakończeniu operacji. done element będzie wywoływany z trzema argumentami: obiekt Error (może mieć wartość null), argument always-null (w celu zachowania spójności z innymi metodami) oraz obiekt odpowiedzi specyficzny dla transportu przydatny do rejestrowania lub debugowania.

exportDevicesToBlob(string, boolean)

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

Parametry

outputBlobContainerUri

string

excludeKeys

boolean

Zwraca

Promise<JobStatus>

exportDevicesToBlob(string, boolean, Callback<JobStatus>)

Eksportowanie urządzeń do obiektu blob w zadaniu zbiorczym.

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

Parametry

outputBlobContainerUri

string

Identyfikator URI kontenera, w którym zostanie utworzony obiekt blob o nazwie "devices.txt" zawierający listę urządzeń.

excludeKeys

boolean

Wartość logiczna wskazująca, czy klucze zabezpieczeń powinny być wykluczone z wyeksportowanych danych.

done

Callback<JobStatus>

Opcjonalna funkcja wywoływana podczas tworzenia zadania z dwoma argumentami: obiekt błędu, jeśli wystąpił błąd (w przeciwnym razie ma wartość null) i stan zadania, którego można użyć do śledzenia postępu eksportowania urządzeń.

exportDevicesToBlobByIdentity(string, boolean)

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

Parametry

outputBlobContainerUri

string

excludeKeys

boolean

Zwraca

Promise<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)

Eksportowanie urządzeń do obiektu blob w zadaniu zbiorczym przy użyciu skonfigurowanej tożsamości.

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

Parametry

outputBlobContainerUri

string

Identyfikator URI kontenera, w którym zostanie utworzony obiekt blob o nazwie "devices.txt" zawierający listę urządzeń.

excludeKeys

boolean

Wartość logiczna wskazująca, czy klucze zabezpieczeń powinny być wykluczone z wyeksportowanych danych.

done

Callback<JobStatus>

Opcjonalna funkcja wywoływana podczas tworzenia zadania z dwoma argumentami: obiekt błędu, jeśli wystąpił błąd (w przeciwnym razie ma wartość null) i stan zadania, którego można użyć do śledzenia postępu eksportowania urządzeń.

exportDevicesToBlobByIdentity(string, boolean, string)

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

Parametry

outputBlobContainerUri

string

excludeKeys

boolean

userAssignedIdentity

string

Zwraca

Promise<JobStatus>

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

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

Parametry

outputBlobContainerUri

string

excludeKeys

boolean

userAssignedIdentity

string

done

Callback<JobStatus>

fromConnectionString(string)

Tworzy obiekt rejestru z podanych parametrów połączenia.

static function fromConnectionString(value: string): Registry

Parametry

value

string

Parametry połączenia, które hermetyzują odpowiednie (odczyt i/lub zapis) uprawnienia rejestru.

Zwraca

Registry

fromSharedAccessSignature(string)

Tworzy obiekt rejestru z danego sygnatury dostępu współdzielonego.

static function fromSharedAccessSignature(value: string): Registry

Parametry

value

string

Sygnatura dostępu współdzielonego, która hermetyzuje odpowiednie (odczyt i/lub zapis) uprawnienia rejestru.

Zwraca

Registry

fromTokenCredential(string, TokenCredential)

Tworzy obiekt Rejestru z danego obiektu Azure TokenCredential.

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

Parametry

hostName

string

Nazwa hosta usługi platformy Azure.

tokenCredential

TokenCredential

Element Azure TokenCredential używany do uwierzytelniania w usłudze platformy Azure

Zwraca

Registry

get(string)

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

Parametry

deviceId

string

Zwraca

Promise<ResultWithHttpResponse<Device>>

get(string, HttpResponseCallback<Device>)

Żąda informacji o istniejącej tożsamości urządzenia w centrum IoT.

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

Parametry

deviceId

string

Identyfikator istniejącej tożsamości urządzenia.

done

HttpResponseCallback<Device>

Opcjonalna funkcja wywoływana po zakończeniu operacji. done element zostanie wywołany z trzema argumentami: obiekt Błędu (może mieć wartość null), obiekt Urządzenia reprezentujący utworzoną tożsamość urządzenia oraz obiekt odpowiedzi specyficzny dla transportu przydatny do rejestrowania lub debugowania.

getConfiguration(string)

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

Parametry

configurationId

string

Zwraca

Promise<ResultWithHttpResponse<Configuration>>

getConfiguration(string, HttpResponseCallback<Configuration>)

Pobieranie pojedynczej konfiguracji z IoT Hub

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

Parametry

configurationId

string

Identyfikator konfiguracji, z którą chcesz pobrać

done

HttpResponseCallback<Configuration>

Opcjonalne wywołanie zwrotne, które będzie wywoływane za pomocą obiektu Error lub module:azure-iothub. Obiekt konfiguracji ze szczegółami konfiguracji.

getConfigurations()

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

Zwraca

Promise<ResultWithHttpResponse<Configuration[]>>

getConfigurations(HttpResponseCallback<Configuration[]>)

Pobieranie wszystkich konfiguracji w IoT Hub

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

Parametry

done

HttpResponseCallback<Configuration[]>

Opcjonalne wywołanie zwrotne, które będzie wywoływane z obiektem Error lub tablicą module:azure-iothub. Obiekty konfiguracji dla wszystkich konfiguracji.

getJob(string)

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

Parametry

jobId

string

Zwraca

Promise<JobStatus>

getJob(string, Callback<JobStatus>)

Pobierz stan zadania importu/eksportu zbiorczego.

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

Parametry

jobId

string

Identyfikator zadania, dla którego użytkownik chce uzyskać informacje o stanie.

done

Callback<JobStatus>

Opcjonalna funkcja do wywołania z dwoma argumentami: obiekt błędu, jeśli wystąpił błąd (w przeciwnym razie wartość null) i stan zadania, którego identyfikator został przekazany jako argument.

getModule(string, string)

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

Parametry

deviceId

string

moduleId

string

Zwraca

Promise<ResultWithHttpResponse<Module>>

getModule(string, string, HttpResponseCallback<Module>)

Pobieranie pojedynczego modułu z urządzenia na IoT Hub

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

Parametry

deviceId

string

Identyfikator urządzenia, który jest właścicielem modułu.

moduleId

string

Identyfikator modułu do pobrania

done

HttpResponseCallback<Module>

Opcjonalne wywołanie zwrotne, które będzie wywoływane za pomocą obiektu Error lub module:azure-iothub. Obiekt modułu dla żądanego modułu

getModulesOnDevice(string)

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

Parametry

deviceId

string

Zwraca

Promise<ResultWithHttpResponse<Module[]>>

getModulesOnDevice(string, HttpResponseCallback<Module[]>)

Pobieranie listy wszystkich modułów na urządzeniu IoT Hub

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

Parametry

deviceId

string

Identyfikator urządzenia, dla których otrzymujemy moduły

done

HttpResponseCallback<Module[]>

Opcjonalne wywołanie zwrotne, które będzie wywoływane z obiektem Error lub tablicą module:azure-iothub. Obiekty modułu dla wszystkich modułów.

getModuleTwin(string, string)

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

Parametry

deviceId

string

moduleId

string

Zwraca

Promise<ResultWithHttpResponse<Twin>>

getModuleTwin(string, string, HttpResponseCallback<Twin>)

Pobiera bliźniaczą reprezentację modułu z określonym identyfikatorem modułu.

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

Parametry

deviceId

string

Identyfikator urządzenia.

moduleId

string

Identyfikator modułu.

done

HttpResponseCallback<Twin>

Opcjonalne wywołanie zwrotne, które będzie wywoływane z obiektem Error lub wystąpieniem bliźniaczej reprezentacji modułu.

getRegistryStatistics()

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

Zwraca

Promise<ResultWithHttpResponse<RegistryStatistics>>

getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)

Pobiera statystyki dotyczące urządzeń w rejestrze tożsamości urządzeń.

function getRegistryStatistics(done?: HttpResponseCallback<RegistryStatistics>)

Parametry

done

HttpResponseCallback<RegistryStatistics>

Opcjonalne wywołanie zwrotne, które będzie wywoływane z obiektem Błąd lub statystykami rejestru urządzeń.

getTwin(string)

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

Parametry

deviceId

string

Zwraca

Promise<ResultWithHttpResponse<Twin>>

getTwin(string, HttpResponseCallback<Twin>)

Pobiera bliźniaczą reprezentację urządzenia z określonym identyfikatorem urządzenia.

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

Parametry

deviceId

string

Identyfikator urządzenia.

done

HttpResponseCallback<Twin>

Opcjonalne wywołanie zwrotne, które będzie wywoływane z obiektem Error lub wystąpieniem bliźniaczej reprezentacji urządzenia.

importDevicesFromBlob(string, string)

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

Parametry

inputBlobContainerUri

string

outputBlobContainerUri

string

Zwraca

Promise<JobStatus>

importDevicesFromBlob(string, string, Callback<JobStatus>)

Importuje urządzenia z obiektu blob w zadaniu zbiorczym.

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

Parametry

inputBlobContainerUri

string

Identyfikator URI kontenera z obiektem blob o nazwie "devices.txt" zawierającym listę urządzeń do zaimportowania.

outputBlobContainerUri

string

Identyfikator URI do kontenera, w którym zostanie utworzony obiekt blob z dziennikami procesu importowania.

done

Callback<JobStatus>

Opcjonalna funkcja wywoływana podczas tworzenia zadania z dwoma argumentami: obiekt błędu, jeśli wystąpił błąd (w przeciwnym razie ma wartość null) i stan zadania, którego można użyć do śledzenia postępu importowania urządzeń.

importDevicesFromBlobByIdentity(string, string)

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

Parametry

inputBlobContainerUri

string

outputBlobContainerUri

string

Zwraca

Promise<JobStatus>

importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)

Importuje urządzenia z obiektu blob w zadaniu zbiorczym przy użyciu skonfigurowanej tożsamości.

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

Parametry

inputBlobContainerUri

string

Identyfikator URI kontenera z obiektem blob o nazwie "devices.txt" zawierającym listę urządzeń do zaimportowania.

outputBlobContainerUri

string

Identyfikator URI do kontenera, w którym zostanie utworzony obiekt blob z dziennikami procesu importowania.

done

Callback<JobStatus>

Opcjonalna funkcja wywoływana podczas tworzenia zadania z dwoma argumentami: obiekt błędu, jeśli wystąpił błąd (w przeciwnym razie ma wartość null) i stan zadania, którego można użyć do śledzenia postępu importowania urządzeń.

importDevicesFromBlobByIdentity(string, string, string)

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

Parametry

inputBlobContainerUri

string

outputBlobContainerUri

string

userAssignedIdentity

string

Zwraca

Promise<JobStatus>

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

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

Parametry

inputBlobContainerUri

string

outputBlobContainerUri

string

userAssignedIdentity

string

done

Callback<JobStatus>

list()

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

Zwraca

Promise<ResultWithHttpResponse<Device[]>>

list(HttpResponseCallback<Device[]>)

Żąda informacji o pierwszych 1000 tożsamościach urządzeń w centrum IoT.

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

Parametry

done

HttpResponseCallback<Device[]>

Opcjonalna funkcja wywoływana po zakończeniu operacji. done element zostanie wywołany z trzema argumentami: obiekt Błędu (może mieć wartość null), tablicę obiektów urządzenia reprezentujących wymienione tożsamości urządzeń oraz obiekt odpowiedzi specyficzny dla transportu przydatny do rejestrowania lub debugowania.

listJobs()

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

Zwraca

Promise<ResultWithHttpResponse<any>>

listJobs(HttpResponseCallback<any>)

Wyświetl listę ostatnich zadań importu/eksportu (w tym aktywnych, jeśli istnieje).

function listJobs(done?: HttpResponseCallback<any>)

Parametry

done

HttpResponseCallback<any>

Opcjonalna funkcja do wywołania z dwoma argumentami: obiekt błędu, jeśli wystąpił błąd (w przeciwnym razie wartość null) i lista przeszłych zadań jako argument.

removeConfiguration(string)

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

Parametry

configurationId

string

Zwraca

Promise<ResultWithHttpResponse<any>>

removeConfiguration(string, HttpResponseCallback<any>)

Usuwanie konfiguracji z danym identyfikatorem z IoT Hub

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

Parametry

configurationId

string

Identyfikator konfiguracji do usunięcia

done

HttpResponseCallback<any>

Opcjonalna funkcja wywoływana po zakończeniu operacji. done element zostanie wywołany z trzema argumentami: obiekt Error (może mieć wartość null), treść odpowiedzi i obiekt odpowiedzi specyficzny dla transportu przydatny do rejestrowania lub debugowania.

removeDevices(DeviceDescription[], boolean)

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

Parametry

devices

DeviceDescription[]

forceRemove

boolean

Zwraca

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

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

Aktualizacje tablicę urządzeń.

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

Parametry

devices

DeviceDescription[]

Tablica obiektów, które muszą zawierać deviceId właściwość, której wartość jest prawidłowym identyfikatorem urządzenia.

forceRemove

boolean

jeśli forceRemove ma wartość true, urządzenie zostanie usunięte niezależnie od elementu etag. W przeciwnym razie tagi etag muszą być zgodne.

done

HttpResponseCallback<BulkRegistryOperationResult>

Opcjonalna funkcja wywoływana po zakończeniu operacji. done element będzie wywoływany z trzema argumentami: obiekt Error (może mieć wartość null), BulkRegistryOperationResult i obiekt odpowiedzi specyficzny dla transportu przydatny do rejestrowania lub debugowania.

removeModule(Module, TripleValueCallback<any, any>)

Usuń dany moduł z rejestru

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

Parametry

module

Module

done

TripleValueCallback<any, any>

Opcjonalna funkcja wywoływana po zakończeniu operacji. done element zostanie wywołany z trzema argumentami: obiekt Error (może mieć wartość null), treść odpowiedzi i obiekt odpowiedzi specyficzny dla transportu przydatny do rejestrowania lub debugowania.

removeModule(string | Module)

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

Parametry

moduleOrDeviceId

string | Module

Zwraca

Promise<ResultWithHttpResponse<any>>

removeModule(string | Module, string)

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

Parametry

moduleOrDeviceId

string | Module

moduleId

string

Zwraca

Promise<ResultWithHttpResponse<any>>

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

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

Parametry

deviceId

string

moduleId

string

done

TripleValueCallback<any, any>

update(DeviceDescription)

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

Parametry

deviceInfo

DeviceDescription

Zwraca

Promise<ResultWithHttpResponse<Device>>

update(DeviceDescription, HttpResponseCallback<Device>)

Aktualizacje istniejącą tożsamość urządzenia w centrum IoT z podanymi informacjami o urządzeniu. Parametr deviceInfo musi zawierać wszystkie właściwości, które można aktualizować. Jeśli na przykład aktualizacja status właściwości z disabled do enabled, deviceInfo obiekt powinien mieć również stanReason, uwierzytelnianie (i jego właściwości podrzędne), możliwości i deviceScope ustawione na bieżące wartości urządzeń lub te właściwości zostaną zresetowane. Zaleca się, aby przed wykonaniem aktualizacji wywołać interfejs API get.

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

Parametry

deviceInfo

DeviceDescription

Obiekt, który musi zawierać deviceId właściwość, której wartość jest prawidłowym identyfikatorem urządzenia.

done

HttpResponseCallback<Device>

Opcjonalna funkcja wywoływana po zakończeniu operacji. done element zostanie wywołany z trzema argumentami: obiekt Error (może mieć wartość null), obiekt Urządzenie reprezentujący zaktualizowaną tożsamość urządzenia oraz obiekt odpowiedzi specyficzny dla transportu przydatny do rejestrowania lub debugowania.

updateConfiguration(Configuration)

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

Parametry

configuration

Configuration

Zwraca

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean)

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

Parametry

configuration

Configuration

forceUpdate

boolean

Zwraca

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)

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

Parametry

configuration

Configuration

forceUpdate

boolean

done

HttpResponseCallback<any>

updateConfiguration(Configuration, HttpResponseCallback<any>)

Aktualizowanie konfiguracji w centrum IoT

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

Parametry

configuration

Configuration

Obiekt typu module:azure-iothub. Konfiguracja dodawania do centrum

done

HttpResponseCallback<any>

Opcjonalna funkcja wywoływana po zakończeniu operacji. done element zostanie wywołany z trzema argumentami: obiekt Error (może mieć wartość null), treść odpowiedzi i obiekt odpowiedzi specyficzny dla transportu przydatny do rejestrowania lub debugowania.

updateDevices(DeviceDescription[], boolean)

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

Parametry

devices

DeviceDescription[]

forceUpdate

boolean

Zwraca

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

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

Aktualizacje tablicę urządzeń. Poszczególne elementy parametru devices muszą zawierać wszystkie właściwości, które można aktualizować. Jeśli na przykład zaktualizujesz status właściwość z disabled do enabled, obiekt powinien mieć również stanReason, uwierzytelnianie (i jego właściwości podrzędne), możliwości i urządzenieScope ustawione na bieżące wartości urządzeń lub te właściwości zostaną zresetowane. Przed wykonaniem aktualizacji zaleca się wywołanie interfejsu API get.

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

Parametry

devices

DeviceDescription[]

Tablica obiektów, które muszą zawierać deviceId właściwość, której wartość jest prawidłowym identyfikatorem urządzenia.

forceUpdate

boolean

jeśli forceUpdate ma wartość true, urządzenie zostanie zaktualizowane niezależnie od tagu etag. W przeciwnym razie etagi muszą być zgodne.

done

HttpResponseCallback<BulkRegistryOperationResult>

Opcjonalna funkcja wywoływana po zakończeniu operacji. done będzie wywoływana z trzema argumentami: obiekt Error (może mieć wartość null), BulkRegistryOperationResult i obiekt odpowiedzi specyficzny dla transportu przydatny do rejestrowania lub debugowania.

updateModule(Module)

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

Parametry

module

Module

Zwraca

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean)

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

Parametry

module

Module

forceUpdate

boolean

Zwraca

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean, HttpResponseCallback<any>)

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

Parametry

module

Module

forceUpdate

boolean

done

HttpResponseCallback<any>

updateModule(Module, TripleValueCallback<any, any>)

Aktualizowanie danego obiektu modułu w rejestrze

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

Parametry

module

Module

Obiekt modułu do aktualizacji.

done

TripleValueCallback<any, any>

Opcjonalna funkcja wywoływana po zakończeniu operacji. done będzie wywoływana z trzema argumentami: obiekt Error (może mieć wartość null), treść odpowiedzi i obiekt odpowiedzi specyficzny dla transportu przydatny do rejestrowania lub debugowania.

updateModuleTwin(string, string, any, string)

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

Parametry

deviceId

string

moduleId

string

patch

any

etag

string

Zwraca

Promise<ResultWithHttpResponse<Twin>>

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

Aktualizacje bliźniaczego modułu z daną poprawką.

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

Parametry

deviceId

string

Identyfikator urządzenia.

moduleId

string

Identyfikator modułu

patch

any

Żądane właściwości i tagi, aby zastosować poprawkę bliźniaczej reprezentacji modułu.

etag

string

Najnowszy element etag dla tej reprezentacji modułu lub "*", aby wymusić aktualizację, nawet jeśli bliźniacze reprezentacja modułu została zaktualizowana od czasu uzyskania elementu etag.

done

HttpResponseCallback<Twin>

Opcjonalne wywołanie zwrotne, które będzie wywoływane z obiektem Error lub wystąpieniem bliźniaczej reprezentacji modułu.

updateTwin(string, any, string)

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

Parametry

deviceId

string

patch

any

etag

string

Zwraca

Promise<ResultWithHttpResponse<Twin>>

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

Aktualizacje bliźniaczej reprezentacji urządzenia z daną poprawką.

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

Parametry

deviceId

string

Identyfikator urządzenia.

patch

any

Żądane właściwości i tagi, aby zastosować poprawkę bliźniaczej reprezentacji urządzenia.

etag

string

Najnowszy element etag dla tej bliźniaczej reprezentacji urządzenia lub "*", aby wymusić aktualizację, nawet jeśli bliźniacze reprezentacja urządzenia została zaktualizowana od czasu uzyskania tagu etag.

done

HttpResponseCallback<Twin>

Opcjonalne wywołanie zwrotne, które będzie wywoływane z obiektem Error lub wystąpieniem bliźniaczej reprezentacji urządzenia.