Registry class

Referentie

Pakket:: azure-iothub

De registerklasse biedt toegang tot de IoT Hub-apparaatidentiteitsservice. 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 apparaatidentiteiten is HTTPS.

Methoden

addConfiguration(Configuration)
addConfiguration(Configuration, HttpResponseCallback<any>)	Voeg een configuratie toe aan een IoT-hub.
addDevices(DeviceDescription[])
addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)	Hiermee voegt u een matrix met apparaten toe.
addModule(Module)
addModule(Module, HttpResponseCallback<any>)	Voeg de opgegeven module toe aan het register.
applyConfigurationContentOnDevice(string, ConfigurationContent)
applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)	De opgegeven configuratie toepassen op een apparaat op een IoT Hub
cancelJob(string)
cancelJob(string, Callback<JobStatus>)	Annuleer een bulkimport-/exporttaak.
create(DeviceDescription)
create(DeviceDescription, HttpResponseCallback<Device>)	Hiermee maakt u een nieuwe apparaat-id op een IoT-hub.
createQuery(string, number)	Hiermee maakt u een query die kan worden uitgevoerd op het IoT Hub-exemplaar om informatie over apparaten of taken te vinden.
delete(string)
delete(string, HttpResponseCallback<any>)	Hiermee verwijdert u een bestaande apparaat-id uit een IoT-hub.
exportDevicesToBlob(string, boolean)
exportDevicesToBlob(string, boolean, Callback<JobStatus>)	Apparaten exporteren naar een blob in een bulktaak.
exportDevicesToBlobByIdentity(string, boolean)
exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)	Apparaten exporteren naar een blob in een bulktaak met behulp van een geconfigureerde identiteit.
exportDevicesToBlobByIdentity(string, boolean, string)
exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)
fromConnectionString(string)	Hiermee maakt u een registerobject op basis van de opgegeven verbindingsreeks.
fromSharedAccessSignature(string)	Hiermee wordt een registerobject samengesteld op basis van de opgegeven Shared Access Signature.
fromTokenCredential(string, TokenCredential)	Hiermee wordt een registerobject gemaakt van het opgegeven Azure-tokenCredential.
get(string)
get(string, HttpResponseCallback<Device>)	Vraagt informatie op over een bestaande apparaat-id op een IoT-hub.
getConfiguration(string)
getConfiguration(string, HttpResponseCallback<Configuration>)	Eén configuratie ophalen uit een IoT Hub
getConfigurations()
getConfigurations(HttpResponseCallback<Configuration[]>)	Alle configuraties op een IoT Hub ophalen
getJob(string)
getJob(string, Callback<JobStatus>)	De status van een bulkimport-/exporttaak ophalen.
getModule(string, string)
getModule(string, string, HttpResponseCallback<Module>)	Eén module ophalen van een apparaat op een IoT Hub
getModulesOnDevice(string)
getModulesOnDevice(string, HttpResponseCallback<Module[]>)	Een lijst met alle modules op een IoT Hub-apparaat ophalen
getModuleTwin(string, string)
getModuleTwin(string, string, HttpResponseCallback<Twin>)	Hiermee haalt u de moduledubbel van de module op met de opgegeven module-id.
getRegistryStatistics()
getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)	Hiermee haalt u statistieken op over de apparaten in het apparaatidentiteitsregister.
getTwin(string)
getTwin(string, HttpResponseCallback<Twin>)	Hiermee haalt u de apparaatdubbel van het apparaat op met de opgegeven apparaat-id.
importDevicesFromBlob(string, string)
importDevicesFromBlob(string, string, Callback<JobStatus>)	Hiermee importeert u apparaten uit een blob in bulktaak.
importDevicesFromBlobByIdentity(string, string)
importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)	Hiermee importeert u apparaten uit een blob in bulktaak met behulp van een geconfigureerde identiteit.
importDevicesFromBlobByIdentity(string, string, string)
importDevicesFromBlobByIdentity(string, string, string, Callback<JobStatus>)
list()
list(HttpResponseCallback<Device[]>)	Vraagt informatie over de eerste 1000 apparaatidentiteiten op een IoT-hub aan.
listJobs()
listJobs(HttpResponseCallback<any>)	Vermeld de laatste import-/exporttaken (inclusief de actieve taken, indien van toepassing).
removeConfiguration(string)
removeConfiguration(string, HttpResponseCallback<any>)	Een configuratie met de opgegeven id verwijderen uit een IoT Hub
removeDevices(DeviceDescription[], boolean)
removeDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	Hiermee wordt een matrix met apparaten bijgewerkt.
removeModule(Module, TripleValueCallback<any, any>)	De opgegeven module uit het register verwijderen
removeModule(string \| Module)
removeModule(string \| Module, string)
removeModule(string, string, TripleValueCallback<any, any>)
update(DeviceDescription)
update(DeviceDescription, HttpResponseCallback<Device>)	Hiermee werkt u een bestaande apparaat-id op een IoT-hub bij met de opgegeven apparaatgegevens. De parameter `deviceInfo` moet alle eigenschappen bevatten die kunnen worden bijgewerkt. Als u bijvoorbeeld de eigenschap `status` bijwerkt van `disabled` naar `enabled`, moet het `deviceInfo` object ook de statusReason, verificatie (en de subeigenschappen) hebben, en deviceScope is ingesteld op de huidige waarden van de apparaten of worden deze eigenschappen opnieuw ingesteld. Het wordt aanbevolen om de get-API eerst aan te roepen voordat u een update uitvoert.
updateConfiguration(Configuration)
updateConfiguration(Configuration, boolean)
updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)
updateConfiguration(Configuration, HttpResponseCallback<any>)	Een configuratie bijwerken in een IoT-hub
updateDevices(DeviceDescription[], boolean)
updateDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	Hiermee wordt een matrix met apparaten bijgewerkt. De afzonderlijke elementen van de parameter `devices` moeten alle eigenschappen bevatten die kunnen worden bijgewerkt. Als u bijvoorbeeld de eigenschap `status` bijwerkt van `disabled` naar `enabled`, moet het object ook de statusReason, verificatie (en de subeigenschappen) hebben, en deviceScope is ingesteld op de huidige waarden van de apparaten of worden deze eigenschappen opnieuw ingesteld. Het wordt aanbevolen om de get-API eerst aan te roepen voordat u een update uitvoert.
updateModule(Module)
updateModule(Module, boolean)
updateModule(Module, boolean, HttpResponseCallback<any>)
updateModule(Module, TripleValueCallback<any, any>)	Het opgegeven moduleobject in het register bijwerken
updateModuleTwin(string, string, any, string)
updateModuleTwin(string, string, any, string, HttpResponseCallback<Twin>)	Hiermee wordt de tweeling van een specifieke module bijgewerkt met de opgegeven patch.
updateTwin(string, any, string)
updateTwin(string, any, string, HttpResponseCallback<Twin>)	Hiermee werkt u de apparaatdubbel van een specifiek apparaat bij met de opgegeven patch.

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 die moet worden toegevoegd 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 nuttig is voor logboekregistratie of foutopsporing.

addDevices(DeviceDescription[])

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

Parameters

devices: DeviceDescription[]

Retouren

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)

Hiermee voegt u een matrix met apparaten toe.

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

Parameters

devices: DeviceDescription[]

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 foutobject (kan null zijn), een BulkRegistryOperationResult en een transportspecifiek antwoordobject dat nuttig 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>

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 toe te passen op

content: ConfigurationContent

De configuratie die moet worden toegepast

done: HttpResponseCallback<any>

cancelJob(string)

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

Parameters

jobId: string

Retouren

Promise<JobStatus>

cancelJob(string, Callback<JobStatus>)

Annuleer een bulkimport-/exporttaak.

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, (null anders) 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 apparaat object 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 over apparaten of taken te vinden.

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

Parameters

sqlQuery: string

De query die is geschreven als een SQL-tekenreeks.

pageSize: number

Het gewenste aantal resultaten per pagina (optioneel: 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 altijd 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>)

Apparaten exporteren naar een blob in een bulktaak.

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

Parameters

outputBlobContainerUri: string

De URI naar een container waarin 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>)

Apparaten exporteren 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 waarin 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>

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 maakt u een registerobject op basis van de opgegeven verbindingsreeks.

static function fromConnectionString(value: string): Registry

Parameters

value: string

Een verbindingsreeks die de juiste registermachtigingen (lezen en/of schrijven) inkapselt.

Retouren

Registry

fromSharedAccessSignature(string)

Hiermee wordt een registerobject samengesteld op basis van de opgegeven Shared Access Signature.

static function fromSharedAccessSignature(value: string): Registry

Parameters

value: string

Een handtekening voor gedeelde toegang die de juiste registermachtigingen (lezen en/of schrijven) inkapselt.

Retouren

Registry

fromTokenCredential(string, TokenCredential)

Hiermee wordt een registerobject gemaakt van het opgegeven Azure-tokenCredential.

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

Parameters

hostName: string

Hostnaam van de Azure-service.

tokenCredential: TokenCredential

Een Azure TokenCredential die wordt gebruikt om te verifiëren met de Azure-service

Retouren

Registry

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>

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 foutobject of een module:azure-iothub. Configuratieobject met de configuratiedetails.

getConfigurations()

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

Retouren

Promise<ResultWithHttpResponse<Configuration[]>>

getConfigurations(HttpResponseCallback<Configuration[]>)

Alle configuraties op een IoT Hub ophalen

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

Parameters

done: HttpResponseCallback<Configuration[]>

De optionele callback die wordt aangeroepen met een foutobject 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 die moet worden aangeroepen 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

Module-id die moet worden opgehaald

done: HttpResponseCallback<Module>

De optionele callback die wordt aangeroepen met een foutobject 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 foutobject 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 error-object of het moduledubbelexemplaren.

getRegistryStatistics()

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

Retouren

Promise<ResultWithHttpResponse<RegistryStatistics>>

getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)

Hiermee haalt u statistieken op over de apparaten in het apparaatidentiteitsregister.

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>)

Hiermee importeert u 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 waarin een blob wordt gemaakt met logboeken van het importproces.

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 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>)

Hiermee importeert u apparaten uit een blob in bulktaak 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 waarin een blob wordt gemaakt met logboeken van het importproces.

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 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 over de eerste 1000 apparaatidentiteiten op een IoT-hub aan.

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 Apparaat objecten 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>)

Vermeld de laatste import-/exporttaken (inclusief de actieve taken, 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, (null anders) 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>

removeDevices(DeviceDescription[], boolean)

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

Parameters

devices: DeviceDescription[]

forceRemove: boolean

Retouren

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

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

Hiermee wordt een matrix met apparaten bijgewerkt.

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

Parameters

devices: DeviceDescription[]

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>

removeModule(Module, TripleValueCallback<any, any>)

De opgegeven module uit het register verwijderen

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

Parameters

module: Module

done: TripleValueCallback<any, any>

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>)

Hiermee werkt u een bestaande apparaat-id op een IoT-hub bij met de opgegeven apparaatgegevens. De parameter deviceInfo moet alle eigenschappen bevatten die kunnen worden bijgewerkt. Als u bijvoorbeeld de eigenschap status bijwerkt van disabled naar enabled, moet het deviceInfo object ook de statusReason, verificatie (en de subeigenschappen) hebben, en deviceScope is ingesteld op de huidige waarden van de apparaten of worden deze eigenschappen opnieuw ingesteld. Het wordt aanbevolen om de get-API eerst 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 Device-object 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 die moet worden toegevoegd aan de hub

done: HttpResponseCallback<any>

updateDevices(DeviceDescription[], boolean)

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

Parameters

devices: DeviceDescription[]

forceUpdate: boolean

Retouren

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

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

Hiermee wordt een matrix met apparaten bijgewerkt. De afzonderlijke elementen van de parameter devices moeten alle eigenschappen bevatten die kunnen worden bijgewerkt. Als u bijvoorbeeld de eigenschap status bijwerkt van disabled naar enabled, moet het object ook de statusReason, verificatie (en de subeigenschappen) hebben, en deviceScope is ingesteld op de huidige waarden van de apparaten of worden deze eigenschappen opnieuw ingesteld. Het wordt aanbevolen om de get-API eerst aan te roepen voordat u een update uitvoert.

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

Parameters

devices: DeviceDescription[]

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>

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>

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>)

Hiermee wordt de tweeling van een specifieke module bijgewerkt 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 nieuwste 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 error-object of het moduledubbelexemplaren.

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>)

Hiermee werkt u de apparaatdubbel van een specifiek apparaat bij 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 nieuwste 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.

Delen via

Registry class

Methoden

Methodedetails

addConfiguration(Configuration)

Parameters

Retouren

addConfiguration(Configuration, HttpResponseCallback<any>)

Parameters

addDevices(DeviceDescription[])

Parameters

Retouren

addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)

Parameters

addModule(Module)

Parameters

Retouren

addModule(Module, HttpResponseCallback<any>)

Parameters

applyConfigurationContentOnDevice(string, ConfigurationContent)

Parameters

Retouren

applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)

Parameters

cancelJob(string)

Parameters

Retouren

cancelJob(string, Callback<JobStatus>)

Parameters

create(DeviceDescription)

Parameters

Retouren

create(DeviceDescription, HttpResponseCallback<Device>)

Parameters

createQuery(string, number)

Parameters

Retouren

delete(string)

Parameters

Retouren

delete(string, HttpResponseCallback<any>)

Parameters

exportDevicesToBlob(string, boolean)

Parameters

Retouren

exportDevicesToBlob(string, boolean, Callback<JobStatus>)

Parameters

exportDevicesToBlobByIdentity(string, boolean)

Parameters

Retouren

exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)

Parameters

exportDevicesToBlobByIdentity(string, boolean, string)

Parameters

Retouren

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

Parameters

fromConnectionString(string)

Parameters

Retouren

fromSharedAccessSignature(string)

Parameters

Retouren

fromTokenCredential(string, TokenCredential)

Parameters

Retouren

get(string)

Parameters

Retouren

get(string, HttpResponseCallback<Device>)

Parameters

getConfiguration(string)

Parameters

Retouren

getConfiguration(string, HttpResponseCallback<Configuration>)

Parameters

getConfigurations()

Retouren

getConfigurations(HttpResponseCallback<Configuration[]>)

Parameters