azure.mgmt.iothubprovisioningservices.models.IotDpsPropertiesDescription class

Constructor

IotDpsPropertiesDescription(*args: Any, **kwargs: Any)

Variables

Name	Description
state	str or State Current state of the provisioning service. Known values are: "Activating", "Active", "Deleting", "Deleted", "ActivationFailed", "DeletionFailed", "Transitioning", "Suspending", "Suspended", "Resuming", "FailingOver", and "FailoverFailed".
public_network_access	str or PublicNetworkAccess Whether requests from Public Network are allowed. Known values are: "Enabled" and "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. Known values are: "Hashed", "GeoLatency", and "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.
portal_operations_host_name	str Portal endpoint to enable CORS for this provisioning service.
disable_local_auth	bool Disables all authentication methods other than Azure RBAC.

allocation_policy

"Hashed", "GeoLatency", and "Static".

allocation_policy: str | _models.AllocationPolicy | None

authorization_policies

List of authorization keys for a provisioning service.

authorization_policies: list['_models.SharedAccessSignatureAuthorizationRuleAccessRightsDescription'] | None

device_provisioning_host_name

Device endpoint for this provisioning service.

device_provisioning_host_name: str | None

disable_local_auth

Disables all authentication methods other than Azure RBAC.

disable_local_auth: bool | None

enable_data_residency

Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery.

enable_data_residency: bool | None

id_scope

Unique identifier of this provisioning service.

id_scope: str | None

iot_hubs

List of IoT hubs associated with this provisioning service.

iot_hubs: list['_models.IotHubDefinitionDescription'] | None

ip_filter_rules

The IP filter rules.

ip_filter_rules: list['_models.IpFilterRule'] | None

portal_operations_host_name

Portal endpoint to enable CORS for this provisioning service.

portal_operations_host_name: str | None

private_endpoint_connections

Private endpoint connections created on this IotHub.

private_endpoint_connections: list['_models.PrivateEndpointConnection'] | None

provisioning_state

The ARM provisioning state of the provisioning service.

provisioning_state: str | None

public_network_access

"Enabled" and "Disabled".

public_network_access: str | _models.PublicNetworkAccess | None

service_operations_host_name

Service endpoint for provisioning service.

service_operations_host_name: str | None

state

"Activating", "Active", "Deleting", "Deleted", "ActivationFailed", "DeletionFailed", "Transitioning", "Suspending", "Suspended", "Resuming", "FailingOver", and "FailoverFailed".

state: str | _models.State | None