DeviceClientOptions interface

  • Başvuru
Paket:
azure-iot-device

İstemci nesnesi için seçenekler. setOptions işlevine geçirilir.

Örnek

 var options = {
   cert: myX509Certificate,
   key: myX509Key,
   http: {
     receivePolicy: {
       interval: 10
     }
   }
 }
 client.setOptions(options, callback);
Extends

X509

Özellikler

amqp

AMQP aktarımına özgü seçeneklere sahip isteğe bağlı nesne
ca

Hub hizmeti tarafından kullanılan sertifika yetkilisi için PEM biçimindeki ortak sertifika. Bu, hub'ın TLS bağlantılarının güvenliğini sağlamak için kullandığı CA'dır ve istemci, hub'ın kimliğini doğrulamak için bu genel sertifikayı kullanarak bağlantıyı doğrular. Azure veri merkezinin içindeki bir Azure IoT Hub bağlanıyorsanız, bunu ayarlamanız gerekmez. Başka bir hub'a (örneğin bir Edge Hub' a) bağlanıyorsanız, bunu hub'ın TLS için kullandığı sunucu sertifikasına ayarlamanız gerekebilir.
http

HTTP aktarımına özgü seçeneklere sahip isteğe bağlı nesne
keepalive

Sayısal biçimde tutma aralığı (saniye). Bu, MQTT için özel olarak keepalive ping'i denetler. AMQP veya HTTP kullanıyorsanız, bu hiçbir şey yapmaz.
modelId

!! Yalnızca Dijital İkiz Kullan!! MQTT kullanıcı adı ayarında Digital Twin modelId değerini ayarlarken kullanılan dize.
mqtt

MQTT aktarımına özgü seçeneklere sahip isteğe bağlı nesne
productInfo

Mevcut Kullanıcı Aracısı bilgilerine eklenecek özel kullanıcı tanımlı bilgiler. Kullanıcı Aracısı Tanımlama bilgileri ağırlıklı olarak Microsoft tarafından Azure IoT için Cihaz İstemcisi kullanımıyla ilgili meta verileri tanımlamak için dahili olarak kullanılır.
tokenRenewal

Belirteç yenileme değerlerine sahip isteğe bağlı nesne. Yalnızca önceden paylaşılan anahtarları kullanan kimlik doğrulaması ile kullanın.

Devralınan Özellikler

cert

X509 Sertifikası.
clientCertEngine

İstemci sertifikasını sağlayabilen OpenSSL altyapısının adı.
key

X509 sertifikasıyla ilişkili anahtar.
passphrase

X509 sertifikasıyla ilişkili anahtarın kodunu çözmek için kullanılan parola.

Özellik Ayrıntıları

amqp

AMQP aktarımına özgü seçeneklere sahip isteğe bağlı nesne

amqp?: AmqpTransportOptions

Özellik Değeri

AmqpTransportOptions

ca

Hub hizmeti tarafından kullanılan sertifika yetkilisi için PEM biçimindeki ortak sertifika. Bu, hub'ın TLS bağlantılarının güvenliğini sağlamak için kullandığı CA'dır ve istemci, hub'ın kimliğini doğrulamak için bu genel sertifikayı kullanarak bağlantıyı doğrular. Azure veri merkezinin içindeki bir Azure IoT Hub bağlanıyorsanız, bunu ayarlamanız gerekmez. Başka bir hub'a (örneğin bir Edge Hub' a) bağlanıyorsanız, bunu hub'ın TLS için kullandığı sunucu sertifikasına ayarlamanız gerekebilir.

ca?: string

Özellik Değeri

string

http

HTTP aktarımına özgü seçeneklere sahip isteğe bağlı nesne

http?: HttpTransportOptions

Özellik Değeri

HttpTransportOptions

keepalive

Sayısal biçimde tutma aralığı (saniye). Bu, MQTT için özel olarak keepalive ping'i denetler. AMQP veya HTTP kullanıyorsanız, bu hiçbir şey yapmaz.

keepalive?: number

Özellik Değeri

number

modelId

!! Yalnızca Dijital İkiz Kullan!! MQTT kullanıcı adı ayarında Digital Twin modelId değerini ayarlarken kullanılan dize.

modelId?: string

Özellik Değeri

string

mqtt

MQTT aktarımına özgü seçeneklere sahip isteğe bağlı nesne

mqtt?: MqttTransportOptions

Özellik Değeri

MqttTransportOptions

productInfo

Mevcut Kullanıcı Aracısı bilgilerine eklenecek özel kullanıcı tanımlı bilgiler. Kullanıcı Aracısı Tanımlama bilgileri ağırlıklı olarak Microsoft tarafından Azure IoT için Cihaz İstemcisi kullanımıyla ilgili meta verileri tanımlamak için dahili olarak kullanılır.

productInfo?: string

Özellik Değeri

string

tokenRenewal

Belirteç yenileme değerlerine sahip isteğe bağlı nesne. Yalnızca önceden paylaşılan anahtarları kullanan kimlik doğrulaması ile kullanın.

tokenRenewal?: TokenRenewalValues

Özellik Değeri

TokenRenewalValues

Devralınan Özellik Detayları

cert

X509 Sertifikası.

cert?: string | Buffer | string[] | Buffer[]

Özellik Değeri

string | Buffer | string[] | Buffer[]

Devralınan X509.cert

clientCertEngine

İstemci sertifikasını sağlayabilen OpenSSL altyapısının adı.

clientCertEngine?: string

Özellik Değeri

string

Devralınan X509.clientCertEngine

key

X509 sertifikasıyla ilişkili anahtar.

key?: string | Buffer

Özellik Değeri

string | Buffer

Devralınan X509.key

passphrase

X509 sertifikasıyla ilişkili anahtarın kodunu çözmek için kullanılan parola.

passphrase?: string

Özellik Değeri

string

Devralınan X509.passphrase