Registry class

Paquet:

azure-iothub

La classe Registry fournit l’accès au service d’identité d’appareil IoT Hub. Les utilisateurs du Kit de développement logiciel (SDK) doivent instancier cette classe avec l’une des méthodes de fabrique : fromConnectionString ou fromSharedAccessSignature.

Le protocole utilisé pour les opérations de registre des identités d’appareil est HTTPS.

Méthodes

addConfiguration(Configuration)
addConfiguration(Configuration, HttpResponseCallback<any>)	Ajoutez une configuration à un hub IoT.
addDevices(DeviceDescription[])
addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)	Ajoute un tableau d’appareils.
addModule(Module)
addModule(Module, HttpResponseCallback<any>)	Ajoutez le module donné au Registre.
applyConfigurationContentOnDevice(string, ConfigurationContent)
applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)	Appliquer la configuration donnée à un appareil sur un IoT Hub
cancelJob(string)
cancelJob(string, Callback<JobStatus>)	Annuler un travail d’importation/exportation en bloc.
create(DeviceDescription)
create(DeviceDescription, HttpResponseCallback<Device>)	Crée une identité d’appareil sur un hub IoT.
createQuery(string, number)	Crée une requête qui peut être exécutée sur l’instance IoT Hub pour trouver des informations sur les appareils ou les travaux.
delete(string)
delete(string, HttpResponseCallback<any>)	Supprime une identité d’appareil existante d’un hub IoT.
exportDevicesToBlob(string, boolean)
exportDevicesToBlob(string, boolean, Callback<JobStatus>)	Exporter des appareils vers un objet blob dans un travail en bloc.
exportDevicesToBlobByIdentity(string, boolean)
exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)	Exportez des appareils vers un objet blob dans un travail en bloc à l’aide d’une identité configurée.
exportDevicesToBlobByIdentity(string, boolean, string)
exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)
fromConnectionString(string)	Construit un objet Registry à partir de la chaîne de connexion donnée.
fromSharedAccessSignature(string)	Construit un objet Registry à partir de la signature d’accès partagé donnée.
fromTokenCredential(string, TokenCredential)	Construit un objet Registry à partir de l’objet Azure TokenCredential donné.
get(string)
get(string, HttpResponseCallback<Device>)	Demande des informations sur une identité d’appareil existante sur un hub IoT.
getConfiguration(string)
getConfiguration(string, HttpResponseCallback<Configuration>)	Obtenir une configuration unique à partir d’un IoT Hub
getConfigurations()
getConfigurations(HttpResponseCallback<Configuration[]>)	Obtenir toutes les configurations sur un IoT Hub
getJob(string)
getJob(string, Callback<JobStatus>)	Obtenez l’état d’un travail d’importation/exportation en bloc.
getModule(string, string)
getModule(string, string, HttpResponseCallback<Module>)	Obtenir un seul module à partir d’un appareil sur un IoT Hub
getModulesOnDevice(string)
getModulesOnDevice(string, HttpResponseCallback<Module[]>)	Obtenir la liste de tous les modules sur un appareil IoT Hub
getModuleTwin(string, string)
getModuleTwin(string, string, HttpResponseCallback<Twin>)	Obtient le jumeau de module du module avec l’identificateur de module spécifié.
getRegistryStatistics()
getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)	Obtient des statistiques sur les appareils dans le registre d’identités d’appareil.
getTwin(string)
getTwin(string, HttpResponseCallback<Twin>)	Obtient le jumeau d’appareil de l’appareil avec l’identificateur d’appareil spécifié.
importDevicesFromBlob(string, string)
importDevicesFromBlob(string, string, Callback<JobStatus>)	Importe des appareils à partir d’un objet blob dans un travail en bloc.
importDevicesFromBlobByIdentity(string, string)
importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)	Importe des appareils à partir d’un objet blob dans un travail en bloc à l’aide d’une identité configurée.
importDevicesFromBlobByIdentity(string, string, string)
importDevicesFromBlobByIdentity(string, string, string, Callback<JobStatus>)
list()
list(HttpResponseCallback<Device[]>)	Demande des informations sur les 1 000 premières identités d’appareil sur un hub IoT.
listJobs()
listJobs(HttpResponseCallback<any>)	Répertoriez les derniers travaux d’importation/exportation (y compris le travail actif, le cas échéant).
removeConfiguration(string)
removeConfiguration(string, HttpResponseCallback<any>)	Supprimer une configuration avec l’ID donné d’un IoT Hub
removeDevices(DeviceDescription[], boolean)
removeDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	Mises à jour un tableau d’appareils.
removeModule(Module, TripleValueCallback<any, any>)	Supprimer le module donné du Registre
removeModule(string | Module)
removeModule(string | Module, string)
removeModule(string, string, TripleValueCallback<any, any>)
update(DeviceDescription)
update(DeviceDescription, HttpResponseCallback<Device>)	Mises à jour une identité d’appareil existante sur un hub IoT avec les informations d’appareil données. Le deviceInfo paramètre doit inclure toutes les propriétés pouvant être mises à jour. Par exemple, si vous mettez à jour la status propriété de disabled vers enabled, l’objet deviceInfo doit également avoir la valeur statusReason, l’authentification (et ses sous-propriétés), les fonctionnalités et deviceScope définies sur les valeurs actuelles des appareils, sinon ces propriétés seront réinitialisées. Il est recommandé d’appeler d’abord l’API get avant d’effectuer une mise à jour.
updateConfiguration(Configuration)
updateConfiguration(Configuration, boolean)
updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)
updateConfiguration(Configuration, HttpResponseCallback<any>)	Mettre à jour une configuration dans un hub IoT
updateDevices(DeviceDescription[], boolean)
updateDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	Mises à jour un tableau d’appareils. Les éléments individuels du devices paramètre doivent inclure toutes les propriétés pouvant être mises à jour. Par exemple, si vous mettez à jour la status propriété de disabled vers enabled, l’objet doit également avoir la valeur statusReason, l’authentification (et ses sous-propriétés), les fonctionnalités et deviceScope définies sur les valeurs actuelles des appareils, sinon ces propriétés sont réinitialisées. Il est recommandé d’appeler d’abord l’API get avant d’effectuer une mise à jour.
updateModule(Module)
updateModule(Module, boolean)
updateModule(Module, boolean, HttpResponseCallback<any>)
updateModule(Module, TripleValueCallback<any, any>)	Mettre à jour l’objet de module donné dans le Registre
updateModuleTwin(string, string, any, string)
updateModuleTwin(string, string, any, string, HttpResponseCallback<Twin>)	Mises à jour le jumeau d’un module spécifique avec le correctif donné.
updateTwin(string, any, string)
updateTwin(string, any, string, HttpResponseCallback<Twin>)	Mises à jour le jumeau d’appareil d’un appareil spécifique avec le correctif donné.

Détails de la méthode

addConfiguration(Configuration)

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

Paramètres

configuration

Configuration

Retours

Promise<ResultWithHttpResponse<any>>

addConfiguration(Configuration, HttpResponseCallback<any>)

Ajoutez une configuration à un hub IoT.

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

Paramètres

configuration

Configuration

Objet de type module:azure-iothub. Configuration à ajouter au hub

done

HttpResponseCallback<any>

Fonction facultative à appeler lorsque l’opération est terminée. done sera appelé avec trois arguments : un objet Error (peut être null), le corps de la réponse et un objet de réponse spécifique au transport utile pour la journalisation ou le débogage.

addDevices(DeviceDescription[])

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

Paramètres

devices

DeviceDescription[]

Retours

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)

Ajoute un tableau d’appareils.

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

Paramètres

devices

DeviceDescription[]

Tableau d’objets qui doit inclure une deviceId propriété dont la valeur est un identificateur d’appareil valide.

done

HttpResponseCallback<BulkRegistryOperationResult>

Fonction facultative à appeler lorsque l’opération est terminée. done sera appelé avec trois arguments : un objet Error (peut être null), un BulkRegistryOperationResult et un objet de réponse spécifique au transport utile pour la journalisation ou le débogage.

addModule(Module)

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

Paramètres

module

Module

Retours

Promise<ResultWithHttpResponse<any>>

addModule(Module, HttpResponseCallback<any>)

Ajoutez le module donné au Registre.

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

Paramètres

module

Module

Objet module à ajouter au Registre.

done

HttpResponseCallback<any>

Fonction facultative à appeler lorsque l’opération est terminée. done sera appelé avec trois arguments : un objet Error (peut être null), le corps de la réponse et un objet de réponse spécifique au transport utile pour la journalisation ou le débogage.

applyConfigurationContentOnDevice(string, ConfigurationContent)

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

Paramètres

deviceId

string

content

ConfigurationContent

Retours

Promise<ResultWithHttpResponse<any>>

applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)

Appliquer la configuration donnée à un appareil sur un IoT Hub

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

Paramètres

deviceId

string

ID de l’appareil à lequel appliquer la configuration

content

ConfigurationContent

Configuration à appliquer

done

HttpResponseCallback<any>

Fonction facultative à appeler lorsque l’opération est terminée. done sera appelé avec trois arguments : un objet Error (peut être null), le corps de la réponse et un objet de réponse spécifique au transport utile pour la journalisation ou le débogage.

cancelJob(string)

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

Paramètres

jobId

string

Retours

Promise<JobStatus>

cancelJob(string, Callback<JobStatus>)

Annuler un travail d’importation/exportation en bloc.

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

Paramètres

jobId

string

Identificateur du travail pour lequel l’utilisateur souhaite obtenir des informations d’état.

done

Callback<JobStatus>

Fonction facultative à appeler avec deux arguments : un objet d’erreur si une erreur s’est produite (null sinon) et l’état (annulé) du travail dont l’identificateur a été passé en tant qu’argument.

create(DeviceDescription)

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

Paramètres

deviceInfo

DeviceDescription

Retours

Promise<ResultWithHttpResponse<Device>>

create(DeviceDescription, HttpResponseCallback<Device>)

Crée une identité d’appareil sur un hub IoT.

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

Paramètres

deviceInfo

DeviceDescription

L’objet doit inclure une deviceId propriété avec un identificateur d’appareil valide.

done

HttpResponseCallback<Device>

Fonction facultative à appeler lorsque l’opération est terminée. done sera appelé avec trois arguments : un objet Error (peut être null), un objet Device représentant l’identité d’appareil créée et un objet de réponse spécifique au transport utile pour la journalisation ou le débogage.

createQuery(string, number)

Crée une requête qui peut être exécutée sur l’instance IoT Hub pour trouver des informations sur les appareils ou les travaux.

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

Paramètres

sqlQuery

string

Requête écrite sous forme de chaîne SQL.

pageSize

number

Nombre souhaité de résultats par page (facultatif. valeur par défaut : 1000, max: 10000).

Retours

Query

delete(string)

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

Paramètres

deviceId

string

Retours

Promise<ResultWithHttpResponse<any>>

delete(string, HttpResponseCallback<any>)

Supprime une identité d’appareil existante d’un hub IoT.

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

Paramètres

deviceId

string

Identificateur d’une identité d’appareil existante.

done

HttpResponseCallback<any>

Fonction facultative à appeler lorsque l’opération est terminée. done sera appelé avec trois arguments : un objet Error (peut être null), un argument toujours null (pour la cohérence avec les autres méthodes) et un objet de réponse spécifique au transport utile pour la journalisation ou le débogage.

exportDevicesToBlob(string, boolean)

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

Paramètres

outputBlobContainerUri

string

excludeKeys

boolean

Retours

Promise<JobStatus>

exportDevicesToBlob(string, boolean, Callback<JobStatus>)

Exporter des appareils vers un objet blob dans un travail en bloc.

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

Paramètres

outputBlobContainerUri

string

URI d’un conteneur dans lequel un objet blob nommé « devices.txt » sera créé contenant la liste des appareils.

excludeKeys

boolean

Boolean indiquant si les clés de sécurité doivent être exclues des données exportées.

done

Callback<JobStatus>

Fonction facultative à appeler lorsque le travail a été créé, avec deux arguments : un objet d’erreur si une erreur s’est produite (null dans le cas contraire) et l’état du travail qui peut être utilisé pour suivre la progression de l’exportation des appareils.

exportDevicesToBlobByIdentity(string, boolean)

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

Paramètres

outputBlobContainerUri

string

excludeKeys

boolean

Retours

Promise<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)

Exportez des appareils vers un objet blob dans un travail en bloc à l’aide d’une identité configurée.

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

Paramètres

outputBlobContainerUri

string

URI d’un conteneur dans lequel un objet blob nommé « devices.txt » sera créé contenant la liste des appareils.

excludeKeys

boolean

Boolean indiquant si les clés de sécurité doivent être exclues des données exportées.

done

Callback<JobStatus>

Fonction facultative à appeler lorsque le travail a été créé, avec deux arguments : un objet d’erreur si une erreur s’est produite (null dans le cas contraire) et l’état du travail qui peut être utilisé pour suivre la progression de l’exportation des appareils.

exportDevicesToBlobByIdentity(string, boolean, string)

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

Paramètres

outputBlobContainerUri

string

excludeKeys

boolean

userAssignedIdentity

string

Retours

Promise<JobStatus>

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

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

Paramètres

outputBlobContainerUri

string

excludeKeys

boolean

userAssignedIdentity

string

done

Callback<JobStatus>

fromConnectionString(string)

Construit un objet Registry à partir de la chaîne de connexion donnée.

static function fromConnectionString(value: string): Registry

Paramètres

value

string

Chaîne de connexion qui encapsule les autorisations de Registre appropriées (lecture et/ou écriture).

Retours

Registry

fromSharedAccessSignature(string)

Construit un objet Registry à partir de la signature d’accès partagé donnée.

static function fromSharedAccessSignature(value: string): Registry

Paramètres

value

string

Signature d’accès partagé qui encapsule les autorisations de Registre appropriées (lecture et/ou écriture).

Retours

Registry

fromTokenCredential(string, TokenCredential)

Construit un objet Registry à partir de l’objet Azure TokenCredential donné.

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

Paramètres

hostName

string

Nom d’hôte du service Azure.

tokenCredential

TokenCredential

Un jeton Azure TokenCredential utilisé pour s’authentifier auprès du service Azure

Retours

Registry

get(string)

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

Paramètres

deviceId

string

Retours

Promise<ResultWithHttpResponse<Device>>

get(string, HttpResponseCallback<Device>)

Demande des informations sur une identité d’appareil existante sur un hub IoT.

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

Paramètres

deviceId

string

Identificateur d’une identité d’appareil existante.

done

HttpResponseCallback<Device>

Fonction facultative à appeler lorsque l’opération est terminée. done sera appelé avec trois arguments : un objet Error (peut être null), un objet Device représentant l’identité d’appareil créée et un objet de réponse spécifique au transport utile pour la journalisation ou le débogage.

getConfiguration(string)

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

Paramètres

configurationId

string

Retours

Promise<ResultWithHttpResponse<Configuration>>

getConfiguration(string, HttpResponseCallback<Configuration>)

Obtenir une configuration unique à partir d’un IoT Hub

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

Paramètres

configurationId

string

ID de la configuration avec laquelle vous souhaitez récupérer

done

HttpResponseCallback<Configuration>

Rappel facultatif qui sera appelé avec un objet Error ou un module:azure-iothub. Objet de configuration avec les détails de configuration.

getConfigurations()

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

Retours

Promise<ResultWithHttpResponse<Configuration[]>>

getConfigurations(HttpResponseCallback<Configuration[]>)

Obtenir toutes les configurations sur un IoT Hub

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

Paramètres

done

HttpResponseCallback<Configuration[]>

Rappel facultatif qui sera appelé avec un objet Error ou un tableau de module:azure-iothub. Objets de configuration pour toutes les configurations.

getJob(string)

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

Paramètres

jobId

string

Retours

Promise<JobStatus>

getJob(string, Callback<JobStatus>)

Obtenez l’état d’un travail d’importation/exportation en bloc.

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

Paramètres

jobId

string

Identificateur du travail pour lequel l’utilisateur souhaite obtenir des informations d’état.

done

Callback<JobStatus>

Fonction facultative à appeler avec deux arguments : un objet d’erreur si une erreur s’est produite (null sinon) et l’état du travail dont l’identificateur a été passé en tant qu’argument.

getModule(string, string)

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

Paramètres

deviceId

string

moduleId

string

Retours

Promise<ResultWithHttpResponse<Module>>

getModule(string, string, HttpResponseCallback<Module>)

Obtenir un seul module à partir d’un appareil sur un IoT Hub

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

Paramètres

deviceId

string

ID d’appareil propriétaire du module.

moduleId

string

ID de module à récupérer

done

HttpResponseCallback<Module>

Rappel facultatif qui sera appelé avec un objet Error ou le module:azure-iothub. Objet module pour le module demandé

getModulesOnDevice(string)

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

Paramètres

deviceId

string

Retours

Promise<ResultWithHttpResponse<Module[]>>

getModulesOnDevice(string, HttpResponseCallback<Module[]>)

Obtenir la liste de tous les modules sur un appareil IoT Hub

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

Paramètres

deviceId

string

ID de l’appareil pour lequel nous obtenons des modules

done

HttpResponseCallback<Module[]>

Rappel facultatif qui sera appelé avec un objet Error ou un tableau de module:azure-iothub. Objets de module pour tous les modules.

getModuleTwin(string, string)

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

Paramètres

deviceId

string

moduleId

string

Retours

Promise<ResultWithHttpResponse<Twin>>

getModuleTwin(string, string, HttpResponseCallback<Twin>)

Obtient le jumeau de module du module avec l’identificateur de module spécifié.

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

Paramètres

deviceId

string

Identificateur de l’appareil.

moduleId

string

Identificateur de module.

done

HttpResponseCallback<Twin>

Rappel facultatif qui sera appelé avec un objet Error ou l’instance de jumeau de module.

getRegistryStatistics()

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

Retours

Promise<ResultWithHttpResponse<RegistryStatistics>>

getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)

Obtient des statistiques sur les appareils dans le registre d’identités d’appareil.

function getRegistryStatistics(done?: HttpResponseCallback<RegistryStatistics>)

Paramètres

done

HttpResponseCallback<RegistryStatistics>

Rappel facultatif qui sera appelé avec un objet Error ou les statistiques du Registre d’appareils.

getTwin(string)

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

Paramètres

deviceId

string

Retours

Promise<ResultWithHttpResponse<Twin>>

getTwin(string, HttpResponseCallback<Twin>)

Obtient le jumeau d’appareil de l’appareil avec l’identificateur d’appareil spécifié.

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

Paramètres

deviceId

string

Identificateur de l’appareil.

done

HttpResponseCallback<Twin>

Rappel facultatif qui sera appelé avec un objet Error ou l’instance de jumeau d’appareil.

importDevicesFromBlob(string, string)

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

Paramètres

inputBlobContainerUri

string

outputBlobContainerUri

string

Retours

Promise<JobStatus>

importDevicesFromBlob(string, string, Callback<JobStatus>)

Importe des appareils à partir d’un objet blob dans un travail en bloc.

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

Paramètres

inputBlobContainerUri

string

URI d’un conteneur avec un objet blob nommé « devices.txt » contenant une liste d’appareils à importer.

outputBlobContainerUri

string

URI d’un conteneur dans lequel un objet blob sera créé avec les journaux du processus d’importation.

done

Callback<JobStatus>

Fonction facultative à appeler lorsque le travail a été créé, avec deux arguments : un objet d’erreur si une erreur s’est produite (null dans le cas contraire) et l’état du travail qui peut être utilisé pour suivre la progression de l’importation des appareils.

importDevicesFromBlobByIdentity(string, string)

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

Paramètres

inputBlobContainerUri

string

outputBlobContainerUri

string

Retours

Promise<JobStatus>

importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)

Importe des appareils à partir d’un objet blob dans un travail en bloc à l’aide d’une identité configurée.

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

Paramètres

inputBlobContainerUri

string

URI d’un conteneur avec un objet blob nommé « devices.txt » contenant une liste d’appareils à importer.

outputBlobContainerUri

string

URI d’un conteneur dans lequel un objet blob sera créé avec les journaux du processus d’importation.

done

Callback<JobStatus>

Fonction facultative à appeler lorsque le travail a été créé, avec deux arguments : un objet d’erreur si une erreur s’est produite (null dans le cas contraire) et l’état du travail qui peut être utilisé pour suivre la progression de l’importation des appareils.

importDevicesFromBlobByIdentity(string, string, string)

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

Paramètres

inputBlobContainerUri

string

outputBlobContainerUri

string

userAssignedIdentity

string

Retours

Promise<JobStatus>

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

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

Paramètres

inputBlobContainerUri

string

outputBlobContainerUri

string

userAssignedIdentity

string

done

Callback<JobStatus>

list()

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

Retours

Promise<ResultWithHttpResponse<Device[]>>

list(HttpResponseCallback<Device[]>)

Demande des informations sur les 1 000 premières identités d’appareil sur un hub IoT.

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

Paramètres

done

HttpResponseCallback<Device[]>

Fonction facultative à appeler lorsque l’opération est terminée. done sera appelé avec trois arguments : un objet Error (peut être null), un tableau d’objets Device représentant les identités d’appareil répertoriées et un objet de réponse spécifique au transport utile pour la journalisation ou le débogage.

listJobs()

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

Retours

Promise<ResultWithHttpResponse<any>>

listJobs(HttpResponseCallback<any>)

Répertoriez les derniers travaux d’importation/exportation (y compris le travail actif, le cas échéant).

function listJobs(done?: HttpResponseCallback<any>)

Paramètres

done

HttpResponseCallback<any>

Fonction facultative à appeler avec deux arguments : un objet d’erreur en cas d’erreur (null dans le cas contraire) et la liste des travaux passés en tant qu’argument.

removeConfiguration(string)

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

Paramètres

configurationId

string

Retours

Promise<ResultWithHttpResponse<any>>

removeConfiguration(string, HttpResponseCallback<any>)

Supprimer une configuration avec l’ID donné d’un IoT Hub

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

Paramètres

configurationId

string

ID de la configuration à supprimer

done

HttpResponseCallback<any>

Fonction facultative à appeler lorsque l’opération est terminée. done sera appelé avec trois arguments : un objet Error (peut être null), le corps de la réponse et un objet de réponse spécifique au transport utile pour la journalisation ou le débogage.

removeDevices(DeviceDescription[], boolean)

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

Paramètres

devices

DeviceDescription[]

forceRemove

boolean

Retours

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

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

Mises à jour un tableau d’appareils.

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

Paramètres

devices

DeviceDescription[]

Tableau d’objets qui doit inclure une deviceId propriété dont la valeur est un identificateur d’appareil valide.

forceRemove

boolean

si forceRemove a la valeur true, l’appareil sera supprimé indépendamment d’un etag. Sinon, les etags doivent correspondre.

done

HttpResponseCallback<BulkRegistryOperationResult>

Fonction facultative à appeler lorsque l’opération est terminée. done sera appelé avec trois arguments : un objet Error (peut être null), un BulkRegistryOperationResult et un objet de réponse spécifique au transport utile pour la journalisation ou le débogage.

removeModule(Module, TripleValueCallback<any, any>)

Supprimer le module donné du Registre

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

Paramètres

module

Module

done

TripleValueCallback<any, any>

Fonction facultative à appeler lorsque l’opération est terminée. done sera appelé avec trois arguments : un objet Error (peut être null), le corps de la réponse et un objet de réponse spécifique au transport utile pour la journalisation ou le débogage.

removeModule(string | Module)

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

Paramètres

moduleOrDeviceId

string | Module

Retours

Promise<ResultWithHttpResponse<any>>

removeModule(string | Module, string)

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

Paramètres

moduleOrDeviceId

string | Module

moduleId

string

Retours

Promise<ResultWithHttpResponse<any>>

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

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

Paramètres

deviceId

string

moduleId

string

done

TripleValueCallback<any, any>

update(DeviceDescription)

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

Paramètres

deviceInfo

DeviceDescription

Retours

Promise<ResultWithHttpResponse<Device>>

update(DeviceDescription, HttpResponseCallback<Device>)

Mises à jour une identité d’appareil existante sur un hub IoT avec les informations d’appareil données. Le deviceInfo paramètre doit inclure toutes les propriétés pouvant être mises à jour. Par exemple, si vous mettez à jour la status propriété de disabled vers enabled, l’objet deviceInfo doit également avoir la valeur statusReason, l’authentification (et ses sous-propriétés), les fonctionnalités et deviceScope définies sur les valeurs actuelles des appareils, sinon ces propriétés seront réinitialisées. Il est recommandé d’appeler d’abord l’API get avant d’effectuer une mise à jour.

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

Paramètres

deviceInfo

DeviceDescription

Objet qui doit inclure une deviceId propriété dont la valeur est un identificateur d’appareil valide.

done

HttpResponseCallback<Device>

Fonction facultative à appeler lorsque l’opération est terminée. done sera appelé avec trois arguments : un objet Error (peut être null), un objet Device représentant l’identité de l’appareil mise à jour et un objet de réponse spécifique au transport utile pour la journalisation ou le débogage.

updateConfiguration(Configuration)

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

Paramètres

configuration

Configuration

Retours

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean)

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

Paramètres

configuration

Configuration

forceUpdate

boolean

Retours

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)

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

Paramètres

configuration

Configuration

forceUpdate

boolean

done

HttpResponseCallback<any>

updateConfiguration(Configuration, HttpResponseCallback<any>)

Mettre à jour une configuration dans un hub IoT

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

Paramètres

configuration

Configuration

Objet de type module:azure-iothub. Configuration à ajouter au hub

done

HttpResponseCallback<any>

Fonction facultative à appeler lorsque l’opération est terminée. done sera appelé avec trois arguments : un objet Error (peut être null), le corps de la réponse et un objet de réponse spécifique au transport utile pour la journalisation ou le débogage.

updateDevices(DeviceDescription[], boolean)

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

Paramètres

devices

DeviceDescription[]

forceUpdate

boolean

Retours

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

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

Mises à jour un tableau d’appareils. Les éléments individuels du devices paramètre doivent inclure toutes les propriétés pouvant être mises à jour. Par exemple, si vous mettez à jour la status propriété de disabled vers enabled, l’objet doit également avoir la valeur statusReason, l’authentification (et ses sous-propriétés), les fonctionnalités et deviceScope définies sur les valeurs actuelles des appareils, sinon ces propriétés sont réinitialisées. Il est recommandé d’appeler d’abord l’API get avant d’effectuer une mise à jour.

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

Paramètres

devices

DeviceDescription[]

Tableau d’objets qui doit inclure une deviceId propriété dont la valeur est un identificateur d’appareil valide.

forceUpdate

boolean

si forceUpdate a la valeur true, l’appareil est mis à jour indépendamment d’un etag. Sinon, les etags doivent correspondre.

done

HttpResponseCallback<BulkRegistryOperationResult>

Fonction facultative à appeler lorsque l’opération est terminée. done sera appelé avec trois arguments : un objet Error (peut être null), un BulkRegistryOperationResult et un objet de réponse spécifique au transport utile pour la journalisation ou le débogage.

updateModule(Module)

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

Paramètres

module

Module

Retours

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean)

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

Paramètres

module

Module

forceUpdate

boolean

Retours

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean, HttpResponseCallback<any>)

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

Paramètres

module

Module

forceUpdate

boolean

done

HttpResponseCallback<any>

updateModule(Module, TripleValueCallback<any, any>)

Mettre à jour l’objet de module donné dans le Registre

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

Paramètres

module

Module

Objet module à mettre à jour.

done

TripleValueCallback<any, any>

Fonction facultative à appeler lorsque l’opération est terminée. done sera appelé avec trois arguments : un objet Error (peut être null), le corps de la réponse et un objet de réponse spécifique au transport utile pour la journalisation ou le débogage.

updateModuleTwin(string, string, any, string)

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

Paramètres

deviceId

string

moduleId

string

patch

any

etag

string

Retours

Promise<ResultWithHttpResponse<Twin>>

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

Mises à jour le jumeau d’un module spécifique avec le correctif donné.

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

Paramètres

deviceId

string

Identificateur de l’appareil.

moduleId

string

Identificateur du module

patch

any

Propriétés et balises souhaitées pour corriger le jumeau de module.

etag

string

Dernier etag pour ce jumeau de module ou « * » pour forcer une mise à jour même si le jumeau de module a été mis à jour depuis l’obtention de l’etag.

done

HttpResponseCallback<Twin>

Rappel facultatif qui sera appelé avec un objet Error ou l’instance de jumeau de module.

updateTwin(string, any, string)

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

Paramètres

deviceId

string

patch

any

etag

string

Retours

Promise<ResultWithHttpResponse<Twin>>

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

Mises à jour le jumeau d’appareil d’un appareil spécifique avec le correctif donné.

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

Paramètres

deviceId

string

Identificateur de l’appareil.

patch

any

Propriétés et balises souhaitées avec laquelle corriger le jumeau d’appareil.

etag

string

Dernier etag pour ce jumeau d’appareil ou « * » pour forcer une mise à jour même si le jumeau d’appareil a été mis à jour depuis l’obtention de l’etag.

done

HttpResponseCallback<Twin>

Rappel facultatif qui sera appelé avec un objet Error ou l’instance de jumeau d’appareil.