azure-docs-sdk-java/docs-ref-autogen/com.microsoft.azure.sdk.iot...

408 строки
22 KiB
YAML

### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider
id: _iot_hub_x509_hardware_authentication_provider
parent: com.microsoft.azure.sdk.iot.device.auth
children:
- com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider.getSSLContext()
- com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider.IotHubX509HardwareAuthenticationProvider(String,String,String,String,SecurityProvider)
- com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider.securityProviderX509
- com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider.setIotHubTrustedCert(String)
- com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider.setPathToIotHubTrustedCert(String)
href: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider.yml
langs:
- java
name: IotHubX509HardwareAuthenticationProvider
nameWithType: IotHubX509HardwareAuthenticationProvider
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubX509HardwareAuthenticationProvider
type: Class
source:
remote: &o0
path: device/iot-device-client/src/main/java/com/microsoft/azure/sdk/iot/device/auth/IotHubX509HardwareAuthenticationProvider.java
branch: master
repo: https://github.com/Azure/azure-iot-sdk-java
path: device/iot-device-client/src/main/java/com/microsoft/azure/sdk/iot/device/auth/IotHubX509HardwareAuthenticationProvider.java
startLine: 15
package: com.microsoft.azure.sdk.iot.device.auth
syntax:
content: public class IotHubX509HardwareAuthenticationProvider extends IotHubAuthenticationProvider
inheritance:
- java.lang.Object
- com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider
inheritedMembers:
- com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.deviceId
- com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.gatewayHostname
- com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.getDeviceId()
- com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.getGatewayHostname()
- com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.getHostname()
- com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.getIotHubTrustedCert()
- com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.getModuleId()
- com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.getPathToIotHubTrustedCert()
- com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.hostname
- com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.IotHubAuthenticationProvider(String,String,String,String)
- com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.iotHubSSLContext
- com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.iotHubTrustedCert
- com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.moduleId
- com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.pathToIotHubTrustedCert
- com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.sslContextNeedsUpdate
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider.getSSLContext()
id: getSSLContext()
parent: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider
href: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider.yml
langs:
- java
name: getSSLContext()
nameWithType: IotHubX509HardwareAuthenticationProvider.getSSLContext()
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubX509HardwareAuthenticationProvider.getSSLContext()
overload: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider.getSSLContext*
type: Method
source:
remote: *o0
path: device/iot-device-client/src/main/java/com/microsoft/azure/sdk/iot/device/auth/IotHubX509HardwareAuthenticationProvider.java
startLine: 39
package: com.microsoft.azure.sdk.iot.device.auth
summary: <p>Getter for IotHubSSLContext </p>
syntax:
content: public SSLContext getSSLContext()
return:
type: 13e89c07
description: <p>The value of IotHubSSLContext </p>
exceptions:
- type: cbf33bbe
description: <p>if an error occurs when generating the SSLContext </p>
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider.IotHubX509HardwareAuthenticationProvider(String,String,String,String,SecurityProvider)
id: IotHubX509HardwareAuthenticationProvider(String,String,String,String,SecurityProvider)
parent: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider
href: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider.yml
langs:
- java
name: IotHubX509HardwareAuthenticationProvider(String hostname, String gatewayHostname, String deviceId, String moduleId, SecurityProvider securityProvider)
nameWithType: IotHubX509HardwareAuthenticationProvider.IotHubX509HardwareAuthenticationProvider(String hostname, String gatewayHostname, String deviceId, String moduleId, SecurityProvider securityProvider)
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubX509HardwareAuthenticationProvider.IotHubX509HardwareAuthenticationProvider(String hostname, String gatewayHostname, String deviceId, String moduleId, SecurityProvider securityProvider)
overload: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider.IotHubX509HardwareAuthenticationProvider*
type: Constructor
source:
remote: *o0
path: device/iot-device-client/src/main/java/com/microsoft/azure/sdk/iot/device/auth/IotHubX509HardwareAuthenticationProvider.java
startLine: 19
package: com.microsoft.azure.sdk.iot.device.auth
syntax:
content: public IotHubX509HardwareAuthenticationProvider(String hostname, String gatewayHostname, String deviceId, String moduleId, SecurityProvider securityProvider)
parameters:
- id: hostname
type: "26831127"
- id: gatewayHostname
type: "26831127"
- id: deviceId
type: "26831127"
- id: moduleId
type: "26831127"
- id: securityProvider
type: com.microsoft.azure.sdk.iot.provisioning.security._security_provider
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider.securityProviderX509
id: securityProviderX509
parent: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider
href: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider.yml
langs:
- java
name: securityProviderX509
nameWithType: IotHubX509HardwareAuthenticationProvider.securityProviderX509
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubX509HardwareAuthenticationProvider.securityProviderX509
type: Field
source:
remote: *o0
path: device/iot-device-client/src/main/java/com/microsoft/azure/sdk/iot/device/auth/IotHubX509HardwareAuthenticationProvider.java
startLine: 17
package: com.microsoft.azure.sdk.iot.device.auth
syntax:
content: protected SecurityProviderX509 securityProviderX509
return:
type: com.microsoft.azure.sdk.iot.provisioning.security._security_provider_x509
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider.setIotHubTrustedCert(String)
id: setIotHubTrustedCert(String)
parent: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider
href: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider.yml
langs:
- java
name: setIotHubTrustedCert(String certificate)
nameWithType: IotHubX509HardwareAuthenticationProvider.setIotHubTrustedCert(String certificate)
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubX509HardwareAuthenticationProvider.setIotHubTrustedCert(String certificate)
overload: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider.setIotHubTrustedCert*
type: Method
source:
remote: *o0
path: device/iot-device-client/src/main/java/com/microsoft/azure/sdk/iot/device/auth/IotHubX509HardwareAuthenticationProvider.java
startLine: 75
package: com.microsoft.azure.sdk.iot.device.auth
summary: <p>Setter for the user trusted certificate </p>
syntax:
content: public void setIotHubTrustedCert(String certificate)
parameters:
- id: certificate
type: "26831127"
description: <p>valid user trusted certificate string </p>
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider.setPathToIotHubTrustedCert(String)
id: setPathToIotHubTrustedCert(String)
parent: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider
href: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider.yml
langs:
- java
name: setPathToIotHubTrustedCert(String pathToCertificate)
nameWithType: IotHubX509HardwareAuthenticationProvider.setPathToIotHubTrustedCert(String pathToCertificate)
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubX509HardwareAuthenticationProvider.setPathToIotHubTrustedCert(String pathToCertificate)
overload: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider.setPathToIotHubTrustedCert*
type: Method
source:
remote: *o0
path: device/iot-device-client/src/main/java/com/microsoft/azure/sdk/iot/device/auth/IotHubX509HardwareAuthenticationProvider.java
startLine: 64
package: com.microsoft.azure.sdk.iot.device.auth
summary: <p>Setter for the providing trusted certificate. </p>
syntax:
content: public void setPathToIotHubTrustedCert(String pathToCertificate)
parameters:
- id: pathToCertificate
type: "26831127"
description: <p>path to the certificate for one way authentication. </p>
references:
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider.IotHubX509HardwareAuthenticationProvider*
name: IotHubX509HardwareAuthenticationProvider
nameWithType: IotHubX509HardwareAuthenticationProvider.IotHubX509HardwareAuthenticationProvider
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubX509HardwareAuthenticationProvider.IotHubX509HardwareAuthenticationProvider
package: com.microsoft.azure.sdk.iot.device.auth
- uid: cbf33bbe
spec.java:
- name: IOException
fullName: IOException
- uid: 13e89c07
spec.java:
- name: SSLContext
fullName: SSLContext
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider.getSSLContext*
name: getSSLContext
nameWithType: IotHubX509HardwareAuthenticationProvider.getSSLContext
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubX509HardwareAuthenticationProvider.getSSLContext
package: com.microsoft.azure.sdk.iot.device.auth
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider.setPathToIotHubTrustedCert*
name: setPathToIotHubTrustedCert
nameWithType: IotHubX509HardwareAuthenticationProvider.setPathToIotHubTrustedCert
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubX509HardwareAuthenticationProvider.setPathToIotHubTrustedCert
package: com.microsoft.azure.sdk.iot.device.auth
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_x509_hardware_authentication_provider.setIotHubTrustedCert*
name: setIotHubTrustedCert
nameWithType: IotHubX509HardwareAuthenticationProvider.setIotHubTrustedCert
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubX509HardwareAuthenticationProvider.setIotHubTrustedCert
package: com.microsoft.azure.sdk.iot.device.auth
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.deviceId
parent: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider
href: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.yml
name: deviceId
nameWithType: IotHubAuthenticationProvider.deviceId
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.deviceId
type: Field
syntax:
content: protected String deviceId
return:
type: "26831127"
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.gatewayHostname
parent: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider
href: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.yml
name: gatewayHostname
nameWithType: IotHubAuthenticationProvider.gatewayHostname
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.gatewayHostname
type: Field
syntax:
content: protected String gatewayHostname
return:
type: "26831127"
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.getDeviceId()
parent: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider
href: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.yml
name: getDeviceId()
nameWithType: IotHubAuthenticationProvider.getDeviceId()
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.getDeviceId()
type: Method
summary: <p>Get the deviceId </p>
syntax:
content: public String getDeviceId()
return:
type: "26831127"
description: <p>the saved deviceId </p>
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.getGatewayHostname()
parent: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider
href: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.yml
name: getGatewayHostname()
nameWithType: IotHubAuthenticationProvider.getGatewayHostname()
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.getGatewayHostname()
type: Method
summary: <p>Get the gatewayHostname </p>
syntax:
content: public String getGatewayHostname()
return:
type: "26831127"
description: <p>the saved gatewayHostname </p>
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.getHostname()
parent: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider
href: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.yml
name: getHostname()
nameWithType: IotHubAuthenticationProvider.getHostname()
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.getHostname()
type: Method
summary: <p>Get the hostname </p>
syntax:
content: public String getHostname()
return:
type: "26831127"
description: <p>the saved hostname </p>
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.getIotHubTrustedCert()
parent: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider
href: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.yml
name: getIotHubTrustedCert()
nameWithType: IotHubAuthenticationProvider.getIotHubTrustedCert()
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.getIotHubTrustedCert()
type: Method
syntax:
content: public String getIotHubTrustedCert()
return:
type: "26831127"
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.getModuleId()
parent: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider
href: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.yml
name: getModuleId()
nameWithType: IotHubAuthenticationProvider.getModuleId()
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.getModuleId()
type: Method
summary: <p>Get the module id </p>
syntax:
content: public String getModuleId()
return:
type: "26831127"
description: <p>the saved module id </p>
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.getPathToIotHubTrustedCert()
parent: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider
href: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.yml
name: getPathToIotHubTrustedCert()
nameWithType: IotHubAuthenticationProvider.getPathToIotHubTrustedCert()
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.getPathToIotHubTrustedCert()
type: Method
syntax:
content: public String getPathToIotHubTrustedCert()
return:
type: "26831127"
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.hostname
parent: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider
href: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.yml
name: hostname
nameWithType: IotHubAuthenticationProvider.hostname
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.hostname
type: Field
syntax:
content: protected String hostname
return:
type: "26831127"
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.IotHubAuthenticationProvider(String,String,String,String)
parent: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider
href: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.yml
name: IotHubAuthenticationProvider(String hostname, String gatewayHostname, String deviceId, String moduleId)
nameWithType: IotHubAuthenticationProvider.IotHubAuthenticationProvider(String hostname, String gatewayHostname, String deviceId, String moduleId)
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.IotHubAuthenticationProvider(String hostname, String gatewayHostname, String deviceId, String moduleId)
type: Constructor
syntax:
content: public IotHubAuthenticationProvider(String hostname, String gatewayHostname, String deviceId, String moduleId)
parameters:
- id: hostname
type: "26831127"
- id: gatewayHostname
type: "26831127"
- id: deviceId
type: "26831127"
- id: moduleId
type: "26831127"
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.iotHubSSLContext
parent: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider
href: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.yml
name: iotHubSSLContext
nameWithType: IotHubAuthenticationProvider.iotHubSSLContext
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.iotHubSSLContext
type: Field
syntax:
content: protected IotHubSSLContext iotHubSSLContext
return:
type: com.microsoft.azure.sdk.iot.deps.auth._iot_hub_s_s_l_context
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.iotHubTrustedCert
parent: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider
href: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.yml
name: iotHubTrustedCert
nameWithType: IotHubAuthenticationProvider.iotHubTrustedCert
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.iotHubTrustedCert
type: Field
syntax:
content: protected String iotHubTrustedCert
return:
type: "26831127"
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.moduleId
parent: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider
href: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.yml
name: moduleId
nameWithType: IotHubAuthenticationProvider.moduleId
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.moduleId
type: Field
syntax:
content: protected String moduleId
return:
type: "26831127"
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.pathToIotHubTrustedCert
parent: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider
href: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.yml
name: pathToIotHubTrustedCert
nameWithType: IotHubAuthenticationProvider.pathToIotHubTrustedCert
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.pathToIotHubTrustedCert
type: Field
syntax:
content: protected String pathToIotHubTrustedCert
return:
type: "26831127"
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.sslContextNeedsUpdate
parent: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider
href: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.yml
name: sslContextNeedsUpdate
nameWithType: IotHubAuthenticationProvider.sslContextNeedsUpdate
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.sslContextNeedsUpdate
type: Field
syntax:
content: protected boolean sslContextNeedsUpdate
return:
type: 4fc6e284
- uid: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider
parent: com.microsoft.azure.sdk.iot.device.auth
href: com.microsoft.azure.sdk.iot.device.auth._iot_hub_authentication_provider.yml
name: IotHubAuthenticationProvider
nameWithType: IotHubAuthenticationProvider
fullName: com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider
type: Class
summary: <p>Base class for providing authentication for a Device Client or Module Client, including x509 and SAS based authentication. </p>
syntax:
content: public class IotHubAuthenticationProvider
- uid: com.microsoft.azure.sdk.iot.provisioning.security._security_provider_x509
parent: com.microsoft.azure.sdk.iot.provisioning.security
href: com.microsoft.azure.sdk.iot.provisioning.security._security_provider_x509.yml
name: SecurityProviderX509
nameWithType: SecurityProviderX509
fullName: com.microsoft.azure.sdk.iot.provisioning.security.SecurityProviderX509
type: Class
syntax:
content: public class SecurityProviderX509
- uid: com.microsoft.azure.sdk.iot.provisioning.security._security_provider
parent: com.microsoft.azure.sdk.iot.provisioning.security
href: com.microsoft.azure.sdk.iot.provisioning.security._security_provider.yml
name: SecurityProvider
nameWithType: SecurityProvider
fullName: com.microsoft.azure.sdk.iot.provisioning.security.SecurityProvider
type: Class
syntax:
content: public class SecurityProvider