Microsoft.Devices (preview:2025-02-01)

2025/07/11 • 24 updated methods

Operations_List (updated)
Description :  List the operations for the provider
Reference :  Link ¶

⚶ Changes

{
  "#id": "Operations_List",
  "Description": {
    "new": "List the operations for the provider",
    "old": "Lists all of the available Microsoft.Devices REST API operations."
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "[Placeholder] Description for value property",
            "old": "Provisioning service operations supported by the Microsoft.Devices resource provider."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "Description": {
              "new": "Represents an operation.",
              "old": "Provisioning Service REST API operation."
            },
            "$properties": [
              {
                "#name": "name",
                "Description": {
                  "new": "The name of the operation.",
                  "old": "Operation name: {provider}/{resource}/{read | write | action | delete}"
                }
              },
              {
                "#name": "display",
                "Description": {
                  "new": "The display information for the operation.",
                  "old": "The object that represents the operation."
                }
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "[Placeholder] Description for nextLink property.",
            "old": "URL to get the next set of operation list results if there are any."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.Devices/operations
{
api-version:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: [Placeholder] Description for value property ,
Required: True ,
}
[
{
name:
{
Description: The name of the operation. ,
Required: False ,
}
string ,
display:
{
Description: The display information for the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft Devices. ,
Required: False ,
}
string ,
resource:
{
Description: Resource Type: ProvisioningServices. ,
Required: False ,
}
string ,
operation:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: [Placeholder] Description for nextLink property. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotDpsResource_CheckProvisioningServiceNameAvailability (updated)
Description :  Check if a provisioning service name is available. This will validate if the name is syntactically valid and if the name is usable
Reference :  Link ¶

⚶ Changes

{
  "#id": "IotDpsResource_CheckProvisioningServiceNameAvailability",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The version of the API."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription identifier."
      }
    },
    {
      "#name": "arguments",
      "Description": {
        "new": "The request body",
        "old": "Set the name parameter in the OperationInputs structure to the name of the provisioning service to check."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkProvisioningServiceNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
arguments:
{
Description: The request body ,
Required: True ,
}
{
name:
{
Description: The name of the Provisioning Service to check. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: specifies if a name is available or not ,
Required: False ,
}
boolean ,
reason:
{
Description: specifies the reason a name is unavailable ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: message containing a detailed reason name is unavailable ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotDpsResource_ListBySubscription (updated)
Description :  List all the provisioning services for a given subscription id.
Reference :  Link ¶

⚶ Changes

{
  "#id": "IotDpsResource_ListBySubscription",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The version of the API."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription identifier."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a ProvisioningServiceDescription list operation.",
        "old": "List of provisioning service descriptions."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ProvisioningServiceDescription items on this page",
            "old": "List of provisioning service descriptions."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": [
              {
                "@added_83dd48e09bf14553abf2167df22a6307": {
                  "#name": "resourcegroup",
                  "Description": "The resource group of the resource.",
                  "Required": false,
                  "Type": "string"
                }
              },
              {
                "@added_8680a873b5e84707ba5421b7a9e60c21": {
                  "#name": "subscriptionid",
                  "Description": "The subscription id of the resource.",
                  "Required": false,
                  "Type": "string"
                }
              },
              {
                "properties": [
                  {
                    "privateEndpointConnections": {
                      "$properties": {
                        "@removed_f2fafefd7bc14cc9ac8be59c167e2823": {
                          "#name": "id",
                          "Description": "The resource identifier.",
                          "Required": false,
                          "Type": "string"
                        },
                        "@removed_ac348e6f7a3c4316bd3902d3186081b0": {
                          "#name": "name",
                          "Description": "The resource name.",
                          "Required": false,
                          "Type": "string"
                        },
                        "@removed_523f0b8a68104e1e8631c3fdbe31d04f": {
                          "#name": "type",
                          "Description": "The resource type.",
                          "Required": false,
                          "Type": "string"
                        },
                        "@removed_6932b21a1bdb4c85b2345d4009258fb1": {
                          "#name": "systemData",
                          "Description": "Metadata pertaining to creation and last modification of the resource.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "createdBy",
                              "Description": "The identity that created the resource.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "createdByType",
                              "Description": "The type of identity that created the resource.",
                              "Enum": [
                                [
                                  "User",
                                  ""
                                ],
                                [
                                  "Application",
                                  ""
                                ],
                                [
                                  "ManagedIdentity",
                                  ""
                                ],
                                [
                                  "Key",
                                  ""
                                ]
                              ],
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "createdAt",
                              "Description": "The timestamp of resource creation (UTC).",
                              "Format": "date-time",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "lastModifiedBy",
                              "Description": "The identity that last modified the resource.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "lastModifiedByType",
                              "Description": "The type of identity that last modified the resource.",
                              "Enum": [
                                [
                                  "User",
                                  ""
                                ],
                                [
                                  "Application",
                                  ""
                                ],
                                [
                                  "ManagedIdentity",
                                  ""
                                ],
                                [
                                  "Key",
                                  ""
                                ]
                              ],
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "lastModifiedAt",
                              "Description": "The timestamp of resource last modification (UTC)",
                              "Format": "date-time",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        }
                      }
                    }
                  }
                ]
              },
              {
                "#name": "identity",
                "Description": {
                  "new": "The managed service identities assigned to this resource.",
                  "old": "The managed identities for a provisioning service."
                }
              },
              {
                "@removed_e0411d5761c64374add3da354961d50f": {
                  "#name": "systemData",
                  "Description": "Metadata pertaining to creation and last modification of the resource.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "createdBy",
                      "Description": "The identity that created the resource.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "createdByType",
                      "Description": "The type of identity that created the resource.",
                      "Enum": [
                        [
                          "User",
                          ""
                        ],
                        [
                          "Application",
                          ""
                        ],
                        [
                          "ManagedIdentity",
                          ""
                        ],
                        [
                          "Key",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "createdAt",
                      "Description": "The timestamp of resource creation (UTC).",
                      "Format": "date-time",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "lastModifiedBy",
                      "Description": "The identity that last modified the resource.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "lastModifiedByType",
                      "Description": "The type of identity that last modified the resource.",
                      "Enum": [
                        [
                          "User",
                          ""
                        ],
                        [
                          "Application",
                          ""
                        ],
                        [
                          "ManagedIdentity",
                          ""
                        ],
                        [
                          "Key",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "lastModifiedAt",
                      "Description": "The timestamp of resource last modification (UTC)",
                      "Format": "date-time",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "the next link"
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Devices/provisioningServices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ProvisioningServiceDescription items on this page ,
Required: True ,
}
[
{
etag:
{
Description: 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. ,
Required: False ,
}
string ,
resourcegroup:
{
Description: The resource group of the resource. ,
Required: False ,
}
string ,
subscriptionid:
{
Description: The subscription id of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Service specific properties for a provisioning service ,
Required: True ,
}
{
state:
{
Description: Current state of the provisioning service. ,
Enum:
{
Activating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
ActivationFailed: No description available. ,
DeletionFailed: No description available. ,
Transitioning: No description available. ,
Suspending: No description available. ,
Suspended: No description available. ,
Resuming: No description available. ,
FailingOver: No description available. ,
FailoverFailed: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
ipFilterRules:
{
Description: The IP filter rules. ,
Required: False ,
}
[
{
filterName:
{
Description: The name of the IP filter rule. ,
Required: True ,
}
string ,
action:
{
Description: The desired action for requests captured by this rule. ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: True ,
}
enum ,
ipMask:
{
Description: A string that contains the IP address range in CIDR notation for the rule. ,
Required: True ,
}
string ,
target:
{
Description: Target for requests captured by this rule. ,
Enum:
{
all: No description available. ,
serviceApi: No description available. ,
deviceApi: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The ARM provisioning state of the provisioning service. ,
Required: False ,
}
string ,
iotHubs:
{
Description: List of IoT hubs associated with this provisioning service. ,
Required: False ,
}
[
{
applyAllocationPolicy:
{
Description: flag for applying allocationPolicy or not for a given iot hub. ,
Required: False ,
}
boolean ,
allocationWeight:
{
Description: weight to apply for a given iot h. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Host name of the IoT hub. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string of the IoT hub. ,
Required: False ,
}
string ,
location:
{
Description: ARM region of the IoT hub. ,
Required: True ,
}
string ,
authenticationType:
{
Description: IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned. ,
Enum:
{
KeyBased: No description available. ,
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
selectedUserAssignedIdentityResourceId:
{
Description: The selected user-assigned identity resource Id associated with IoT Hub. This is required when authenticationType is UserAssigned. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
allocationPolicy:
{
Description: Allocation policy to be used by this provisioning service. ,
Enum:
{
Hashed: No description available. ,
GeoLatency: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
serviceOperationsHostName:
{
Description: Service endpoint for provisioning service. ,
Required: False ,
}
string ,
deviceProvisioningHostName:
{
Description: Device endpoint for this provisioning service. ,
Required: False ,
}
string ,
idScope:
{
Description: Unique identifier of this provisioning service. ,
Required: False ,
}
string ,
authorizationPolicies:
{
Description: List of authorization keys for a provisioning service. ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the key. ,
Required: True ,
}
string ,
primaryKey:
{
Description: Primary SAS key value. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary SAS key value. ,
Required: False ,
}
string ,
rights:
{
Description: Rights that this key has. ,
Enum:
{
ServiceConfig: No description available. ,
EnrollmentRead: No description available. ,
EnrollmentWrite: No description available. ,
DeviceConnect: No description available. ,
RegistrationStatusRead: No description available. ,
RegistrationStatusWrite: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
enableDataResidency:
{
Description: Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery. ,
Required: False ,
}
boolean ,
portalOperationsHostName:
{
Description: Portal endpoint to enable CORS for this provisioning service. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Sku info for a provisioning Service. ,
Required: True ,
}
{
name:
{
Description: Sku name. ,
Enum:
{
S1: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Pricing tier name of the provisioning service. ,
Required: False ,
}
string ,
capacity:
{
Description: The number of units to provision ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotDpsResource_ListByResourceGroup (updated)
Description :  Get a list of all provisioning services in the given resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "IotDpsResource_ListByResourceGroup",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The version of the API."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription identifier."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Resource group identifier."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a ProvisioningServiceDescription list operation.",
        "old": "List of provisioning service descriptions."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ProvisioningServiceDescription items on this page",
            "old": "List of provisioning service descriptions."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": [
              {
                "@added_5381e450df9f4dda8119180bf2cbf7b6": {
                  "#name": "resourcegroup",
                  "Description": "The resource group of the resource.",
                  "Required": false,
                  "Type": "string"
                }
              },
              {
                "@added_8f218b4d00fc4414b1a90fefa9bcc570": {
                  "#name": "subscriptionid",
                  "Description": "The subscription id of the resource.",
                  "Required": false,
                  "Type": "string"
                }
              },
              {
                "properties": [
                  {
                    "privateEndpointConnections": {
                      "$properties": {
                        "@removed_597c4161fce84878aca0db04575f67c3": {
                          "#name": "id",
                          "Description": "The resource identifier.",
                          "Required": false,
                          "Type": "string"
                        },
                        "@removed_94a0d91e78674ed6bb09a7cade3755a1": {
                          "#name": "name",
                          "Description": "The resource name.",
                          "Required": false,
                          "Type": "string"
                        },
                        "@removed_4058d0a273d84038bdca632833886a10": {
                          "#name": "type",
                          "Description": "The resource type.",
                          "Required": false,
                          "Type": "string"
                        },
                        "@removed_d08b22c032994ced8e24f0ab4131e683": {
                          "#name": "systemData",
                          "Description": "Metadata pertaining to creation and last modification of the resource.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "createdBy",
                              "Description": "The identity that created the resource.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "createdByType",
                              "Description": "The type of identity that created the resource.",
                              "Enum": [
                                [
                                  "User",
                                  ""
                                ],
                                [
                                  "Application",
                                  ""
                                ],
                                [
                                  "ManagedIdentity",
                                  ""
                                ],
                                [
                                  "Key",
                                  ""
                                ]
                              ],
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "createdAt",
                              "Description": "The timestamp of resource creation (UTC).",
                              "Format": "date-time",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "lastModifiedBy",
                              "Description": "The identity that last modified the resource.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "lastModifiedByType",
                              "Description": "The type of identity that last modified the resource.",
                              "Enum": [
                                [
                                  "User",
                                  ""
                                ],
                                [
                                  "Application",
                                  ""
                                ],
                                [
                                  "ManagedIdentity",
                                  ""
                                ],
                                [
                                  "Key",
                                  ""
                                ]
                              ],
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "lastModifiedAt",
                              "Description": "The timestamp of resource last modification (UTC)",
                              "Format": "date-time",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        }
                      }
                    }
                  }
                ]
              },
              {
                "#name": "identity",
                "Description": {
                  "new": "The managed service identities assigned to this resource.",
                  "old": "The managed identities for a provisioning service."
                }
              },
              {
                "@removed_c3e1622c89ee473fb731d0a72a16bc73": {
                  "#name": "systemData",
                  "Description": "Metadata pertaining to creation and last modification of the resource.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "createdBy",
                      "Description": "The identity that created the resource.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "createdByType",
                      "Description": "The type of identity that created the resource.",
                      "Enum": [
                        [
                          "User",
                          ""
                        ],
                        [
                          "Application",
                          ""
                        ],
                        [
                          "ManagedIdentity",
                          ""
                        ],
                        [
                          "Key",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "createdAt",
                      "Description": "The timestamp of resource creation (UTC).",
                      "Format": "date-time",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "lastModifiedBy",
                      "Description": "The identity that last modified the resource.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "lastModifiedByType",
                      "Description": "The type of identity that last modified the resource.",
                      "Enum": [
                        [
                          "User",
                          ""
                        ],
                        [
                          "Application",
                          ""
                        ],
                        [
                          "ManagedIdentity",
                          ""
                        ],
                        [
                          "Key",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "lastModifiedAt",
                      "Description": "The timestamp of resource last modification (UTC)",
                      "Format": "date-time",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "the next link"
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ProvisioningServiceDescription items on this page ,
Required: True ,
}
[
{
etag:
{
Description: 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. ,
Required: False ,
}
string ,
resourcegroup:
{
Description: The resource group of the resource. ,
Required: False ,
}
string ,
subscriptionid:
{
Description: The subscription id of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Service specific properties for a provisioning service ,
Required: True ,
}
{
state:
{
Description: Current state of the provisioning service. ,
Enum:
{
Activating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
ActivationFailed: No description available. ,
DeletionFailed: No description available. ,
Transitioning: No description available. ,
Suspending: No description available. ,
Suspended: No description available. ,
Resuming: No description available. ,
FailingOver: No description available. ,
FailoverFailed: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
ipFilterRules:
{
Description: The IP filter rules. ,
Required: False ,
}
[
{
filterName:
{
Description: The name of the IP filter rule. ,
Required: True ,
}
string ,
action:
{
Description: The desired action for requests captured by this rule. ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: True ,
}
enum ,
ipMask:
{
Description: A string that contains the IP address range in CIDR notation for the rule. ,
Required: True ,
}
string ,
target:
{
Description: Target for requests captured by this rule. ,
Enum:
{
all: No description available. ,
serviceApi: No description available. ,
deviceApi: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The ARM provisioning state of the provisioning service. ,
Required: False ,
}
string ,
iotHubs:
{
Description: List of IoT hubs associated with this provisioning service. ,
Required: False ,
}
[
{
applyAllocationPolicy:
{
Description: flag for applying allocationPolicy or not for a given iot hub. ,
Required: False ,
}
boolean ,
allocationWeight:
{
Description: weight to apply for a given iot h. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Host name of the IoT hub. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string of the IoT hub. ,
Required: False ,
}
string ,
location:
{
Description: ARM region of the IoT hub. ,
Required: True ,
}
string ,
authenticationType:
{
Description: IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned. ,
Enum:
{
KeyBased: No description available. ,
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
selectedUserAssignedIdentityResourceId:
{
Description: The selected user-assigned identity resource Id associated with IoT Hub. This is required when authenticationType is UserAssigned. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
allocationPolicy:
{
Description: Allocation policy to be used by this provisioning service. ,
Enum:
{
Hashed: No description available. ,
GeoLatency: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
serviceOperationsHostName:
{
Description: Service endpoint for provisioning service. ,
Required: False ,
}
string ,
deviceProvisioningHostName:
{
Description: Device endpoint for this provisioning service. ,
Required: False ,
}
string ,
idScope:
{
Description: Unique identifier of this provisioning service. ,
Required: False ,
}
string ,
authorizationPolicies:
{
Description: List of authorization keys for a provisioning service. ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the key. ,
Required: True ,
}
string ,
primaryKey:
{
Description: Primary SAS key value. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary SAS key value. ,
Required: False ,
}
string ,
rights:
{
Description: Rights that this key has. ,
Enum:
{
ServiceConfig: No description available. ,
EnrollmentRead: No description available. ,
EnrollmentWrite: No description available. ,
DeviceConnect: No description available. ,
RegistrationStatusRead: No description available. ,
RegistrationStatusWrite: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
enableDataResidency:
{
Description: Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery. ,
Required: False ,
}
boolean ,
portalOperationsHostName:
{
Description: Portal endpoint to enable CORS for this provisioning service. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Sku info for a provisioning Service. ,
Required: True ,
}
{
name:
{
Description: Sku name. ,
Enum:
{
S1: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Pricing tier name of the provisioning service. ,
Required: False ,
}
string ,
capacity:
{
Description: The number of units to provision ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotDpsResource_Get (updated)
Description :  Get the metadata of the provisioning service without SAS keys.
Reference :  Link ¶

⚶ Changes

{
  "#id": "IotDpsResource_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The version of the API."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription identifier."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Resource group name."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "@added_7e3f1c78ae324f6685cf388459b4ac35": {
            "#name": "resourcegroup",
            "Description": "The resource group of the resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_d1815abfdf68461c81609da39f824b0d": {
            "#name": "subscriptionid",
            "Description": "The subscription id of the resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "properties": [
            {
              "privateEndpointConnections": {
                "$properties": {
                  "@removed_78764ec383fd44efb37bfe5485a68b76": {
                    "#name": "id",
                    "Description": "The resource identifier.",
                    "Required": false,
                    "Type": "string"
                  },
                  "@removed_f4938616c2f04f669d5e37d2d8725d81": {
                    "#name": "name",
                    "Description": "The resource name.",
                    "Required": false,
                    "Type": "string"
                  },
                  "@removed_7010dcf9193d4b7faec48e5a941ed756": {
                    "#name": "type",
                    "Description": "The resource type.",
                    "Required": false,
                    "Type": "string"
                  },
                  "@removed_582a4ec24646487cac4082f6d2558c93": {
                    "#name": "systemData",
                    "Description": "Metadata pertaining to creation and last modification of the resource.",
                    "Required": false,
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "createdBy",
                        "Description": "The identity that created the resource.",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "createdByType",
                        "Description": "The type of identity that created the resource.",
                        "Enum": [
                          [
                            "User",
                            ""
                          ],
                          [
                            "Application",
                            ""
                          ],
                          [
                            "ManagedIdentity",
                            ""
                          ],
                          [
                            "Key",
                            ""
                          ]
                        ],
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "createdAt",
                        "Description": "The timestamp of resource creation (UTC).",
                        "Format": "date-time",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "lastModifiedBy",
                        "Description": "The identity that last modified the resource.",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "lastModifiedByType",
                        "Description": "The type of identity that last modified the resource.",
                        "Enum": [
                          [
                            "User",
                            ""
                          ],
                          [
                            "Application",
                            ""
                          ],
                          [
                            "ManagedIdentity",
                            ""
                          ],
                          [
                            "Key",
                            ""
                          ]
                        ],
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "lastModifiedAt",
                        "Description": "The timestamp of resource last modification (UTC)",
                        "Format": "date-time",
                        "Required": false,
                        "Type": "string"
                      }
                    ]
                  }
                }
              }
            }
          ]
        },
        {
          "#name": "identity",
          "Description": {
            "new": "The managed service identities assigned to this resource.",
            "old": "The managed identities for a provisioning service."
          }
        },
        {
          "@removed_6f226eab62094cdcb0cf420edc538c5d": {
            "#name": "systemData",
            "Description": "Metadata pertaining to creation and last modification of the resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The timestamp of resource creation (UTC).",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedAt",
                "Description": "The timestamp of resource last modification (UTC)",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              }
            ]
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: 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. ,
Required: False ,
}
string ,
resourcegroup:
{
Description: The resource group of the resource. ,
Required: False ,
}
string ,
subscriptionid:
{
Description: The subscription id of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Service specific properties for a provisioning service ,
Required: True ,
}
{
state:
{
Description: Current state of the provisioning service. ,
Enum:
{
Activating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
ActivationFailed: No description available. ,
DeletionFailed: No description available. ,
Transitioning: No description available. ,
Suspending: No description available. ,
Suspended: No description available. ,
Resuming: No description available. ,
FailingOver: No description available. ,
FailoverFailed: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
ipFilterRules:
{
Description: The IP filter rules. ,
Required: False ,
}
[
{
filterName:
{
Description: The name of the IP filter rule. ,
Required: True ,
}
string ,
action:
{
Description: The desired action for requests captured by this rule. ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: True ,
}
enum ,
ipMask:
{
Description: A string that contains the IP address range in CIDR notation for the rule. ,
Required: True ,
}
string ,
target:
{
Description: Target for requests captured by this rule. ,
Enum:
{
all: No description available. ,
serviceApi: No description available. ,
deviceApi: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The ARM provisioning state of the provisioning service. ,
Required: False ,
}
string ,
iotHubs:
{
Description: List of IoT hubs associated with this provisioning service. ,
Required: False ,
}
[
{
applyAllocationPolicy:
{
Description: flag for applying allocationPolicy or not for a given iot hub. ,
Required: False ,
}
boolean ,
allocationWeight:
{
Description: weight to apply for a given iot h. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Host name of the IoT hub. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string of the IoT hub. ,
Required: False ,
}
string ,
location:
{
Description: ARM region of the IoT hub. ,
Required: True ,
}
string ,
authenticationType:
{
Description: IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned. ,
Enum:
{
KeyBased: No description available. ,
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
selectedUserAssignedIdentityResourceId:
{
Description: The selected user-assigned identity resource Id associated with IoT Hub. This is required when authenticationType is UserAssigned. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
allocationPolicy:
{
Description: Allocation policy to be used by this provisioning service. ,
Enum:
{
Hashed: No description available. ,
GeoLatency: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
serviceOperationsHostName:
{
Description: Service endpoint for provisioning service. ,
Required: False ,
}
string ,
deviceProvisioningHostName:
{
Description: Device endpoint for this provisioning service. ,
Required: False ,
}
string ,
idScope:
{
Description: Unique identifier of this provisioning service. ,
Required: False ,
}
string ,
authorizationPolicies:
{
Description: List of authorization keys for a provisioning service. ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the key. ,
Required: True ,
}
string ,
primaryKey:
{
Description: Primary SAS key value. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary SAS key value. ,
Required: False ,
}
string ,
rights:
{
Description: Rights that this key has. ,
Enum:
{
ServiceConfig: No description available. ,
EnrollmentRead: No description available. ,
EnrollmentWrite: No description available. ,
DeviceConnect: No description available. ,
RegistrationStatusRead: No description available. ,
RegistrationStatusWrite: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
enableDataResidency:
{
Description: Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery. ,
Required: False ,
}
boolean ,
portalOperationsHostName:
{
Description: Portal endpoint to enable CORS for this provisioning service. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Sku info for a provisioning Service. ,
Required: True ,
}
{
name:
{
Description: Sku name. ,
Enum:
{
S1: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Pricing tier name of the provisioning service. ,
Required: False ,
}
string ,
capacity:
{
Description: The number of units to provision ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotDpsResource_CreateOrUpdate (updated)
Description :  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.
Reference :  Link ¶

⚶ Changes

{
  "#id": "IotDpsResource_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The version of the API."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription identifier."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Resource group identifier."
      }
    },
    {
      "#name": "provisioningServiceName",
      "Description": {
        "new": "Name of the provisioning service to retrieve.",
        "old": "Name of provisioning service to create or update."
      }
    },
    {
      "iotDpsDescription": {
        "$properties": [
          {
            "@added_310b96b2702d477fa9c38d8f088996c2": {
              "#name": "resourcegroup",
              "Description": "The resource group of the resource.",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@added_61a83e10557c4966bd9888f33ed7f4d7": {
              "#name": "subscriptionid",
              "Description": "The subscription id of the resource.",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "properties": [
              {
                "privateEndpointConnections": {
                  "$properties": {
                    "@removed_865706cfa7be4a63b9ac28320cec891b": {
                      "#name": "id",
                      "Description": "The resource identifier.",
                      "Required": false,
                      "Type": "string"
                    },
                    "@removed_b288c9b258e14f8082e78758de785a95": {
                      "#name": "name",
                      "Description": "The resource name.",
                      "Required": false,
                      "Type": "string"
                    },
                    "@removed_7cd0da727d604105930d585f00326c2d": {
                      "#name": "type",
                      "Description": "The resource type.",
                      "Required": false,
                      "Type": "string"
                    },
                    "@removed_76db1d0da5be42688b61e6684528d379": {
                      "#name": "systemData",
                      "Description": "Metadata pertaining to creation and last modification of the resource.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "createdBy",
                          "Description": "The identity that created the resource.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "createdByType",
                          "Description": "The type of identity that created the resource.",
                          "Enum": [
                            [
                              "User",
                              ""
                            ],
                            [
                              "Application",
                              ""
                            ],
                            [
                              "ManagedIdentity",
                              ""
                            ],
                            [
                              "Key",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "createdAt",
                          "Description": "The timestamp of resource creation (UTC).",
                          "Format": "date-time",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedBy",
                          "Description": "The identity that last modified the resource.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedByType",
                          "Description": "The type of identity that last modified the resource.",
                          "Enum": [
                            [
                              "User",
                              ""
                            ],
                            [
                              "Application",
                              ""
                            ],
                            [
                              "ManagedIdentity",
                              ""
                            ],
                            [
                              "Key",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedAt",
                          "Description": "The timestamp of resource last modification (UTC)",
                          "Format": "date-time",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  }
                }
              }
            ]
          },
          {
            "#name": "identity",
            "Description": {
              "new": "The managed service identities assigned to this resource.",
              "old": "The managed identities for a provisioning service."
            }
          },
          {
            "@removed_5fbbf74e759f4e82b9ab2a441abd06fc": {
              "#name": "systemData",
              "Description": "Metadata pertaining to creation and last modification of the resource.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "createdBy",
                  "Description": "The identity that created the resource.",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "createdByType",
                  "Description": "The type of identity that created the resource.",
                  "Enum": [
                    [
                      "User",
                      ""
                    ],
                    [
                      "Application",
                      ""
                    ],
                    [
                      "ManagedIdentity",
                      ""
                    ],
                    [
                      "Key",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "createdAt",
                  "Description": "The timestamp of resource creation (UTC).",
                  "Format": "date-time",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "lastModifiedBy",
                  "Description": "The identity that last modified the resource.",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "lastModifiedByType",
                  "Description": "The type of identity that last modified the resource.",
                  "Enum": [
                    [
                      "User",
                      ""
                    ],
                    [
                      "Application",
                      ""
                    ],
                    [
                      "ManagedIdentity",
                      ""
                    ],
                    [
                      "Key",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "lastModifiedAt",
                  "Description": "The timestamp of resource last modification (UTC)",
                  "Format": "date-time",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "@added_062cfcef5b2d488e9e1d4c78210c6e84": {
            "#name": "resourcegroup",
            "Description": "The resource group of the resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_104decd225f5475f9b30867e4e082dd3": {
            "#name": "subscriptionid",
            "Description": "The subscription id of the resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "properties": [
            {
              "privateEndpointConnections": {
                "$properties": {
                  "@removed_50b61dab775044e19edfe0189b02ae85": {
                    "#name": "id",
                    "Description": "The resource identifier.",
                    "Required": false,
                    "Type": "string"
                  },
                  "@removed_b2a52aa353d6467cb7dccdccfb04a040": {
                    "#name": "name",
                    "Description": "The resource name.",
                    "Required": false,
                    "Type": "string"
                  },
                  "@removed_38366eed727342f4801ef26a6dea0066": {
                    "#name": "type",
                    "Description": "The resource type.",
                    "Required": false,
                    "Type": "string"
                  },
                  "@removed_d74b4de7d5044a1d93f681b9b2fa5808": {
                    "#name": "systemData",
                    "Description": "Metadata pertaining to creation and last modification of the resource.",
                    "Required": false,
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "createdBy",
                        "Description": "The identity that created the resource.",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "createdByType",
                        "Description": "The type of identity that created the resource.",
                        "Enum": [
                          [
                            "User",
                            ""
                          ],
                          [
                            "Application",
                            ""
                          ],
                          [
                            "ManagedIdentity",
                            ""
                          ],
                          [
                            "Key",
                            ""
                          ]
                        ],
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "createdAt",
                        "Description": "The timestamp of resource creation (UTC).",
                        "Format": "date-time",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "lastModifiedBy",
                        "Description": "The identity that last modified the resource.",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "lastModifiedByType",
                        "Description": "The type of identity that last modified the resource.",
                        "Enum": [
                          [
                            "User",
                            ""
                          ],
                          [
                            "Application",
                            ""
                          ],
                          [
                            "ManagedIdentity",
                            ""
                          ],
                          [
                            "Key",
                            ""
                          ]
                        ],
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "lastModifiedAt",
                        "Description": "The timestamp of resource last modification (UTC)",
                        "Format": "date-time",
                        "Required": false,
                        "Type": "string"
                      }
                    ]
                  }
                }
              }
            }
          ]
        },
        {
          "#name": "identity",
          "Description": {
            "new": "The managed service identities assigned to this resource.",
            "old": "The managed identities for a provisioning service."
          }
        },
        {
          "@removed_732550853cc248fe899a0a07cb358fd7": {
            "#name": "systemData",
            "Description": "Metadata pertaining to creation and last modification of the resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The timestamp of resource creation (UTC).",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedAt",
                "Description": "The timestamp of resource last modification (UTC)",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              }
            ]
          }
        }
      ]
    },
    "201": {
      "$properties": [
        {
          "@added_a3dfe65be09b4423bb8a719ade449b4c": {
            "#name": "resourcegroup",
            "Description": "The resource group of the resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_834efb105e5549c4a702d34c4561cf9e": {
            "#name": "subscriptionid",
            "Description": "The subscription id of the resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "properties": [
            {
              "privateEndpointConnections": {
                "$properties": {
                  "@removed_8cec14cca2df47a98bf97446b17dd039": {
                    "#name": "id",
                    "Description": "The resource identifier.",
                    "Required": false,
                    "Type": "string"
                  },
                  "@removed_4ee7c91ca893461b944be43ed26253b7": {
                    "#name": "name",
                    "Description": "The resource name.",
                    "Required": false,
                    "Type": "string"
                  },
                  "@removed_f757c1d8df4d45968e75afa407f51a46": {
                    "#name": "type",
                    "Description": "The resource type.",
                    "Required": false,
                    "Type": "string"
                  },
                  "@removed_ce3c5ff6d6f74d9e8ad72ee96bbae5d3": {
                    "#name": "systemData",
                    "Description": "Metadata pertaining to creation and last modification of the resource.",
                    "Required": false,
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "createdBy",
                        "Description": "The identity that created the resource.",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "createdByType",
                        "Description": "The type of identity that created the resource.",
                        "Enum": [
                          [
                            "User",
                            ""
                          ],
                          [
                            "Application",
                            ""
                          ],
                          [
                            "ManagedIdentity",
                            ""
                          ],
                          [
                            "Key",
                            ""
                          ]
                        ],
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "createdAt",
                        "Description": "The timestamp of resource creation (UTC).",
                        "Format": "date-time",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "lastModifiedBy",
                        "Description": "The identity that last modified the resource.",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "lastModifiedByType",
                        "Description": "The type of identity that last modified the resource.",
                        "Enum": [
                          [
                            "User",
                            ""
                          ],
                          [
                            "Application",
                            ""
                          ],
                          [
                            "ManagedIdentity",
                            ""
                          ],
                          [
                            "Key",
                            ""
                          ]
                        ],
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "lastModifiedAt",
                        "Description": "The timestamp of resource last modification (UTC)",
                        "Format": "date-time",
                        "Required": false,
                        "Type": "string"
                      }
                    ]
                  }
                }
              }
            }
          ]
        },
        {
          "#name": "identity",
          "Description": {
            "new": "The managed service identities assigned to this resource.",
            "old": "The managed identities for a provisioning service."
          }
        },
        {
          "@removed_ad4faff80b5947a7ba86ad6a7b2486f5": {
            "#name": "systemData",
            "Description": "Metadata pertaining to creation and last modification of the resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The timestamp of resource creation (UTC).",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedAt",
                "Description": "The timestamp of resource last modification (UTC)",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              }
            ]
          }
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
iotDpsDescription:
{
Description: Description of the provisioning service to create or update. ,
Required: True ,
}
{
etag:
{
Description: 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. ,
Required: False ,
}
string ,
resourcegroup:
{
Description: The resource group of the resource. ,
Required: False ,
}
string ,
subscriptionid:
{
Description: The subscription id of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Service specific properties for a provisioning service ,
Required: True ,
}
{
state:
{
Description: Current state of the provisioning service. ,
Enum:
{
Activating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
ActivationFailed: No description available. ,
DeletionFailed: No description available. ,
Transitioning: No description available. ,
Suspending: No description available. ,
Suspended: No description available. ,
Resuming: No description available. ,
FailingOver: No description available. ,
FailoverFailed: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
ipFilterRules:
{
Description: The IP filter rules. ,
Required: False ,
}
[
{
filterName:
{
Description: The name of the IP filter rule. ,
Required: True ,
}
string ,
action:
{
Description: The desired action for requests captured by this rule. ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: True ,
}
enum ,
ipMask:
{
Description: A string that contains the IP address range in CIDR notation for the rule. ,
Required: True ,
}
string ,
target:
{
Description: Target for requests captured by this rule. ,
Enum:
{
all: No description available. ,
serviceApi: No description available. ,
deviceApi: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The ARM provisioning state of the provisioning service. ,
Required: False ,
}
string ,
iotHubs:
{
Description: List of IoT hubs associated with this provisioning service. ,
Required: False ,
}
[
{
applyAllocationPolicy:
{
Description: flag for applying allocationPolicy or not for a given iot hub. ,
Required: False ,
}
boolean ,
allocationWeight:
{
Description: weight to apply for a given iot h. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Host name of the IoT hub. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string of the IoT hub. ,
Required: False ,
}
string ,
location:
{
Description: ARM region of the IoT hub. ,
Required: True ,
}
string ,
authenticationType:
{
Description: IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned. ,
Enum:
{
KeyBased: No description available. ,
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
selectedUserAssignedIdentityResourceId:
{
Description: The selected user-assigned identity resource Id associated with IoT Hub. This is required when authenticationType is UserAssigned. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
allocationPolicy:
{
Description: Allocation policy to be used by this provisioning service. ,
Enum:
{
Hashed: No description available. ,
GeoLatency: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
serviceOperationsHostName:
{
Description: Service endpoint for provisioning service. ,
Required: False ,
}
string ,
deviceProvisioningHostName:
{
Description: Device endpoint for this provisioning service. ,
Required: False ,
}
string ,
idScope:
{
Description: Unique identifier of this provisioning service. ,
Required: False ,
}
string ,
authorizationPolicies:
{
Description: List of authorization keys for a provisioning service. ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the key. ,
Required: True ,
}
string ,
primaryKey:
{
Description: Primary SAS key value. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary SAS key value. ,
Required: False ,
}
string ,
rights:
{
Description: Rights that this key has. ,
Enum:
{
ServiceConfig: No description available. ,
EnrollmentRead: No description available. ,
EnrollmentWrite: No description available. ,
DeviceConnect: No description available. ,
RegistrationStatusRead: No description available. ,
RegistrationStatusWrite: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
enableDataResidency:
{
Description: Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery. ,
Required: False ,
}
boolean ,
portalOperationsHostName:
{
Description: Portal endpoint to enable CORS for this provisioning service. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Sku info for a provisioning Service. ,
Required: True ,
}
{
name:
{
Description: Sku name. ,
Enum:
{
S1: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Pricing tier name of the provisioning service. ,
Required: False ,
}
string ,
capacity:
{
Description: The number of units to provision ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
etag:
{
Description: 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. ,
Required: False ,
}
string ,
resourcegroup:
{
Description: The resource group of the resource. ,
Required: False ,
}
string ,
subscriptionid:
{
Description: The subscription id of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Service specific properties for a provisioning service ,
Required: True ,
}
{
state:
{
Description: Current state of the provisioning service. ,
Enum:
{
Activating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
ActivationFailed: No description available. ,
DeletionFailed: No description available. ,
Transitioning: No description available. ,
Suspending: No description available. ,
Suspended: No description available. ,
Resuming: No description available. ,
FailingOver: No description available. ,
FailoverFailed: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
ipFilterRules:
{
Description: The IP filter rules. ,
Required: False ,
}
[
{
filterName:
{
Description: The name of the IP filter rule. ,
Required: True ,
}
string ,
action:
{
Description: The desired action for requests captured by this rule. ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: True ,
}
enum ,
ipMask:
{
Description: A string that contains the IP address range in CIDR notation for the rule. ,
Required: True ,
}
string ,
target:
{
Description: Target for requests captured by this rule. ,
Enum:
{
all: No description available. ,
serviceApi: No description available. ,
deviceApi: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The ARM provisioning state of the provisioning service. ,
Required: False ,
}
string ,
iotHubs:
{
Description: List of IoT hubs associated with this provisioning service. ,
Required: False ,
}
[
{
applyAllocationPolicy:
{
Description: flag for applying allocationPolicy or not for a given iot hub. ,
Required: False ,
}
boolean ,
allocationWeight:
{
Description: weight to apply for a given iot h. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Host name of the IoT hub. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string of the IoT hub. ,
Required: False ,
}
string ,
location:
{
Description: ARM region of the IoT hub. ,
Required: True ,
}
string ,
authenticationType:
{
Description: IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned. ,
Enum:
{
KeyBased: No description available. ,
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
selectedUserAssignedIdentityResourceId:
{
Description: The selected user-assigned identity resource Id associated with IoT Hub. This is required when authenticationType is UserAssigned. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
allocationPolicy:
{
Description: Allocation policy to be used by this provisioning service. ,
Enum:
{
Hashed: No description available. ,
GeoLatency: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
serviceOperationsHostName:
{
Description: Service endpoint for provisioning service. ,
Required: False ,
}
string ,
deviceProvisioningHostName:
{
Description: Device endpoint for this provisioning service. ,
Required: False ,
}
string ,
idScope:
{
Description: Unique identifier of this provisioning service. ,
Required: False ,
}
string ,
authorizationPolicies:
{
Description: List of authorization keys for a provisioning service. ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the key. ,
Required: True ,
}
string ,
primaryKey:
{
Description: Primary SAS key value. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary SAS key value. ,
Required: False ,
}
string ,
rights:
{
Description: Rights that this key has. ,
Enum:
{
ServiceConfig: No description available. ,
EnrollmentRead: No description available. ,
EnrollmentWrite: No description available. ,
DeviceConnect: No description available. ,
RegistrationStatusRead: No description available. ,
RegistrationStatusWrite: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
enableDataResidency:
{
Description: Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery. ,
Required: False ,
}
boolean ,
portalOperationsHostName:
{
Description: Portal endpoint to enable CORS for this provisioning service. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Sku info for a provisioning Service. ,
Required: True ,
}
{
name:
{
Description: Sku name. ,
Enum:
{
S1: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Pricing tier name of the provisioning service. ,
Required: False ,
}
string ,
capacity:
{
Description: The number of units to provision ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The description of the provisioning service. ,
}
{
etag:
{
Description: 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. ,
Required: False ,
}
string ,
resourcegroup:
{
Description: The resource group of the resource. ,
Required: False ,
}
string ,
subscriptionid:
{
Description: The subscription id of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Service specific properties for a provisioning service ,
Required: True ,
}
{
state:
{
Description: Current state of the provisioning service. ,
Enum:
{
Activating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
ActivationFailed: No description available. ,
DeletionFailed: No description available. ,
Transitioning: No description available. ,
Suspending: No description available. ,
Suspended: No description available. ,
Resuming: No description available. ,
FailingOver: No description available. ,
FailoverFailed: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
ipFilterRules:
{
Description: The IP filter rules. ,
Required: False ,
}
[
{
filterName:
{
Description: The name of the IP filter rule. ,
Required: True ,
}
string ,
action:
{
Description: The desired action for requests captured by this rule. ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: True ,
}
enum ,
ipMask:
{
Description: A string that contains the IP address range in CIDR notation for the rule. ,
Required: True ,
}
string ,
target:
{
Description: Target for requests captured by this rule. ,
Enum:
{
all: No description available. ,
serviceApi: No description available. ,
deviceApi: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The ARM provisioning state of the provisioning service. ,
Required: False ,
}
string ,
iotHubs:
{
Description: List of IoT hubs associated with this provisioning service. ,
Required: False ,
}
[
{
applyAllocationPolicy:
{
Description: flag for applying allocationPolicy or not for a given iot hub. ,
Required: False ,
}
boolean ,
allocationWeight:
{
Description: weight to apply for a given iot h. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Host name of the IoT hub. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string of the IoT hub. ,
Required: False ,
}
string ,
location:
{
Description: ARM region of the IoT hub. ,
Required: True ,
}
string ,
authenticationType:
{
Description: IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned. ,
Enum:
{
KeyBased: No description available. ,
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
selectedUserAssignedIdentityResourceId:
{
Description: The selected user-assigned identity resource Id associated with IoT Hub. This is required when authenticationType is UserAssigned. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
allocationPolicy:
{
Description: Allocation policy to be used by this provisioning service. ,
Enum:
{
Hashed: No description available. ,
GeoLatency: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
serviceOperationsHostName:
{
Description: Service endpoint for provisioning service. ,
Required: False ,
}
string ,
deviceProvisioningHostName:
{
Description: Device endpoint for this provisioning service. ,
Required: False ,
}
string ,
idScope:
{
Description: Unique identifier of this provisioning service. ,
Required: False ,
}
string ,
authorizationPolicies:
{
Description: List of authorization keys for a provisioning service. ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the key. ,
Required: True ,
}
string ,
primaryKey:
{
Description: Primary SAS key value. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary SAS key value. ,
Required: False ,
}
string ,
rights:
{
Description: Rights that this key has. ,
Enum:
{
ServiceConfig: No description available. ,
EnrollmentRead: No description available. ,
EnrollmentWrite: No description available. ,
DeviceConnect: No description available. ,
RegistrationStatusRead: No description available. ,
RegistrationStatusWrite: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
enableDataResidency:
{
Description: Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery. ,
Required: False ,
}
boolean ,
portalOperationsHostName:
{
Description: Portal endpoint to enable CORS for this provisioning service. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Sku info for a provisioning Service. ,
Required: True ,
}
{
name:
{
Description: Sku name. ,
Enum:
{
S1: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Pricing tier name of the provisioning service. ,
Required: False ,
}
string ,
capacity:
{
Description: The number of units to provision ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotDpsResource_Update (updated)
Description :  Update an existing provisioning service's tags. to update other fields use the CreateOrUpdate method
Reference :  Link ¶

⚶ Changes

{
  "#id": "IotDpsResource_Update",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The version of the API."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription identifier."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Resource group identifier."
      }
    },
    {
      "#name": "provisioningServiceName",
      "Description": {
        "new": "Name of the provisioning service to retrieve.",
        "old": "Name of provisioning service to create or update."
      }
    },
    {
      "ProvisioningServiceTags": {
        "$properties": [
          {
            "#name": "tags",
            "Type": {
              "new": "object",
              "old": "string"
            }
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "@added_0d1e768685ab441e863e6f6f652541f9": {
            "#name": "resourcegroup",
            "Description": "The resource group of the resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_1b0ca39802c0498597b7b27b71b921fa": {
            "#name": "subscriptionid",
            "Description": "The subscription id of the resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "properties": [
            {
              "privateEndpointConnections": {
                "$properties": {
                  "@removed_c6df0d4a02254a17865a11d577f9a5ce": {
                    "#name": "id",
                    "Description": "The resource identifier.",
                    "Required": false,
                    "Type": "string"
                  },
                  "@removed_d86a65dabefb4d52ad6749b464fdc9ac": {
                    "#name": "name",
                    "Description": "The resource name.",
                    "Required": false,
                    "Type": "string"
                  },
                  "@removed_fc18f94437834d2b8b982303a8667e06": {
                    "#name": "type",
                    "Description": "The resource type.",
                    "Required": false,
                    "Type": "string"
                  },
                  "@removed_ea42988717c045f8b4905b8918f10ce1": {
                    "#name": "systemData",
                    "Description": "Metadata pertaining to creation and last modification of the resource.",
                    "Required": false,
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "createdBy",
                        "Description": "The identity that created the resource.",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "createdByType",
                        "Description": "The type of identity that created the resource.",
                        "Enum": [
                          [
                            "User",
                            ""
                          ],
                          [
                            "Application",
                            ""
                          ],
                          [
                            "ManagedIdentity",
                            ""
                          ],
                          [
                            "Key",
                            ""
                          ]
                        ],
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "createdAt",
                        "Description": "The timestamp of resource creation (UTC).",
                        "Format": "date-time",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "lastModifiedBy",
                        "Description": "The identity that last modified the resource.",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "lastModifiedByType",
                        "Description": "The type of identity that last modified the resource.",
                        "Enum": [
                          [
                            "User",
                            ""
                          ],
                          [
                            "Application",
                            ""
                          ],
                          [
                            "ManagedIdentity",
                            ""
                          ],
                          [
                            "Key",
                            ""
                          ]
                        ],
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "lastModifiedAt",
                        "Description": "The timestamp of resource last modification (UTC)",
                        "Format": "date-time",
                        "Required": false,
                        "Type": "string"
                      }
                    ]
                  }
                }
              }
            }
          ]
        },
        {
          "#name": "identity",
          "Description": {
            "new": "The managed service identities assigned to this resource.",
            "old": "The managed identities for a provisioning service."
          }
        },
        {
          "@removed_194eb4a619db494486666d5f962443f4": {
            "#name": "systemData",
            "Description": "Metadata pertaining to creation and last modification of the resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The timestamp of resource creation (UTC).",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedAt",
                "Description": "The timestamp of resource last modification (UTC)",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              }
            ]
          }
        }
      ]
    },
    "@added_7dc7fa35d1cf469480d43811886eea2f": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
ProvisioningServiceTags:
{
Description: Updated tag information to set into the provisioning service instance. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}
,
$schema:
{
Description: The description of the provisioning service. ,
}
{
etag:
{
Description: 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. ,
Required: False ,
}
string ,
resourcegroup:
{
Description: The resource group of the resource. ,
Required: False ,
}
string ,
subscriptionid:
{
Description: The subscription id of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Service specific properties for a provisioning service ,
Required: True ,
}
{
state:
{
Description: Current state of the provisioning service. ,
Enum:
{
Activating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
ActivationFailed: No description available. ,
DeletionFailed: No description available. ,
Transitioning: No description available. ,
Suspending: No description available. ,
Suspended: No description available. ,
Resuming: No description available. ,
FailingOver: No description available. ,
FailoverFailed: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
ipFilterRules:
{
Description: The IP filter rules. ,
Required: False ,
}
[
{
filterName:
{
Description: The name of the IP filter rule. ,
Required: True ,
}
string ,
action:
{
Description: The desired action for requests captured by this rule. ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: True ,
}
enum ,
ipMask:
{
Description: A string that contains the IP address range in CIDR notation for the rule. ,
Required: True ,
}
string ,
target:
{
Description: Target for requests captured by this rule. ,
Enum:
{
all: No description available. ,
serviceApi: No description available. ,
deviceApi: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The ARM provisioning state of the provisioning service. ,
Required: False ,
}
string ,
iotHubs:
{
Description: List of IoT hubs associated with this provisioning service. ,
Required: False ,
}
[
{
applyAllocationPolicy:
{
Description: flag for applying allocationPolicy or not for a given iot hub. ,
Required: False ,
}
boolean ,
allocationWeight:
{
Description: weight to apply for a given iot h. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Host name of the IoT hub. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string of the IoT hub. ,
Required: False ,
}
string ,
location:
{
Description: ARM region of the IoT hub. ,
Required: True ,
}
string ,
authenticationType:
{
Description: IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned. ,
Enum:
{
KeyBased: No description available. ,
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
selectedUserAssignedIdentityResourceId:
{
Description: The selected user-assigned identity resource Id associated with IoT Hub. This is required when authenticationType is UserAssigned. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
allocationPolicy:
{
Description: Allocation policy to be used by this provisioning service. ,
Enum:
{
Hashed: No description available. ,
GeoLatency: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
serviceOperationsHostName:
{
Description: Service endpoint for provisioning service. ,
Required: False ,
}
string ,
deviceProvisioningHostName:
{
Description: Device endpoint for this provisioning service. ,
Required: False ,
}
string ,
idScope:
{
Description: Unique identifier of this provisioning service. ,
Required: False ,
}
string ,
authorizationPolicies:
{
Description: List of authorization keys for a provisioning service. ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the key. ,
Required: True ,
}
string ,
primaryKey:
{
Description: Primary SAS key value. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary SAS key value. ,
Required: False ,
}
string ,
rights:
{
Description: Rights that this key has. ,
Enum:
{
ServiceConfig: No description available. ,
EnrollmentRead: No description available. ,
EnrollmentWrite: No description available. ,
DeviceConnect: No description available. ,
RegistrationStatusRead: No description available. ,
RegistrationStatusWrite: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
enableDataResidency:
{
Description: Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery. ,
Required: False ,
}
boolean ,
portalOperationsHostName:
{
Description: Portal endpoint to enable CORS for this provisioning service. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Sku info for a provisioning Service. ,
Required: True ,
}
{
name:
{
Description: Sku name. ,
Enum:
{
S1: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Pricing tier name of the provisioning service. ,
Required: False ,
}
string ,
capacity:
{
Description: The number of units to provision ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IotDpsResource_Delete (updated)
Description :  Deletes the Provisioning Service.
Reference :  Link ¶

⚶ Changes

{
  "#id": "IotDpsResource_Delete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The version of the API."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription identifier."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Resource group identifier."
      }
    },
    {
      "#name": "provisioningServiceName",
      "Description": {
        "new": "Name of the provisioning service to retrieve.",
        "old": "Name of provisioning service to delete."
      }
    }
  ]
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
DpsCertificate_List (updated)
Description :  Get all the certificates tied to the provisioning service.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DpsCertificate_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The version of the API."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription identifier."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Name of resource group."
      }
    },
    {
      "#name": "provisioningServiceName",
      "Description": {
        "new": "Name of the provisioning service to retrieve.",
        "old": "Name of provisioning service to retrieve certificates for."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "expiry",
                "Format": {
                  "new": "date-time-rfc7231",
                  "old": "date-time-rfc1123"
                }
              },
              {
                "#name": "created",
                "Format": {
                  "new": "date-time-rfc7231",
                  "old": "date-time-rfc1123"
                }
              },
              {
                "#name": "updated",
                "Format": {
                  "new": "date-time-rfc7231",
                  "old": "date-time-rfc1123"
                }
              }
            ],
            "@removed_5c484b6092bc45aeab412dff1f9c48dd": {
              "#name": "id",
              "Description": "The resource identifier.",
              "Required": false,
              "Type": "string"
            },
            "@removed_03db0c0b10b84b22b1c5b0fc79dc029e": {
              "#name": "name",
              "Description": "The name of the certificate.",
              "Required": false,
              "Type": "string"
            },
            "@removed_8f56e53cc54e423f95517e2e1ce68b77": {
              "#name": "type",
              "Description": "The resource type.",
              "Required": false,
              "Type": "string"
            },
            "@removed_c5baae4aeb8d48ca991d1706f1c5e1b1": {
              "#name": "systemData",
              "Description": "Metadata pertaining to creation and last modification of the resource.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "createdBy",
                  "Description": "The identity that created the resource.",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "createdByType",
                  "Description": "The type of identity that created the resource.",
                  "Enum": [
                    [
                      "User",
                      ""
                    ],
                    [
                      "Application",
                      ""
                    ],
                    [
                      "ManagedIdentity",
                      ""
                    ],
                    [
                      "Key",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "createdAt",
                  "Description": "The timestamp of resource creation (UTC).",
                  "Format": "date-time",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "lastModifiedBy",
                  "Description": "The identity that last modified the resource.",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "lastModifiedByType",
                  "Description": "The type of identity that last modified the resource.",
                  "Enum": [
                    [
                      "User",
                      ""
                    ],
                    [
                      "Application",
                      ""
                    ],
                    [
                      "ManagedIdentity",
                      ""
                    ],
                    [
                      "Key",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "lastModifiedAt",
                  "Description": "The timestamp of resource last modification (UTC)",
                  "Format": "date-time",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of Certificate objects. ,
Required: False ,
}
[
{
properties:
{
Description: properties of a certificate ,
Required: False ,
}
{
subject:
{
Description: The certificate's subject name. ,
Required: False ,
}
string ,
expiry:
{
Description: The certificate's expiration date and time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate's thumbprint. ,
Required: False ,
}
string ,
isVerified:
{
Description: Determines whether certificate has been verified. ,
Required: False ,
}
boolean ,
certificate:
{
Description: base-64 representation of X509 certificate .cer file or just .pem file content. ,
Format: byte ,
Required: False ,
}
string ,
created:
{
Description: The certificate's creation date and time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
}
,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
DpsCertificate_Get (updated)
Description :  Get the certificate from the provisioning service.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DpsCertificate_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The version of the API."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription identifier."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Resource group identifier."
      }
    },
    {
      "#name": "provisioningServiceName",
      "Description": {
        "new": "Name of the provisioning service to retrieve.",
        "old": "Name of the provisioning service the certificate is associated with."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "expiry",
            "Format": {
              "new": "date-time-rfc7231",
              "old": "date-time-rfc1123"
            }
          },
          {
            "#name": "created",
            "Format": {
              "new": "date-time-rfc7231",
              "old": "date-time-rfc1123"
            }
          },
          {
            "#name": "updated",
            "Format": {
              "new": "date-time-rfc7231",
              "old": "date-time-rfc1123"
            }
          }
        ],
        "@removed_b166762117a848979058e7cfc9755f27": {
          "#name": "id",
          "Description": "The resource identifier.",
          "Required": false,
          "Type": "string"
        },
        "@removed_944042f39b16437b8d5d4c1b7ad5f6ab": {
          "#name": "name",
          "Description": "The name of the certificate.",
          "Required": false,
          "Type": "string"
        },
        "@removed_e7591a0d8ffc4cf7ac10d86e592108a8": {
          "#name": "type",
          "Description": "The resource type.",
          "Required": false,
          "Type": "string"
        },
        "@removed_07d1b8e1ab354e0fbefaa87ff7b6eb2e": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
certificateName:
{
Description: Name of the certificate to retrieve. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the certificate. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: properties of a certificate ,
Required: False ,
}
{
subject:
{
Description: The certificate's subject name. ,
Required: False ,
}
string ,
expiry:
{
Description: The certificate's expiration date and time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate's thumbprint. ,
Required: False ,
}
string ,
isVerified:
{
Description: Determines whether certificate has been verified. ,
Required: False ,
}
boolean ,
certificate:
{
Description: base-64 representation of X509 certificate .cer file or just .pem file content. ,
Format: byte ,
Required: False ,
}
string ,
created:
{
Description: The certificate's creation date and time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
}
,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
DpsCertificate_CreateOrUpdate (updated)
Description :  Add new certificate or update an existing certificate.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DpsCertificate_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The version of the API."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription identifier."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Resource group identifier."
      }
    },
    {
      "#name": "provisioningServiceName",
      "Description": {
        "new": "Name of the provisioning service to retrieve.",
        "old": "The name of the provisioning service."
      }
    },
    {
      "#name": "certificateName",
      "Description": {
        "new": "Name of the certificate to retrieve.",
        "old": "The name of the certificate create or update."
      }
    },
    {
      "certificateDescription": {
        "$properties": {
          "properties": [
            {
              "#name": "expiry",
              "Format": {
                "new": "date-time-rfc7231",
                "old": "date-time-rfc1123"
              }
            },
            {
              "#name": "created",
              "Format": {
                "new": "date-time-rfc7231",
                "old": "date-time-rfc1123"
              }
            },
            {
              "#name": "updated",
              "Format": {
                "new": "date-time-rfc7231",
                "old": "date-time-rfc1123"
              }
            }
          ],
          "@removed_f9304c383cbc468eabd517b22201209e": {
            "#name": "id",
            "Description": "The resource identifier.",
            "Required": false,
            "Type": "string"
          },
          "@removed_6c640e7933df497b81c34020c570cddd": {
            "#name": "name",
            "Description": "The name of the certificate.",
            "Required": false,
            "Type": "string"
          },
          "@removed_f03b01b790564fbd854a0d0c7e7b4b8a": {
            "#name": "type",
            "Description": "The resource type.",
            "Required": false,
            "Type": "string"
          },
          "@removed_c8bbbc32ce484928895f6967e7c5d9fc": {
            "#name": "systemData",
            "Description": "Metadata pertaining to creation and last modification of the resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The timestamp of resource creation (UTC).",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedAt",
                "Description": "The timestamp of resource last modification (UTC)",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              }
            ]
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "expiry",
            "Format": {
              "new": "date-time-rfc7231",
              "old": "date-time-rfc1123"
            }
          },
          {
            "#name": "created",
            "Format": {
              "new": "date-time-rfc7231",
              "old": "date-time-rfc1123"
            }
          },
          {
            "#name": "updated",
            "Format": {
              "new": "date-time-rfc7231",
              "old": "date-time-rfc1123"
            }
          }
        ],
        "@removed_11187ee92c434984b53e492838757112": {
          "#name": "id",
          "Description": "The resource identifier.",
          "Required": false,
          "Type": "string"
        },
        "@removed_0575aeb9b1d349dcaec1134723b650c8": {
          "#name": "name",
          "Description": "The name of the certificate.",
          "Required": false,
          "Type": "string"
        },
        "@removed_de55f59d39fa413a8cccfb1311c6b8a8": {
          "#name": "type",
          "Description": "The resource type.",
          "Required": false,
          "Type": "string"
        },
        "@removed_2ef9b3a1866f4647be3f469bb8615fd6": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
certificateName:
{
Description: Name of the certificate to retrieve. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate. ,
Required: False ,
}
string ,
certificateDescription:
{
Description: The certificate body. ,
Required: True ,
}
{
properties:
{
Description: properties of a certificate ,
Required: False ,
}
{
subject:
{
Description: The certificate's subject name. ,
Required: False ,
}
string ,
expiry:
{
Description: The certificate's expiration date and time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate's thumbprint. ,
Required: False ,
}
string ,
isVerified:
{
Description: Determines whether certificate has been verified. ,
Required: False ,
}
boolean ,
certificate:
{
Description: base-64 representation of X509 certificate .cer file or just .pem file content. ,
Format: byte ,
Required: False ,
}
string ,
created:
{
Description: The certificate's creation date and time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
}
,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: properties of a certificate ,
Required: False ,
}
{
subject:
{
Description: The certificate's subject name. ,
Required: False ,
}
string ,
expiry:
{
Description: The certificate's expiration date and time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate's thumbprint. ,
Required: False ,
}
string ,
isVerified:
{
Description: Determines whether certificate has been verified. ,
Required: False ,
}
boolean ,
certificate:
{
Description: base-64 representation of X509 certificate .cer file or just .pem file content. ,
Format: byte ,
Required: False ,
}
string ,
created:
{
Description: The certificate's creation date and time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
}
,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
DpsCertificate_Delete (updated)
Description :  Deletes the specified certificate associated with the Provisioning Service
Reference :  Link ¶

⚶ Changes

{
  "#id": "DpsCertificate_Delete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The version of the API."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription identifier."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Resource group identifier."
      }
    },
    {
      "#name": "provisioningServiceName",
      "Description": {
        "new": "Name of the provisioning service to retrieve.",
        "old": "The name of the provisioning service."
      }
    },
    {
      "#name": "certificateName",
      "Description": {
        "new": "Name of the certificate to retrieve.",
        "old": "This is a mandatory field, and is the logical name of the certificate that the provisioning service will access by."
      }
    }
  ]
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
certificateName:
{
Description: Name of the certificate to retrieve. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the certificate ,
Required: True ,
}
string ,
certificate.name:
{
Description: This is optional, and it is the Common Name of the certificate. ,
Required: False ,
}
string ,
certificate.rawBytes:
{
Description: Raw data within the certificate. ,
Format: byte ,
Required: False ,
}
string ,
certificate.isVerified:
{
Description: Indicates if certificate has been verified by owner of the private key. ,
Required: False ,
}
boolean ,
certificate.purpose:
{
Description: A description that mentions the purpose of the certificate. ,
Required: False ,
}
string ,
certificate.created:
{
Description: Time the certificate is created. ,
Format: date-time ,
Required: False ,
}
string ,
certificate.lastUpdated:
{
Description: Time the certificate is last updated. ,
Format: date-time ,
Required: False ,
}
string ,
certificate.hasPrivateKey:
{
Description: Indicates if the certificate contains a private key. ,
Required: False ,
}
boolean ,
certificate.nonce:
{
Description: Random number generated to indicate Proof of Possession. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
DpsCertificate_GenerateVerificationCode (updated)
Description :  Generate verification code for Proof of Possession.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DpsCertificate_GenerateVerificationCode",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The version of the API."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription identifier."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "name of resource group."
      }
    },
    {
      "#name": "provisioningServiceName",
      "Description": {
        "new": "Name of the provisioning service to retrieve.",
        "old": "Name of provisioning service."
      }
    },
    {
      "#name": "certificateName",
      "Description": {
        "new": "Name of the certificate to retrieve.",
        "old": "The mandatory logical name of the certificate, that the provisioning service uses to access."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/generateVerificationCode
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
certificateName:
{
Description: Name of the certificate to retrieve. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate. ,
Required: True ,
}
string ,
certificate.name:
{
Description: Common Name for the certificate. ,
Required: False ,
}
string ,
certificate.rawBytes:
{
Description: Raw data of certificate. ,
Format: byte ,
Required: False ,
}
string ,
certificate.isVerified:
{
Description: Indicates if the certificate has been verified by owner of the private key. ,
Required: False ,
}
boolean ,
certificate.purpose:
{
Description: Description mentioning the purpose of the certificate. ,
Required: False ,
}
string ,
certificate.created:
{
Description: Certificate creation time. ,
Format: date-time ,
Required: False ,
}
string ,
certificate.lastUpdated:
{
Description: Certificate last updated time. ,
Format: date-time ,
Required: False ,
}
string ,
certificate.hasPrivateKey:
{
Description: Indicates if the certificate contains private key. ,
Required: False ,
}
boolean ,
certificate.nonce:
{
Description: Random number generated to indicate Proof of Possession. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of certificate. ,
Required: False ,
}
string ,
etag:
{
Description: Request etag. ,
Required: False ,
}
string ,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
verificationCode:
{
Description: Verification code. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate subject. ,
Required: False ,
}
string ,
expiry:
{
Description: Code expiry. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
isVerified:
{
Description: Indicate if the certificate is verified by owner of private key. ,
Required: False ,
}
boolean ,
certificate:
{
Description: base-64 representation of X509 certificate .cer file or just .pem file content. ,
Format: byte ,
Required: False ,
}
string ,
created:
{
Description: Certificate created time. ,
Required: False ,
}
string ,
updated:
{
Description: Certificate updated time. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
DpsCertificate_VerifyCertificate (updated)
Description :  Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DpsCertificate_VerifyCertificate",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The version of the API."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription identifier."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Resource group name."
      }
    },
    {
      "#name": "provisioningServiceName",
      "Description": {
        "new": "Name of the provisioning service to retrieve.",
        "old": "Provisioning service name."
      }
    },
    {
      "#name": "certificateName",
      "Description": {
        "new": "Name of the certificate to retrieve.",
        "old": "The mandatory logical name of the certificate, that the provisioning service uses to access."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "expiry",
            "Format": {
              "new": "date-time-rfc7231",
              "old": "date-time-rfc1123"
            }
          },
          {
            "#name": "created",
            "Format": {
              "new": "date-time-rfc7231",
              "old": "date-time-rfc1123"
            }
          },
          {
            "#name": "updated",
            "Format": {
              "new": "date-time-rfc7231",
              "old": "date-time-rfc1123"
            }
          }
        ],
        "@removed_1683880b1291451786fbcc760f62fd7c": {
          "#name": "id",
          "Description": "The resource identifier.",
          "Required": false,
          "Type": "string"
        },
        "@removed_88d1e0a5ba0f40ff8c0a4dd71a18c58d": {
          "#name": "name",
          "Description": "The name of the certificate.",
          "Required": false,
          "Type": "string"
        },
        "@removed_5ff0d9ad75714852a6ad84b1e9fb0336": {
          "#name": "type",
          "Description": "The resource type.",
          "Required": false,
          "Type": "string"
        },
        "@removed_590bdcec2b9c4cf49dfd71c1043d4470": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/verify
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
certificateName:
{
Description: Name of the certificate to retrieve. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the certificate. ,
Required: True ,
}
string ,
certificate.name:
{
Description: Common Name for the certificate. ,
Required: False ,
}
string ,
certificate.rawBytes:
{
Description: Raw data of certificate. ,
Format: byte ,
Required: False ,
}
string ,
certificate.isVerified:
{
Description: Indicates if the certificate has been verified by owner of the private key. ,
Required: False ,
}
boolean ,
certificate.purpose:
{
Description: Describe the purpose of the certificate. ,
Required: False ,
}
string ,
certificate.created:
{
Description: Certificate creation time. ,
Format: date-time ,
Required: False ,
}
string ,
certificate.lastUpdated:
{
Description: Certificate last updated time. ,
Format: date-time ,
Required: False ,
}
string ,
certificate.hasPrivateKey:
{
Description: Indicates if the certificate contains private key. ,
Required: False ,
}
boolean ,
certificate.nonce:
{
Description: Random number generated to indicate Proof of Possession. ,
Required: False ,
}
string ,
request:
{
Description: The name of the certificate ,
Required: True ,
}
{
certificate:
{
Description: base-64 representation of X509 certificate .cer file or just .pem file content. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: properties of a certificate ,
Required: False ,
}
{
subject:
{
Description: The certificate's subject name. ,
Required: False ,
}
string ,
expiry:
{
Description: The certificate's expiration date and time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate's thumbprint. ,
Required: False ,
}
string ,
isVerified:
{
Description: Determines whether certificate has been verified. ,
Required: False ,
}
boolean ,
certificate:
{
Description: base-64 representation of X509 certificate .cer file or just .pem file content. ,
Format: byte ,
Required: False ,
}
string ,
created:
{
Description: The certificate's creation date and time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
}
,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotDpsResource_ListKeysForKeyName (updated)
Description :  List primary and secondary keys for a specific key name
Reference :  Link ¶

⚶ Changes

{
  "#id": "IotDpsResource_ListKeysForKeyName",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The version of the API."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription identifier."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group that contains the provisioning service."
      }
    },
    {
      "#name": "provisioningServiceName",
      "Description": {
        "new": "Name of the provisioning service to retrieve.",
        "old": "Name of the provisioning service."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/keys/{keyName}/listkeys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
keyName:
{
Description: Logical key name to get key-values for. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
keyName:
{
Description: Name of the key. ,
Required: True ,
}
string ,
primaryKey:
{
Description: Primary SAS key value. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary SAS key value. ,
Required: False ,
}
string ,
rights:
{
Description: Rights that this key has. ,
Enum:
{
ServiceConfig: No description available. ,
EnrollmentRead: No description available. ,
EnrollmentWrite: No description available. ,
DeviceConnect: No description available. ,
RegistrationStatusRead: No description available. ,
RegistrationStatusWrite: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotDpsResource_ListKeys (updated)
Description :  List the primary and secondary keys for a provisioning service.
Reference :  Link ¶

⚶ Changes

{
  "#id": "IotDpsResource_ListKeys",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The version of the API."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription identifier."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "resource group name"
      }
    },
    {
      "#name": "provisioningServiceName",
      "Description": {
        "new": "Name of the provisioning service to retrieve.",
        "old": "The provisioning service name to get the shared access keys for."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The SharedAccessSignatureAuthorizationRuleAccessRightsDescription items on this page",
            "old": "The list of shared access policies."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The next link."
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/listkeys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SharedAccessSignatureAuthorizationRuleAccessRightsDescription items on this page ,
Required: True ,
}
[
{
keyName:
{
Description: Name of the key. ,
Required: True ,
}
string ,
primaryKey:
{
Description: Primary SAS key value. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary SAS key value. ,
Required: False ,
}
string ,
rights:
{
Description: Rights that this key has. ,
Enum:
{
ServiceConfig: No description available. ,
EnrollmentRead: No description available. ,
EnrollmentWrite: No description available. ,
DeviceConnect: No description available. ,
RegistrationStatusRead: No description available. ,
RegistrationStatusWrite: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotDpsResource_GetOperationResult (updated)
Description :  Gets the status of a long running operation, such as create, update or delete a provisioning service.
Reference :  Link ¶

⚶ Changes

{
  "#id": "IotDpsResource_GetOperationResult",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The version of the API."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription identifier."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Resource group identifier."
      }
    },
    {
      "#name": "provisioningServiceName",
      "Description": {
        "new": "Name of the provisioning service to retrieve.",
        "old": "Name of provisioning service that the operation is running on."
      }
    }
  ]
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/operationresults/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation id corresponding to long running operation. Use this to poll for the status. ,
Required: True ,
}
string ,
asyncinfo:
{
Description: Async header used to poll on the status of the operation, obtained while creating the long running operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: current status of a long running operation. ,
Required: False ,
}
string ,
error:
{
Description: Error message containing code, description and details ,
Required: False ,
}
{
code:
{
Description: standard error code ,
Required: False ,
}
string ,
message:
{
Description: standard error description ,
Required: False ,
}
string ,
details:
{
Description: detailed summary of error ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotDpsResource_ListPrivateEndpointConnections (updated)
Description :  List private endpoint connection properties
Reference :  Link ¶

⚶ Changes

{
  "#id": "IotDpsResource_ListPrivateEndpointConnections",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The version of the API."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription identifier."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group that contains the provisioning service."
      }
    },
    {
      "#name": "resourceName",
      "Description": {
        "new": "Name of the provisioning service to retrieve.",
        "old": "The name of the provisioning service."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Represents a list of private endpoint connections.",
        "old": "The list of private endpoint connections for a provisioning service"
      },
      "$items": {
        "$properties": {
          "@removed_7811c437efc847158a64fec57cfd5092": {
            "#name": "id",
            "Description": "The resource identifier.",
            "Required": false,
            "Type": "string"
          },
          "@removed_e9d3284b5b824628bd44a89dabc064c7": {
            "#name": "name",
            "Description": "The resource name.",
            "Required": false,
            "Type": "string"
          },
          "@removed_5eb0589192f84b48baf59483ef18f443": {
            "#name": "type",
            "Description": "The resource type.",
            "Required": false,
            "Type": "string"
          },
          "@removed_1e1b168cf1b84d2babed3b8bd84b82ef": {
            "#name": "systemData",
            "Description": "Metadata pertaining to creation and last modification of the resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The timestamp of resource creation (UTC).",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedAt",
                "Description": "The timestamp of resource last modification (UTC)",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateEndpointConnections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotDpsResource_GetPrivateEndpointConnection (updated)
Description :  Get private endpoint connection properties
Reference :  Link ¶

⚶ Changes

{
  "#id": "IotDpsResource_GetPrivateEndpointConnection",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The version of the API."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription identifier."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group that contains the provisioning service."
      }
    },
    {
      "#name": "resourceName",
      "Description": {
        "new": "Name of the provisioning service to retrieve.",
        "old": "The name of the provisioning service."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_0cdb09ea940b4aed9d9e3c2676d06e3b": {
          "#name": "id",
          "Description": "The resource identifier.",
          "Required": false,
          "Type": "string"
        },
        "@removed_fb86d45a70354075a9a4ecee0b06a4c3": {
          "#name": "name",
          "Description": "The resource name.",
          "Required": false,
          "Type": "string"
        },
        "@removed_01813bff44bc42ab86810eb896ef057f": {
          "#name": "type",
          "Description": "The resource type.",
          "Required": false,
          "Type": "string"
        },
        "@removed_42304596510a4576ab0c1c78f05d7bac": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotDpsResource_CreateOrUpdatePrivateEndpointConnection (updated)
Description :  Create or update the status of a private endpoint connection with the specified name
Reference :  Link ¶

⚶ Changes

{
  "#id": "IotDpsResource_CreateOrUpdatePrivateEndpointConnection",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The version of the API."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription identifier."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group that contains the provisioning service."
      }
    },
    {
      "#name": "resourceName",
      "Description": {
        "new": "Name of the provisioning service to retrieve.",
        "old": "The name of the provisioning service."
      }
    },
    {
      "privateEndpointConnection": {
        "$properties": {
          "@removed_cbc3b53001be40a582ae5401e626613e": {
            "#name": "id",
            "Description": "The resource identifier.",
            "Required": false,
            "Type": "string"
          },
          "@removed_5b95cb44ee1d4359a9b94dd341059868": {
            "#name": "name",
            "Description": "The resource name.",
            "Required": false,
            "Type": "string"
          },
          "@removed_09e8faaa3dcb41388d4c846a9f4165d7": {
            "#name": "type",
            "Description": "The resource type.",
            "Required": false,
            "Type": "string"
          },
          "@removed_a899caef270742e2ab23ddb403443b10": {
            "#name": "systemData",
            "Description": "Metadata pertaining to creation and last modification of the resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The timestamp of resource creation (UTC).",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedAt",
                "Description": "The timestamp of resource last modification (UTC)",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              }
            ]
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_25903044dd114ee38ee64dad1c5f846f": {
          "#name": "id",
          "Description": "The resource identifier.",
          "Required": false,
          "Type": "string"
        },
        "@removed_377e6649d8b14a90bbeb0e24a140eda9": {
          "#name": "name",
          "Description": "The resource name.",
          "Required": false,
          "Type": "string"
        },
        "@removed_18e57a80991046c9b839dd0637ecb8e2": {
          "#name": "type",
          "Description": "The resource type.",
          "Required": false,
          "Type": "string"
        },
        "@removed_a9ec5073146e42a2a8e3d3857fefed39": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    },
    "201": {
      "$properties": {
        "@removed_a5e274b02eaa4c70926c37ab6f2a5bec": {
          "#name": "id",
          "Description": "The resource identifier.",
          "Required": false,
          "Type": "string"
        },
        "@removed_9d866a13692e4c6faa676a279fdd4b0b": {
          "#name": "name",
          "Description": "The resource name.",
          "Required": false,
          "Type": "string"
        },
        "@removed_0f743e49199e4b6fbcc70f981f2dccce": {
          "#name": "type",
          "Description": "The resource type.",
          "Required": false,
          "Type": "string"
        },
        "@removed_c3a681be2dd04ff7bc3d66d7d5d32db9": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection ,
Required: True ,
}
string ,
privateEndpointConnection:
{
Description: The private endpoint connection with updated properties ,
Required: True ,
}
{
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The private endpoint connection of a provisioning service ,
}
{
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotDpsResource_DeletePrivateEndpointConnection (updated)
Description :  Delete private endpoint connection with the specified name
Reference :  Link ¶

⚶ Changes

{
  "#id": "IotDpsResource_DeletePrivateEndpointConnection",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The version of the API."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription identifier."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group that contains the provisioning service."
      }
    },
    {
      "#name": "resourceName",
      "Description": {
        "new": "Name of the provisioning service to retrieve.",
        "old": "The name of the provisioning service."
      }
    }
  ],
  "$responses": [
    {
      "200": {
        "$properties": {
          "@removed_029c6bd1cc9941919938c665602255fe": {
            "#name": "id",
            "Description": "The resource identifier.",
            "Required": false,
            "Type": "string"
          },
          "@removed_1108db5e7905472facd5a27b3bb7fae8": {
            "#name": "name",
            "Description": "The resource name.",
            "Required": false,
            "Type": "string"
          },
          "@removed_991a61b2f7084e41aeb4cc6ee99aafbc": {
            "#name": "type",
            "Description": "The resource type.",
            "Required": false,
            "Type": "string"
          },
          "@removed_b7eeb59b3cae4892b35a7ef96288b0c3": {
            "#name": "systemData",
            "Description": "Metadata pertaining to creation and last modification of the resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The timestamp of resource creation (UTC).",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedAt",
                "Description": "The timestamp of resource last modification (UTC)",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              }
            ]
          }
        }
      }
    },
    {
      "#status": "202",
      "$headers": [
        {
          "#name": "location",
          "Description": {
            "new": "The Location header contains the URL where the status of the long running operation can be checked.",
            "old": "Operation Status Location URI"
          }
        },
        {
          "#name": "retry-after",
          "Description": {
            "new": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
            "old": "Retry After"
          },
          "Type": {
            "new": "integer",
            "old": "string"
          }
        },
        {
          "@removed_83c9e3b2ce8c4b52b0b195bfd73b3a7e": {
            "#name": "azure-asyncoperation",
            "Description": "Operation Status Location URI",
            "Type": "string"
          }
        }
      ],
      "$schema": {
        "$properties": {
          "@removed_6a4722217c8749fa9bbf098092244e68": {
            "#name": "id",
            "Description": "The resource identifier.",
            "Required": false,
            "Type": "string"
          },
          "@removed_ff005dec88a840369212592aca2162fc": {
            "#name": "name",
            "Description": "The resource name.",
            "Required": false,
            "Type": "string"
          },
          "@removed_0c9a0dce05a94284a53f833b5492d3ee": {
            "#name": "type",
            "Description": "The resource type.",
            "Required": false,
            "Type": "string"
          },
          "@removed_f42f56ad2b7346fd895199c5cd9f6092": {
            "#name": "systemData",
            "Description": "Metadata pertaining to creation and last modification of the resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The timestamp of resource creation (UTC).",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedAt",
                "Description": "The timestamp of resource last modification (UTC)",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              }
            ]
          }
        }
      }
    }
  ]
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The private endpoint connection of a provisioning service ,
}
{
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotDpsResource_ListPrivateLinkResources (updated)
Description :  List private link resources for the given provisioning service
Reference :  Link ¶

⚶ Changes

{
  "#id": "IotDpsResource_ListPrivateLinkResources",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The version of the API."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription identifier."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group that contains the provisioning service."
      }
    },
    {
      "#name": "resourceName",
      "Description": {
        "new": "Name of the provisioning service to retrieve.",
        "old": "The name of the provisioning service."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "@removed_451759b299404c27bdaad87258bc99c9": {
              "#name": "id",
              "Description": "The resource identifier.",
              "Required": false,
              "Type": "string"
            },
            "@removed_f969f2c78bfa4f47b608b9b1fce7f291": {
              "#name": "name",
              "Description": "The resource name.",
              "Required": false,
              "Type": "string"
            },
            "@removed_499ae73ca0424f9e8020f3d3d2ae63dc": {
              "#name": "type",
              "Description": "The resource type.",
              "Required": false,
              "Type": "string"
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateLinkResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of available private link resources for a provisioning service ,
Required: False ,
}
[
{
properties:
{
Description: The properties for a group information object ,
Required: True ,
}
{
groupId:
{
Description: The group id ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The required members for a specific group id ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The required DNS zones for a specific group id ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotDpsResource_GetPrivateLinkResources (updated)
Description :  Get the specified private link resource for the given provisioning service
Reference :  Link ¶

⚶ Changes

{
  "#id": "IotDpsResource_GetPrivateLinkResources",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The version of the API."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription identifier."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group that contains the provisioning service."
      }
    },
    {
      "#name": "resourceName",
      "Description": {
        "new": "Name of the provisioning service to retrieve.",
        "old": "The name of the provisioning service."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_8692bae7d48a4c538e64e8d55f27a651": {
          "#name": "id",
          "Description": "The resource identifier.",
          "Required": false,
          "Type": "string"
        },
        "@removed_e338ce4d87e7435c8f302a781dd3fc2f": {
          "#name": "name",
          "Description": "The resource name.",
          "Required": false,
          "Type": "string"
        },
        "@removed_3acf3ba095724ec7be55f4ca0a574c21": {
          "#name": "type",
          "Description": "The resource type.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateLinkResources/{groupId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
groupId:
{
Description: The name of the private link resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties for a group information object ,
Required: True ,
}
{
groupId:
{
Description: The group id ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The required members for a specific group id ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The required DNS zones for a specific group id ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotDpsResource_listValidSkus (updated)
Description :  Gets the list of valid SKUs and tiers for a provisioning service.
Reference :  Link ¶

⚶ Changes

{
  "#id": "IotDpsResource_listValidSkus",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The version of the API."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription identifier."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Name of resource group."
      }
    },
    {
      "#name": "provisioningServiceName",
      "Description": {
        "new": "Name of the provisioning service to retrieve.",
        "old": "Name of provisioning service."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The IotDpsSkuDefinition items on this page",
            "old": "The list of SKUs"
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The next link."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/skus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The IotDpsSkuDefinition items on this page ,
Required: True ,
}
[
{
name:
{
Description: Sku name. ,
Enum:
{
S1: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}