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

Model

IotDpsPropertiesDescription

Constructor

IotDpsPropertiesDescription(*, state: Optional[Union[str, azure.mgmt.iothubprovisioningservices.models._iot_dps_client_enums.State]] = None, public_network_access: Optional[Union[str, azure.mgmt.iothubprovisioningservices.models._iot_dps_client_enums.PublicNetworkAccess]] = None, ip_filter_rules: Optional[List[azure.mgmt.iothubprovisioningservices.models._models_py3.IpFilterRule]] = None, private_endpoint_connections: Optional[List[azure.mgmt.iothubprovisioningservices.models._models_py3.PrivateEndpointConnection]] = None, provisioning_state: Optional[str] = None, iot_hubs: Optional[List[azure.mgmt.iothubprovisioningservices.models._models_py3.IotHubDefinitionDescription]] = None, allocation_policy: Optional[Union[str, azure.mgmt.iothubprovisioningservices.models._iot_dps_client_enums.AllocationPolicy]] = None, authorization_policies: Optional[List[azure.mgmt.iothubprovisioningservices.models._models_py3.SharedAccessSignatureAuthorizationRuleAccessRightsDescription]] = None, enable_data_residency: Optional[bool] = None, **kwargs)

Variables

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.