Class IotHubProperties
java.lang.Object
com.azure.resourcemanager.iothub.models.IotHubProperties
The properties of an IoT hub.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the allowedFqdnList property: List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.Get the authorizationPolicies property: The shared access policies you can use to secure a connection to the IoT hub.Get the cloudToDevice property: The IoT hub cloud-to-device messaging properties.comments()
Get the comments property: IoT hub comments.Get the deviceStreams property: The device streams properties of iothub.Get the disableDeviceSas property: If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.Get the disableLocalAuth property: If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.Get the disableModuleSas property: If true, all module scoped SAS keys cannot be used for authentication.Get the enableDataResidency property: This property when set to true, will enable data residency, thus, disabling disaster recovery.Get the enableFileUploadNotifications property: If True, file upload notifications are enabled.Get the encryption property: The encryption properties for the IoT hub.Get the eventHubEndpoints property: The Event Hub-compatible endpoint properties.features()
Get the features property: The capabilities and features enabled for the IoT hub.hostname()
Get the hostname property: The name of the host.Get the ipFilterRules property: The IP filter rules.Get the locations property: Primary and secondary location for iot hub.Get the messagingEndpoints property: The messaging endpoint properties for the file upload notification queue.Get the minTlsVersion property: Specifies the minimum TLS version to support for this hub.Get the networkRuleSets property: Network Rule Set Properties of IotHub.Get the privateEndpointConnections property: Private endpoint connections created on this IotHub.Get the provisioningState property: The provisioning state.Get the publicNetworkAccess property: Whether requests from Public Network are allowed.Get the restrictOutboundNetworkAccess property: If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.Get the rootCertificate property: This property store root certificate related information.routing()
Get the routing property: The routing related properties of the IoT hub.state()
Get the state property: The hub state.Get the storageEndpoints property: The list of Azure Storage endpoints where you can upload files.void
validate()
Validates the instance.withAllowedFqdnList
(List<String> allowedFqdnList) Set the allowedFqdnList property: List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.withAuthorizationPolicies
(List<SharedAccessSignatureAuthorizationRuleInner> authorizationPolicies) Set the authorizationPolicies property: The shared access policies you can use to secure a connection to the IoT hub.withCloudToDevice
(CloudToDeviceProperties cloudToDevice) Set the cloudToDevice property: The IoT hub cloud-to-device messaging properties.withComments
(String comments) Set the comments property: IoT hub comments.withDeviceStreams
(IotHubPropertiesDeviceStreams deviceStreams) Set the deviceStreams property: The device streams properties of iothub.withDisableDeviceSas
(Boolean disableDeviceSas) Set the disableDeviceSas property: If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.withDisableLocalAuth
(Boolean disableLocalAuth) Set the disableLocalAuth property: If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.withDisableModuleSas
(Boolean disableModuleSas) Set the disableModuleSas property: If true, all module scoped SAS keys cannot be used for authentication.withEnableDataResidency
(Boolean enableDataResidency) Set the enableDataResidency property: This property when set to true, will enable data residency, thus, disabling disaster recovery.withEnableFileUploadNotifications
(Boolean enableFileUploadNotifications) Set the enableFileUploadNotifications property: If True, file upload notifications are enabled.withEncryption
(EncryptionPropertiesDescription encryption) Set the encryption property: The encryption properties for the IoT hub.withEventHubEndpoints
(Map<String, EventHubProperties> eventHubEndpoints) Set the eventHubEndpoints property: The Event Hub-compatible endpoint properties.withFeatures
(Capabilities features) Set the features property: The capabilities and features enabled for the IoT hub.withIpFilterRules
(List<IpFilterRule> ipFilterRules) Set the ipFilterRules property: The IP filter rules.withMessagingEndpoints
(Map<String, MessagingEndpointProperties> messagingEndpoints) Set the messagingEndpoints property: The messaging endpoint properties for the file upload notification queue.withMinTlsVersion
(String minTlsVersion) Set the minTlsVersion property: Specifies the minimum TLS version to support for this hub.withNetworkRuleSets
(NetworkRuleSetProperties networkRuleSets) Set the networkRuleSets property: Network Rule Set Properties of IotHub.withPrivateEndpointConnections
(List<PrivateEndpointConnectionInner> privateEndpointConnections) Set the privateEndpointConnections property: Private endpoint connections created on this IotHub.withPublicNetworkAccess
(PublicNetworkAccess publicNetworkAccess) Set the publicNetworkAccess property: Whether requests from Public Network are allowed.withRestrictOutboundNetworkAccess
(Boolean restrictOutboundNetworkAccess) Set the restrictOutboundNetworkAccess property: If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.withRootCertificate
(RootCertificateProperties rootCertificate) Set the rootCertificate property: This property store root certificate related information.withRouting
(RoutingProperties routing) Set the routing property: The routing related properties of the IoT hub.withStorageEndpoints
(Map<String, StorageEndpointProperties> storageEndpoints) Set the storageEndpoints property: The list of Azure Storage endpoints where you can upload files.
-
Constructor Details
-
IotHubProperties
public IotHubProperties()
-
-
Method Details
-
authorizationPolicies
Get the authorizationPolicies property: The shared access policies you can use to secure a connection to the IoT hub.- Returns:
- the authorizationPolicies value.
-
withAuthorizationPolicies
public IotHubProperties withAuthorizationPolicies(List<SharedAccessSignatureAuthorizationRuleInner> authorizationPolicies) Set the authorizationPolicies property: The shared access policies you can use to secure a connection to the IoT hub.- Parameters:
authorizationPolicies
- the authorizationPolicies value to set.- Returns:
- the IotHubProperties object itself.
-
disableLocalAuth
Get the disableLocalAuth property: If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.- Returns:
- the disableLocalAuth value.
-
withDisableLocalAuth
Set the disableLocalAuth property: If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.- Parameters:
disableLocalAuth
- the disableLocalAuth value to set.- Returns:
- the IotHubProperties object itself.
-
disableDeviceSas
Get the disableDeviceSas property: If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.- Returns:
- the disableDeviceSas value.
-
withDisableDeviceSas
Set the disableDeviceSas property: If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.- Parameters:
disableDeviceSas
- the disableDeviceSas value to set.- Returns:
- the IotHubProperties object itself.
-
disableModuleSas
Get the disableModuleSas property: If true, all module scoped SAS keys cannot be used for authentication.- Returns:
- the disableModuleSas value.
-
withDisableModuleSas
Set the disableModuleSas property: If true, all module scoped SAS keys cannot be used for authentication.- Parameters:
disableModuleSas
- the disableModuleSas value to set.- Returns:
- the IotHubProperties object itself.
-
restrictOutboundNetworkAccess
Get the restrictOutboundNetworkAccess property: If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.- Returns:
- the restrictOutboundNetworkAccess value.
-
withRestrictOutboundNetworkAccess
Set the restrictOutboundNetworkAccess property: If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.- Parameters:
restrictOutboundNetworkAccess
- the restrictOutboundNetworkAccess value to set.- Returns:
- the IotHubProperties object itself.
-
allowedFqdnList
Get the allowedFqdnList property: List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.- Returns:
- the allowedFqdnList value.
-
withAllowedFqdnList
Set the allowedFqdnList property: List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.- Parameters:
allowedFqdnList
- the allowedFqdnList value to set.- Returns:
- the IotHubProperties object itself.
-
publicNetworkAccess
Get the publicNetworkAccess property: Whether requests from Public Network are allowed.- Returns:
- the publicNetworkAccess value.
-
withPublicNetworkAccess
Set the publicNetworkAccess property: Whether requests from Public Network are allowed.- Parameters:
publicNetworkAccess
- the publicNetworkAccess value to set.- Returns:
- the IotHubProperties object itself.
-
ipFilterRules
Get the ipFilterRules property: The IP filter rules.- Returns:
- the ipFilterRules value.
-
withIpFilterRules
Set the ipFilterRules property: The IP filter rules.- Parameters:
ipFilterRules
- the ipFilterRules value to set.- Returns:
- the IotHubProperties object itself.
-
networkRuleSets
Get the networkRuleSets property: Network Rule Set Properties of IotHub.- Returns:
- the networkRuleSets value.
-
withNetworkRuleSets
Set the networkRuleSets property: Network Rule Set Properties of IotHub.- Parameters:
networkRuleSets
- the networkRuleSets value to set.- Returns:
- the IotHubProperties object itself.
-
minTlsVersion
Get the minTlsVersion property: Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected.- Returns:
- the minTlsVersion value.
-
withMinTlsVersion
Set the minTlsVersion property: Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected.- Parameters:
minTlsVersion
- the minTlsVersion value to set.- Returns:
- the IotHubProperties object itself.
-
privateEndpointConnections
Get the privateEndpointConnections property: Private endpoint connections created on this IotHub.- Returns:
- the privateEndpointConnections value.
-
withPrivateEndpointConnections
public IotHubProperties withPrivateEndpointConnections(List<PrivateEndpointConnectionInner> privateEndpointConnections) Set the privateEndpointConnections property: Private endpoint connections created on this IotHub.- Parameters:
privateEndpointConnections
- the privateEndpointConnections value to set.- Returns:
- the IotHubProperties object itself.
-
provisioningState
Get the provisioningState property: The provisioning state.- Returns:
- the provisioningState value.
-
state
Get the state property: The hub state.- Returns:
- the state value.
-
hostname
Get the hostname property: The name of the host.- Returns:
- the hostname value.
-
eventHubEndpoints
Get the eventHubEndpoints property: The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub.- Returns:
- the eventHubEndpoints value.
-
withEventHubEndpoints
Set the eventHubEndpoints property: The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub.- Parameters:
eventHubEndpoints
- the eventHubEndpoints value to set.- Returns:
- the IotHubProperties object itself.
-
routing
Get the routing property: The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging.- Returns:
- the routing value.
-
withRouting
Set the routing property: The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging.- Parameters:
routing
- the routing value to set.- Returns:
- the IotHubProperties object itself.
-
storageEndpoints
Get the storageEndpoints property: The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.- Returns:
- the storageEndpoints value.
-
withStorageEndpoints
public IotHubProperties withStorageEndpoints(Map<String, StorageEndpointProperties> storageEndpoints) Set the storageEndpoints property: The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.- Parameters:
storageEndpoints
- the storageEndpoints value to set.- Returns:
- the IotHubProperties object itself.
-
messagingEndpoints
Get the messagingEndpoints property: The messaging endpoint properties for the file upload notification queue.- Returns:
- the messagingEndpoints value.
-
withMessagingEndpoints
public IotHubProperties withMessagingEndpoints(Map<String, MessagingEndpointProperties> messagingEndpoints) Set the messagingEndpoints property: The messaging endpoint properties for the file upload notification queue.- Parameters:
messagingEndpoints
- the messagingEndpoints value to set.- Returns:
- the IotHubProperties object itself.
-
enableFileUploadNotifications
Get the enableFileUploadNotifications property: If True, file upload notifications are enabled.- Returns:
- the enableFileUploadNotifications value.
-
withEnableFileUploadNotifications
Set the enableFileUploadNotifications property: If True, file upload notifications are enabled.- Parameters:
enableFileUploadNotifications
- the enableFileUploadNotifications value to set.- Returns:
- the IotHubProperties object itself.
-
cloudToDevice
Get the cloudToDevice property: The IoT hub cloud-to-device messaging properties.- Returns:
- the cloudToDevice value.
-
withCloudToDevice
Set the cloudToDevice property: The IoT hub cloud-to-device messaging properties.- Parameters:
cloudToDevice
- the cloudToDevice value to set.- Returns:
- the IotHubProperties object itself.
-
comments
Get the comments property: IoT hub comments.- Returns:
- the comments value.
-
withComments
Set the comments property: IoT hub comments.- Parameters:
comments
- the comments value to set.- Returns:
- the IotHubProperties object itself.
-
deviceStreams
Get the deviceStreams property: The device streams properties of iothub.- Returns:
- the deviceStreams value.
-
withDeviceStreams
Set the deviceStreams property: The device streams properties of iothub.- Parameters:
deviceStreams
- the deviceStreams value to set.- Returns:
- the IotHubProperties object itself.
-
features
Get the features property: The capabilities and features enabled for the IoT hub.- Returns:
- the features value.
-
withFeatures
Set the features property: The capabilities and features enabled for the IoT hub.- Parameters:
features
- the features value to set.- Returns:
- the IotHubProperties object itself.
-
encryption
Get the encryption property: The encryption properties for the IoT hub.- Returns:
- the encryption value.
-
withEncryption
Set the encryption property: The encryption properties for the IoT hub.- Parameters:
encryption
- the encryption value to set.- Returns:
- the IotHubProperties object itself.
-
locations
Get the locations property: Primary and secondary location for iot hub.- Returns:
- the locations value.
-
enableDataResidency
Get the enableDataResidency property: This property when set to true, will enable data residency, thus, disabling disaster recovery.- Returns:
- the enableDataResidency value.
-
withEnableDataResidency
Set the enableDataResidency property: This property when set to true, will enable data residency, thus, disabling disaster recovery.- Parameters:
enableDataResidency
- the enableDataResidency value to set.- Returns:
- the IotHubProperties object itself.
-
rootCertificate
Get the rootCertificate property: This property store root certificate related information.- Returns:
- the rootCertificate value.
-
withRootCertificate
Set the rootCertificate property: This property store root certificate related information.- Parameters:
rootCertificate
- the rootCertificate value to set.- Returns:
- the IotHubProperties object itself.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-