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

2025/07/25 • 5 updated methods

IotDpsResource_ListBySubscription (updated)
Description :  List all the provisioning services for a given subscription id.
Reference :  Link ¶

⚶ Changes

{
  "#id": "IotDpsResource_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "iotHubs": {
                  "$properties": [
                    {
                      "#name": "connectionString",
                      "Required": {
                        "new": true,
                        "old": false
                      }
                    },
                    {
                      "@removed_3385887f37de41cabac4f955380c02ec": {
                        "#name": "authenticationType",
                        "Description": "IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned.",
                        "Enum": [
                          [
                            "KeyBased",
                            ""
                          ],
                          [
                            "UserAssigned",
                            ""
                          ],
                          [
                            "SystemAssigned",
                            ""
                          ]
                        ],
                        "Required": false,
                        "Type": "string"
                      }
                    },
                    {
                      "@removed_41625f2e5d15483f9f51f767ede8cae0": {
                        "#name": "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,
                        "Type": "string"
                      }
                    }
                  ]
                }
              },
              {
                "@added_f728765468c742c181456f756b6e35b3": {
                  "#name": "deviceRegistryNamespace",
                  "Description": "The Device Registry namespace that is linked to the provisioning service.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "resourceId",
                      "Description": "The ARM resource ID of the Device Registry namespace.",
                      "Format": "arm-id",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "authenticationType",
                      "Description": "Device Registry Namespace MI authentication type: UserAssigned, SystemAssigned.",
                      "Enum": [
                        [
                          "UserAssigned",
                          "User assigned authentication type."
                        ],
                        [
                          "SystemAssigned",
                          "System assigned authentication type."
                        ]
                      ],
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "selectedUserAssignedIdentityResourceId",
                      "Description": "The selected user-assigned identity resource Id associated with Device Registry namespace. This is required when authenticationType is UserAssigned.",
                      "Format": "arm-id",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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: True ,
}
string ,
location:
{
Description: ARM region of the IoT hub. ,
Required: True ,
}
string ,
}
,
]
,
deviceRegistryNamespace:
{
Description: The Device Registry namespace that is linked to the provisioning service. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource ID of the Device Registry namespace. ,
Format: arm-id ,
Required: True ,
}
string ,
authenticationType:
{
Description: Device Registry Namespace MI authentication type: UserAssigned, SystemAssigned. ,
Enum:
{
UserAssigned: User assigned authentication type. ,
SystemAssigned: System assigned authentication type. ,
}
,
Required: True ,
}
enum ,
selectedUserAssignedIdentityResourceId:
{
Description: The selected user-assigned identity resource Id associated with Device Registry namespace. 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",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "iotHubs": {
                  "$properties": [
                    {
                      "#name": "connectionString",
                      "Required": {
                        "new": true,
                        "old": false
                      }
                    },
                    {
                      "@removed_f17b865eef3e45729ccb5fb3a5599d35": {
                        "#name": "authenticationType",
                        "Description": "IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned.",
                        "Enum": [
                          [
                            "KeyBased",
                            ""
                          ],
                          [
                            "UserAssigned",
                            ""
                          ],
                          [
                            "SystemAssigned",
                            ""
                          ]
                        ],
                        "Required": false,
                        "Type": "string"
                      }
                    },
                    {
                      "@removed_43c16678cd7d49f3aa642d9c6daec057": {
                        "#name": "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,
                        "Type": "string"
                      }
                    }
                  ]
                }
              },
              {
                "@added_e3295ed53be44fc8b92a6078436674e1": {
                  "#name": "deviceRegistryNamespace",
                  "Description": "The Device Registry namespace that is linked to the provisioning service.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "resourceId",
                      "Description": "The ARM resource ID of the Device Registry namespace.",
                      "Format": "arm-id",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "authenticationType",
                      "Description": "Device Registry Namespace MI authentication type: UserAssigned, SystemAssigned.",
                      "Enum": [
                        [
                          "UserAssigned",
                          "User assigned authentication type."
                        ],
                        [
                          "SystemAssigned",
                          "System assigned authentication type."
                        ]
                      ],
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "selectedUserAssignedIdentityResourceId",
                      "Description": "The selected user-assigned identity resource Id associated with Device Registry namespace. This is required when authenticationType is UserAssigned.",
                      "Format": "arm-id",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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: True ,
}
string ,
location:
{
Description: ARM region of the IoT hub. ,
Required: True ,
}
string ,
}
,
]
,
deviceRegistryNamespace:
{
Description: The Device Registry namespace that is linked to the provisioning service. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource ID of the Device Registry namespace. ,
Format: arm-id ,
Required: True ,
}
string ,
authenticationType:
{
Description: Device Registry Namespace MI authentication type: UserAssigned, SystemAssigned. ,
Enum:
{
UserAssigned: User assigned authentication type. ,
SystemAssigned: System assigned authentication type. ,
}
,
Required: True ,
}
enum ,
selectedUserAssignedIdentityResourceId:
{
Description: The selected user-assigned identity resource Id associated with Device Registry namespace. 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",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "iotHubs": {
              "$properties": [
                {
                  "#name": "connectionString",
                  "Required": {
                    "new": true,
                    "old": false
                  }
                },
                {
                  "@removed_b61cb5eaf43b48fa81d6110ba888406c": {
                    "#name": "authenticationType",
                    "Description": "IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned.",
                    "Enum": [
                      [
                        "KeyBased",
                        ""
                      ],
                      [
                        "UserAssigned",
                        ""
                      ],
                      [
                        "SystemAssigned",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  }
                },
                {
                  "@removed_7818c7473c59465bb0fb305c4065823a": {
                    "#name": "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,
                    "Type": "string"
                  }
                }
              ]
            }
          },
          {
            "@added_d54988e63e6346bf88bd67b44917461c": {
              "#name": "deviceRegistryNamespace",
              "Description": "The Device Registry namespace that is linked to the provisioning service.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "resourceId",
                  "Description": "The ARM resource ID of the Device Registry namespace.",
                  "Format": "arm-id",
                  "Required": true,
                  "Type": "string"
                },
                {
                  "#name": "authenticationType",
                  "Description": "Device Registry Namespace MI authentication type: UserAssigned, SystemAssigned.",
                  "Enum": [
                    [
                      "UserAssigned",
                      "User assigned authentication type."
                    ],
                    [
                      "SystemAssigned",
                      "System assigned authentication type."
                    ]
                  ],
                  "Required": true,
                  "Type": "string"
                },
                {
                  "#name": "selectedUserAssignedIdentityResourceId",
                  "Description": "The selected user-assigned identity resource Id associated with Device Registry namespace. This is required when authenticationType is UserAssigned.",
                  "Format": "arm-id",
                  "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: True ,
}
string ,
location:
{
Description: ARM region of the IoT hub. ,
Required: True ,
}
string ,
}
,
]
,
deviceRegistryNamespace:
{
Description: The Device Registry namespace that is linked to the provisioning service. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource ID of the Device Registry namespace. ,
Format: arm-id ,
Required: True ,
}
string ,
authenticationType:
{
Description: Device Registry Namespace MI authentication type: UserAssigned, SystemAssigned. ,
Enum:
{
UserAssigned: User assigned authentication type. ,
SystemAssigned: System assigned authentication type. ,
}
,
Required: True ,
}
enum ,
selectedUserAssignedIdentityResourceId:
{
Description: The selected user-assigned identity resource Id associated with Device Registry namespace. 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": {
    "iotDpsDescription": {
      "$properties": {
        "properties": [
          {
            "iotHubs": {
              "$properties": [
                {
                  "#name": "connectionString",
                  "Required": {
                    "new": true,
                    "old": false
                  }
                },
                {
                  "@removed_6ea4c64b915146f1a8e6e51fc717c2cb": {
                    "#name": "authenticationType",
                    "Description": "IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned.",
                    "Enum": [
                      [
                        "KeyBased",
                        ""
                      ],
                      [
                        "UserAssigned",
                        ""
                      ],
                      [
                        "SystemAssigned",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  }
                },
                {
                  "@removed_7ec3adb8ba004c37900a4e5373d8b946": {
                    "#name": "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,
                    "Type": "string"
                  }
                }
              ]
            }
          },
          {
            "@added_29da6d5383d3463cb62e9e914ecea364": {
              "#name": "deviceRegistryNamespace",
              "Description": "The Device Registry namespace that is linked to the provisioning service.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "resourceId",
                  "Description": "The ARM resource ID of the Device Registry namespace.",
                  "Format": "arm-id",
                  "Required": true,
                  "Type": "string"
                },
                {
                  "#name": "authenticationType",
                  "Description": "Device Registry Namespace MI authentication type: UserAssigned, SystemAssigned.",
                  "Enum": [
                    [
                      "UserAssigned",
                      "User assigned authentication type."
                    ],
                    [
                      "SystemAssigned",
                      "System assigned authentication type."
                    ]
                  ],
                  "Required": true,
                  "Type": "string"
                },
                {
                  "#name": "selectedUserAssignedIdentityResourceId",
                  "Description": "The selected user-assigned identity resource Id associated with Device Registry namespace. This is required when authenticationType is UserAssigned.",
                  "Format": "arm-id",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "iotHubs": {
              "$properties": [
                {
                  "#name": "connectionString",
                  "Required": {
                    "new": true,
                    "old": false
                  }
                },
                {
                  "@removed_6ca10089c5a649209223fc954f4505bd": {
                    "#name": "authenticationType",
                    "Description": "IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned.",
                    "Enum": [
                      [
                        "KeyBased",
                        ""
                      ],
                      [
                        "UserAssigned",
                        ""
                      ],
                      [
                        "SystemAssigned",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  }
                },
                {
                  "@removed_a9ae27fd013341f7b438b7e569de7b4b": {
                    "#name": "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,
                    "Type": "string"
                  }
                }
              ]
            }
          },
          {
            "@added_17c452760ffc422abce886cd5577690b": {
              "#name": "deviceRegistryNamespace",
              "Description": "The Device Registry namespace that is linked to the provisioning service.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "resourceId",
                  "Description": "The ARM resource ID of the Device Registry namespace.",
                  "Format": "arm-id",
                  "Required": true,
                  "Type": "string"
                },
                {
                  "#name": "authenticationType",
                  "Description": "Device Registry Namespace MI authentication type: UserAssigned, SystemAssigned.",
                  "Enum": [
                    [
                      "UserAssigned",
                      "User assigned authentication type."
                    ],
                    [
                      "SystemAssigned",
                      "System assigned authentication type."
                    ]
                  ],
                  "Required": true,
                  "Type": "string"
                },
                {
                  "#name": "selectedUserAssignedIdentityResourceId",
                  "Description": "The selected user-assigned identity resource Id associated with Device Registry namespace. This is required when authenticationType is UserAssigned.",
                  "Format": "arm-id",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "iotHubs": {
              "$properties": [
                {
                  "#name": "connectionString",
                  "Required": {
                    "new": true,
                    "old": false
                  }
                },
                {
                  "@removed_48e87d14f858401aa057b5e4b2a7cf29": {
                    "#name": "authenticationType",
                    "Description": "IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned.",
                    "Enum": [
                      [
                        "KeyBased",
                        ""
                      ],
                      [
                        "UserAssigned",
                        ""
                      ],
                      [
                        "SystemAssigned",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  }
                },
                {
                  "@removed_8baa0ef90dd2494e9213a74c3fb49aaa": {
                    "#name": "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,
                    "Type": "string"
                  }
                }
              ]
            }
          },
          {
            "@added_391282b289414760bec1d4ef3ce52db9": {
              "#name": "deviceRegistryNamespace",
              "Description": "The Device Registry namespace that is linked to the provisioning service.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "resourceId",
                  "Description": "The ARM resource ID of the Device Registry namespace.",
                  "Format": "arm-id",
                  "Required": true,
                  "Type": "string"
                },
                {
                  "#name": "authenticationType",
                  "Description": "Device Registry Namespace MI authentication type: UserAssigned, SystemAssigned.",
                  "Enum": [
                    [
                      "UserAssigned",
                      "User assigned authentication type."
                    ],
                    [
                      "SystemAssigned",
                      "System assigned authentication type."
                    ]
                  ],
                  "Required": true,
                  "Type": "string"
                },
                {
                  "#name": "selectedUserAssignedIdentityResourceId",
                  "Description": "The selected user-assigned identity resource Id associated with Device Registry namespace. This is required when authenticationType is UserAssigned.",
                  "Format": "arm-id",
                  "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: True ,
}
string ,
location:
{
Description: ARM region of the IoT hub. ,
Required: True ,
}
string ,
}
,
]
,
deviceRegistryNamespace:
{
Description: The Device Registry namespace that is linked to the provisioning service. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource ID of the Device Registry namespace. ,
Format: arm-id ,
Required: True ,
}
string ,
authenticationType:
{
Description: Device Registry Namespace MI authentication type: UserAssigned, SystemAssigned. ,
Enum:
{
UserAssigned: User assigned authentication type. ,
SystemAssigned: System assigned authentication type. ,
}
,
Required: True ,
}
enum ,
selectedUserAssignedIdentityResourceId:
{
Description: The selected user-assigned identity resource Id associated with Device Registry namespace. 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: True ,
}
string ,
location:
{
Description: ARM region of the IoT hub. ,
Required: True ,
}
string ,
}
,
]
,
deviceRegistryNamespace:
{
Description: The Device Registry namespace that is linked to the provisioning service. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource ID of the Device Registry namespace. ,
Format: arm-id ,
Required: True ,
}
string ,
authenticationType:
{
Description: Device Registry Namespace MI authentication type: UserAssigned, SystemAssigned. ,
Enum:
{
UserAssigned: User assigned authentication type. ,
SystemAssigned: System assigned authentication type. ,
}
,
Required: True ,
}
enum ,
selectedUserAssignedIdentityResourceId:
{
Description: The selected user-assigned identity resource Id associated with Device Registry namespace. 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: True ,
}
string ,
location:
{
Description: ARM region of the IoT hub. ,
Required: True ,
}
string ,
}
,
]
,
deviceRegistryNamespace:
{
Description: The Device Registry namespace that is linked to the provisioning service. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource ID of the Device Registry namespace. ,
Format: arm-id ,
Required: True ,
}
string ,
authenticationType:
{
Description: Device Registry Namespace MI authentication type: UserAssigned, SystemAssigned. ,
Enum:
{
UserAssigned: User assigned authentication type. ,
SystemAssigned: System assigned authentication type. ,
}
,
Required: True ,
}
enum ,
selectedUserAssignedIdentityResourceId:
{
Description: The selected user-assigned identity resource Id associated with Device Registry namespace. 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",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "iotHubs": {
              "$properties": [
                {
                  "#name": "connectionString",
                  "Required": {
                    "new": true,
                    "old": false
                  }
                },
                {
                  "@removed_c1ae347184094918bdbf02ea37bbcff3": {
                    "#name": "authenticationType",
                    "Description": "IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned.",
                    "Enum": [
                      [
                        "KeyBased",
                        ""
                      ],
                      [
                        "UserAssigned",
                        ""
                      ],
                      [
                        "SystemAssigned",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  }
                },
                {
                  "@removed_6060bbfd715347538fd85d499ec99aae": {
                    "#name": "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,
                    "Type": "string"
                  }
                }
              ]
            }
          },
          {
            "@added_9a379a717afb4c3ba4251cd4d96f1d8a": {
              "#name": "deviceRegistryNamespace",
              "Description": "The Device Registry namespace that is linked to the provisioning service.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "resourceId",
                  "Description": "The ARM resource ID of the Device Registry namespace.",
                  "Format": "arm-id",
                  "Required": true,
                  "Type": "string"
                },
                {
                  "#name": "authenticationType",
                  "Description": "Device Registry Namespace MI authentication type: UserAssigned, SystemAssigned.",
                  "Enum": [
                    [
                      "UserAssigned",
                      "User assigned authentication type."
                    ],
                    [
                      "SystemAssigned",
                      "System assigned authentication type."
                    ]
                  ],
                  "Required": true,
                  "Type": "string"
                },
                {
                  "#name": "selectedUserAssignedIdentityResourceId",
                  "Description": "The selected user-assigned identity resource Id associated with Device Registry namespace. This is required when authenticationType is UserAssigned.",
                  "Format": "arm-id",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ 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: True ,
}
string ,
location:
{
Description: ARM region of the IoT hub. ,
Required: True ,
}
string ,
}
,
]
,
deviceRegistryNamespace:
{
Description: The Device Registry namespace that is linked to the provisioning service. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource ID of the Device Registry namespace. ,
Format: arm-id ,
Required: True ,
}
string ,
authenticationType:
{
Description: Device Registry Namespace MI authentication type: UserAssigned, SystemAssigned. ,
Enum:
{
UserAssigned: User assigned authentication type. ,
SystemAssigned: System assigned authentication type. ,
}
,
Required: True ,
}
enum ,
selectedUserAssignedIdentityResourceId:
{
Description: The selected user-assigned identity resource Id associated with Device Registry namespace. 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 ,
}
,
]
,
}
,
}