DeviceClientOptions interface
Options de l’objet Client. Passé à la fonction setOptions .
Exemple
var options = {
cert: myX509Certificate,
key: myX509Key,
http: {
receivePolicy: {
interval: 10
}
}
}
client.setOptions(options, callback);
- Extends
-
X509
Propriétés
amqp | Objet facultatif avec des options spécifiques au transport AMQP |
ca | Certificat public au format PEM pour l’autorité de certification utilisée par le service Hub. Il s’agit de l’autorité de certification que le hub utilise pour sécuriser les connexions TLS et que le client valide la connexion à l’aide de ce certificat public afin de valider l’identité du hub. Si vous vous connectez à un Azure IoT Hub à l’intérieur d’un centre de données Azure, vous n’avez pas besoin de le définir. Si vous vous connectez à un autre hub (par exemple, un hub Edge), vous devrez peut-être le définir sur le certificat de serveur utilisé par le hub pour TLS. |
http | Objet facultatif avec des options spécifiques au transport HTTP |
keepalive | Intervalle keepalive au format numérique (secondes). Cela contrôle spécifiquement le ping keepalive pour MQTT. Si vous utilisez AMQP ou HTTP, cela ne fera rien. |
model |
!! Utilisation du jumeau numérique uniquement! Chaîne utilisée dans le nom d’utilisateur MQTT définissant le digital twin modelId. |
mqtt | Objet facultatif avec des options spécifiques au transport MQTT |
product |
Informations personnalisées définies par l’utilisateur à ajouter aux informations de l’agent utilisateur existantes. Les informations d’identification de l’agent utilisateur sont principalement utilisées par Microsoft en interne pour identifier les métadonnées liées à l’utilisation du client d’appareil pour Azure IoT. |
token |
Objet facultatif avec des valeurs de renouvellement de jeton. Utilisez uniquement avec l’authentification qui utilise des clés pré-partagées. |
Propriétés héritées
cert | Certificat X509. |
client |
Nom d’un moteur OpenSSL qui peut fournir le certificat client. |
key | Clé associée au certificat X509. |
passphrase | Phrase secrète utilisée pour décoder la clé associée au certificat X509. |
Détails de la propriété
amqp
Objet facultatif avec des options spécifiques au transport AMQP
amqp?: AmqpTransportOptions
Valeur de propriété
ca
Certificat public au format PEM pour l’autorité de certification utilisée par le service Hub. Il s’agit de l’autorité de certification que le hub utilise pour sécuriser les connexions TLS et que le client valide la connexion à l’aide de ce certificat public afin de valider l’identité du hub. Si vous vous connectez à un Azure IoT Hub à l’intérieur d’un centre de données Azure, vous n’avez pas besoin de le définir. Si vous vous connectez à un autre hub (par exemple, un hub Edge), vous devrez peut-être le définir sur le certificat de serveur utilisé par le hub pour TLS.
ca?: string
Valeur de propriété
string
http
Objet facultatif avec des options spécifiques au transport HTTP
http?: HttpTransportOptions
Valeur de propriété
keepalive
Intervalle keepalive au format numérique (secondes). Cela contrôle spécifiquement le ping keepalive pour MQTT. Si vous utilisez AMQP ou HTTP, cela ne fera rien.
keepalive?: number
Valeur de propriété
number
modelId
!! Utilisation du jumeau numérique uniquement! Chaîne utilisée dans le nom d’utilisateur MQTT définissant le digital twin modelId.
modelId?: string
Valeur de propriété
string
mqtt
Objet facultatif avec des options spécifiques au transport MQTT
mqtt?: MqttTransportOptions
Valeur de propriété
productInfo
Informations personnalisées définies par l’utilisateur à ajouter aux informations de l’agent utilisateur existantes. Les informations d’identification de l’agent utilisateur sont principalement utilisées par Microsoft en interne pour identifier les métadonnées liées à l’utilisation du client d’appareil pour Azure IoT.
productInfo?: string
Valeur de propriété
string
tokenRenewal
Objet facultatif avec des valeurs de renouvellement de jeton. Utilisez uniquement avec l’authentification qui utilise des clés pré-partagées.
tokenRenewal?: TokenRenewalValues
Valeur de propriété
TokenRenewalValues
Détails de la propriété héritée
cert
Certificat X509.
cert?: string | Buffer | string[] | Buffer[]
Valeur de propriété
string | Buffer | string[] | Buffer[]
Hérité de X509.cert
clientCertEngine
Nom d’un moteur OpenSSL qui peut fournir le certificat client.
clientCertEngine?: string
Valeur de propriété
string
Hérité de X509.clientCertEngine
key
Clé associée au certificat X509.
key?: string | Buffer
Valeur de propriété
string | Buffer
Hérité de X509.key
passphrase
Phrase secrète utilisée pour décoder la clé associée au certificat X509.
passphrase?: string
Valeur de propriété
string
Hérité de X509.passphrase