Iot Dps Resource - Create Or Update

Create or update the metadata of the provisioning service. The usual pattern to modify a property is to retrieve the provisioning service metadata and security metadata, and then combine them with the modified values in a new body to update the provisioning service.

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

URI Parameters

Name In Required Type Description
provisioningServiceName
path True

string

Name of provisioning service to create or update.

resourceGroupName
path True

string

Resource group identifier.

subscriptionId
path True

string

The subscription identifier.

api-version
query True

string

The version of the API.

Request Body

Name Required Type Description
location True

string

The resource location.

properties True

IotDpsPropertiesDescription

Service specific properties for a provisioning service

sku True

IotDpsSkuInfo

Sku info for a provisioning Service.

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.

resourcegroup

string

The resource group of the resource.

subscriptionid

string

The subscription id of the resource.

tags

object

The resource tags.

Responses

Name Type Description
200 OK

ProvisioningServiceDescription

The body contains all the non-security properties of the provisioning service. Security-related properties are set to null.

201 Created

ProvisioningServiceDescription

This is a long running operation. The operation returns a 201 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation. If successful, the operation returns HTTP status code of 201 (OK).

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

DPSCreate

Sample request

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

{
  "location": "East US",
  "properties": {
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "capacity": 1
  },
  "tags": {}
}

Sample response

{
  "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",
    "authorizationPolicies": [],
    "enableDataResidency": false,
    "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net"
  },
  "resourcegroup": "myResourceGroup",
  "type": "Microsoft.Devices/ProvisioningServices",
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
  "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
  "tags": {},
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}
{
  "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",
    "authorizationPolicies": [],
    "enableDataResidency": false,
    "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net"
  },
  "resourcegroup": "myResourceGroup",
  "type": "Microsoft.Devices/ProvisioningServices",
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
  "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.

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.

Name Type Description
DeviceConnect

string

EnrollmentRead

string

EnrollmentWrite

string

RegistrationStatusRead

string

RegistrationStatusWrite

string

ServiceConfig

string

AllocationPolicy

Allocation policy to be used by this provisioning service.

Name Type Description
GeoLatency

string

Hashed

string

Static

string

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDetails

Error details.

Name Type Description
code

integer

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.

Name Type Description
S1

string

IotDpsSkuInfo

List of possible provisioning service SKUs.

Name Type Description
capacity

integer

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

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.

Name Type Description
Accept

string

Reject

string

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.

Name Type Description
all

string

deviceApi

string

serviceApi

string

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

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

Name Type Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

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

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.

PublicNetworkAccess

Whether requests from Public Network are allowed

Name Type Description
Disabled

string

Enabled

string

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.

Name Type Description
Activating

string

ActivationFailed

string

Active

string

Deleted

string

Deleting

string

DeletionFailed

string

FailingOver

string

FailoverFailed

string

Resuming

string

Suspended

string

Suspending

string

Transitioning

string

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

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

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.