IotDpsPropertiesDescription Class

Package:

com.azure.resourcemanager.deviceprovisioningservices.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-deviceprovisioningservices:1.0.0

• java.lang.Object
• • com.azure.resourcemanager.deviceprovisioningservices.models.IotDpsPropertiesDescription

public final class IotDpsPropertiesDescription

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 Summary

Constructor	Description
IotDpsPropertiesDescription()

Method Summary

Modifier and Type	Method and Description
AllocationPolicy	allocationPolicy() Get the allocationPolicy property: Allocation policy to be used by this provisioning service.
List<SharedAccessSignatureAuthorizationRuleInner>	authorizationPolicies() Get the authorizationPolicies property: List of authorization keys for a provisioning service.
String	deviceProvisioningHostname() Get the deviceProvisioningHostname property: Device endpoint for this provisioning service.
String	idScope() Get the idScope property: Unique identifier of this provisioning service.
List<IotHubDefinitionDescription>	iotHubs() Get the iotHubs property: List of IoT hubs associated with this provisioning service.
List<IpFilterRule>	ipFilterRules() Get the ipFilterRules property: The IP filter rules.
List<PrivateEndpointConnectionInner>	privateEndpointConnections() Get the privateEndpointConnections property: Private endpoint connections created on this IotHub.
String	provisioningState() Get the provisioningState property: The ARM provisioning state of the provisioning service.
PublicNetworkAccess	publicNetworkAccess() Get the publicNetworkAccess property: Whether requests from Public Network are allowed.
String	serviceOperationsHostname() Get the serviceOperationsHostname property: Service endpoint for provisioning service.
State	state() Get the state property: Current state of the provisioning service.
void	validate() Validates the instance.
IotDpsPropertiesDescription	withAllocationPolicy(AllocationPolicy allocationPolicy) Set the allocationPolicy property: Allocation policy to be used by this provisioning service.
IotDpsPropertiesDescription	withAuthorizationPolicies(List<SharedAccessSignatureAuthorizationRuleInner> authorizationPolicies) Set the authorizationPolicies property: List of authorization keys for a provisioning service.
IotDpsPropertiesDescription	withIotHubs(List<IotHubDefinitionDescription> iotHubs) Set the iotHubs property: List of IoT hubs associated with this provisioning service.
IotDpsPropertiesDescription	withIpFilterRules(List<IpFilterRule> ipFilterRules) Set the ipFilterRules property: The IP filter rules.
IotDpsPropertiesDescription	withPrivateEndpointConnections(List<PrivateEndpointConnectionInner> privateEndpointConnections) Set the privateEndpointConnections property: Private endpoint connections created on this IotHub.
IotDpsPropertiesDescription	withProvisioningState(String provisioningState) Set the provisioningState property: The ARM provisioning state of the provisioning service.
IotDpsPropertiesDescription	withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess) Set the publicNetworkAccess property: Whether requests from Public Network are allowed.
IotDpsPropertiesDescription	withState(State state) Set the state property: Current state of the provisioning service.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

IotDpsPropertiesDescription

public IotDpsPropertiesDescription()

Method Details

allocationPolicy

public AllocationPolicy allocationPolicy()

Get the allocationPolicy property: Allocation policy to be used by this provisioning service.

Returns:

the allocationPolicy value.

authorizationPolicies

public List authorizationPolicies()

Get the authorizationPolicies property: List of authorization keys for a provisioning service.

Returns:

the authorizationPolicies 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.

iotHubs

public List iotHubs()

Get the iotHubs property: List of IoT hubs associated with this provisioning service.

Returns:

the iotHubs value.

ipFilterRules

public List ipFilterRules()

Get the ipFilterRules property: The IP filter rules.

Returns:

the ipFilterRules value.

privateEndpointConnections

public List privateEndpointConnections()

Get the privateEndpointConnections property: Private endpoint connections created on this IotHub.

Returns:

the privateEndpointConnections value.

provisioningState

public String provisioningState()

Get the provisioningState property: The ARM provisioning state of the provisioning service.

Returns:

the provisioningState value.

publicNetworkAccess

public PublicNetworkAccess publicNetworkAccess()

Get the publicNetworkAccess property: Whether requests from Public Network are allowed.

Returns:

the publicNetworkAccess value.

serviceOperationsHostname

public String serviceOperationsHostname()

Get the serviceOperationsHostname property: Service endpoint for provisioning service.

Returns:

the serviceOperationsHostname value.

state

public State state()

Get the state property: Current state of the provisioning service.

Returns:

the state value.

validate

public void validate()

Validates the instance.

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.

withAuthorizationPolicies

public IotDpsPropertiesDescription withAuthorizationPolicies(List 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.

withIotHubs

public IotDpsPropertiesDescription withIotHubs(List 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.

withIpFilterRules

public IotDpsPropertiesDescription withIpFilterRules(List ipFilterRules)

Set the ipFilterRules property: The IP filter rules.

Parameters:

ipFilterRules - the ipFilterRules value to set.

Returns:

the IotDpsPropertiesDescription object itself.

withPrivateEndpointConnections

public IotDpsPropertiesDescription withPrivateEndpointConnections(List privateEndpointConnections)

Set the privateEndpointConnections property: Private endpoint connections created on this IotHub.

Parameters:

privateEndpointConnections - the privateEndpointConnections value to set.

Returns:

the IotDpsPropertiesDescription object itself.

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.

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.

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.