Package com.azure.resourcemanager.deviceprovisioningservices.models

Class IotDpsPropertiesDescription

  • public final class IotDpsPropertiesDescription
extends Object
    the service specific properties of a provisioning service, including keys, linked iot hubs, current state, and system generated properties such as hostname and idScope.

    • Constructor Detail

      • IotDpsPropertiesDescription

        public IotDpsPropertiesDescription()

    • Method Detail

      • state

        public State state()
        Get the state property: Current state of the provisioning service.
        Returns:
        the state value.

      • withState

        public IotDpsPropertiesDescription withState​(State state)
        Set the state property: Current state of the provisioning service.
        Parameters:
        state - the state value to set.
        Returns:
        the IotDpsPropertiesDescription object itself.

      • publicNetworkAccess

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

      • withPublicNetworkAccess

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

      • ipFilterRules

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

      • withIpFilterRules

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

      • privateEndpointConnections

        public List<PrivateEndpointConnectionInner> privateEndpointConnections()
        Get the privateEndpointConnections property: Private endpoint connections created on this IotHub.
        Returns:
        the privateEndpointConnections value.

      • withPrivateEndpointConnections

        public IotDpsPropertiesDescription withPrivateEndpointConnections​(List<PrivateEndpointConnectionInner> privateEndpointConnections)
        Set the privateEndpointConnections property: Private endpoint connections created on this IotHub.
        Parameters:
        privateEndpointConnections - the privateEndpointConnections value to set.
        Returns:
        the IotDpsPropertiesDescription object itself.

      • provisioningState

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

      • withProvisioningState

        public IotDpsPropertiesDescription withProvisioningState​(String provisioningState)
        Set the provisioningState property: The ARM provisioning state of the provisioning service.
        Parameters:
        provisioningState - the provisioningState value to set.
        Returns:
        the IotDpsPropertiesDescription object itself.

      • iotHubs

        public List<IotHubDefinitionDescription> iotHubs()
        Get the iotHubs property: List of IoT hubs associated with this provisioning service.
        Returns:
        the iotHubs value.

      • withIotHubs

        public IotDpsPropertiesDescription withIotHubs​(List<IotHubDefinitionDescription> iotHubs)
        Set the iotHubs property: List of IoT hubs associated with this provisioning service.
        Parameters:
        iotHubs - the iotHubs value to set.
        Returns:
        the IotDpsPropertiesDescription object itself.

      • allocationPolicy

        public AllocationPolicy allocationPolicy()
        Get the allocationPolicy property: Allocation policy to be used by this provisioning service.
        Returns:
        the allocationPolicy value.

      • withAllocationPolicy

        public IotDpsPropertiesDescription withAllocationPolicy​(AllocationPolicy allocationPolicy)
        Set the allocationPolicy property: Allocation policy to be used by this provisioning service.
        Parameters:
        allocationPolicy - the allocationPolicy value to set.
        Returns:
        the IotDpsPropertiesDescription object itself.

      • serviceOperationsHostname

        public String serviceOperationsHostname()
        Get the serviceOperationsHostname property: Service endpoint for provisioning service.
        Returns:
        the serviceOperationsHostname value.

      • deviceProvisioningHostname

        public String deviceProvisioningHostname()
        Get the deviceProvisioningHostname property: Device endpoint for this provisioning service.
        Returns:
        the deviceProvisioningHostname value.

      • idScope

        public String idScope()
        Get the idScope property: Unique identifier of this provisioning service.
        Returns:
        the idScope value.

      • authorizationPolicies

        public List<SharedAccessSignatureAuthorizationRuleInner> authorizationPolicies()
        Get the authorizationPolicies property: List of authorization keys for a provisioning service.
        Returns:
        the authorizationPolicies value.

      • withAuthorizationPolicies

        public IotDpsPropertiesDescription withAuthorizationPolicies​(List<SharedAccessSignatureAuthorizationRuleInner> authorizationPolicies)
        Set the authorizationPolicies property: List of authorization keys for a provisioning service.
        Parameters:
        authorizationPolicies - the authorizationPolicies value to set.
        Returns:
        the IotDpsPropertiesDescription object itself.

      • enableDataResidency

        public Boolean enableDataResidency()
        Get the enableDataResidency property: Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery.
        Returns:
        the enableDataResidency value.

      • withEnableDataResidency

        public IotDpsPropertiesDescription withEnableDataResidency​(Boolean enableDataResidency)
        Set the enableDataResidency property: Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery.
        Parameters:
        enableDataResidency - the enableDataResidency value to set.
        Returns:
        the IotDpsPropertiesDescription object itself.

      • validate

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