IotDpsPropertiesDescription Class

the service specific properties of a provisioning service, including keys, linked iot hubs, current state, and system generated properties such as hostname and idScope.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance

msrest.serialization.Model

IotDpsPropertiesDescription

Constructor

IotDpsPropertiesDescription(*, state: str | State | None = None, public_network_access: str | PublicNetworkAccess | None = None, ip_filter_rules: List[IpFilterRule] | None = None, private_endpoint_connections: List[PrivateEndpointConnection] | None = None, provisioning_state: str | None = None, iot_hubs: List[IotHubDefinitionDescription] | None = None, allocation_policy: str | AllocationPolicy | None = None, authorization_policies: List[SharedAccessSignatureAuthorizationRuleAccessRightsDescription] | None = None, enable_data_residency: bool | None = None, **kwargs)

Keyword-Only Parameters

Name	Description
state	str or State Current state of the provisioning service. Possible values include: "Activating", "Active", "Deleting", "Deleted", "ActivationFailed", "DeletionFailed", "Transitioning", "Suspending", "Suspended", "Resuming", "FailingOver", "FailoverFailed".
public_network_access	str or PublicNetworkAccess Whether requests from Public Network are allowed. Possible values include: "Enabled", "Disabled".
ip_filter_rules	list[IpFilterRule] The IP filter rules.
private_endpoint_connections	list[PrivateEndpointConnection] Private endpoint connections created on this IotHub.
provisioning_state	str The ARM provisioning state of the provisioning service.
iot_hubs	list[IotHubDefinitionDescription] List of IoT hubs associated with this provisioning service.
allocation_policy	str or AllocationPolicy Allocation policy to be used by this provisioning service. Possible values include: "Hashed", "GeoLatency", "Static".
authorization_policies	list[SharedAccessSignatureAuthorizationRuleAccessRightsDescription] List of authorization keys for a provisioning service.
enable_data_residency	bool Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery.

Variables

Name	Description
state	str or State Current state of the provisioning service. Possible values include: "Activating", "Active", "Deleting", "Deleted", "ActivationFailed", "DeletionFailed", "Transitioning", "Suspending", "Suspended", "Resuming", "FailingOver", "FailoverFailed".
public_network_access	str or PublicNetworkAccess Whether requests from Public Network are allowed. Possible values include: "Enabled", "Disabled".
ip_filter_rules	list[IpFilterRule] The IP filter rules.
private_endpoint_connections	list[PrivateEndpointConnection] Private endpoint connections created on this IotHub.
provisioning_state	str The ARM provisioning state of the provisioning service.
iot_hubs	list[IotHubDefinitionDescription] List of IoT hubs associated with this provisioning service.
allocation_policy	str or AllocationPolicy Allocation policy to be used by this provisioning service. Possible values include: "Hashed", "GeoLatency", "Static".
service_operations_host_name	str Service endpoint for provisioning service.
device_provisioning_host_name	str Device endpoint for this provisioning service.
id_scope	str Unique identifier of this provisioning service.
authorization_policies	list[SharedAccessSignatureAuthorizationRuleAccessRightsDescription] List of authorization keys for a provisioning service.
enable_data_residency	bool Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery.