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.

Constructor

IotDpsPropertiesDescription()

Variables

Name	Description
state	Union[str, <xref:"State">] Current state of the provisioning service. Known values are: "Activating", "Active", "Deleting", "Deleted", "ActivationFailed", "DeletionFailed", "Transitioning", "Suspending", "Suspended", "Resuming", "FailingOver", and "FailoverFailed".
publicNetworkAccess	Union[str, <xref:"PublicNetworkAccess">] Whether requests from Public Network are allowed. Known values are: "Enabled" and "Disabled".
ipFilterRules	list[<xref:"IpFilterRule">] The IP filter rules.
privateEndpointConnections	list[<xref:"PrivateEndpointConnection">] Private endpoint connections created on this IotHub.
provisioningState	str The ARM provisioning state of the provisioning service.
iotHubs	list[<xref:"IotHubDefinitionDescription">] List of IoT hubs associated with this provisioning service.
allocationPolicy	Union[str, <xref:"AllocationPolicy">] Allocation policy to be used by this provisioning service. Known values are: "Hashed", "GeoLatency", and "Static".
serviceOperationsHostName	str Service endpoint for provisioning service.
deviceProvisioningHostName	str Device endpoint for this provisioning service.
idScope	str Unique identifier of this provisioning service.
authorizationPolicies	list[<xref:"SharedAccessSignatureAuthorizationRuleAccessRightsDescription">] List of authorization keys for a provisioning service.
enableDataResidency	bool Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery.
portalOperationsHostName	str Portal endpoint to enable CORS for this provisioning service.
disableLocalAuth	bool Disables all authentication methods other than Azure RBAC.

Attributes

allocationPolicy

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

allocationPolicy: str | AllocationPolicy

authorizationPolicies

List of authorization keys for a provisioning service.

authorizationPolicies: list['SharedAccessSignatureAuthorizationRuleAccessRightsDescription']

deviceProvisioningHostName

Device endpoint for this provisioning service.

deviceProvisioningHostName: str

disableLocalAuth

Disables all authentication methods other than Azure RBAC.

disableLocalAuth: bool

enableDataResidency

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

enableDataResidency: bool

idScope

Unique identifier of this provisioning service.

idScope: str

iotHubs

List of IoT hubs associated with this provisioning service.

iotHubs: list['IotHubDefinitionDescription']

ipFilterRules

The IP filter rules.

ipFilterRules: list['IpFilterRule']

portalOperationsHostName

Portal endpoint to enable CORS for this provisioning service.

portalOperationsHostName: str

privateEndpointConnections

Private endpoint connections created on this IotHub.

privateEndpointConnections: list['PrivateEndpointConnection']

provisioningState

The ARM provisioning state of the provisioning service.

provisioningState: str

publicNetworkAccess

"Enabled" and "Disabled".

publicNetworkAccess: str | PublicNetworkAccess

serviceOperationsHostName

Service endpoint for provisioning service.

serviceOperationsHostName: str

state

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

state: str | State