Package com.azure.resourcemanager.iothub.models

Class IotHubProperties

  • public final class IotHubProperties
extends Object
    The properties of an IoT hub.

    • Constructor Detail

      • IotHubProperties

        public IotHubProperties()

    • Method Detail

      • authorizationPolicies

        public List<SharedAccessSignatureAuthorizationRuleInner> 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

        public Boolean 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

        public IotHubProperties withDisableLocalAuth​(Boolean disableLocalAuth)
        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

        public Boolean 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

        public IotHubProperties 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.
        Parameters:
        disableDeviceSas - the disableDeviceSas value to set.
        Returns:
        the IotHubProperties object itself.

      • disableModuleSas

        public Boolean disableModuleSas()
        Get the disableModuleSas property: If true, all module scoped SAS keys cannot be used for authentication.
        Returns:
        the disableModuleSas value.

      • withDisableModuleSas

        public IotHubProperties withDisableModuleSas​(Boolean disableModuleSas)
        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

        public Boolean 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

        public IotHubProperties 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.
        Parameters:
        restrictOutboundNetworkAccess - the restrictOutboundNetworkAccess value to set.
        Returns:
        the IotHubProperties object itself.

      • allowedFqdnList

        public List<String> allowedFqdnList()
        Get the allowedFqdnList property: List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.
        Returns:
        the allowedFqdnList value.

      • withAllowedFqdnList

        public IotHubProperties withAllowedFqdnList​(List<String> allowedFqdnList)
        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

        public PublicNetworkAccess publicNetworkAccess()
        Get the publicNetworkAccess property: Whether requests from Public Network are allowed.
        Returns:
        the publicNetworkAccess value.

      • withPublicNetworkAccess

        public IotHubProperties withPublicNetworkAccess​(PublicNetworkAccess publicNetworkAccess)
        Set the publicNetworkAccess property: Whether requests from Public Network are allowed.
        Parameters:
        publicNetworkAccess - the publicNetworkAccess value to set.
        Returns:
        the IotHubProperties object itself.

      • ipFilterRules

        public List<IpFilterRule> ipFilterRules()
        Get the ipFilterRules property: The IP filter rules.
        Returns:
        the ipFilterRules value.

      • withIpFilterRules

        public IotHubProperties withIpFilterRules​(List<IpFilterRule> ipFilterRules)
        Set the ipFilterRules property: The IP filter rules.
        Parameters:
        ipFilterRules - the ipFilterRules value to set.
        Returns:
        the IotHubProperties object itself.

      • networkRuleSets

        public NetworkRuleSetProperties networkRuleSets()
        Get the networkRuleSets property: Network Rule Set Properties of IotHub.
        Returns:
        the networkRuleSets value.

      • withNetworkRuleSets

        public IotHubProperties withNetworkRuleSets​(NetworkRuleSetProperties networkRuleSets)
        Set the networkRuleSets property: Network Rule Set Properties of IotHub.
        Parameters:
        networkRuleSets - the networkRuleSets value to set.
        Returns:
        the IotHubProperties object itself.

      • minTlsVersion

        public String 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

        public IotHubProperties withMinTlsVersion​(String minTlsVersion)
        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

        public List<PrivateEndpointConnectionInner> 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

        public String provisioningState()
        Get the provisioningState property: The provisioning state.
        Returns:
        the provisioningState value.

      • state

        public String state()
        Get the state property: The hub state.
        Returns:
        the state value.

      • hostname

        public String hostname()
        Get the hostname property: The name of the host.
        Returns:
        the hostname value.

      • eventHubEndpoints

        public Map<String,​EventHubProperties> 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

        public IotHubProperties withEventHubEndpoints​(Map<String,​EventHubProperties> eventHubEndpoints)
        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

        public RoutingProperties 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

        public IotHubProperties withRouting​(RoutingProperties routing)
        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

        public Map<String,​StorageEndpointProperties> 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

        public Map<String,​MessagingEndpointProperties> 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

        public Boolean enableFileUploadNotifications()
        Get the enableFileUploadNotifications property: If True, file upload notifications are enabled.
        Returns:
        the enableFileUploadNotifications value.

      • withEnableFileUploadNotifications

        public IotHubProperties withEnableFileUploadNotifications​(Boolean enableFileUploadNotifications)
        Set the enableFileUploadNotifications property: If True, file upload notifications are enabled.
        Parameters:
        enableFileUploadNotifications - the enableFileUploadNotifications value to set.
        Returns:
        the IotHubProperties object itself.

      • cloudToDevice

        public CloudToDeviceProperties cloudToDevice()
        Get the cloudToDevice property: The IoT hub cloud-to-device messaging properties.
        Returns:
        the cloudToDevice value.

      • withCloudToDevice

        public IotHubProperties withCloudToDevice​(CloudToDeviceProperties cloudToDevice)
        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

        public String comments()
        Get the comments property: IoT hub comments.
        Returns:
        the comments value.

      • withComments

        public IotHubProperties withComments​(String comments)
        Set the comments property: IoT hub comments.
        Parameters:
        comments - the comments value to set.
        Returns:
        the IotHubProperties object itself.

      • features

        public Capabilities features()
        Get the features property: The capabilities and features enabled for the IoT hub.
        Returns:
        the features value.

      • withFeatures

        public IotHubProperties withFeatures​(Capabilities features)
        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.

      • locations

        public List<IotHubLocationDescription> locations()
        Get the locations property: Primary and secondary location for iot hub.
        Returns:
        the locations value.

      • enableDataResidency

        public Boolean enableDataResidency()
        Get the enableDataResidency property: This property when set to true, will enable data residency, thus, disabling disaster recovery.
        Returns:
        the enableDataResidency value.

      • withEnableDataResidency

        public IotHubProperties withEnableDataResidency​(Boolean enableDataResidency)
        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.

      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.