Registry class
Die Registrierungsklasse 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
add |
|
add |
Hinzufügen einer Konfiguration zu einem IoT-Hub. |
add |
|
add |
Fügt ein Array von Geräten hinzu. |
add |
|
add |
Fügen Sie das angegebene Modul zur Registrierung hinzu. |
apply |
|
apply |
Anwenden der angegebenen Konfiguration auf ein Gerät auf einem IoT Hub |
cancel |
|
cancel |
Abbrechen eines Massenimport-/Exportauftrags. |
create(Device |
|
create(Device |
Erstellt eine neue Geräteidentität auf einem IoT-Hub. |
create |
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, Http |
Entfernt eine vorhandene Geräteidentität aus einem IoT-Hub. |
export |
|
export |
Exportieren sie Geräte in einen Blob in einem Massenauftrag. |
export |
|
export |
Exportieren Von Geräten in einen Blob in einem Massenauftrag mithilfe einer konfigurierten Identität. |
export |
|
export |
|
from |
Erstellt ein Registry -Objekt aus der angegebenen Verbindungszeichenfolge. |
from |
Erstellt ein Registrierungsobjekt aus der angegebenen Signatur für den freigegebenen Zugriff. |
from |
Erstellt ein Registrierungsobjekt aus dem angegebenen Azure TokenCredential. |
get(string) | |
get(string, Http |
Fordert Informationen zu einer vorhandenen Geräteidentität auf einem IoT-Hub an. |
get |
|
get |
Abrufen einer einzelnen Konfiguration von einem IoT Hub |
get |
|
get |
Abrufen aller Konfigurationen auf einem IoT Hub |
get |
|
get |
Rufen Sie den Status eines Massenimport-/Exportauftrags ab. |
get |
|
get |
Abrufen eines einzelnen Moduls von einem Gerät auf einem IoT Hub |
get |
|
get |
Abrufen einer Liste aller Module auf einem IoT Hub-Gerät |
get |
|
get |
Ruft den Module Twin des Moduls mit dem angegebenen Modulbezeichner ab. |
get |
|
get |
Ruft Statistiken zu den Geräten in der Geräteidentitätsregistrierung ab. |
get |
|
get |
Ruft den Device Twin des Geräts mit der angegebenen Geräte-ID ab. |
import |
|
import |
Importiert Geräte aus einem Blob im Massenauftrag. |
import |
|
import |
Importiert Geräte aus einem Blob im Massenauftrag mithilfe einer konfigurierten Identität. |
import |
|
import |
|
list() | |
list(Http |
Fordert Informationen zu den ersten 1000 Geräteidentitäten auf einem IoT-Hub an. |
list |
|
list |
Auflisten der letzten Import-/Exportaufträge (einschließlich des aktiven, falls vorhanden). |
remove |
|
remove |
Entfernen einer Konfiguration mit der angegebenen ID aus einem IoT Hub |
remove |
|
remove |
Aktualisiert ein Array von Geräten. |
remove |
Entfernen des angegebenen Moduls aus der Registrierung |
remove |
|
remove |
|
remove |
|
update(Device |
|
update(Device |
Aktualisiert eine vorhandene Geräteidentität auf einem IoT-Hub mit den angegebenen Geräteinformationen.
Der parameter |
update |
|
update |
|
update |
|
update |
Aktualisieren einer Konfiguration in einem IoT-Hub |
update |
|
update |
Aktualisiert ein Array von Geräten.
Die einzelnen Elemente des |
update |
|
update |
|
update |
|
update |
Aktualisieren des angegebenen Modulobjekts in der Registrierung |
update |
|
update |
Aktualisiert den Twin eines bestimmten Moduls mit dem angegebenen Patch. |
update |
|
update |
Aktualisiert den Device Twin 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>)
Hinzufügen einer Konfiguration zu einem IoT-Hub.
function addConfiguration(configuration: Configuration, done?: HttpResponseCallback<any>)
Parameter
- configuration
- Configuration
Ein Objekt vom Typ "module:azure-iothub". Konfiguration zum Hinzufügen zum Hub
- done
-
HttpResponseCallback<any>
Die optionale Funktion, die aufgerufen werden soll, wenn der Vorgang abgeschlossen ist.
done
wird mit drei Argumenten aufgerufen: ein Error-Objekt (kann null sein), der Textkörper der Antwort und ein transportspezifisches Antwortobjekt, das für die Protokollierung oder das Debuggen nützlich ist.
addDevices(DeviceDescription[])
function addDevices(devices: DeviceDescription[]): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>
Parameter
- devices
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
Ein Array von Objekten, die eine deviceId
Eigenschaft enthalten müssen, 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: ein Error-Objekt (kann null sein), ein BulkRegistryOperationResult und ein transportspezifisches Antwortobjekt, das zum Protokollieren oder 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 zur Registrierung hinzu.
function addModule(module: Module, done?: HttpResponseCallback<any>)
Parameter
- module
- Module
Modulobjekt, das der Registrierung 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: ein Error-Objekt (kann null sein), der Textkörper der Antwort und ein transportspezifisches Antwortobjekt, das für die Protokollierung oder das Debuggen nützlich ist.
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>
Die optionale Funktion, die aufgerufen werden soll, wenn der Vorgang abgeschlossen ist.
done
wird mit drei Argumenten aufgerufen: ein Error-Objekt (kann null sein), der Textkörper der Antwort und ein transportspezifisches Antwortobjekt, das für die Protokollierung oder das Debuggen nützlich ist.
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 auf 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 zum Protokollieren oder 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 Abfrage, die als SQL-Zeichenfolge geschrieben wurde.
- 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: ein Error-Objekt (kann null sein), ein Always-Null-Argument (für Konsistenz mit den anderen Methoden) und ein transportspezifisches 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 sie Geräte in einen Blob in einem Massenauftrag.
function exportDevicesToBlob(outputBlobContainerUri: string, excludeKeys: boolean, done?: Callback<JobStatus>)
Parameter
- outputBlobContainerUri
-
string
Der URI zu einem 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 aus den exportierten Daten ausgeschlossen werden sollen.
- done
-
Callback<JobStatus>
Die optionale Funktion, die aufgerufen werden soll, wenn der Auftrag erstellt wurde, mit zwei Argumenten: ein Fehlerobjekt, wenn ein Fehler aufgetreten ist (andernfalls NULL) und der Auftragsstatus, mit dem der Fortschritt des Geräteexports nachverfolgt 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 einen Blob in einem Massenauftrag mithilfe einer konfigurierten Identität.
function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean, done?: Callback<JobStatus>)
Parameter
- outputBlobContainerUri
-
string
Der URI zu einem 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 aus den exportierten Daten ausgeschlossen werden sollen.
- done
-
Callback<JobStatus>
Die optionale Funktion, die aufgerufen werden soll, wenn der Auftrag erstellt wurde, mit zwei Argumenten: ein Fehlerobjekt, wenn ein Fehler aufgetreten ist (andernfalls NULL) und der Auftragsstatus, mit dem der Fortschritt des Geräteexports nachverfolgt werden kann.
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
fromSharedAccessSignature(string)
Erstellt ein Registrierungsobjekt aus der angegebenen Signatur für den freigegebenen Zugriff.
static function fromSharedAccessSignature(value: string): Registry
Parameter
- value
-
string
Eine Gemeinsame Zugriffssignatur, die die entsprechenden Registrierungsberechtigungen (Lese- und/oder Schreibzugriff) kapselt.
Gibt zurück
fromTokenCredential(string, TokenCredential)
Erstellt ein Registrierungsobjekt aus dem 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
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 auf einem IoT-Hub an.
function get(deviceId: string, done?: HttpResponseCallback<Device>)
Parameter
- deviceId
-
string
Der Bezeichner einer vorhandenen Geräteidentität.
- 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 zum Protokollieren oder Debuggen nützlich ist.
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 von einem IoT Hub
function getConfiguration(configurationId: string, done?: HttpResponseCallback<Configuration>)
Parameter
- configurationId
-
string
Die ID der Konfiguration, mit der Sie abrufen möchten
- 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 Modul: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>)
Rufen Sie 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 das Modul besitzt.
- moduleId
-
string
Modul-ID zum Abrufen
- done
-
HttpResponseCallback<Module>
Der optionale Rückruf, der entweder mit einem Error-Objekt oder dem Modul:azure-iothub aufgerufen wird. Module-Objekt 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 für
- done
-
HttpResponseCallback<Module[]>
Der optionale Rückruf, der entweder mit einem Error-Objekt oder einem Array von Modul: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 Module Twin 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 Twin-Instanz des Moduls 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 Device Twin des Geräts mit der angegebenen Geräte-ID 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 Twin-Instanz des Geräts 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 im Massenauftrag.
function importDevicesFromBlob(inputBlobContainerUri: string, outputBlobContainerUri: string, done?: Callback<JobStatus>)
Parameter
- inputBlobContainerUri
-
string
Der URI zu einem Container mit einem Blob mit dem Namen '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 Importvorgangs erstellt wird.
- done
-
Callback<JobStatus>
Die optionale Funktion, die aufgerufen werden soll, wenn der Auftrag erstellt wurde, mit zwei Argumenten: ein Fehlerobjekt, wenn ein Fehler aufgetreten ist (andernfalls NULL) und der 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 zu einem Container mit einem Blob mit dem Namen '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 Importvorgangs erstellt wird.
- done
-
Callback<JobStatus>
Die optionale Funktion, die aufgerufen werden soll, wenn der Auftrag erstellt wurde, mit zwei Argumenten: ein Fehlerobjekt, wenn ein Fehler aufgetreten ist (andernfalls NULL) und der Auftragsstatus, der zum Nachverfolgen des Fortschritts des Geräteimports verwendet werden kann.
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 auf 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: ein Error-Objekt (kann null sein), ein Array von Device-Objekten, die die aufgeführten Geräteidentitäten darstellen, und ein transportspezifisches 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>)
Auflisten der letzten Import-/Exportaufträge (einschließlich des aktiven, 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>
Die optionale Funktion, die aufgerufen werden soll, wenn der Vorgang abgeschlossen ist.
done
wird mit drei Argumenten aufgerufen: ein Error-Objekt (kann null sein), der Textkörper der Antwort und ein transportspezifisches Antwortobjekt, das für die Protokollierung oder das Debuggen nützlich ist.
removeDevices(DeviceDescription[], boolean)
function removeDevices(devices: DeviceDescription[], forceRemove: boolean): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>
Parameter
- devices
- forceRemove
-
boolean
Gibt zurück
Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>
removeDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)
Aktualisiert ein Array von Geräten.
function removeDevices(devices: DeviceDescription[], forceRemove: boolean, done?: HttpResponseCallback<BulkRegistryOperationResult>)
Parameter
- devices
Ein Array von Objekten, die eine deviceId
Eigenschaft enthalten müssen, 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>
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 BulkRegistryOperationResult und ein transportspezifisches Antwortobjekt, das zum Protokollieren oder Debuggen nützlich ist.
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>
Die optionale Funktion, die aufgerufen werden soll, wenn der Vorgang abgeschlossen ist.
done
wird mit drei Argumenten aufgerufen: ein Error-Objekt (kann null sein), der Textkörper der Antwort und ein transportspezifisches Antwortobjekt, das für die Protokollierung oder das Debuggen nützlich ist.
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>)
Aktualisiert eine vorhandene Geräteidentität auf einem IoT-Hub mit den angegebenen Geräteinformationen.
Der parameter deviceInfo
muss alle aktualisierbaren Eigenschaften enthalten. Wenn sie z. B. die status
-Eigenschaft von disabled
auf enabled
aktualisieren, sollte das deviceInfo
-Objekt auch den StatusReason, die Authentifizierung (und seine Untereigenschaften), Funktionen und deviceScope auf die aktuellen Gerätewerte festlegen, oder diese Eigenschaften werden zurückgesetzt. Es wird empfohlen, dass die Get-API zuerst aufgerufen wird, bevor Sie ein Update ausführen.
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: ein Error-Objekt (kann null sein), ein Device-Objekt, das die aktualisierte Geräteidentität darstellt, und ein transportspezifisches 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 zum Hinzufügen zum Hub
- done
-
HttpResponseCallback<any>
Die optionale Funktion, die aufgerufen werden soll, wenn der Vorgang abgeschlossen ist.
done
wird mit drei Argumenten aufgerufen: ein Error-Objekt (kann null sein), der Textkörper der Antwort und ein transportspezifisches Antwortobjekt, das für die Protokollierung oder das Debuggen nützlich ist.
updateDevices(DeviceDescription[], boolean)
function updateDevices(devices: DeviceDescription[], forceUpdate: boolean): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>
Parameter
- devices
- forceUpdate
-
boolean
Gibt zurück
Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>
updateDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)
Aktualisiert ein Array von Geräten.
Die einzelnen Elemente des devices
-Parameters müssen alle Aktualisierbaren Eigenschaften enthalten. Wenn sie beispielsweise die status
-Eigenschaft von disabled
auf enabled
aktualisieren, sollte das Objekt auch den StatusReason, die Authentifizierung (und seine Untereigenschaften), Funktionen und deviceScope auf die aktuellen Gerätewerte festlegen, oder diese Eigenschaften werden 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
Ein Array von Objekten, die eine deviceId
Eigenschaft enthalten müssen, 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 aufgerufen werden soll, wenn der Vorgang abgeschlossen ist.
done
wird mit drei Argumenten aufgerufen: ein Error-Objekt (kann null sein), ein BulkRegistryOperationResult und ein transportspezifisches Antwortobjekt, das zum Protokollieren oder 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
Modulobjekt, das aktualisiert werden soll.
- done
-
TripleValueCallback<any, any>
Die optionale Funktion, die aufgerufen werden soll, wenn der Vorgang abgeschlossen ist.
done
wird mit drei Argumenten aufgerufen: ein Error-Objekt (kann null sein), der Textkörper der Antwort und ein transportspezifisches 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>)
Aktualisiert den Twin 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
Der Modulbezeichner
- patch
-
any
Die gewünschten Eigenschaften und Tags zum Patchen des Moduls Twin mit.
- etag
-
string
Das neueste Etag für dieses Modul Twin oder '*', um eine Aktualisierung zu erzwingen, auch wenn das Modul-Twin seit dem Abrufen des Etags aktualisiert wurde.
- done
-
HttpResponseCallback<Twin>
Der optionale Rückruf, der entweder mit einem Error-Objekt oder der Twin-Instanz des Moduls 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>)
Aktualisiert den Device Twin 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 der das Gerät gepatcht werden soll.
- etag
-
string
Das neueste Etag für dieses Gerät Twin oder '*', um ein Update zu erzwingen, auch wenn das Gerät Twin seit dem Abrufen des Etags aktualisiert wurde.
- done
-
HttpResponseCallback<Twin>
Der optionale Rückruf, der entweder mit einem Error-Objekt oder der Twin-Instanz des Geräts aufgerufen wird.