Registry class
De klasse Registry biedt toegang tot de IoT Hub apparaat-id-service. Gebruikers van de SDK moeten deze klasse instantiëren met een van de factorymethoden: fromConnectionString of fromSharedAccessSignature.
Het protocol dat wordt gebruikt voor registerbewerkingen voor apparaat-id's is HTTPS.
Methoden
Methodedetails
addConfiguration(Configuration)
function addConfiguration(configuration: Configuration): Promise<ResultWithHttpResponse<any>>Parameters
- configuration
- Configuration
Retouren
Promise<ResultWithHttpResponse<any>>
addConfiguration(Configuration, HttpResponseCallback<any>)
Voeg een configuratie toe aan een IoT-hub.
function addConfiguration(configuration: Configuration, done?: HttpResponseCallback<any>)Parameters
- configuration
- Configuration
Een object van het type module:azure-iothub. Configuratie om toe te voegen aan de hub
- done
-
HttpResponseCallback<any>
De optionele functie die moet worden aangeroepen wanneer de bewerking is voltooid. done wordt aangeroepen met drie argumenten: een foutobject (kan null zijn), de hoofdtekst van het antwoord en een transportspecifiek antwoordobject dat handig is voor logboekregistratie of foutopsporing.
addDevices(DeviceDescription[])
function addDevices(devices: DeviceDescription[]): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>Parameters
- devices
Retouren
Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>
addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)
Hiermee voegt u een matrix van apparaten toe.
function addDevices(devices: DeviceDescription[], done?: HttpResponseCallback<BulkRegistryOperationResult>)Parameters
- devices
Een matrix met objecten die een deviceId eigenschap moeten bevatten waarvan de waarde een geldige apparaat-id is.
- done
-
HttpResponseCallback<BulkRegistryOperationResult>
De optionele functie die moet worden aangeroepen wanneer de bewerking is voltooid. done wordt aangeroepen met drie argumenten: een Error-object (kan null zijn), een BulkRegistryOperationResult en een transportspecifiek antwoordobject dat handig is voor logboekregistratie of foutopsporing.
addModule(Module)
function addModule(module: Module): Promise<ResultWithHttpResponse<any>>Parameters
- module
- Module
Retouren
Promise<ResultWithHttpResponse<any>>
addModule(Module, HttpResponseCallback<any>)
Voeg de opgegeven module toe aan het register.
function addModule(module: Module, done?: HttpResponseCallback<any>)Parameters
- module
- Module
Moduleobject dat moet worden toegevoegd aan het register.
- done
-
HttpResponseCallback<any>
De optionele functie die moet worden aangeroepen wanneer de bewerking is voltooid. done wordt aangeroepen met drie argumenten: een foutobject (kan null zijn), de hoofdtekst van het antwoord en een transportspecifiek antwoordobject dat handig is voor logboekregistratie of foutopsporing.
applyConfigurationContentOnDevice(string, ConfigurationContent)
function applyConfigurationContentOnDevice(deviceId: string, content: ConfigurationContent): Promise<ResultWithHttpResponse<any>>Parameters
- deviceId
-
string
- content
- ConfigurationContent
Retouren
Promise<ResultWithHttpResponse<any>>
applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)
De opgegeven configuratie toepassen op een apparaat op een IoT Hub
function applyConfigurationContentOnDevice(deviceId: string, content: ConfigurationContent, done?: HttpResponseCallback<any>)Parameters
- deviceId
-
string
Id van het apparaat om de configuratie op toe te passen
- content
- ConfigurationContent
De configuratie die moet worden toegepast
- done
-
HttpResponseCallback<any>
De optionele functie die moet worden aangeroepen wanneer de bewerking is voltooid. done wordt aangeroepen met drie argumenten: een foutobject (kan null zijn), de hoofdtekst van het antwoord en een transportspecifiek antwoordobject dat handig is voor logboekregistratie of foutopsporing.
cancelJob(string)
function cancelJob(jobId: string): Promise<JobStatus>Parameters
- jobId
-
string
Retouren
Promise<JobStatus>
cancelJob(string, Callback<JobStatus>)
Een taak voor bulkimport/export annuleren.
function cancelJob(jobId: string, done?: Callback<JobStatus>)Parameters
- jobId
-
string
De id van de taak waarvoor de gebruiker statusinformatie wil ophalen.
- done
-
Callback<JobStatus>
De optionele functie die moet worden aangeroepen met twee argumenten: een foutobject als er een fout is opgetreden (anders null) en de (geannuleerde) status van de taak waarvan de id als argument is doorgegeven.
create(DeviceDescription)
function create(deviceInfo: DeviceDescription): Promise<ResultWithHttpResponse<Device>>Parameters
- deviceInfo
- DeviceDescription
Retouren
Promise<ResultWithHttpResponse<Device>>
create(DeviceDescription, HttpResponseCallback<Device>)
Hiermee maakt u een nieuwe apparaat-id op een IoT-hub.
function create(deviceInfo: DeviceDescription, done?: HttpResponseCallback<Device>)Parameters
- deviceInfo
- DeviceDescription
Het object moet een deviceId eigenschap met een geldige apparaat-id bevatten.
- done
-
HttpResponseCallback<Device>
De optionele functie die moet worden aangeroepen wanneer de bewerking is voltooid. done wordt aangeroepen met drie argumenten: een foutobject (kan null zijn), een apparaatobject dat de gemaakte apparaat-id vertegenwoordigt en een transportspecifiek antwoordobject dat handig is voor logboekregistratie of foutopsporing.
createQuery(string, number)
Hiermee maakt u een query die kan worden uitgevoerd op het IoT Hub-exemplaar om informatie te vinden over apparaten of taken.
function createQuery(sqlQuery: string, pageSize?: number): QueryParameters
- sqlQuery
-
string
De query die is geschreven als een SQL-tekenreeks.
- pageSize
-
number
Het gewenste aantal resultaten per pagina (optioneel. standaard: 1000, max: 10000).
Retouren
Query
delete(string)
function delete(deviceId: string): Promise<ResultWithHttpResponse<any>>Parameters
- deviceId
-
string
Retouren
Promise<ResultWithHttpResponse<any>>
delete(string, HttpResponseCallback<any>)
Hiermee verwijdert u een bestaande apparaat-id uit een IoT-hub.
function delete(deviceId: string, done?: HttpResponseCallback<any>)Parameters
- deviceId
-
string
De id van een bestaande apparaat-id.
- done
-
HttpResponseCallback<any>
De optionele functie die moet worden aangeroepen wanneer de bewerking is voltooid. done wordt aangeroepen met drie argumenten: een foutobject (kan null zijn), een always-null-argument (voor consistentie met de andere methoden) en een transportspecifiek antwoordobject dat handig is voor logboekregistratie of foutopsporing.
exportDevicesToBlob(string, boolean)
function exportDevicesToBlob(outputBlobContainerUri: string, excludeKeys: boolean): Promise<JobStatus>Parameters
- outputBlobContainerUri
-
string
- excludeKeys
-
boolean
Retouren
Promise<JobStatus>
exportDevicesToBlob(string, boolean, Callback<JobStatus>)
Exporteer apparaten naar een blob in een bulktaak.
function exportDevicesToBlob(outputBlobContainerUri: string, excludeKeys: boolean, done?: Callback<JobStatus>)Parameters
- outputBlobContainerUri
-
string
De URI naar een container waar een blob met de naam 'devices.txt' wordt gemaakt met de lijst met apparaten.
- excludeKeys
-
boolean
Booleaanse waarde die aangeeft of beveiligingssleutels moeten worden uitgesloten van de geëxporteerde gegevens.
- done
-
Callback<JobStatus>
De optionele functie die moet worden aangeroepen wanneer de taak is gemaakt, met twee argumenten: een foutobject als er een fout is opgetreden (null anders) en de taakstatus die kan worden gebruikt om de voortgang van de export van apparaten bij te houden.
exportDevicesToBlobByIdentity(string, boolean)
function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean): Promise<JobStatus>Parameters
- outputBlobContainerUri
-
string
- excludeKeys
-
boolean
Retouren
Promise<JobStatus>
exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)
Exporteer apparaten naar een blob in een bulktaak met behulp van een geconfigureerde identiteit.
function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean, done?: Callback<JobStatus>)Parameters
- outputBlobContainerUri
-
string
De URI naar een container waar een blob met de naam 'devices.txt' wordt gemaakt met de lijst met apparaten.
- excludeKeys
-
boolean
Booleaanse waarde die aangeeft of beveiligingssleutels moeten worden uitgesloten van de geëxporteerde gegevens.
- done
-
Callback<JobStatus>
De optionele functie die moet worden aangeroepen wanneer de taak is gemaakt, met twee argumenten: een foutobject als er een fout is opgetreden (null anders) en de taakstatus die kan worden gebruikt om de voortgang van de export van apparaten bij te houden.
exportDevicesToBlobByIdentity(string, boolean, string)
function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean, userAssignedIdentity: string): Promise<JobStatus>Parameters
- outputBlobContainerUri
-
string
- excludeKeys
-
boolean
- userAssignedIdentity
-
string
Retouren
Promise<JobStatus>
exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)
function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean, userAssignedIdentity: string, done: Callback<JobStatus>)Parameters
- outputBlobContainerUri
-
string
- excludeKeys
-
boolean
- userAssignedIdentity
-
string
- done
-
Callback<JobStatus>
fromConnectionString(string)
Hiermee wordt een registerobject gemaakt op basis van de opgegeven connection string.
static function fromConnectionString(value: string): RegistryParameters
- value
-
string
Een connection string die de juiste registermachtigingen (lezen en/of schrijven) bevat.
Retouren
fromSharedAccessSignature(string)
Hiermee wordt een registerobject gemaakt op basis van de opgegeven shared access signature.
static function fromSharedAccessSignature(value: string): RegistryParameters
- value
-
string
Een Shared Access Signature die de juiste registermachtigingen (lezen en/of schrijven) bevat.
Retouren
fromTokenCredential(string, TokenCredential)
Hiermee wordt een Registry-object gemaakt van de opgegeven Azure TokenCredential.
static function fromTokenCredential(hostName: string, tokenCredential: TokenCredential): RegistryParameters
- hostName
-
string
Hostnaam van de Azure-service.
- tokenCredential
- TokenCredential
Een Azure TokenCredential die wordt gebruikt voor verificatie met de Azure-service
Retouren
get(string)
function get(deviceId: string): Promise<ResultWithHttpResponse<Device>>Parameters
- deviceId
-
string
Retouren
Promise<ResultWithHttpResponse<Device>>
get(string, HttpResponseCallback<Device>)
Vraagt informatie op over een bestaande apparaat-id op een IoT-hub.
function get(deviceId: string, done?: HttpResponseCallback<Device>)Parameters
- deviceId
-
string
De id van een bestaande apparaat-id.
- done
-
HttpResponseCallback<Device>
De optionele functie die moet worden aangeroepen wanneer de bewerking is voltooid. done wordt aangeroepen met drie argumenten: een foutobject (kan null zijn), een apparaatobject dat de gemaakte apparaat-id vertegenwoordigt en een transportspecifiek antwoordobject dat handig is voor logboekregistratie of foutopsporing.
getConfiguration(string)
function getConfiguration(configurationId: string): Promise<ResultWithHttpResponse<Configuration>>Parameters
- configurationId
-
string
Retouren
Promise<ResultWithHttpResponse<Configuration>>
getConfiguration(string, HttpResponseCallback<Configuration>)
Eén configuratie ophalen uit een IoT Hub
function getConfiguration(configurationId: string, done?: HttpResponseCallback<Configuration>)Parameters
- configurationId
-
string
De id van de configuratie waarmee u wilt ophalen
- done
-
HttpResponseCallback<Configuration>
De optionele callback die wordt aangeroepen met een Error-object of een module: azure-iothub. Configuratieobject met de configuratiedetails.
getConfigurations()
function getConfigurations(): Promise<ResultWithHttpResponse<Configuration[]>>Retouren
Promise<ResultWithHttpResponse<Configuration[]>>
getConfigurations(HttpResponseCallback<Configuration[]>)
Alle configuraties ophalen op een IoT Hub
function getConfigurations(done?: HttpResponseCallback<Configuration[]>)Parameters
- done
-
HttpResponseCallback<Configuration[]>
De optionele callback die wordt aangeroepen met een Error-object of een matrix van module:azure-iothub. Configuratieobjecten voor alle configuraties.
getJob(string)
function getJob(jobId: string): Promise<JobStatus>Parameters
- jobId
-
string
Retouren
Promise<JobStatus>
getJob(string, Callback<JobStatus>)
De status van een bulkimport-/exporttaak ophalen.
function getJob(jobId: string, done?: Callback<JobStatus>)Parameters
- jobId
-
string
De id van de taak waarvoor de gebruiker statusinformatie wil ophalen.
- done
-
Callback<JobStatus>
De optionele functie om aan te roepen met twee argumenten: een foutobject als er een fout is opgetreden (anders null) en de status van de taak waarvan de id als argument is doorgegeven.
getModule(string, string)
function getModule(deviceId: string, moduleId: string): Promise<ResultWithHttpResponse<Module>>Parameters
- deviceId
-
string
- moduleId
-
string
Retouren
Promise<ResultWithHttpResponse<Module>>
getModule(string, string, HttpResponseCallback<Module>)
Eén module ophalen van een apparaat op een IoT Hub
function getModule(deviceId: string, moduleId: string, done?: HttpResponseCallback<Module>)Parameters
- deviceId
-
string
Apparaat-id die eigenaar is van de module.
- moduleId
-
string
Op te halen module-id
- done
-
HttpResponseCallback<Module>
De optionele callback die wordt aangeroepen met een Error-object of de module:azure-iothub. Moduleobject voor de aangevraagde module
getModulesOnDevice(string)
function getModulesOnDevice(deviceId: string): Promise<ResultWithHttpResponse<Module[]>>Parameters
- deviceId
-
string
Retouren
Promise<ResultWithHttpResponse<Module[]>>
getModulesOnDevice(string, HttpResponseCallback<Module[]>)
Een lijst met alle modules op een IoT Hub apparaat ophalen
function getModulesOnDevice(deviceId: string, done?: HttpResponseCallback<Module[]>)Parameters
- deviceId
-
string
Id van het apparaat waarvoor we modules ophalen
- done
-
HttpResponseCallback<Module[]>
De optionele callback die wordt aangeroepen met een Error-object of een matrix van module:azure-iothub. Moduleobjecten voor alle modules.
getModuleTwin(string, string)
function getModuleTwin(deviceId: string, moduleId: string): Promise<ResultWithHttpResponse<Twin>>Parameters
- deviceId
-
string
- moduleId
-
string
Retouren
Promise<ResultWithHttpResponse<Twin>>
getModuleTwin(string, string, HttpResponseCallback<Twin>)
Hiermee haalt u de moduledubbel van de module op met de opgegeven module-id.
function getModuleTwin(deviceId: string, moduleId: string, done?: HttpResponseCallback<Twin>)Parameters
- deviceId
-
string
De apparaat-id.
- moduleId
-
string
De module-id.
- done
-
HttpResponseCallback<Twin>
De optionele callback die wordt aangeroepen met een foutobject of het exemplaar van de moduledubbel.
getRegistryStatistics()
function getRegistryStatistics(): Promise<ResultWithHttpResponse<RegistryStatistics>>Retouren
Promise<ResultWithHttpResponse<RegistryStatistics>>
getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)
Hiermee haalt u statistieken op over de apparaten in het register voor apparaat-id's.
function getRegistryStatistics(done?: HttpResponseCallback<RegistryStatistics>)Parameters
- done
-
HttpResponseCallback<RegistryStatistics>
De optionele callback die wordt aangeroepen met een foutobject of de statistieken van het apparaatregister.
getTwin(string)
function getTwin(deviceId: string): Promise<ResultWithHttpResponse<Twin>>Parameters
- deviceId
-
string
Retouren
Promise<ResultWithHttpResponse<Twin>>
getTwin(string, HttpResponseCallback<Twin>)
Hiermee haalt u de apparaatdubbel van het apparaat op met de opgegeven apparaat-id.
function getTwin(deviceId: string, done?: HttpResponseCallback<Twin>)Parameters
- deviceId
-
string
De apparaat-id.
- done
-
HttpResponseCallback<Twin>
De optionele callback die wordt aangeroepen met een foutobject of het apparaatdubbelexemplaren.
importDevicesFromBlob(string, string)
function importDevicesFromBlob(inputBlobContainerUri: string, outputBlobContainerUri: string): Promise<JobStatus>Parameters
- inputBlobContainerUri
-
string
- outputBlobContainerUri
-
string
Retouren
Promise<JobStatus>
importDevicesFromBlob(string, string, Callback<JobStatus>)
Importeert apparaten uit een blob in bulktaak.
function importDevicesFromBlob(inputBlobContainerUri: string, outputBlobContainerUri: string, done?: Callback<JobStatus>)Parameters
- inputBlobContainerUri
-
string
De URI naar een container met een blob met de naam 'devices.txt' met een lijst met apparaten die moeten worden geïmporteerd.
- outputBlobContainerUri
-
string
De URI naar een container waar een blob wordt gemaakt met logboeken van het importproces.
- done
-
Callback<JobStatus>
De optionele functie die wordt aangeroepen wanneer de taak is gemaakt, met twee argumenten: een foutobject als er een fout is opgetreden (null, anders null) en de taakstatus die kan worden gebruikt om de voortgang van het importeren van apparaten bij te houden.
importDevicesFromBlobByIdentity(string, string)
function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string): Promise<JobStatus>Parameters
- inputBlobContainerUri
-
string
- outputBlobContainerUri
-
string
Retouren
Promise<JobStatus>
importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)
Importeert apparaten uit een blob bulksgewijs met behulp van een geconfigureerde identiteit.
function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string, done?: Callback<JobStatus>)Parameters
- inputBlobContainerUri
-
string
De URI naar een container met een blob met de naam 'devices.txt' met een lijst met apparaten die moeten worden geïmporteerd.
- outputBlobContainerUri
-
string
De URI naar een container waar een blob wordt gemaakt met logboeken van het importproces.
- done
-
Callback<JobStatus>
De optionele functie die wordt aangeroepen wanneer de taak is gemaakt, met twee argumenten: een foutobject als er een fout is opgetreden (null, anders null) en de taakstatus die kan worden gebruikt om de voortgang van het importeren van apparaten bij te houden.
importDevicesFromBlobByIdentity(string, string, string)
function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string, userAssignedIdentity: string): Promise<JobStatus>Parameters
- inputBlobContainerUri
-
string
- outputBlobContainerUri
-
string
- userAssignedIdentity
-
string
Retouren
Promise<JobStatus>
importDevicesFromBlobByIdentity(string, string, string, Callback<JobStatus>)
function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string, userAssignedIdentity: string, done: Callback<JobStatus>)Parameters
- inputBlobContainerUri
-
string
- outputBlobContainerUri
-
string
- userAssignedIdentity
-
string
- done
-
Callback<JobStatus>
list()
function list(): Promise<ResultWithHttpResponse<Device[]>>Retouren
Promise<ResultWithHttpResponse<Device[]>>
list(HttpResponseCallback<Device[]>)
Vraagt informatie op over de eerste 1000 apparaatidentiteiten op een IoT-hub.
function list(done?: HttpResponseCallback<Device[]>)Parameters
- done
-
HttpResponseCallback<Device[]>
De optionele functie die moet worden aangeroepen wanneer de bewerking is voltooid. done wordt aangeroepen met drie argumenten: een foutobject (kan null zijn), een matrix van apparaatobjecten die de vermelde apparaatidentiteiten vertegenwoordigen en een transportspecifiek antwoordobject dat handig is voor logboekregistratie of foutopsporing.
listJobs()
function listJobs(): Promise<ResultWithHttpResponse<any>>Retouren
Promise<ResultWithHttpResponse<any>>
listJobs(HttpResponseCallback<any>)
De laatste import-/exporttaken weergeven (inclusief de actieve taak, indien van toepassing).
function listJobs(done?: HttpResponseCallback<any>)Parameters
- done
-
HttpResponseCallback<any>
De optionele functie die moet worden aangeroepen met twee argumenten: een foutobject als er een fout is opgetreden (anders null) en de lijst met eerdere taken als argument.
removeConfiguration(string)
function removeConfiguration(configurationId: string): Promise<ResultWithHttpResponse<any>>Parameters
- configurationId
-
string
Retouren
Promise<ResultWithHttpResponse<any>>
removeConfiguration(string, HttpResponseCallback<any>)
Een configuratie met de opgegeven id verwijderen uit een IoT Hub
function removeConfiguration(configurationId: string, done?: HttpResponseCallback<any>)Parameters
- configurationId
-
string
Id van de configuratie die moet worden verwijderd
- done
-
HttpResponseCallback<any>
De optionele functie die moet worden aangeroepen wanneer de bewerking is voltooid. done wordt aangeroepen met drie argumenten: een foutobject (kan null zijn), de hoofdtekst van het antwoord en een transportspecifiek antwoordobject dat handig is voor logboekregistratie of foutopsporing.
removeDevices(DeviceDescription[], boolean)
function removeDevices(devices: DeviceDescription[], forceRemove: boolean): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>Parameters
- devices
- forceRemove
-
boolean
Retouren
Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>
removeDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)
Updates een matrix van apparaten.
function removeDevices(devices: DeviceDescription[], forceRemove: boolean, done?: HttpResponseCallback<BulkRegistryOperationResult>)Parameters
- devices
Een matrix met objecten die een deviceId eigenschap moeten bevatten waarvan de waarde een geldige apparaat-id is.
- forceRemove
-
boolean
als forceRemove waar is, wordt het apparaat verwijderd, ongeacht een etag. Anders moeten de etags overeenkomen.
- done
-
HttpResponseCallback<BulkRegistryOperationResult>
De optionele functie die moet worden aangeroepen wanneer de bewerking is voltooid. done wordt aangeroepen met drie argumenten: een Error-object (kan null zijn), een BulkRegistryOperationResult en een transportspecifiek antwoordobject dat handig is voor logboekregistratie of foutopsporing.
removeModule(Module, TripleValueCallback<any, any>)
De opgegeven module verwijderen uit het register
function removeModule(module: Module, done?: TripleValueCallback<any, any>)Parameters
- module
- Module
- done
-
TripleValueCallback<any, any>
De optionele functie die moet worden aangeroepen wanneer de bewerking is voltooid. done wordt aangeroepen met drie argumenten: een foutobject (kan null zijn), de hoofdtekst van het antwoord en een transportspecifiek antwoordobject dat handig is voor logboekregistratie of foutopsporing.
removeModule(string | Module)
function removeModule(moduleOrDeviceId: string | Module): Promise<ResultWithHttpResponse<any>>Parameters
- moduleOrDeviceId
-
string | Module
Retouren
Promise<ResultWithHttpResponse<any>>
removeModule(string | Module, string)
function removeModule(moduleOrDeviceId: string | Module, moduleId: string): Promise<ResultWithHttpResponse<any>>Parameters
- moduleOrDeviceId
-
string | Module
- moduleId
-
string
Retouren
Promise<ResultWithHttpResponse<any>>
removeModule(string, string, TripleValueCallback<any, any>)
function removeModule(deviceId: string, moduleId: string, done: TripleValueCallback<any, any>)Parameters
- deviceId
-
string
- moduleId
-
string
- done
-
TripleValueCallback<any, any>
update(DeviceDescription)
function update(deviceInfo: DeviceDescription): Promise<ResultWithHttpResponse<Device>>Parameters
- deviceInfo
- DeviceDescription
Retouren
Promise<ResultWithHttpResponse<Device>>
update(DeviceDescription, HttpResponseCallback<Device>)
Updates een bestaande apparaat-id op een IoT-hub met de opgegeven apparaatgegevens.
De deviceInfo parameter moet alle eigenschappen bevatten die kunnen worden bijgewerkt. Als bijvoorbeeld de status eigenschap van disabled wordt bijgewerkt naar enabled, moet het deviceInfo object ook de statusReason, verificatie (en de sub-eigenschappen), mogelijkheden en deviceScope hebben ingesteld op de huidige waarden van het apparaat of worden deze eigenschappen opnieuw ingesteld. Het wordt aanbevolen om eerst de get-API aan te roepen voordat u een update uitvoert.
function update(deviceInfo: DeviceDescription, done?: HttpResponseCallback<Device>)Parameters
- deviceInfo
- DeviceDescription
Een object dat een deviceId eigenschap moet bevatten waarvan de waarde een geldige apparaat-id is.
- done
-
HttpResponseCallback<Device>
De optionele functie die moet worden aangeroepen wanneer de bewerking is voltooid. done wordt aangeroepen met drie argumenten: een foutobject (kan null zijn), een apparaatobject dat de bijgewerkte apparaat-id vertegenwoordigt en een transportspecifiek antwoordobject dat handig is voor logboekregistratie of foutopsporing.
updateConfiguration(Configuration)
function updateConfiguration(configuration: Configuration): Promise<ResultWithHttpResponse<any>>Parameters
- configuration
- Configuration
Retouren
Promise<ResultWithHttpResponse<any>>
updateConfiguration(Configuration, boolean)
function updateConfiguration(configuration: Configuration, forceUpdate: boolean): Promise<ResultWithHttpResponse<any>>Parameters
- configuration
- Configuration
- forceUpdate
-
boolean
Retouren
Promise<ResultWithHttpResponse<any>>
updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)
function updateConfiguration(configuration: Configuration, forceUpdate: boolean, done: HttpResponseCallback<any>)Parameters
- configuration
- Configuration
- forceUpdate
-
boolean
- done
-
HttpResponseCallback<any>
updateConfiguration(Configuration, HttpResponseCallback<any>)
Een configuratie bijwerken in een IoT-hub
function updateConfiguration(configuration: Configuration, done?: HttpResponseCallback<any>)Parameters
- configuration
- Configuration
Een object van het type module:azure-iothub. Configuratie om toe te voegen aan de hub
- done
-
HttpResponseCallback<any>
De optionele functie die moet worden aangeroepen wanneer de bewerking is voltooid. done wordt aangeroepen met drie argumenten: een foutobject (kan null zijn), de hoofdtekst van het antwoord en een transportspecifiek antwoordobject dat handig is voor logboekregistratie of foutopsporing.
updateDevices(DeviceDescription[], boolean)
function updateDevices(devices: DeviceDescription[], forceUpdate: boolean): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>Parameters
- devices
- forceUpdate
-
boolean
Retouren
Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>
updateDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)
Updates een matrix van apparaten.
De afzonderlijke elementen van de devices parameter moeten alle eigenschappen bevatten die kunnen worden bijgewerkt. Als bijvoorbeeld de status eigenschap van disabled wordt bijgewerkt naar enabled, moet het object ook de statusReason, verificatie (en de sub-eigenschappen), mogelijkheden en deviceScope hebben ingesteld op de huidige waarden van het apparaat of worden deze eigenschappen opnieuw ingesteld. Het wordt aanbevolen om eerst de get-API aan te roepen voordat u een update uitvoert.
function updateDevices(devices: DeviceDescription[], forceUpdate: boolean, done?: HttpResponseCallback<BulkRegistryOperationResult>)Parameters
- devices
Een matrix met objecten die een deviceId eigenschap moeten bevatten waarvan de waarde een geldige apparaat-id is.
- forceUpdate
-
boolean
als forceUpdate waar is, wordt het apparaat bijgewerkt, ongeacht een etag. Anders moeten de etags overeenkomen.
- done
-
HttpResponseCallback<BulkRegistryOperationResult>
De optionele functie die moet worden aangeroepen wanneer de bewerking is voltooid. done wordt aangeroepen met drie argumenten: een Error-object (kan null zijn), een BulkRegistryOperationResult en een transportspecifiek antwoordobject dat handig is voor logboekregistratie of foutopsporing.
updateModule(Module)
function updateModule(module: Module): Promise<ResultWithHttpResponse<any>>Parameters
- module
- Module
Retouren
Promise<ResultWithHttpResponse<any>>
updateModule(Module, boolean)
function updateModule(module: Module, forceUpdate: boolean): Promise<ResultWithHttpResponse<any>>Parameters
- module
- Module
- forceUpdate
-
boolean
Retouren
Promise<ResultWithHttpResponse<any>>
updateModule(Module, boolean, HttpResponseCallback<any>)
function updateModule(module: Module, forceUpdate: boolean, done: HttpResponseCallback<any>)Parameters
- module
- Module
- forceUpdate
-
boolean
- done
-
HttpResponseCallback<any>
updateModule(Module, TripleValueCallback<any, any>)
Het opgegeven moduleobject in het register bijwerken
function updateModule(module: Module, done?: TripleValueCallback<any, any>)Parameters
- module
- Module
Moduleobject dat moet worden bijgewerkt.
- done
-
TripleValueCallback<any, any>
De optionele functie die moet worden aangeroepen wanneer de bewerking is voltooid. done wordt aangeroepen met drie argumenten: een foutobject (kan null zijn), de hoofdtekst van het antwoord en een transportspecifiek antwoordobject dat handig is voor logboekregistratie of foutopsporing.
updateModuleTwin(string, string, any, string)
function updateModuleTwin(deviceId: string, moduleId: string, patch: any, etag: string): Promise<ResultWithHttpResponse<Twin>>Parameters
- deviceId
-
string
- moduleId
-
string
- patch
-
any
- etag
-
string
Retouren
Promise<ResultWithHttpResponse<Twin>>
updateModuleTwin(string, string, any, string, HttpResponseCallback<Twin>)
Updates de tweeling van een specifieke module met de opgegeven patch.
function updateModuleTwin(deviceId: string, moduleId: string, patch: any, etag: string, done?: HttpResponseCallback<Twin>)Parameters
- deviceId
-
string
De apparaat-id.
- moduleId
-
string
De module-id
- patch
-
any
De gewenste eigenschappen en tags waarmee de moduledubbel moet worden gepatcht.
- etag
-
string
De meest recente etag voor deze moduledubbel of *om een update af te dwingen, zelfs als de moduledubbel is bijgewerkt sinds de etag is verkregen.
- done
-
HttpResponseCallback<Twin>
De optionele callback die wordt aangeroepen met een foutobject of het exemplaar van de moduledubbel.
updateTwin(string, any, string)
function updateTwin(deviceId: string, patch: any, etag: string): Promise<ResultWithHttpResponse<Twin>>Parameters
- deviceId
-
string
- patch
-
any
- etag
-
string
Retouren
Promise<ResultWithHttpResponse<Twin>>
updateTwin(string, any, string, HttpResponseCallback<Twin>)
Updates de apparaatdubbel van een specifiek apparaat met de opgegeven patch.
function updateTwin(deviceId: string, patch: any, etag: string, done?: HttpResponseCallback<Twin>)Parameters
- deviceId
-
string
De apparaat-id.
- patch
-
any
De gewenste eigenschappen en tags waarmee de apparaatdubbel moet worden gepatcht.
- etag
-
string
De meest recente etag voor deze apparaatdubbel of '*' om een update af te dwingen, zelfs als de apparaatdubbel is bijgewerkt sinds de etag is verkregen.
- done
-
HttpResponseCallback<Twin>
De optionele callback die wordt aangeroepen met een foutobject of het apparaatdubbelexemplaren.