Registry class
Klassen Registry ger åtkomst till IoT Hub enhetsidentitetstjänsten. Användare av SDK:t bör instansiera den här klassen med någon av fabriksmetoderna: fromConnectionString eller fromSharedAccessSignature.
Protokollet som används för enhetsidentitetsregisteråtgärder är HTTPS.
Metoder
Metodinformation
addConfiguration(Configuration)
function addConfiguration(configuration: Configuration): Promise<ResultWithHttpResponse<any>>Parametrar
- configuration
- Configuration
Returer
Promise<ResultWithHttpResponse<any>>
addConfiguration(Configuration, HttpResponseCallback<any>)
Lägg till en konfiguration i en IoT-hubb.
function addConfiguration(configuration: Configuration, done?: HttpResponseCallback<any>)Parametrar
- configuration
- Configuration
Ett objekt av typen module:azure-iothub. Konfiguration som ska läggas till i hubben
- done
-
HttpResponseCallback<any>
Den valfria funktionen som ska anropas när åtgärden har slutförts. done anropas med tre argument: ett felobjekt (kan vara null), brödtexten i svaret och ett transportspecifikt svarsobjekt som är användbart för loggning eller felsökning.
addDevices(DeviceDescription[])
function addDevices(devices: DeviceDescription[]): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>Parametrar
- devices
Returer
Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>
addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)
Lägger till en matris med enheter.
function addDevices(devices: DeviceDescription[], done?: HttpResponseCallback<BulkRegistryOperationResult>)Parametrar
- devices
En matris med objekt som måste innehålla en deviceId egenskap vars värde är en giltig enhetsidentifierare.
- done
-
HttpResponseCallback<BulkRegistryOperationResult>
Den valfria funktionen som ska anropas när åtgärden har slutförts. done anropas med tre argument: ett felobjekt (kan vara null), ett BulkRegistryOperationResult och ett transportspecifikt svarsobjekt som är användbart för loggning eller felsökning.
addModule(Module)
function addModule(module: Module): Promise<ResultWithHttpResponse<any>>Parametrar
- module
- Module
Returer
Promise<ResultWithHttpResponse<any>>
addModule(Module, HttpResponseCallback<any>)
Lägg till den angivna modulen i registret.
function addModule(module: Module, done?: HttpResponseCallback<any>)Parametrar
- module
- Module
Modulobjekt som ska läggas till i registret.
- done
-
HttpResponseCallback<any>
Den valfria funktionen som ska anropas när åtgärden har slutförts. done anropas med tre argument: ett felobjekt (kan vara null), brödtexten i svaret och ett transportspecifikt svarsobjekt som är användbart för loggning eller felsökning.
applyConfigurationContentOnDevice(string, ConfigurationContent)
function applyConfigurationContentOnDevice(deviceId: string, content: ConfigurationContent): Promise<ResultWithHttpResponse<any>>Parametrar
- deviceId
-
string
- content
- ConfigurationContent
Returer
Promise<ResultWithHttpResponse<any>>
applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)
Tillämpa den angivna konfigurationen på en enhet på en IoT Hub
function applyConfigurationContentOnDevice(deviceId: string, content: ConfigurationContent, done?: HttpResponseCallback<any>)Parametrar
- deviceId
-
string
ID för enheten som konfigurationen ska tillämpas på
- content
- ConfigurationContent
Den konfiguration som ska tillämpas
- done
-
HttpResponseCallback<any>
Den valfria funktionen som ska anropas när åtgärden har slutförts. done anropas med tre argument: ett felobjekt (kan vara null), brödtexten i svaret och ett transportspecifikt svarsobjekt som är användbart för loggning eller felsökning.
cancelJob(string)
function cancelJob(jobId: string): Promise<JobStatus>Parametrar
- jobId
-
string
Returer
Promise<JobStatus>
cancelJob(string, Callback<JobStatus>)
Avbryt ett massimport-/exportjobb.
function cancelJob(jobId: string, done?: Callback<JobStatus>)Parametrar
- jobId
-
string
Identifieraren för jobbet som användaren vill hämta statusinformation för.
- done
-
Callback<JobStatus>
Den valfria funktionen som anropas med två argument: ett felobjekt om ett fel har inträffat( annars null) och (avbruten) status för jobbet vars identifierare skickades som ett argument.
create(DeviceDescription)
function create(deviceInfo: DeviceDescription): Promise<ResultWithHttpResponse<Device>>Parametrar
- deviceInfo
- DeviceDescription
Returer
Promise<ResultWithHttpResponse<Device>>
create(DeviceDescription, HttpResponseCallback<Device>)
Skapar en ny enhetsidentitet på en IoT-hubb.
function create(deviceInfo: DeviceDescription, done?: HttpResponseCallback<Device>)Parametrar
- deviceInfo
- DeviceDescription
Objektet måste innehålla en deviceId egenskap med en giltig enhetsidentifierare.
- done
-
HttpResponseCallback<Device>
Den valfria funktionen som ska anropas när åtgärden har slutförts. done anropas med tre argument: ett felobjekt (kan vara null), ett enhetsobjekt som representerar den skapade enhetsidentiteten och ett transportspecifikt svarsobjekt som är användbart för loggning eller felsökning.
createQuery(string, number)
Skapar en fråga som kan köras på IoT Hub-instansen för att hitta information om enheter eller jobb.
function createQuery(sqlQuery: string, pageSize?: number): QueryParametrar
- sqlQuery
-
string
Frågan skrivs som en SQL-sträng.
- pageSize
-
number
Önskat antal resultat per sida (valfritt. standard: 1 000, max: 1 0000).
Returer
Query
delete(string)
function delete(deviceId: string): Promise<ResultWithHttpResponse<any>>Parametrar
- deviceId
-
string
Returer
Promise<ResultWithHttpResponse<any>>
delete(string, HttpResponseCallback<any>)
Tar bort en befintlig enhetsidentitet från en IoT-hubb.
function delete(deviceId: string, done?: HttpResponseCallback<any>)Parametrar
- deviceId
-
string
Identifieraren för en befintlig enhetsidentitet.
- done
-
HttpResponseCallback<any>
Den valfria funktionen som ska anropas när åtgärden har slutförts. done anropas med tre argument: ett felobjekt (kan vara null), ett always-null-argument (för konsekvens med de andra metoderna) och ett transportspecifikt svarsobjekt som är användbart för loggning eller felsökning.
exportDevicesToBlob(string, boolean)
function exportDevicesToBlob(outputBlobContainerUri: string, excludeKeys: boolean): Promise<JobStatus>Parametrar
- outputBlobContainerUri
-
string
- excludeKeys
-
boolean
Returer
Promise<JobStatus>
exportDevicesToBlob(string, boolean, Callback<JobStatus>)
Exportera enheter till en blob i ett massjobb.
function exportDevicesToBlob(outputBlobContainerUri: string, excludeKeys: boolean, done?: Callback<JobStatus>)Parametrar
- outputBlobContainerUri
-
string
URI:n till en container där en blob med namnet "devices.txt" skapas som innehåller listan över enheter.
- excludeKeys
-
boolean
Booleskt värde som anger om säkerhetsnycklar ska undantas från exporterade data.
- done
-
Callback<JobStatus>
Den valfria funktionen att anropa när jobbet har skapats, med två argument: ett felobjekt om ett fel har inträffat (annars null) och jobbstatusen som kan användas för att spåra förloppet för enhetsexporten.
exportDevicesToBlobByIdentity(string, boolean)
function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean): Promise<JobStatus>Parametrar
- outputBlobContainerUri
-
string
- excludeKeys
-
boolean
Returer
Promise<JobStatus>
exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)
Exportera enheter till en blob i ett massjobb med hjälp av en konfigurerad identitet.
function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean, done?: Callback<JobStatus>)Parametrar
- outputBlobContainerUri
-
string
URI:n till en container där en blob med namnet "devices.txt" skapas som innehåller listan över enheter.
- excludeKeys
-
boolean
Booleskt värde som anger om säkerhetsnycklar ska undantas från exporterade data.
- done
-
Callback<JobStatus>
Den valfria funktionen att anropa när jobbet har skapats, med två argument: ett felobjekt om ett fel har inträffat (annars null) och jobbstatusen som kan användas för att spåra förloppet för enhetsexporten.
exportDevicesToBlobByIdentity(string, boolean, string)
function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean, userAssignedIdentity: string): Promise<JobStatus>Parametrar
- outputBlobContainerUri
-
string
- excludeKeys
-
boolean
- userAssignedIdentity
-
string
Returer
Promise<JobStatus>
exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)
function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean, userAssignedIdentity: string, done: Callback<JobStatus>)Parametrar
- outputBlobContainerUri
-
string
- excludeKeys
-
boolean
- userAssignedIdentity
-
string
- done
-
Callback<JobStatus>
fromConnectionString(string)
Konstruerar ett registerobjekt från den angivna anslutningssträngen.
static function fromConnectionString(value: string): RegistryParametrar
- value
-
string
En anslutningssträng som kapslar in lämpliga (läs- och/eller skrivbehörigheter) registerbehörigheter.
Returer
fromSharedAccessSignature(string)
Konstruerar ett registerobjekt från den angivna signaturen för delad åtkomst.
static function fromSharedAccessSignature(value: string): RegistryParametrar
- value
-
string
En signatur för delad åtkomst som kapslar in lämpliga (läs- och/eller skrivbehörigheter) registerbehörigheter.
Returer
fromTokenCredential(string, TokenCredential)
Konstruerar ett registerobjekt från angiven Azure TokenCredential.
static function fromTokenCredential(hostName: string, tokenCredential: TokenCredential): RegistryParametrar
- hostName
-
string
Värdnamnet för Azure-tjänsten.
- tokenCredential
- TokenCredential
En Azure TokenCredential som används för att autentisera med Azure-tjänsten
Returer
get(string)
function get(deviceId: string): Promise<ResultWithHttpResponse<Device>>Parametrar
- deviceId
-
string
Returer
Promise<ResultWithHttpResponse<Device>>
get(string, HttpResponseCallback<Device>)
Begär information om en befintlig enhetsidentitet på en IoT-hubb.
function get(deviceId: string, done?: HttpResponseCallback<Device>)Parametrar
- deviceId
-
string
Identifieraren för en befintlig enhetsidentitet.
- done
-
HttpResponseCallback<Device>
Den valfria funktionen som ska anropas när åtgärden har slutförts. done anropas med tre argument: ett felobjekt (kan vara null), ett enhetsobjekt som representerar den skapade enhetsidentiteten och ett transportspecifikt svarsobjekt som är användbart för loggning eller felsökning.
getConfiguration(string)
function getConfiguration(configurationId: string): Promise<ResultWithHttpResponse<Configuration>>Parametrar
- configurationId
-
string
Returer
Promise<ResultWithHttpResponse<Configuration>>
getConfiguration(string, HttpResponseCallback<Configuration>)
Hämta en enda konfiguration från en IoT Hub
function getConfiguration(configurationId: string, done?: HttpResponseCallback<Configuration>)Parametrar
- configurationId
-
string
ID:t för konfigurationen som du ska hämta
- done
-
HttpResponseCallback<Configuration>
Det valfria återanropet som anropas med antingen ett felobjekt eller en modul:azure-iothub. Konfigurationsobjekt med konfigurationsinformationen.
getConfigurations()
function getConfigurations(): Promise<ResultWithHttpResponse<Configuration[]>>Returer
Promise<ResultWithHttpResponse<Configuration[]>>
getConfigurations(HttpResponseCallback<Configuration[]>)
Hämta alla konfigurationer på en IoT Hub
function getConfigurations(done?: HttpResponseCallback<Configuration[]>)Parametrar
- done
-
HttpResponseCallback<Configuration[]>
Det valfria återanropet som anropas med antingen ett felobjekt eller en matris med module:azure-iothub. Konfigurationsobjekt för alla konfigurationer.
getJob(string)
function getJob(jobId: string): Promise<JobStatus>Parametrar
- jobId
-
string
Returer
Promise<JobStatus>
getJob(string, Callback<JobStatus>)
Hämta status för ett massimport-/exportjobb.
function getJob(jobId: string, done?: Callback<JobStatus>)Parametrar
- jobId
-
string
Identifieraren för jobbet som användaren vill hämta statusinformation för.
- done
-
Callback<JobStatus>
Den valfria funktionen som ska anropas med två argument: ett felobjekt om ett fel har inträffat (annars null) och status för jobbet vars identifierare skickades som ett argument.
getModule(string, string)
function getModule(deviceId: string, moduleId: string): Promise<ResultWithHttpResponse<Module>>Parametrar
- deviceId
-
string
- moduleId
-
string
Returer
Promise<ResultWithHttpResponse<Module>>
getModule(string, string, HttpResponseCallback<Module>)
Hämta en enskild modul från en enhet på en IoT Hub
function getModule(deviceId: string, moduleId: string, done?: HttpResponseCallback<Module>)Parametrar
- deviceId
-
string
Enhets-ID som äger modulen.
- moduleId
-
string
Modul-ID som ska hämtas
- done
-
HttpResponseCallback<Module>
Det valfria återanropet som anropas med antingen ett Fel-objekt eller modulen:azure-iothub. Modulobjekt för den begärda modulen
getModulesOnDevice(string)
function getModulesOnDevice(deviceId: string): Promise<ResultWithHttpResponse<Module[]>>Parametrar
- deviceId
-
string
Returer
Promise<ResultWithHttpResponse<Module[]>>
getModulesOnDevice(string, HttpResponseCallback<Module[]>)
Hämta en lista över alla moduler på en IoT Hub enhet
function getModulesOnDevice(deviceId: string, done?: HttpResponseCallback<Module[]>)Parametrar
- deviceId
-
string
ID för enheten som vi hämtar moduler för
- done
-
HttpResponseCallback<Module[]>
Det valfria återanropet som anropas med antingen ett felobjekt eller en matris med module:azure-iothub. Modulobjekt för alla moduler.
getModuleTwin(string, string)
function getModuleTwin(deviceId: string, moduleId: string): Promise<ResultWithHttpResponse<Twin>>Parametrar
- deviceId
-
string
- moduleId
-
string
Returer
Promise<ResultWithHttpResponse<Twin>>
getModuleTwin(string, string, HttpResponseCallback<Twin>)
Hämtar modultvillingen för modulen med den angivna modulidentifieraren.
function getModuleTwin(deviceId: string, moduleId: string, done?: HttpResponseCallback<Twin>)Parametrar
- deviceId
-
string
Enhetsidentifieraren.
- moduleId
-
string
Modulidentifieraren.
- done
-
HttpResponseCallback<Twin>
Det valfria återanropet som anropas med antingen ett Fel-objekt eller modultvillinginstansen.
getRegistryStatistics()
function getRegistryStatistics(): Promise<ResultWithHttpResponse<RegistryStatistics>>Returer
Promise<ResultWithHttpResponse<RegistryStatistics>>
getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)
Hämtar statistik om enheterna i enhetsidentitetsregistret.
function getRegistryStatistics(done?: HttpResponseCallback<RegistryStatistics>)Parametrar
- done
-
HttpResponseCallback<RegistryStatistics>
Det valfria återanropet som anropas med antingen ett felobjekt eller enhetsregistrets statistik.
getTwin(string)
function getTwin(deviceId: string): Promise<ResultWithHttpResponse<Twin>>Parametrar
- deviceId
-
string
Returer
Promise<ResultWithHttpResponse<Twin>>
getTwin(string, HttpResponseCallback<Twin>)
Hämtar enhetens enhetstvilling med den angivna enhetsidentifieraren.
function getTwin(deviceId: string, done?: HttpResponseCallback<Twin>)Parametrar
- deviceId
-
string
Enhetsidentifieraren.
- done
-
HttpResponseCallback<Twin>
Det valfria återanropet som anropas med antingen ett Fel-objekt eller enhetstvillinginstansen.
importDevicesFromBlob(string, string)
function importDevicesFromBlob(inputBlobContainerUri: string, outputBlobContainerUri: string): Promise<JobStatus>Parametrar
- inputBlobContainerUri
-
string
- outputBlobContainerUri
-
string
Returer
Promise<JobStatus>
importDevicesFromBlob(string, string, Callback<JobStatus>)
Importerar enheter från en blob i massjobb.
function importDevicesFromBlob(inputBlobContainerUri: string, outputBlobContainerUri: string, done?: Callback<JobStatus>)Parametrar
- inputBlobContainerUri
-
string
URI:n till en container med en blob med namnet "devices.txt" som innehåller en lista över enheter som ska importeras.
- outputBlobContainerUri
-
string
URI:n till en container där en blob skapas med loggar för importprocessen.
- done
-
Callback<JobStatus>
Den valfria funktionen som anropas när jobbet har skapats, med två argument: ett felobjekt om ett fel har inträffat (annars null) och jobbstatusen som kan användas för att spåra förloppet för enhetsimporten.
importDevicesFromBlobByIdentity(string, string)
function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string): Promise<JobStatus>Parametrar
- inputBlobContainerUri
-
string
- outputBlobContainerUri
-
string
Returer
Promise<JobStatus>
importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)
Importerar enheter från en blob i massjobb med hjälp av en konfigurerad identitet.
function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string, done?: Callback<JobStatus>)Parametrar
- inputBlobContainerUri
-
string
URI:n till en container med en blob med namnet "devices.txt" som innehåller en lista över enheter som ska importeras.
- outputBlobContainerUri
-
string
URI:n till en container där en blob skapas med loggar för importprocessen.
- done
-
Callback<JobStatus>
Den valfria funktionen som anropas när jobbet har skapats, med två argument: ett felobjekt om ett fel har inträffat (annars null) och jobbstatusen som kan användas för att spåra förloppet för enhetsimporten.
importDevicesFromBlobByIdentity(string, string, string)
function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string, userAssignedIdentity: string): Promise<JobStatus>Parametrar
- inputBlobContainerUri
-
string
- outputBlobContainerUri
-
string
- userAssignedIdentity
-
string
Returer
Promise<JobStatus>
importDevicesFromBlobByIdentity(string, string, string, Callback<JobStatus>)
function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string, userAssignedIdentity: string, done: Callback<JobStatus>)Parametrar
- inputBlobContainerUri
-
string
- outputBlobContainerUri
-
string
- userAssignedIdentity
-
string
- done
-
Callback<JobStatus>
list()
function list(): Promise<ResultWithHttpResponse<Device[]>>Returer
Promise<ResultWithHttpResponse<Device[]>>
list(HttpResponseCallback<Device[]>)
Begär information om de första 1 000 enhetsidentiteterna på en IoT-hubb.
function list(done?: HttpResponseCallback<Device[]>)Parametrar
- done
-
HttpResponseCallback<Device[]>
Den valfria funktionen som ska anropas när åtgärden har slutförts. done anropas med tre argument: ett felobjekt (kan vara null), en matris med enhetsobjekt som representerar enhetsidentiteterna i listan och ett transportspecifikt svarsobjekt som är användbart för loggning eller felsökning.
listJobs()
function listJobs(): Promise<ResultWithHttpResponse<any>>Returer
Promise<ResultWithHttpResponse<any>>
listJobs(HttpResponseCallback<any>)
Visa en lista över de senaste import-/exportjobben (inklusive det aktiva, om det finns några).
function listJobs(done?: HttpResponseCallback<any>)Parametrar
- done
-
HttpResponseCallback<any>
Den valfria funktionen som ska anropas med två argument: ett felobjekt om ett fel har inträffat (annars null) och listan över tidigare jobb som argument.
removeConfiguration(string)
function removeConfiguration(configurationId: string): Promise<ResultWithHttpResponse<any>>Parametrar
- configurationId
-
string
Returer
Promise<ResultWithHttpResponse<any>>
removeConfiguration(string, HttpResponseCallback<any>)
Ta bort en konfiguration med det angivna ID:t från en IoT Hub
function removeConfiguration(configurationId: string, done?: HttpResponseCallback<any>)Parametrar
- configurationId
-
string
ID för konfigurationen som ska tas bort
- done
-
HttpResponseCallback<any>
Den valfria funktionen som ska anropas när åtgärden har slutförts. done anropas med tre argument: ett felobjekt (kan vara null), brödtexten i svaret och ett transportspecifikt svarsobjekt som är användbart för loggning eller felsökning.
removeDevices(DeviceDescription[], boolean)
function removeDevices(devices: DeviceDescription[], forceRemove: boolean): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>Parametrar
- devices
- forceRemove
-
boolean
Returer
Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>
removeDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)
Uppdateringar en matris med enheter.
function removeDevices(devices: DeviceDescription[], forceRemove: boolean, done?: HttpResponseCallback<BulkRegistryOperationResult>)Parametrar
- devices
En matris med objekt som måste innehålla en deviceId egenskap vars värde är en giltig enhetsidentifierare.
- forceRemove
-
boolean
om forceRemove är sant tas enheten bort oavsett etag. Annars måste etags matcha.
- done
-
HttpResponseCallback<BulkRegistryOperationResult>
Den valfria funktionen som ska anropas när åtgärden har slutförts. done anropas med tre argument: ett felobjekt (kan vara null), ett BulkRegistryOperationResult och ett transportspecifikt svarsobjekt som är användbart för loggning eller felsökning.
removeModule(Module, TripleValueCallback<any, any>)
Ta bort den angivna modulen från registret
function removeModule(module: Module, done?: TripleValueCallback<any, any>)Parametrar
- module
- Module
- done
-
TripleValueCallback<any, any>
Den valfria funktionen som ska anropas när åtgärden har slutförts. done anropas med tre argument: ett felobjekt (kan vara null), brödtexten i svaret och ett transportspecifikt svarsobjekt som är användbart för loggning eller felsökning.
removeModule(string | Module)
function removeModule(moduleOrDeviceId: string | Module): Promise<ResultWithHttpResponse<any>>Parametrar
- moduleOrDeviceId
-
string | Module
Returer
Promise<ResultWithHttpResponse<any>>
removeModule(string | Module, string)
function removeModule(moduleOrDeviceId: string | Module, moduleId: string): Promise<ResultWithHttpResponse<any>>Parametrar
- moduleOrDeviceId
-
string | Module
- moduleId
-
string
Returer
Promise<ResultWithHttpResponse<any>>
removeModule(string, string, TripleValueCallback<any, any>)
function removeModule(deviceId: string, moduleId: string, done: TripleValueCallback<any, any>)Parametrar
- deviceId
-
string
- moduleId
-
string
- done
-
TripleValueCallback<any, any>
update(DeviceDescription)
function update(deviceInfo: DeviceDescription): Promise<ResultWithHttpResponse<Device>>Parametrar
- deviceInfo
- DeviceDescription
Returer
Promise<ResultWithHttpResponse<Device>>
update(DeviceDescription, HttpResponseCallback<Device>)
Uppdateringar en befintlig enhetsidentitet på en IoT-hubb med den angivna enhetsinformationen.
Parametern deviceInfo måste innehålla alla egenskaper som kan uppdateras. Om du till exempel uppdaterar status egenskapen från disabled till enableddeviceInfo ska objektet också ha statusReason, autentisering (och dess underegenskaper), funktioner och deviceScope inställda på enheternas aktuella värden, annars återställs dessa egenskaper. Vi rekommenderar att get-API:et anropas först innan du gör en uppdatering.
function update(deviceInfo: DeviceDescription, done?: HttpResponseCallback<Device>)Parametrar
- deviceInfo
- DeviceDescription
Ett objekt som måste innehålla en deviceId egenskap vars värde är en giltig enhetsidentifierare.
- done
-
HttpResponseCallback<Device>
Den valfria funktionen som ska anropas när åtgärden har slutförts. done anropas med tre argument: ett felobjekt (kan vara null), ett enhetsobjekt som representerar den uppdaterade enhetsidentiteten och ett transportspecifikt svarsobjekt som är användbart för loggning eller felsökning.
updateConfiguration(Configuration)
function updateConfiguration(configuration: Configuration): Promise<ResultWithHttpResponse<any>>Parametrar
- configuration
- Configuration
Returer
Promise<ResultWithHttpResponse<any>>
updateConfiguration(Configuration, boolean)
function updateConfiguration(configuration: Configuration, forceUpdate: boolean): Promise<ResultWithHttpResponse<any>>Parametrar
- configuration
- Configuration
- forceUpdate
-
boolean
Returer
Promise<ResultWithHttpResponse<any>>
updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)
function updateConfiguration(configuration: Configuration, forceUpdate: boolean, done: HttpResponseCallback<any>)Parametrar
- configuration
- Configuration
- forceUpdate
-
boolean
- done
-
HttpResponseCallback<any>
updateConfiguration(Configuration, HttpResponseCallback<any>)
Uppdatera en konfiguration i en IoT-hubb
function updateConfiguration(configuration: Configuration, done?: HttpResponseCallback<any>)Parametrar
- configuration
- Configuration
Ett objekt av typen module:azure-iothub. Konfiguration som ska läggas till i hubben
- done
-
HttpResponseCallback<any>
Den valfria funktionen som ska anropas när åtgärden har slutförts. done anropas med tre argument: ett felobjekt (kan vara null), brödtexten i svaret och ett transportspecifikt svarsobjekt som är användbart för loggning eller felsökning.
updateDevices(DeviceDescription[], boolean)
function updateDevices(devices: DeviceDescription[], forceUpdate: boolean): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>Parametrar
- devices
- forceUpdate
-
boolean
Returer
Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>
updateDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)
Uppdateringar en matris med enheter.
De enskilda elementen i parametern devices måste innehålla alla egenskaper som är uppdaterade. Om du till exempel uppdaterar status egenskapen från disabled till enabledska objektet också ha statusReason, autentisering (och dess underegenskaper), funktioner och deviceScope inställt på enheternas aktuella värden, annars återställs dessa egenskaper. Vi rekommenderar att get-API:et anropas först innan du gör en uppdatering.
function updateDevices(devices: DeviceDescription[], forceUpdate: boolean, done?: HttpResponseCallback<BulkRegistryOperationResult>)Parametrar
- devices
En matris med objekt som måste innehålla en deviceId egenskap vars värde är en giltig enhetsidentifierare.
- forceUpdate
-
boolean
om forceUpdate är sant uppdateras enheten oavsett etag. Annars måste etags matcha.
- done
-
HttpResponseCallback<BulkRegistryOperationResult>
Den valfria funktionen att anropa när åtgärden är klar. done anropas med tre argument: ett felobjekt (kan vara null), ett BulkRegistryOperationResult och ett transportspecifikt svarsobjekt som är användbart för loggning eller felsökning.
updateModule(Module)
function updateModule(module: Module): Promise<ResultWithHttpResponse<any>>Parametrar
- module
- Module
Returer
Promise<ResultWithHttpResponse<any>>
updateModule(Module, boolean)
function updateModule(module: Module, forceUpdate: boolean): Promise<ResultWithHttpResponse<any>>Parametrar
- module
- Module
- forceUpdate
-
boolean
Returer
Promise<ResultWithHttpResponse<any>>
updateModule(Module, boolean, HttpResponseCallback<any>)
function updateModule(module: Module, forceUpdate: boolean, done: HttpResponseCallback<any>)Parametrar
- module
- Module
- forceUpdate
-
boolean
- done
-
HttpResponseCallback<any>
updateModule(Module, TripleValueCallback<any, any>)
Uppdatera det angivna modulobjektet i registret
function updateModule(module: Module, done?: TripleValueCallback<any, any>)Parametrar
- module
- Module
Modulobjekt som ska uppdateras.
- done
-
TripleValueCallback<any, any>
Den valfria funktionen att anropa när åtgärden är klar. done anropas med tre argument: ett felobjekt (kan vara null), svarets brödtext och ett transportspecifikt svarsobjekt som är användbart för loggning eller felsökning.
updateModuleTwin(string, string, any, string)
function updateModuleTwin(deviceId: string, moduleId: string, patch: any, etag: string): Promise<ResultWithHttpResponse<Twin>>Parametrar
- deviceId
-
string
- moduleId
-
string
- patch
-
any
- etag
-
string
Returer
Promise<ResultWithHttpResponse<Twin>>
updateModuleTwin(string, string, any, string, HttpResponseCallback<Twin>)
Uppdateringar tvillingen för en specifik modul med den angivna korrigeringen.
function updateModuleTwin(deviceId: string, moduleId: string, patch: any, etag: string, done?: HttpResponseCallback<Twin>)Parametrar
- deviceId
-
string
Enhetsidentifieraren.
- moduleId
-
string
Modulidentifieraren
- patch
-
any
Önskade egenskaper och taggar att korrigera modultvillingen med.
- etag
-
string
Den senaste etag för den här modultvillingen eller "*" för att framtvinga en uppdatering även om modultvillingen har uppdaterats sedan etag erhölls.
- done
-
HttpResponseCallback<Twin>
Det valfria återanropet som anropas med antingen ett felobjekt eller modultvillinginstansen.
updateTwin(string, any, string)
function updateTwin(deviceId: string, patch: any, etag: string): Promise<ResultWithHttpResponse<Twin>>Parametrar
- deviceId
-
string
- patch
-
any
- etag
-
string
Returer
Promise<ResultWithHttpResponse<Twin>>
updateTwin(string, any, string, HttpResponseCallback<Twin>)
Uppdateringar enhetstvillingen för en specifik enhet med den angivna korrigeringen.
function updateTwin(deviceId: string, patch: any, etag: string, done?: HttpResponseCallback<Twin>)Parametrar
- deviceId
-
string
Enhetsidentifieraren.
- patch
-
any
Önskade egenskaper och taggar att korrigera enhetstvillingen med.
- etag
-
string
Den senaste etag för den här enhetstvillingen eller "*" för att framtvinga en uppdatering även om enhetstvillingen har uppdaterats sedan etag erhölls.
- done
-
HttpResponseCallback<Twin>
Det valfria återanropet som anropas med antingen ett felobjekt eller en enhetstvillinginstans.