Iot Dps Resource - List By Subscription

Get all the provisioning services in a subscription.
List all the provisioning services for a given subscription id.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Devices/provisioningServices?api-version=2022-12-12

URI Parameters

Name In Required Type Description
subscriptionId
path True

string

The subscription identifier.

api-version
query True

string

The version of the API.

Responses

Name Type Description
200 OK

ProvisioningServiceDescriptionListResult

This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the provisioning services in the subscription.

Other Status Codes

ErrorDetails

Default error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

DPSListBySubscription

Sample request

GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/provisioningServices?api-version=2022-12-12

Sample response

{
  "value": [
    {
      "etag": "AAAAAAAADGk=",
      "name": "myFirstProvisioningService",
      "location": "eastus",
      "properties": {
        "state": "Active",
        "allocationPolicy": "Hashed",
        "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
        "deviceProvisioningHostName": "global.azure-devices-provisioning.net",
        "idScope": "0ne00000012",
        "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net"
      },
      "resourcegroup": "myResourceGroup",
      "type": "Microsoft.Devices/ProvisioningServices",
      "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
      "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
      "tags": {},
      "sku": {
        "name": "S1",
        "tier": "Standard",
        "capacity": 1
      }
    },
    {
      "etag": "AAAAAAAADGk=",
      "name": "mySecondProvisioningService",
      "location": "eastus",
      "properties": {
        "state": "Active",
        "allocationPolicy": "Hashed",
        "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
        "deviceProvisioningHostName": "global.azure-devices-provisioning.net",
        "idScope": "0ne00000012",
        "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net"
      },
      "resourcegroup": "myResourceGroup",
      "type": "Microsoft.Devices/ProvisioningServices",
      "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/mySecondProvisioningService",
      "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
      "tags": {},
      "sku": {
        "name": "S1",
        "tier": "Standard",
        "capacity": 1
      }
    }
  ]
}

Definitions

Name Description
AccessRightsDescription

Rights that this key has.

AllocationPolicy

Allocation policy to be used by this provisioning service.

createdByType

The type of identity that created the resource.

ErrorDetails

Error details.

IotDpsPropertiesDescription

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

IotDpsSku

Sku name.

IotDpsSkuInfo

List of possible provisioning service SKUs.

IotHubDefinitionDescription

Description of the IoT hub.

IpFilterActionType

The desired action for requests captured by this rule.

IpFilterRule

The IP filter rules for a provisioning Service.

IpFilterTargetType

Target for requests captured by this rule.

PrivateEndpoint

The private endpoint property of a private endpoint connection

PrivateEndpointConnection

The private endpoint connection of a provisioning service

PrivateEndpointConnectionProperties

The properties of a private endpoint connection

PrivateLinkServiceConnectionState

The current state of a private endpoint connection

PrivateLinkServiceConnectionStatus

The status of a private endpoint connection

ProvisioningServiceDescription

The description of the provisioning service.

ProvisioningServiceDescriptionListResult

List of provisioning service descriptions.

PublicNetworkAccess

Whether requests from Public Network are allowed

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Description of the shared access key.

state

Current state of the provisioning service.

systemData

Metadata pertaining to creation and last modification of the resource.

AccessRightsDescription

Rights that this key has.

Value Description
DeviceConnect
EnrollmentRead
EnrollmentWrite
RegistrationStatusRead
RegistrationStatusWrite
ServiceConfig

AllocationPolicy

Allocation policy to be used by this provisioning service.

Value Description
GeoLatency
Hashed
Static

createdByType

The type of identity that created the resource.

Value Description
Application
Key
ManagedIdentity
User

ErrorDetails

Error details.

Name Type Description
code

integer (int32)

The error code.

details

string

The error details.

httpStatusCode

string

The HTTP status code.

message

string

The error message.

IotDpsPropertiesDescription

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

Name Type Description
allocationPolicy

AllocationPolicy

Allocation policy to be used by this provisioning service.

authorizationPolicies

SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]

List of authorization keys for a provisioning service.

deviceProvisioningHostName

string

Device endpoint for this provisioning service.

enableDataResidency

boolean

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

idScope

string

Unique identifier of this provisioning service.

iotHubs

IotHubDefinitionDescription[]

List of IoT hubs associated with this provisioning service.

ipFilterRules

IpFilterRule[]

The IP filter rules.

portalOperationsHostName

string

Portal endpoint to enable CORS for this provisioning service.

privateEndpointConnections

PrivateEndpointConnection[]

Private endpoint connections created on this IotHub

provisioningState

string

The ARM provisioning state of the provisioning service.

publicNetworkAccess

PublicNetworkAccess

Whether requests from Public Network are allowed

serviceOperationsHostName

string

Service endpoint for provisioning service.

state

state

Current state of the provisioning service.

IotDpsSku

Sku name.

Value Description
S1

IotDpsSkuInfo

List of possible provisioning service SKUs.

Name Type Description
capacity

integer (int64)

The number of units to provision

name

IotDpsSku

Sku name.

tier

string

Pricing tier name of the provisioning service.

IotHubDefinitionDescription

Description of the IoT hub.

Name Type Description
allocationWeight

integer (int32)

weight to apply for a given iot h.

applyAllocationPolicy

boolean

flag for applying allocationPolicy or not for a given iot hub.

connectionString

string

Connection string of the IoT hub.

location

string

ARM region of the IoT hub.

name

string

Host name of the IoT hub.

IpFilterActionType

The desired action for requests captured by this rule.

Value Description
Accept
Reject

IpFilterRule

The IP filter rules for a provisioning Service.

Name Type Description
action

IpFilterActionType

The desired action for requests captured by this rule.

filterName

string

The name of the IP filter rule.

ipMask

string

A string that contains the IP address range in CIDR notation for the rule.

target

IpFilterTargetType

Target for requests captured by this rule.

IpFilterTargetType

Target for requests captured by this rule.

Value Description
all
deviceApi
serviceApi

PrivateEndpoint

The private endpoint property of a private endpoint connection

Name Type Description
id

string

The resource identifier.

PrivateEndpointConnection

The private endpoint connection of a provisioning service

Name Type Description
id

string

The resource identifier.

name

string

pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$

The resource name.

properties

PrivateEndpointConnectionProperties

The properties of a private endpoint connection

systemData

systemData

Metadata pertaining to creation and last modification of the resource.

type

string

The resource type.

PrivateEndpointConnectionProperties

The properties of a private endpoint connection

Name Type Description
privateEndpoint

PrivateEndpoint

The private endpoint property of a private endpoint connection

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

The current state of a private endpoint connection

PrivateLinkServiceConnectionState

The current state of a private endpoint connection

Name Type Description
actionsRequired

string

Actions required for a private endpoint connection

description

string

The description for the current state of a private endpoint connection

status

PrivateLinkServiceConnectionStatus

The status of a private endpoint connection

PrivateLinkServiceConnectionStatus

The status of a private endpoint connection

Value Description
Approved
Disconnected
Pending
Rejected

ProvisioningServiceDescription

The description of the provisioning service.

Name Type Description
etag

string

The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.

id

string

The resource identifier.

location

string

The resource location.

name

string

pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$

The resource name.

properties

IotDpsPropertiesDescription

Service specific properties for a provisioning service

resourcegroup

string

The resource group of the resource.

sku

IotDpsSkuInfo

Sku info for a provisioning Service.

subscriptionid

string

The subscription id of the resource.

systemData

systemData

Metadata pertaining to creation and last modification of the resource.

tags

object

The resource tags.

type

string

The resource type.

ProvisioningServiceDescriptionListResult

List of provisioning service descriptions.

Name Type Description
nextLink

string

the next link

value

ProvisioningServiceDescription[]

List of provisioning service descriptions.

PublicNetworkAccess

Whether requests from Public Network are allowed

Value Description
Disabled
Enabled

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Description of the shared access key.

Name Type Description
keyName

string

Name of the key.

primaryKey

string

Primary SAS key value.

rights

AccessRightsDescription

Rights that this key has.

secondaryKey

string

Secondary SAS key value.

state

Current state of the provisioning service.

Value Description
Activating
ActivationFailed
Active
Deleted
Deleting
DeletionFailed
FailingOver
FailoverFailed
Resuming
Suspended
Suspending
Transitioning

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string (date-time)

The timestamp of resource last modification (UTC)

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.