你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

X509AuthenticationProvider class

提供一个 AuthenticationProvider 对象,该对象只需使用 X509 证书和密钥创建,然后由设备客户端和传输用于向 Azure IoT 中心实例进行身份验证。

SharedAccessSignatureAuthenticationProviderSharedAccessKeyAuthenticationProvider 对象不同,X509AuthenticationProvider 不会发出 newTokenAvailable 事件,因为 X509 身份验证中没有涉及令牌。 传输将使用 getDeviceCredentials 方法获取凭据。

属性

type

方法

fromX509Options(string, string, X509)

从包含证书和密钥的 X509 对象创建新的 X509AuthenticationProvider

getDeviceCredentials()
getDeviceCredentials(Callback<TransportConfig>)

传输使用此方法,以 TransportConfig 对象的形式获取最新的设备凭据。

setX509Options(X509)

更新设备用于连接和使用 Azure IoT 中心实例进行身份验证的证书和密钥。

属性详细信息

type

type: AuthenticationType

属性值

AuthenticationType

方法详细信息

fromX509Options(string, string, X509)

从包含证书和密钥的 X509 对象创建新的 X509AuthenticationProvider

static function fromX509Options(deviceId: string, iotHubHostname: string, x509info: X509): X509AuthenticationProvider

参数

deviceId

string

设备标识符。

iotHubHostname

string

设备应连接到的 Azure IoT 中心实例的主机名。

x509info

X509

一个 X509 对象,其中包含一个证书和密钥,设备可用于向 Azure IoT 中心实例进行身份验证。

返回

getDeviceCredentials()

function getDeviceCredentials(): Promise<TransportConfig>

返回

Promise<TransportConfig>

getDeviceCredentials(Callback<TransportConfig>)

传输使用此方法,以 TransportConfig 对象的形式获取最新的设备凭据。

function getDeviceCredentials(callback?: Callback<TransportConfig>)

参数

callback

Callback<TransportConfig>

将使用错误或一组可用于向 IoT 中心进行身份验证的设备凭据调用的可选函数。

setX509Options(X509)

更新设备用于连接和使用 Azure IoT 中心实例进行身份验证的证书和密钥。

function setX509Options(x509: X509)

参数

x509

X509

包含证书和密钥的 X509 对象。