DeviceClientOptions interface
Client オブジェクトのオプション。 setOptions 関数に渡されます。
例
var options = {
cert: myX509Certificate,
key: myX509Key,
http: {
receivePolicy: {
interval: 10
}
}
}
client.setOptions(options, callback);
- Extends
-
X509
プロパティ
amqp | AMQP トランスポートに固有のオプションを持つ省略可能なオブジェクト |
ca | ハブ サービスで使用されている証明機関の PEM 形式のパブリック証明書。 これは、ハブが TLS 接続をセキュリティで保護するために使用している CA であり、クライアントはハブの ID を検証するために、このパブリック証明書を使用して接続を検証します。 Azure データ センター内のAzure IoT Hubに接続する場合は、これを設定する必要はありません。 他のハブ (エッジ ハブなど) に接続している場合は、ハブが TLS に使用するサーバー証明書にこれを設定する必要がある場合があります。 |
http | HTTP トランスポートに固有のオプションを持つ省略可能なオブジェクト |
keepalive | 数値形式のキープアライブ間隔 (秒)。 これにより、MQTT のキープアライブ ping が特に制御されます。 AMQP または HTTP を使用している場合、何も実行されません。 |
model |
!!デジタルツインのみご利用!! MQTT ユーザー名の Digital Twin modelId の設定で使用される文字列。 |
mqtt | MQTT トランスポートに固有のオプションを持つ省略可能なオブジェクト |
product |
既存のユーザー エージェント情報に追加するカスタム ユーザー定義情報。 ユーザー エージェント識別情報は、主に Microsoft 内部で、Azure IoT のデバイス クライアントの使用状況に関連するメタデータを識別するために使用されます。 |
token |
トークン更新値を持つ省略可能なオブジェクト。 事前共有キーを使用する認証でのみ を使用します。 |
継承されたプロパティ
cert | X509 証明書。 |
client |
クライアント証明書を提供できる OpenSSL エンジンの名前。 |
key | X509 証明書に関連付けられているキー。 |
passphrase | X509 証明書に関連付けられているキーをデコードするために使用されるパスフレーズ。 |
プロパティの詳細
amqp
ca
ハブ サービスで使用されている証明機関の PEM 形式のパブリック証明書。 これは、ハブが TLS 接続をセキュリティで保護するために使用している CA であり、クライアントはハブの ID を検証するために、このパブリック証明書を使用して接続を検証します。 Azure データ センター内のAzure IoT Hubに接続する場合は、これを設定する必要はありません。 他のハブ (エッジ ハブなど) に接続している場合は、ハブが TLS に使用するサーバー証明書にこれを設定する必要がある場合があります。
ca?: string
プロパティ値
string
http
keepalive
数値形式のキープアライブ間隔 (秒)。 これにより、MQTT のキープアライブ ping が特に制御されます。 AMQP または HTTP を使用している場合、何も実行されません。
keepalive?: number
プロパティ値
number
modelId
!!デジタルツインのみご利用!! MQTT ユーザー名の Digital Twin modelId の設定で使用される文字列。
modelId?: string
プロパティ値
string
mqtt
productInfo
既存のユーザー エージェント情報に追加するカスタム ユーザー定義情報。 ユーザー エージェント識別情報は、主に Microsoft 内部で、Azure IoT のデバイス クライアントの使用状況に関連するメタデータを識別するために使用されます。
productInfo?: string
プロパティ値
string
tokenRenewal
トークン更新値を持つ省略可能なオブジェクト。 事前共有キーを使用する認証でのみ を使用します。
tokenRenewal?: TokenRenewalValues
プロパティ値
TokenRenewalValues
継承されたプロパティの詳細
cert
X509 証明書。
cert?: string | Buffer | string[] | Buffer[]
プロパティ値
string | Buffer | string[] | Buffer[]
継承元 X509.cert
clientCertEngine
クライアント証明書を提供できる OpenSSL エンジンの名前。
clientCertEngine?: string
プロパティ値
string
継承元 X509.clientCertEngine
key
X509 証明書に関連付けられているキー。
key?: string | Buffer
プロパティ値
string | Buffer
継承元 X509.key
passphrase
X509 証明書に関連付けられているキーをデコードするために使用されるパスフレーズ。
passphrase?: string
プロパティ値
string
継承元 X509.パスフレーズ