Registry class

Referenz

Paket:: azure-iothub

Die Registry-Klasse bietet Zugriff auf den IoT Hub Geräteidentitätsdienst. Benutzer des SDK sollten diese Klasse mit einer der Factorymethoden instanziieren: fromConnectionString oder fromSharedAccessSignature.

Das protokoll, das für Geräteidentitätsregistrierungsvorgänge verwendet wird, ist HTTPS.

Methoden

addConfiguration(Configuration)
addConfiguration(Configuration, HttpResponseCallback<any>)	Fügen Sie einer IoT Hub-Instanz eine Konfiguration hinzu.
addDevices(DeviceDescription[])
addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)	Fügt ein Array von Geräten hinzu.
addModule(Module)
addModule(Module, HttpResponseCallback<any>)	Fügen Sie das angegebene Modul der Registrierung hinzu.
applyConfigurationContentOnDevice(string, ConfigurationContent)
applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)	Anwenden der angegebenen Konfiguration auf ein Gerät auf einem IoT Hub
cancelJob(string)
cancelJob(string, Callback<JobStatus>)	Abbrechen eines Massenimport-/Exportauftrags.
create(DeviceDescription)
create(DeviceDescription, HttpResponseCallback<Device>)	Erstellt eine neue Geräteidentität in einem IoT Hub.
createQuery(string, number)	Erstellt eine Abfrage, die auf der IoT Hub-Instanz ausgeführt werden kann, um Informationen zu Geräten oder Aufträgen zu finden.
delete(string)
delete(string, HttpResponseCallback<any>)	Entfernt eine vorhandene Geräteidentität aus einem IoT Hub.
exportDevicesToBlob(string, boolean)
exportDevicesToBlob(string, boolean, Callback<JobStatus>)	Exportieren von Geräten in ein Blob in einem Massenauftrag.
exportDevicesToBlobByIdentity(string, boolean)
exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)	Exportieren von Geräten in ein Blob in einem Massenauftrag mithilfe einer konfigurierten Identität.
exportDevicesToBlobByIdentity(string, boolean, string)
exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)
fromConnectionString(string)	Erstellt ein Registry-Objekt aus der angegebenen Verbindungszeichenfolge.
fromSharedAccessSignature(string)	Erstellt ein Registry-Objekt aus der angegebenen Shared Access Signature.
fromTokenCredential(string, TokenCredential)	Erstellt ein Registry-Objekt aus den angegebenen Azure TokenCredential.
get(string)
get(string, HttpResponseCallback<Device>)	Fordert Informationen zu einer vorhandenen Geräteidentität in einem IoT Hub an.
getConfiguration(string)
getConfiguration(string, HttpResponseCallback<Configuration>)	Abrufen einer einzelnen Konfiguration aus einem IoT Hub
getConfigurations()
getConfigurations(HttpResponseCallback<Configuration[]>)	Abrufen aller Konfigurationen auf einem IoT Hub
getJob(string)
getJob(string, Callback<JobStatus>)	Ruft den Status eines Massenimport-/Exportauftrags ab.
getModule(string, string)
getModule(string, string, HttpResponseCallback<Module>)	Abrufen eines einzelnen Moduls von einem Gerät auf einem IoT Hub
getModulesOnDevice(string)
getModulesOnDevice(string, HttpResponseCallback<Module[]>)	Abrufen einer Liste aller Module auf einem IoT Hub Gerät
getModuleTwin(string, string)
getModuleTwin(string, string, HttpResponseCallback<Twin>)	Ruft den Modulzwillen des Moduls mit dem angegebenen Modulbezeichner ab.
getRegistryStatistics()
getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)	Ruft Statistiken zu den Geräten in der Geräteidentitätsregistrierung ab.
getTwin(string)
getTwin(string, HttpResponseCallback<Twin>)	Ruft den Gerätezwillen des Geräts mit dem angegebenen Gerätebezeichner ab.
importDevicesFromBlob(string, string)
importDevicesFromBlob(string, string, Callback<JobStatus>)	Importiert Geräte aus einem Blob in Einem Massenauftrag.
importDevicesFromBlobByIdentity(string, string)
importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)	Importiert Geräte aus einem Blob im Massenauftrag mithilfe einer konfigurierten Identität.
importDevicesFromBlobByIdentity(string, string, string)
importDevicesFromBlobByIdentity(string, string, string, Callback<JobStatus>)
list()
list(HttpResponseCallback<Device[]>)	Fordert Informationen zu den ersten 1000 Geräteidentitäten in einem IoT Hub an.
listJobs()
listJobs(HttpResponseCallback<any>)	Listet die letzten Import-/Exportaufträge auf (einschließlich des aktiven Auftrags, falls vorhanden).
removeConfiguration(string)
removeConfiguration(string, HttpResponseCallback<any>)	Entfernen einer Konfiguration mit der angegebenen ID aus einem IoT Hub
removeDevices(DeviceDescription[], boolean)
removeDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	Aktualisierungen ein Array von Geräten.
removeModule(Module, TripleValueCallback<any, any>)	Entfernen des angegebenen Moduls aus der Registrierung
removeModule(string \| Module)
removeModule(string \| Module, string)
removeModule(string, string, TripleValueCallback<any, any>)
update(DeviceDescription)
update(DeviceDescription, HttpResponseCallback<Device>)	Aktualisierungen eine vorhandene Geräteidentität in einem IoT Hub mit den angegebenen Geräteinformationen. Der `deviceInfo` Parameter muss alle Eigenschaften enthalten, die aktualisierbar sind. Wenn sie z. B. die `status` Eigenschaft von `disabled` auf `enabled`aktualisieren, sollte das `deviceInfo` Objekt auch den StatusReason, die Authentifizierung (und die zugehörigen Untereigenschaften), funktionen und deviceScope aufweisen, die auf die aktuellen Gerätewerte festgelegt sind, oder diese Eigenschaften werden zurückgesetzt. Es wird empfohlen, dass die get-API zuerst aufgerufen wird, bevor ein Update ausgeführt wird.
updateConfiguration(Configuration)
updateConfiguration(Configuration, boolean)
updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)
updateConfiguration(Configuration, HttpResponseCallback<any>)	Aktualisieren einer Konfiguration in einem IoT Hub
updateDevices(DeviceDescription[], boolean)
updateDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	Aktualisierungen ein Array von Geräten. Die einzelnen Elemente des `devices` Parameters müssen alle Eigenschaften enthalten, die aktualisierbar sind. Wenn beispielsweise die `status` -Eigenschaft von `disabled` in `enabled`aktualisiert wird, sollte das -Objekt auch den StatusReason, die Authentifizierung (und ihre Untereigenschaften), funktionen und deviceScope auf die aktuellen Gerätewerte festgelegt haben, sonst werden diese Eigenschaften zurückgesetzt. Es wird empfohlen, dass die get-API zuerst aufgerufen wird, bevor Sie ein Update ausführen.
updateModule(Module)
updateModule(Module, boolean)
updateModule(Module, boolean, HttpResponseCallback<any>)
updateModule(Module, TripleValueCallback<any, any>)	Aktualisieren des angegebenen Modulobjekts in der Registrierung
updateModuleTwin(string, string, any, string)
updateModuleTwin(string, string, any, string, HttpResponseCallback<Twin>)	Aktualisierungen den Zwilling eines bestimmten Moduls mit dem angegebenen Patch.
updateTwin(string, any, string)
updateTwin(string, any, string, HttpResponseCallback<Twin>)	Aktualisierungen den Gerätezwillen eines bestimmten Geräts mit dem angegebenen Patch.

Details zur Methode

addConfiguration(Configuration)

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

Parameter

configuration: Configuration

Gibt zurück

Promise<ResultWithHttpResponse<any>>

addConfiguration(Configuration, HttpResponseCallback<any>)

Fügen Sie einer IoT Hub-Instanz eine Konfiguration hinzu.

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

Parameter

configuration: Configuration

Ein Objekt vom Typ module:azure-iothub. Konfiguration, die dem Hub hinzugefügt werden soll

done: HttpResponseCallback<any>

Die optionale Funktion, die aufgerufen werden soll, wenn der Vorgang abgeschlossen ist. done wird mit drei Argumenten aufgerufen: einem Error-Objekt (kann NULL sein), dem Text der Antwort und einem transportspezifischen Antwortobjekt, das für die Protokollierung oder das Debuggen nützlich ist.

addDevices(DeviceDescription[])

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

Parameter

devices: DeviceDescription[]

Gibt zurück

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)

Fügt ein Array von Geräten hinzu.

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

Parameter

devices: DeviceDescription[]

Ein Array von -Objekten, das eine deviceId Eigenschaft enthalten muss, deren Wert ein gültiger Gerätebezeichner ist.

done: HttpResponseCallback<BulkRegistryOperationResult>

Die optionale Funktion, die aufgerufen werden soll, wenn der Vorgang abgeschlossen ist. done wird mit drei Argumenten aufgerufen: einem Error-Objekt (kann NULL sein), einem BulkRegistryOperationResult-Objekt und einem transportspezifischen Antwortobjekt, das für die Protokollierung oder das Debuggen nützlich ist.

addModule(Module)

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

Parameter

module: Module

Gibt zurück

Promise<ResultWithHttpResponse<any>>

addModule(Module, HttpResponseCallback<any>)

Fügen Sie das angegebene Modul der Registrierung hinzu.

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

Parameter

module: Module

Modulobjekt, das der Registrierung hinzugefügt werden soll.

done: HttpResponseCallback<any>

applyConfigurationContentOnDevice(string, ConfigurationContent)

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

Parameter

deviceId: string

content: ConfigurationContent

Gibt zurück

Promise<ResultWithHttpResponse<any>>

applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)

Anwenden der angegebenen Konfiguration auf ein Gerät auf einem IoT Hub

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

Parameter

deviceId: string

ID des Geräts, auf das die Konfiguration angewendet werden soll

content: ConfigurationContent

Die anzuwendende Konfiguration

done: HttpResponseCallback<any>

cancelJob(string)

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

Parameter

jobId: string

Gibt zurück

Promise<JobStatus>

cancelJob(string, Callback<JobStatus>)

Abbrechen eines Massenimport-/Exportauftrags.

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

Parameter

jobId: string

Der Bezeichner des Auftrags, für den der Benutzer Statusinformationen abrufen möchte.

done: Callback<JobStatus>

Die optionale Funktion, die mit zwei Argumenten aufgerufen werden soll: ein Fehlerobjekt, wenn ein Fehler aufgetreten ist, (andernfalls NULL) und der (abgebrochene) Status des Auftrags, dessen Bezeichner als Argument übergeben wurde.

create(DeviceDescription)

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

Parameter

deviceInfo: DeviceDescription

Gibt zurück

Promise<ResultWithHttpResponse<Device>>

create(DeviceDescription, HttpResponseCallback<Device>)

Erstellt eine neue Geräteidentität in einem IoT Hub.

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

Parameter

deviceInfo: DeviceDescription

Das Objekt muss eine deviceId Eigenschaft mit einem gültigen Gerätebezeichner enthalten.

done: HttpResponseCallback<Device>

Die optionale Funktion, die aufgerufen werden soll, wenn der Vorgang abgeschlossen ist. done wird mit drei Argumenten aufgerufen: ein Error-Objekt (kann NULL sein), ein Device-Objekt , das die erstellte Geräteidentität darstellt, und ein transportspezifisches Antwortobjekt, das für die Protokollierung oder das Debuggen nützlich ist.

createQuery(string, number)

Erstellt eine Abfrage, die auf der IoT Hub-Instanz ausgeführt werden kann, um Informationen zu Geräten oder Aufträgen zu finden.

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

Parameter

sqlQuery: string

Die als SQL-Zeichenfolge geschriebene Abfrage.

pageSize: number

Die gewünschte Anzahl von Ergebnissen pro Seite (optional. Standard: 1000, max. 10000).

Gibt zurück

Query

delete(string)

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

Parameter

deviceId: string

Gibt zurück

Promise<ResultWithHttpResponse<any>>

delete(string, HttpResponseCallback<any>)

Entfernt eine vorhandene Geräteidentität aus einem IoT Hub.

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

Parameter

deviceId: string

Der Bezeichner einer vorhandenen Geräteidentität.

done: HttpResponseCallback<any>

Die optionale Funktion, die aufgerufen werden soll, wenn der Vorgang abgeschlossen ist. done wird mit drei Argumenten aufgerufen: einem Error-Objekt (kann NULL sein), einem Always-NULL-Argument (aus Konsistenz mit den anderen Methoden) und einem transportspezifischen Antwortobjekt, das für die Protokollierung oder das Debuggen nützlich ist.

exportDevicesToBlob(string, boolean)

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

Parameter

outputBlobContainerUri: string

excludeKeys: boolean

Gibt zurück

Promise<JobStatus>

exportDevicesToBlob(string, boolean, Callback<JobStatus>)

Exportieren von Geräten in ein Blob in einem Massenauftrag.

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

Parameter

outputBlobContainerUri: string

Der URI für einen Container, in dem ein Blob mit dem Namen "devices.txt" erstellt wird, das die Liste der Geräte enthält.

excludeKeys: boolean

Boolescher Wert, der angibt, ob Sicherheitsschlüssel von den exportierten Daten ausgeschlossen werden sollen.

done: Callback<JobStatus>

Die optionale Funktion, die aufgerufen werden soll, wenn der Auftrag erstellt wurde, mit zwei Argumenten: einem Fehlerobjekt, wenn ein Fehler aufgetreten ist, (andernfalls NULL) und dem Auftragsstatus, der zum Nachverfolgen des Fortschritts des Geräteexports verwendet werden kann.

exportDevicesToBlobByIdentity(string, boolean)

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

Parameter

outputBlobContainerUri: string

excludeKeys: boolean

Gibt zurück

Promise<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)

Exportieren von Geräten in ein Blob in einem Massenauftrag mithilfe einer konfigurierten Identität.

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

Parameter

outputBlobContainerUri: string

Der URI für einen Container, in dem ein Blob mit dem Namen "devices.txt" erstellt wird, das die Liste der Geräte enthält.

excludeKeys: boolean

Boolescher Wert, der angibt, ob Sicherheitsschlüssel von den exportierten Daten ausgeschlossen werden sollen.

done: Callback<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, string)

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

Parameter

outputBlobContainerUri: string

excludeKeys: boolean

userAssignedIdentity: string

Gibt zurück

Promise<JobStatus>

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

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

Parameter

outputBlobContainerUri: string

excludeKeys: boolean

userAssignedIdentity: string

done: Callback<JobStatus>

fromConnectionString(string)

Erstellt ein Registry-Objekt aus der angegebenen Verbindungszeichenfolge.

static function fromConnectionString(value: string): Registry

Parameter

value: string

Eine Verbindungszeichenfolge, die die entsprechenden Registrierungsberechtigungen (Lese- und/oder Schreibzugriff) kapselt.

Gibt zurück

Registry

fromSharedAccessSignature(string)

Erstellt ein Registry-Objekt aus der angegebenen Shared Access Signature.

static function fromSharedAccessSignature(value: string): Registry

Parameter

value: string

Eine Shared Access Signature, die die entsprechenden Registrierungsberechtigungen (Lese- und/oder Schreibzugriff) kapselt.

Gibt zurück

Registry

fromTokenCredential(string, TokenCredential)

Erstellt ein Registry-Objekt aus den angegebenen Azure TokenCredential.

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

Parameter

hostName: string

Hostname des Azure-Diensts.

tokenCredential: TokenCredential

Azure TokenCredential, die für die Authentifizierung beim Azure-Dienst verwendet werden

Gibt zurück

Registry

get(string)

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

Parameter

deviceId: string

Gibt zurück

Promise<ResultWithHttpResponse<Device>>

get(string, HttpResponseCallback<Device>)

Fordert Informationen zu einer vorhandenen Geräteidentität in einem IoT Hub an.

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

Parameter

deviceId: string

Der Bezeichner einer vorhandenen Geräteidentität.

done: HttpResponseCallback<Device>

getConfiguration(string)

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

Parameter

configurationId: string

Gibt zurück

Promise<ResultWithHttpResponse<Configuration>>

getConfiguration(string, HttpResponseCallback<Configuration>)

Abrufen einer einzelnen Konfiguration aus einem IoT Hub

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

Parameter

configurationId: string

Die ID der abzurufenden Konfiguration

done: HttpResponseCallback<Configuration>

Der optionale Rückruf, der entweder mit einem Error-Objekt oder einem modul:azure-iothub aufgerufen wird. Konfigurationsobjekt mit den Konfigurationsdetails.

getConfigurations()

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

Gibt zurück

Promise<ResultWithHttpResponse<Configuration[]>>

getConfigurations(HttpResponseCallback<Configuration[]>)

Abrufen aller Konfigurationen auf einem IoT Hub

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

Parameter

done: HttpResponseCallback<Configuration[]>

Der optionale Rückruf, der entweder mit einem Error-Objekt oder einem Array von module:azure-iothub aufgerufen wird. Konfigurationsobjekte für alle Konfigurationen.

getJob(string)

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

Parameter

jobId: string

Gibt zurück

Promise<JobStatus>

getJob(string, Callback<JobStatus>)

Ruft den Status eines Massenimport-/Exportauftrags ab.

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

Parameter

jobId: string

Der Bezeichner des Auftrags, für den der Benutzer Statusinformationen abrufen möchte.

done: Callback<JobStatus>

Die optionale Funktion, die mit zwei Argumenten aufgerufen werden soll: ein Fehlerobjekt, wenn ein Fehler aufgetreten ist( andernfalls NULL) und der Status des Auftrags, dessen Bezeichner als Argument übergeben wurde.

getModule(string, string)

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

Parameter

deviceId: string

moduleId: string

Gibt zurück

Promise<ResultWithHttpResponse<Module>>

getModule(string, string, HttpResponseCallback<Module>)

Abrufen eines einzelnen Moduls von einem Gerät auf einem IoT Hub

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

Parameter

deviceId: string

Geräte-ID, die besitzer des Moduls ist.

moduleId: string

Abzurufende Modul-ID

done: HttpResponseCallback<Module>

Der optionale Rückruf, der entweder mit einem Error-Objekt oder dem modul:azure-iothub aufgerufen wird. Modulobjekt für das angeforderte Modul

getModulesOnDevice(string)

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

Parameter

deviceId: string

Gibt zurück

Promise<ResultWithHttpResponse<Module[]>>

getModulesOnDevice(string, HttpResponseCallback<Module[]>)

Abrufen einer Liste aller Module auf einem IoT Hub Gerät

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

Parameter

deviceId: string

ID des Geräts, für das Module bereitgestellt werden

done: HttpResponseCallback<Module[]>

Der optionale Rückruf, der entweder mit einem Error-Objekt oder einem Array von module:azure-iothub aufgerufen wird. Modulobjekte für alle Module.

getModuleTwin(string, string)

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

Parameter

deviceId: string

moduleId: string

Gibt zurück

Promise<ResultWithHttpResponse<Twin>>

getModuleTwin(string, string, HttpResponseCallback<Twin>)

Ruft den Modulzwillen des Moduls mit dem angegebenen Modulbezeichner ab.

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

Parameter

deviceId: string

Der Gerätebezeichner.

moduleId: string

Der Modulbezeichner.

done: HttpResponseCallback<Twin>

Der optionale Rückruf, der entweder mit einem Error-Objekt oder der Modulzwillungsinstanz aufgerufen wird.

getRegistryStatistics()

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

Gibt zurück

Promise<ResultWithHttpResponse<RegistryStatistics>>

getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)

Ruft Statistiken zu den Geräten in der Geräteidentitätsregistrierung ab.

function getRegistryStatistics(done?: HttpResponseCallback<RegistryStatistics>)

Parameter

done: HttpResponseCallback<RegistryStatistics>

Der optionale Rückruf, der entweder mit einem Error-Objekt oder der Geräteregistrierungsstatistik aufgerufen wird.

getTwin(string)

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

Parameter

deviceId: string

Gibt zurück

Promise<ResultWithHttpResponse<Twin>>

getTwin(string, HttpResponseCallback<Twin>)

Ruft den Gerätezwillen des Geräts mit dem angegebenen Gerätebezeichner ab.

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

Parameter

deviceId: string

Der Gerätebezeichner.

done: HttpResponseCallback<Twin>

Der optionale Rückruf, der entweder mit einem Error-Objekt oder der Gerätezwillungsinstanz aufgerufen wird.

importDevicesFromBlob(string, string)

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

Parameter

inputBlobContainerUri: string

outputBlobContainerUri: string

Gibt zurück

Promise<JobStatus>

importDevicesFromBlob(string, string, Callback<JobStatus>)

Importiert Geräte aus einem Blob in Einem Massenauftrag.

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

Parameter

inputBlobContainerUri: string

Der URI für einen Container mit einem Blob namens "devices.txt", der eine Liste der zu importierenden Geräte enthält.

outputBlobContainerUri: string

Der URI für einen Container, in dem ein Blob mit Protokollen des Importprozesses erstellt wird.

done: Callback<JobStatus>

Die optionale Funktion, die aufgerufen werden soll, wenn der Auftrag erstellt wurde, mit zwei Argumenten: einem Fehlerobjekt, wenn ein Fehler aufgetreten ist( andernfalls NULL) und dem Auftragsstatus, der zum Nachverfolgen des Fortschritts des Geräteimports verwendet werden kann.

importDevicesFromBlobByIdentity(string, string)

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

Parameter

inputBlobContainerUri: string

outputBlobContainerUri: string

Gibt zurück

Promise<JobStatus>

importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)

Importiert Geräte aus einem Blob im Massenauftrag mithilfe einer konfigurierten Identität.

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

Parameter

inputBlobContainerUri: string

Der URI für einen Container mit einem Blob namens "devices.txt", der eine Liste der zu importierenden Geräte enthält.

outputBlobContainerUri: string

Der URI für einen Container, in dem ein Blob mit Protokollen des Importprozesses erstellt wird.

done: Callback<JobStatus>

importDevicesFromBlobByIdentity(string, string, string)

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

Parameter

inputBlobContainerUri: string

outputBlobContainerUri: string

userAssignedIdentity: string

Gibt zurück

Promise<JobStatus>

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

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

Parameter

inputBlobContainerUri: string

outputBlobContainerUri: string

userAssignedIdentity: string

done: Callback<JobStatus>

list()

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

Gibt zurück

Promise<ResultWithHttpResponse<Device[]>>

list(HttpResponseCallback<Device[]>)

Fordert Informationen zu den ersten 1000 Geräteidentitäten in einem IoT Hub an.

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

Parameter

done: HttpResponseCallback<Device[]>

Die optionale Funktion, die aufgerufen werden soll, wenn der Vorgang abgeschlossen ist. done wird mit drei Argumenten aufgerufen: einem Error-Objekt (kann NULL sein), einem Array von Device-Objekten , die die aufgeführten Geräteidentitäten darstellen, und einem transportspezifischen Antwortobjekt, das für die Protokollierung oder das Debuggen nützlich ist.

listJobs()

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

Gibt zurück

Promise<ResultWithHttpResponse<any>>

listJobs(HttpResponseCallback<any>)

Listet die letzten Import-/Exportaufträge auf (einschließlich des aktiven Auftrags, falls vorhanden).

function listJobs(done?: HttpResponseCallback<any>)

Parameter

done: HttpResponseCallback<any>

Die optionale Funktion, die mit zwei Argumenten aufgerufen werden soll: ein Fehlerobjekt, wenn ein Fehler aufgetreten ist, (andernfalls NULL) und die Liste der vergangenen Aufträge als Argument.

removeConfiguration(string)

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

Parameter

configurationId: string

Gibt zurück

Promise<ResultWithHttpResponse<any>>

removeConfiguration(string, HttpResponseCallback<any>)

Entfernen einer Konfiguration mit der angegebenen ID aus einem IoT Hub

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

Parameter

configurationId: string

ID der zu entfernenden Konfiguration

done: HttpResponseCallback<any>

removeDevices(DeviceDescription[], boolean)

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

Parameter

devices: DeviceDescription[]

forceRemove: boolean

Gibt zurück

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

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

Aktualisierungen ein Array von Geräten.

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

Parameter

devices: DeviceDescription[]

Ein Array von -Objekten, das eine deviceId Eigenschaft enthalten muss, deren Wert ein gültiger Gerätebezeichner ist.

forceRemove: boolean

wenn forceRemove true ist, wird das Gerät unabhängig von einem etag entfernt. Andernfalls müssen die etags übereinstimmen.

done: HttpResponseCallback<BulkRegistryOperationResult>

removeModule(Module, TripleValueCallback<any, any>)

Entfernen des angegebenen Moduls aus der Registrierung

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

Parameter

module: Module

done: TripleValueCallback<any, any>

removeModule(string | Module)

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

Parameter

moduleOrDeviceId: string | Module

Gibt zurück

Promise<ResultWithHttpResponse<any>>

removeModule(string | Module, string)

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

Parameter

moduleOrDeviceId: string | Module

moduleId: string

Gibt zurück

Promise<ResultWithHttpResponse<any>>

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

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

Parameter

deviceId: string

moduleId: string

done: TripleValueCallback<any, any>

update(DeviceDescription)

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

Parameter

deviceInfo: DeviceDescription

Gibt zurück

Promise<ResultWithHttpResponse<Device>>

update(DeviceDescription, HttpResponseCallback<Device>)

Aktualisierungen eine vorhandene Geräteidentität in einem IoT Hub mit den angegebenen Geräteinformationen. Der deviceInfo Parameter muss alle Eigenschaften enthalten, die aktualisierbar sind. Wenn sie z. B. die status Eigenschaft von disabled auf enabledaktualisieren, sollte das deviceInfo Objekt auch den StatusReason, die Authentifizierung (und die zugehörigen Untereigenschaften), funktionen und deviceScope aufweisen, die auf die aktuellen Gerätewerte festgelegt sind, oder diese Eigenschaften werden zurückgesetzt. Es wird empfohlen, dass die get-API zuerst aufgerufen wird, bevor ein Update ausgeführt wird.

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

Parameter

deviceInfo: DeviceDescription

Ein -Objekt, das eine deviceId Eigenschaft enthalten muss, deren Wert ein gültiger Gerätebezeichner ist.

done: HttpResponseCallback<Device>

Die optionale Funktion, die aufgerufen werden soll, wenn der Vorgang abgeschlossen ist. done wird mit drei Argumenten aufgerufen: einem Error-Objekt (kann NULL sein), einem Device-Objekt , das die aktualisierte Geräteidentität darstellt, und einem transportspezifischen Antwortobjekt, das zum Protokollieren oder Debuggen nützlich ist.

updateConfiguration(Configuration)

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

Parameter

configuration: Configuration

Gibt zurück

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean)

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

Parameter

configuration: Configuration

forceUpdate: boolean

Gibt zurück

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)

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

Parameter

configuration: Configuration

forceUpdate: boolean

done: HttpResponseCallback<any>

updateConfiguration(Configuration, HttpResponseCallback<any>)

Aktualisieren einer Konfiguration in einem IoT Hub

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

Parameter

configuration: Configuration

Ein Objekt vom Typ module:azure-iothub. Konfiguration, die dem Hub hinzugefügt werden soll

done: HttpResponseCallback<any>

updateDevices(DeviceDescription[], boolean)

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

Parameter

devices: DeviceDescription[]

forceUpdate: boolean

Gibt zurück

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

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

Aktualisierungen ein Array von Geräten. Die einzelnen Elemente des devices Parameters müssen alle Eigenschaften enthalten, die aktualisierbar sind. Wenn beispielsweise die status -Eigenschaft von disabled in enabledaktualisiert wird, sollte das -Objekt auch den StatusReason, die Authentifizierung (und ihre Untereigenschaften), funktionen und deviceScope auf die aktuellen Gerätewerte festgelegt haben, sonst werden diese Eigenschaften zurückgesetzt. Es wird empfohlen, dass die get-API zuerst aufgerufen wird, bevor Sie ein Update ausführen.

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

Parameter

devices: DeviceDescription[]

Ein Array von Objekten, das eine deviceId Eigenschaft enthalten muss, deren Wert ein gültiger Gerätebezeichner ist.

forceUpdate: boolean

wenn forceUpdate true ist, wird das Gerät unabhängig von einem etag aktualisiert. Andernfalls müssen die eTags übereinstimmen.

done: HttpResponseCallback<BulkRegistryOperationResult>

Die optionale Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. done wird mit drei Argumenten aufgerufen: einem Error-Objekt (kann NULL sein), einem BulkRegistryOperationResult-Objekt und einem transportspezifischen Antwortobjekt, das für die Protokollierung oder das Debuggen nützlich ist.

updateModule(Module)

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

Parameter

module: Module

Gibt zurück

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean)

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

Parameter

module: Module

forceUpdate: boolean

Gibt zurück

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean, HttpResponseCallback<any>)

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

Parameter

module: Module

forceUpdate: boolean

done: HttpResponseCallback<any>

updateModule(Module, TripleValueCallback<any, any>)

Aktualisieren des angegebenen Modulobjekts in der Registrierung

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

Parameter

module: Module

Zu aktualisierende Modulobjekt.

done: TripleValueCallback<any, any>

Die optionale Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. done wird mit drei Argumenten aufgerufen: einem Error-Objekt (kann NULL sein), dem Textkörper der Antwort und einem transportspezifischen Antwortobjekt, das für die Protokollierung oder das Debuggen nützlich ist.

updateModuleTwin(string, string, any, string)

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

Parameter

deviceId: string

moduleId: string

patch: any

etag: string

Gibt zurück

Promise<ResultWithHttpResponse<Twin>>

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

Aktualisierungen den Zwilling eines bestimmten Moduls mit dem angegebenen Patch.

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

Parameter

deviceId: string

Der Gerätebezeichner.

moduleId: string

Modulbezeichner

patch: any

Die gewünschten Eigenschaften und Tags, mit denen der Modulzwille gepatcht werden soll.

etag: string

Das neueste etag für diesen Modulzwilling oder "*", um eine Aktualisierung zu erzwingen, auch wenn der Modulzwilling seit dem Abrufen des etags aktualisiert wurde.

done: HttpResponseCallback<Twin>

Der optionale Rückruf, der entweder mit einem Error-Objekt oder der Modulzwilligeninstanz aufgerufen wird.

updateTwin(string, any, string)

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

Parameter

deviceId: string

patch: any

etag: string

Gibt zurück

Promise<ResultWithHttpResponse<Twin>>

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

Aktualisierungen den Gerätezwillen eines bestimmten Geräts mit dem angegebenen Patch.

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

Parameter

deviceId: string

Der Gerätebezeichner.

patch: any

Die gewünschten Eigenschaften und Tags, mit denen der Gerätezwille gepatcht werden soll.

etag: string

Das neueste etag für diesen Gerätezwilling oder "*", um eine Aktualisierung zu erzwingen, auch wenn der Gerätezwilling seit dem Abrufen des etags aktualisiert wurde.

done: HttpResponseCallback<Twin>

Der optionale Rückruf, der entweder mit einem Error-Objekt oder der Gerätezwillzinstanz aufgerufen wird.

Freigeben über

Registry class

Methoden

Details zur Methode

addConfiguration(Configuration)

Parameter

Gibt zurück

addConfiguration(Configuration, HttpResponseCallback<any>)

Parameter

addDevices(DeviceDescription[])

Parameter

Gibt zurück

addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)

Parameter

addModule(Module)

Parameter

Gibt zurück

addModule(Module, HttpResponseCallback<any>)

Parameter

applyConfigurationContentOnDevice(string, ConfigurationContent)

Parameter

Gibt zurück

applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)

Parameter

cancelJob(string)

Parameter

Gibt zurück

cancelJob(string, Callback<JobStatus>)

Parameter

create(DeviceDescription)

Parameter

Gibt zurück

create(DeviceDescription, HttpResponseCallback<Device>)

Parameter

createQuery(string, number)

Parameter

Gibt zurück

delete(string)

Parameter

Gibt zurück

delete(string, HttpResponseCallback<any>)

Parameter

exportDevicesToBlob(string, boolean)

Parameter

Gibt zurück

exportDevicesToBlob(string, boolean, Callback<JobStatus>)

Parameter

exportDevicesToBlobByIdentity(string, boolean)

Parameter

Gibt zurück

exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)

Parameter

exportDevicesToBlobByIdentity(string, boolean, string)

Parameter

Gibt zurück

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

Parameter

fromConnectionString(string)

Parameter

Gibt zurück

fromSharedAccessSignature(string)

Parameter

Gibt zurück

fromTokenCredential(string, TokenCredential)

Parameter

Gibt zurück

get(string)

Parameter

Gibt zurück

get(string, HttpResponseCallback<Device>)

Parameter

getConfiguration(string)

Parameter

Gibt zurück

getConfiguration(string, HttpResponseCallback<Configuration>)

Parameter

getConfigurations()

Gibt zurück

getConfigurations(HttpResponseCallback<Configuration[]>)

Parameter