Share via

IotDpsPropertiesDescription interface

  • Reference
Package:
@azure/arm-deviceprovisioningservices

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

Properties

allocationPolicy

Allocation policy to be used by this provisioning service.
authorizationPolicies

List of authorization keys for a provisioning service.
deviceProvisioningHostName

Device endpoint for this provisioning service. NOTE: This property will not be serialized. It can only be populated by the server.
enableDataResidency

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

Unique identifier of this provisioning service. NOTE: This property will not be serialized. It can only be populated by the server.
iotHubs

List of IoT hubs associated with this provisioning service.
ipFilterRules

The IP filter rules.
privateEndpointConnections

Private endpoint connections created on this IotHub
provisioningState

The ARM provisioning state of the provisioning service.
publicNetworkAccess

Whether requests from Public Network are allowed
serviceOperationsHostName

Service endpoint for provisioning service. NOTE: This property will not be serialized. It can only be populated by the server.
state

Current state of the provisioning service.

Property Details

allocationPolicy

Allocation policy to be used by this provisioning service.

allocationPolicy?: string

Property Value

string

authorizationPolicies

List of authorization keys for a provisioning service.

authorizationPolicies?: SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]

Property Value

SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]

deviceProvisioningHostName

Device endpoint for this provisioning service. NOTE: This property will not be serialized. It can only be populated by the server.

deviceProvisioningHostName?: string

Property Value

string

enableDataResidency

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

enableDataResidency?: boolean

Property Value

boolean

idScope

Unique identifier of this provisioning service. NOTE: This property will not be serialized. It can only be populated by the server.

idScope?: string

Property Value

string

iotHubs

List of IoT hubs associated with this provisioning service.

iotHubs?: IotHubDefinitionDescription[]

Property Value

IotHubDefinitionDescription[]

ipFilterRules

The IP filter rules.

ipFilterRules?: IpFilterRule[]

Property Value

IpFilterRule[]

privateEndpointConnections

Private endpoint connections created on this IotHub

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

provisioningState

The ARM provisioning state of the provisioning service.

provisioningState?: string

Property Value

string

publicNetworkAccess

Whether requests from Public Network are allowed

publicNetworkAccess?: string

Property Value

string

serviceOperationsHostName

Service endpoint for provisioning service. NOTE: This property will not be serialized. It can only be populated by the server.

serviceOperationsHostName?: string

Property Value

string

state

Current state of the provisioning service.

state?: string

Property Value

string