Microsoft.Devices (stable:2022-12-12)

2025/08/29 • 24 new, 24 deleted methods

Operations_List (new)
Description :  Lists all of the available Microsoft.Devices REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Devices/operations
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Provisioning service operations supported by the Microsoft.Devices resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{read | write | action | delete} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents 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: URL to get the next set of operation list results if there are any. ,
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 (new)
Description :  Get the certificate from the provisioning service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}
{
certificateName:
{
Description: Name of the certificate to retrieve. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group identifier. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of the provisioning service the certificate is associated with. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the certificate. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
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-rfc1123 ,
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-rfc1123 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the certificate. ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-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_CreateOrUpdate (new)
Description :  Add new certificate or update an existing certificate.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group identifier. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: The name of the provisioning service. ,
Required: True ,
}
string ,
certificateName:
{
Description: The name of the certificate create or update. ,
Required: True ,
}
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-rfc1123 ,
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-rfc1123 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the certificate. ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
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 ,
}

⚐ 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-rfc1123 ,
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-rfc1123 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the certificate. ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-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_Delete (new)
Description :  Deletes the specified certificate associated with the Provisioning Service
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group identifier. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the certificate ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: The name of the provisioning service. ,
Required: True ,
}
string ,
certificateName:
{
Description: This is a mandatory field, and is the logical name of the certificate that the provisioning service will access by. ,
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 ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
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 ,
}
IotDpsResource_Get (new)
Description :  Get the metadata of the provisioning service without SAS keys.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}
{
provisioningServiceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
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 ,
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 ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
,
]
,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-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 ,
}
IotDpsResource_CreateOrUpdate (new)
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 ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group identifier. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of provisioning service to create or update. ,
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 ,
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 ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
,
]
,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The version of the API. ,
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 ,
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 ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
,
]
,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
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 ,
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 ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
,
]
,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-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 ,
}
IotDpsResource_Update (new)
Description :  Update an existing provisioning service's tags. to update other fields use the CreateOrUpdate method
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group identifier. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of provisioning service to create or update. ,
Required: True ,
}
string ,
ProvisioningServiceTags:
{
Description: Updated tag information to set into the provisioning service instance. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The version of the API. ,
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 ,
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 ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
,
]
,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
IotDpsResource_Delete (new)
Description :  Deletes the Provisioning Service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}
{
provisioningServiceName:
{
Description: Name of provisioning service to delete. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ 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 (new)
Description :  Get all the certificates tied to the provisioning service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of resource group. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of provisioning service to retrieve certificates for. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
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-rfc1123 ,
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-rfc1123 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the certificate. ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-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 ,
}
IotDpsResource_ListBySubscription (new)
Description :  List all the provisioning services for a given subscription id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Devices/provisioningServices
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of provisioning service descriptions. ,
Required: False ,
}
[
{
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 ,
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 ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
,
]
,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: the next link ,
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 (new)
Description :  Get a list of all provisioning services in the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of provisioning service descriptions. ,
Required: False ,
}
[
{
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 ,
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 ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
,
]
,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: the next link ,
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 (new)
Description :  Gets the status of a long running operation, such as create, update or delete a provisioning service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/operationresults/{operationId}
{
operationId:
{
Description: Operation id corresponding to long running operation. Use this to poll for the status. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group identifier. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of provisioning service that the operation is running on. ,
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 ,
api-version:
{
Description: The version of the API. ,
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_listValidSkus (new)
Description :  Gets the list of valid SKUs and tiers for a provisioning service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/skus
{
provisioningServiceName:
{
Description: Name of provisioning service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of SKUs ,
Required: False ,
}
[
{
name:
{
Description: Sku name. ,
Enum:
{
S1: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The next link. ,
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_GenerateVerificationCode (new)
Description :  Generate verification code for Proof of Possession.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/generateVerificationCode
{
certificateName:
{
Description: The mandatory logical name of the certificate, that the provisioning service uses to access. ,
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 ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: name of resource group. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of provisioning service. ,
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 ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
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 (new)
Description :  Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/verify
{
certificateName:
{
Description: The mandatory logical name of the certificate, that the provisioning service uses to access. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the certificate. ,
Required: True ,
}
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 ,
}
,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Provisioning service name. ,
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 ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
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-rfc1123 ,
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-rfc1123 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the certificate. ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-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 ,
}
IotDpsResource_CheckProvisioningServiceNameAvailability (new)
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 ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkProvisioningServiceNameAvailability
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
arguments:
{
Description: Set the name parameter in the OperationInputs structure to the name of the provisioning service to check. ,
Required: True ,
}
{
name:
{
Description: The name of the Provisioning Service to check. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: The version of the API. ,
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_ListKeys (new)
Description :  List the primary and secondary keys for a provisioning service.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/listkeys
{
provisioningServiceName:
{
Description: The provisioning service name to get the shared access keys for. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: resource group name ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of shared access policies. ,
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 ,
}
,
]
,
nextLink:
{
Description: The next link. ,
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 (new)
Description :  List primary and secondary keys for a specific key name
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/keys/{keyName}/listkeys
{
provisioningServiceName:
{
Description: Name of the provisioning service. ,
Required: True ,
}
string ,
keyName:
{
Description: Logical key name to get key-values for. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the provisioning service. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
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_ListPrivateLinkResources (new)
Description :  List private link resources for the given provisioning service
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateLinkResources
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the provisioning service. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the provisioning service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of available private link resources for a provisioning service ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 (new)
Description :  Get the specified private link resource for the given provisioning service
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateLinkResources/{groupId}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the provisioning service. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the provisioning service. ,
Required: True ,
}
string ,
groupId:
{
Description: The name of the private link resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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_ListPrivateEndpointConnections (new)
Description :  List private endpoint connection properties
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateEndpointConnections
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the provisioning service. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the provisioning service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-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 ,
}
IotDpsResource_GetPrivateEndpointConnection (new)
Description :  Get private endpoint connection properties
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the provisioning service. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the provisioning service. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-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 ,
}
IotDpsResource_CreateOrUpdatePrivateEndpointConnection (new)
Description :  Create or update the status of a private endpoint connection with the specified name
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the provisioning service. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the provisioning service. ,
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 ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-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 ,
}
IotDpsResource_DeletePrivateEndpointConnection (new)
Description :  Delete private endpoint connection with the specified name
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the provisioning service. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the provisioning service. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: Operation Status Location URI ,
}
string ,
location:
{
Description: Operation Status Location URI ,
}
string ,
retry-after:
{
Description: Retry After ,
}
string ,
}
,
$schema:
{
Description: The private endpoint connection of a provisioning service ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
Operations_List (removed)
Description :  Lists all of the available Microsoft.Devices REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Devices/operations
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Provisioning service operations supported by the Microsoft.Devices resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{read | write | action | delete} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents 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: URL to get the next set of operation list results if there are any. ,
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 (removed)
Description :  Get the certificate from the provisioning service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}
{
certificateName:
{
Description: Name of the certificate to retrieve. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group identifier. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of the provisioning service the certificate is associated with. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the certificate. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
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-rfc1123 ,
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-rfc1123 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the certificate. ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-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_CreateOrUpdate (removed)
Description :  Add new certificate or update an existing certificate.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group identifier. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: The name of the provisioning service. ,
Required: True ,
}
string ,
certificateName:
{
Description: The name of the certificate create or update. ,
Required: True ,
}
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-rfc1123 ,
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-rfc1123 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the certificate. ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
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 ,
}

⚐ 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-rfc1123 ,
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-rfc1123 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the certificate. ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-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_Delete (removed)
Description :  Deletes the specified certificate associated with the Provisioning Service
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group identifier. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the certificate ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: The name of the provisioning service. ,
Required: True ,
}
string ,
certificateName:
{
Description: This is a mandatory field, and is the logical name of the certificate that the provisioning service will access by. ,
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 ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
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 ,
}
IotDpsResource_Get (removed)
Description :  Get the metadata of the provisioning service without SAS keys.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}
{
provisioningServiceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
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 ,
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 ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
,
]
,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-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 ,
}
IotDpsResource_CreateOrUpdate (removed)
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 ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group identifier. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of provisioning service to create or update. ,
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 ,
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 ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
,
]
,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The version of the API. ,
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 ,
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 ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
,
]
,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
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 ,
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 ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
,
]
,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-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 ,
}
IotDpsResource_Update (removed)
Description :  Update an existing provisioning service's tags. to update other fields use the CreateOrUpdate method
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group identifier. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of provisioning service to create or update. ,
Required: True ,
}
string ,
ProvisioningServiceTags:
{
Description: Updated tag information to set into the provisioning service instance. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The version of the API. ,
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 ,
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 ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
,
]
,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
IotDpsResource_Delete (removed)
Description :  Deletes the Provisioning Service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}
{
provisioningServiceName:
{
Description: Name of provisioning service to delete. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ 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 (removed)
Description :  Get all the certificates tied to the provisioning service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of resource group. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of provisioning service to retrieve certificates for. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
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-rfc1123 ,
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-rfc1123 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the certificate. ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-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 ,
}
IotDpsResource_ListBySubscription (removed)
Description :  List all the provisioning services for a given subscription id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Devices/provisioningServices
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of provisioning service descriptions. ,
Required: False ,
}
[
{
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 ,
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 ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
,
]
,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: the next link ,
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 (removed)
Description :  Get a list of all provisioning services in the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of provisioning service descriptions. ,
Required: False ,
}
[
{
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 ,
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 ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
,
]
,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: the next link ,
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 (removed)
Description :  Gets the status of a long running operation, such as create, update or delete a provisioning service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/operationresults/{operationId}
{
operationId:
{
Description: Operation id corresponding to long running operation. Use this to poll for the status. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group identifier. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of provisioning service that the operation is running on. ,
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 ,
api-version:
{
Description: The version of the API. ,
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_listValidSkus (removed)
Description :  Gets the list of valid SKUs and tiers for a provisioning service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/skus
{
provisioningServiceName:
{
Description: Name of provisioning service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of SKUs ,
Required: False ,
}
[
{
name:
{
Description: Sku name. ,
Enum:
{
S1: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The next link. ,
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_GenerateVerificationCode (removed)
Description :  Generate verification code for Proof of Possession.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/generateVerificationCode
{
certificateName:
{
Description: The mandatory logical name of the certificate, that the provisioning service uses to access. ,
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 ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: name of resource group. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of provisioning service. ,
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 ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
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 (removed)
Description :  Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/verify
{
certificateName:
{
Description: The mandatory logical name of the certificate, that the provisioning service uses to access. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the certificate. ,
Required: True ,
}
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 ,
}
,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Provisioning service name. ,
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 ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
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-rfc1123 ,
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-rfc1123 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the certificate. ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-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 ,
}
IotDpsResource_CheckProvisioningServiceNameAvailability (removed)
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 ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkProvisioningServiceNameAvailability
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
arguments:
{
Description: Set the name parameter in the OperationInputs structure to the name of the provisioning service to check. ,
Required: True ,
}
{
name:
{
Description: The name of the Provisioning Service to check. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: The version of the API. ,
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_ListKeys (removed)
Description :  List the primary and secondary keys for a provisioning service.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/listkeys
{
provisioningServiceName:
{
Description: The provisioning service name to get the shared access keys for. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: resource group name ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of shared access policies. ,
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 ,
}
,
]
,
nextLink:
{
Description: The next link. ,
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 (removed)
Description :  List primary and secondary keys for a specific key name
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/keys/{keyName}/listkeys
{
provisioningServiceName:
{
Description: Name of the provisioning service. ,
Required: True ,
}
string ,
keyName:
{
Description: Logical key name to get key-values for. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the provisioning service. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
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_ListPrivateLinkResources (removed)
Description :  List private link resources for the given provisioning service
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateLinkResources
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the provisioning service. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the provisioning service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of available private link resources for a provisioning service ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 (removed)
Description :  Get the specified private link resource for the given provisioning service
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateLinkResources/{groupId}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the provisioning service. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the provisioning service. ,
Required: True ,
}
string ,
groupId:
{
Description: The name of the private link resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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_ListPrivateEndpointConnections (removed)
Description :  List private endpoint connection properties
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateEndpointConnections
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the provisioning service. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the provisioning service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-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 ,
}
IotDpsResource_GetPrivateEndpointConnection (removed)
Description :  Get private endpoint connection properties
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the provisioning service. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the provisioning service. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-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 ,
}
IotDpsResource_CreateOrUpdatePrivateEndpointConnection (removed)
Description :  Create or update the status of a private endpoint connection with the specified name
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the provisioning service. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the provisioning service. ,
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 ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-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 ,
}
IotDpsResource_DeletePrivateEndpointConnection (removed)
Description :  Delete private endpoint connection with the specified name
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the provisioning service. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the provisioning service. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: Operation Status Location URI ,
}
string ,
location:
{
Description: Operation Status Location URI ,
}
string ,
retry-after:
{
Description: Retry After ,
}
string ,
}
,
$schema:
{
Description: The private endpoint connection of a provisioning service ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}