Microsoft.DigitalTwins (preview:2021-06-30)

2025/10/23 • 22 new, 46 deleted methods

DigitalTwins_Get (new)
Description :  Get DigitalTwinsInstances resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DigitalTwins instance properties. ,
Required: False ,
}
{
createdTime:
{
Description: Time when DigitalTwinsInstance was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Time when DigitalTwinsInstance was updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Api endpoint to work with DigitalTwinsInstance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DigitalTwins_CreateOrUpdate (new)
Description :  Create or update the metadata of a DigitalTwinsInstance. The usual pattern to modify a property is to retrieve the DigitalTwinsInstance and security metadata, and then combine them with the modified values in a new body to update the DigitalTwinsInstance.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
digitalTwinsCreate:
{
Description: The DigitalTwinsInstance and security metadata. ,
Required: True ,
}
{
properties:
{
Description: DigitalTwins instance properties. ,
Required: False ,
}
{
createdTime:
{
Description: Time when DigitalTwinsInstance was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Time when DigitalTwinsInstance was updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Api endpoint to work with DigitalTwinsInstance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: DigitalTwins instance properties. ,
Required: False ,
}
{
createdTime:
{
Description: Time when DigitalTwinsInstance was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Time when DigitalTwinsInstance was updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Api endpoint to work with DigitalTwinsInstance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: DigitalTwins instance properties. ,
Required: False ,
}
{
createdTime:
{
Description: Time when DigitalTwinsInstance was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Time when DigitalTwinsInstance was updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Api endpoint to work with DigitalTwinsInstance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DigitalTwins_Update (new)
Description :  Update metadata of DigitalTwinsInstance.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
digitalTwinsPatchDescription:
{
Description: The DigitalTwinsInstance and security metadata. ,
Required: True ,
}
{
tags:
{
Description: Instance patch properties ,
Required: False ,
}
object ,
identity:
{
Description: The managed identity for the DigitalTwinsInstance. ,
Required: False ,
}
{
type:
{
Description: The type of Managed Identity used by the DigitalTwinsInstance. Only SystemAssigned is supported. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties for the DigitalTwinsInstance. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: DigitalTwins instance properties. ,
Required: False ,
}
{
createdTime:
{
Description: Time when DigitalTwinsInstance was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Time when DigitalTwinsInstance was updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Api endpoint to work with DigitalTwinsInstance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: DigitalTwins instance properties. ,
Required: False ,
}
{
createdTime:
{
Description: Time when DigitalTwinsInstance was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Time when DigitalTwinsInstance was updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Api endpoint to work with DigitalTwinsInstance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DigitalTwins_Delete (new)
Description :  Delete a DigitalTwinsInstance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DigitalTwins instance properties. ,
Required: False ,
}
{
createdTime:
{
Description: Time when DigitalTwinsInstance was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Time when DigitalTwinsInstance was updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Api endpoint to work with DigitalTwinsInstance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: DigitalTwins instance properties. ,
Required: False ,
}
{
createdTime:
{
Description: Time when DigitalTwinsInstance was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Time when DigitalTwinsInstance was updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Api endpoint to work with DigitalTwinsInstance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DigitalTwinsEndpoint_List (new)
Description :  Get DigitalTwinsInstance Endpoints.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of DigitalTwinsInstance Endpoints. ,
Required: False ,
}
string ,
value:
{
Description: A list of DigitalTwinsInstance Endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: DigitalTwinsInstance endpoint resource properties. ,
Required: True ,
}
{
endpointType:
{
Description: The type of Digital Twins endpoint ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
ServiceBus: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Time when the Endpoint was added to DigitalTwinsInstance. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationType:
{
Description: Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. ,
Enum:
{
KeyBased: No description available. ,
IdentityBased: No description available. ,
}
,
Required: False ,
}
enum ,
deadLetterSecret:
{
Description: Dead letter storage secret for key-based authentication. Will be obfuscated during read. ,
Required: False ,
}
string ,
deadLetterUri:
{
Description: Dead letter storage URL for identity-based authentication. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DigitalTwinsEndpoint_Get (new)
Description :  Get DigitalTwinsInstances Endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of Endpoint Resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DigitalTwinsInstance endpoint resource properties. ,
Required: True ,
}
{
endpointType:
{
Description: The type of Digital Twins endpoint ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
ServiceBus: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Time when the Endpoint was added to DigitalTwinsInstance. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationType:
{
Description: Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. ,
Enum:
{
KeyBased: No description available. ,
IdentityBased: No description available. ,
}
,
Required: False ,
}
enum ,
deadLetterSecret:
{
Description: Dead letter storage secret for key-based authentication. Will be obfuscated during read. ,
Required: False ,
}
string ,
deadLetterUri:
{
Description: Dead letter storage URL for identity-based authentication. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DigitalTwinsEndpoint_CreateOrUpdate (new)
Description :  Create or update DigitalTwinsInstance endpoint.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of Endpoint Resource. ,
Required: True ,
}
string ,
endpointDescription:
{
Description: The DigitalTwinsInstance endpoint metadata and security metadata. ,
Required: True ,
}
{
properties:
{
Description: DigitalTwinsInstance endpoint resource properties. ,
Required: True ,
}
{
endpointType:
{
Description: The type of Digital Twins endpoint ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
ServiceBus: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Time when the Endpoint was added to DigitalTwinsInstance. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationType:
{
Description: Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. ,
Enum:
{
KeyBased: No description available. ,
IdentityBased: No description available. ,
}
,
Required: False ,
}
enum ,
deadLetterSecret:
{
Description: Dead letter storage secret for key-based authentication. Will be obfuscated during read. ,
Required: False ,
}
string ,
deadLetterUri:
{
Description: Dead letter storage URL for identity-based authentication. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: DigitalTwinsInstance endpoint resource properties. ,
Required: True ,
}
{
endpointType:
{
Description: The type of Digital Twins endpoint ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
ServiceBus: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Time when the Endpoint was added to DigitalTwinsInstance. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationType:
{
Description: Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. ,
Enum:
{
KeyBased: No description available. ,
IdentityBased: No description available. ,
}
,
Required: False ,
}
enum ,
deadLetterSecret:
{
Description: Dead letter storage secret for key-based authentication. Will be obfuscated during read. ,
Required: False ,
}
string ,
deadLetterUri:
{
Description: Dead letter storage URL for identity-based authentication. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: DigitalTwinsInstance endpoint resource properties. ,
Required: True ,
}
{
endpointType:
{
Description: The type of Digital Twins endpoint ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
ServiceBus: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Time when the Endpoint was added to DigitalTwinsInstance. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationType:
{
Description: Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. ,
Enum:
{
KeyBased: No description available. ,
IdentityBased: No description available. ,
}
,
Required: False ,
}
enum ,
deadLetterSecret:
{
Description: Dead letter storage secret for key-based authentication. Will be obfuscated during read. ,
Required: False ,
}
string ,
deadLetterUri:
{
Description: Dead letter storage URL for identity-based authentication. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DigitalTwinsEndpoint_Delete (new)
Description :  Delete a DigitalTwinsInstance endpoint.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of Endpoint Resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DigitalTwinsInstance endpoint resource properties. ,
Required: True ,
}
{
endpointType:
{
Description: The type of Digital Twins endpoint ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
ServiceBus: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Time when the Endpoint was added to DigitalTwinsInstance. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationType:
{
Description: Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. ,
Enum:
{
KeyBased: No description available. ,
IdentityBased: No description available. ,
}
,
Required: False ,
}
enum ,
deadLetterSecret:
{
Description: Dead letter storage secret for key-based authentication. Will be obfuscated during read. ,
Required: False ,
}
string ,
deadLetterUri:
{
Description: Dead letter storage URL for identity-based authentication. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: DigitalTwinsInstance endpoint resource properties. ,
Required: True ,
}
{
endpointType:
{
Description: The type of Digital Twins endpoint ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
ServiceBus: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Time when the Endpoint was added to DigitalTwinsInstance. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationType:
{
Description: Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. ,
Enum:
{
KeyBased: No description available. ,
IdentityBased: No description available. ,
}
,
Required: False ,
}
enum ,
deadLetterSecret:
{
Description: Dead letter storage secret for key-based authentication. Will be obfuscated during read. ,
Required: False ,
}
string ,
deadLetterUri:
{
Description: Dead letter storage URL for identity-based authentication. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DigitalTwins_List (new)
Description :  Get all the DigitalTwinsInstances in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/digitalTwinsInstances
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of DigitalTwins description objects. ,
Required: False ,
}
string ,
value:
{
Description: A list of DigitalTwins description objects. ,
Required: False ,
}
[
{
properties:
{
Description: DigitalTwins instance properties. ,
Required: False ,
}
{
createdTime:
{
Description: Time when DigitalTwinsInstance was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Time when DigitalTwinsInstance was updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Api endpoint to work with DigitalTwinsInstance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DigitalTwins_ListByResourceGroup (new)
Description :  Get all the DigitalTwinsInstances in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of DigitalTwins description objects. ,
Required: False ,
}
string ,
value:
{
Description: A list of DigitalTwins description objects. ,
Required: False ,
}
[
{
properties:
{
Description: DigitalTwins instance properties. ,
Required: False ,
}
{
createdTime:
{
Description: Time when DigitalTwinsInstance was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Time when DigitalTwinsInstance was updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Api endpoint to work with DigitalTwinsInstance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Operations_List (new)
Description :  Lists all of the available DigitalTwins service REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DigitalTwins/operations
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of DigitalTwins description objects. ,
Required: False ,
}
string ,
value:
{
Description: A list of DigitalTwins operations supported by the Microsoft.DigitalTwins resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{read | write | action | delete} ,
Required: False ,
}
string ,
display:
{
Description: Operation properties display ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft DigitalTwins. ,
Required: False ,
}
string ,
resource:
{
Description: Resource Type: DigitalTwinsInstances. ,
Required: False ,
}
string ,
operation:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
description:
{
Description: Friendly description for the operation. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation. ,
Required: False ,
}
string ,
isDataAction:
{
Description: If the operation is a data action (for data plane rbac). ,
Required: False ,
}
boolean ,
properties:
{
Description: Operation properties. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DigitalTwins_CheckNameAvailability (new)
Description :  Check if a DigitalTwinsInstance name is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/locations/{location}/checkNameAvailability
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
location:
{
Description: Location of DigitalTwinsInstance. ,
Required: True ,
}
string ,
digitalTwinsInstanceCheckName:
{
Description: Set the name parameter in the DigitalTwinsInstanceCheckName structure to the name of the DigitalTwinsInstance to check. ,
Required: True ,
}
{
name:
{
Description: Resource name. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource, for instance Microsoft.DigitalTwins/digitalTwinsInstances. ,
Enum:
{
Microsoft.DigitalTwins/digitalTwinsInstances: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Specifies a Boolean value that indicates if the name is available. ,
Required: False ,
}
boolean ,
message:
{
Description: Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated. ,
Required: False ,
}
string ,
reason:
{
Description: Message providing the reason why the given name is invalid. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateLinkResources_List (new)
Description :  List private link resources for given Digital Twin.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/privateLinkResources
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of available private link resources for a Digital Twin. ,
Required: False ,
}
[
{
properties:
{
Description: The group information properties. ,
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 ,
]
,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateLinkResources_Get (new)
Description :  Get the specified private link resource for the given Digital Twin.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/privateLinkResources/{resourceId}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceId:
{
Description: The name of the private link resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The group information properties. ,
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 ,
]
,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateEndpointConnections_List (new)
Description :  List private endpoint connection properties.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/privateEndpointConnections
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of available private link connections for a Digital Twin. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateEndpointConnections_Get (new)
Description :  Get private endpoint connection properties for the given private endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateEndpointConnections_Delete (new)
Description :  Delete private endpoint connection with the specified name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (new)
Description :  Update the status of a private endpoint connection with the given name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 (202)

{
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
TimeSeriesDatabaseConnections_List (new)
Description :  Get all existing time series database connections for this DigitalTwins instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/timeSeriesDatabaseConnections
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: A list of time series database connection resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a specific time series database connection. ,
Required: False ,
}
{
connectionType:
{
Description: The type of time series connection resource. ,
Enum:
{
AzureDataExplorer: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
TimeSeriesDatabaseConnections_Get (new)
Description :  Get the description of an existing time series database connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/timeSeriesDatabaseConnections/{timeSeriesDatabaseConnectionName}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
timeSeriesDatabaseConnectionName:
{
Description: Name of time series database connection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a specific time series database connection. ,
Required: False ,
}
{
connectionType:
{
Description: The type of time series connection resource. ,
Enum:
{
AzureDataExplorer: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
TimeSeriesDatabaseConnections_CreateOrUpdate (new)
Description :  Create or update a time series database connection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/timeSeriesDatabaseConnections/{timeSeriesDatabaseConnectionName}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
timeSeriesDatabaseConnectionName:
{
Description: Name of time series database connection. ,
Required: True ,
}
string ,
timeSeriesDatabaseConnectionDescription:
{
Description: The time series database connection description. ,
Required: True ,
}
{
properties:
{
Description: Properties of a specific time series database connection. ,
Required: False ,
}
{
connectionType:
{
Description: The type of time series connection resource. ,
Enum:
{
AzureDataExplorer: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a specific time series database connection. ,
Required: False ,
}
{
connectionType:
{
Description: The type of time series connection resource. ,
Enum:
{
AzureDataExplorer: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of a specific time series database connection. ,
Required: False ,
}
{
connectionType:
{
Description: The type of time series connection resource. ,
Enum:
{
AzureDataExplorer: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
TimeSeriesDatabaseConnections_Delete (new)
Description :  Delete a time series database connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/timeSeriesDatabaseConnections/{timeSeriesDatabaseConnectionName}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
timeSeriesDatabaseConnectionName:
{
Description: Name of time series database connection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a specific time series database connection. ,
Required: False ,
}
{
connectionType:
{
Description: The type of time series connection resource. ,
Enum:
{
AzureDataExplorer: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Properties of a specific time series database connection. ,
Required: False ,
}
{
connectionType:
{
Description: The type of time series connection resource. ,
Enum:
{
AzureDataExplorer: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DigitalTwinModels_Add (removed)
Description :  Uploads one or more models. When any error occurs, no models are uploaded. Status codes: * 201 Created * 400 Bad Request * DTDLParserError - The models provided are not valid DTDL. * InvalidArgument - The model id is invalid. * LimitExceeded - The maximum number of model ids allowed in 'dependenciesFor' has been reached. * ModelVersionNotSupported - The version of DTDL used is not supported. * 409 Conflict * ModelAlreadyExists - The model provided already exists.
Reference :  Link ¶

⚼ Request

POST:  /models
{
models:
{
Description: An array of models to add. ,
Required: False ,
}
object ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
displayName:
{
Description: A language map that contains the localized display names as specified in the model definition. ,
Required: False ,
}
object ,
description:
{
Description: A language map that contains the localized descriptions as specified in the model definition. ,
Required: False ,
}
object ,
id:
{
Description: The id of the model as specified in the model definition. ,
Required: True ,
}
string ,
uploadTime:
{
Description: The time the model was uploaded to the service. ,
Format: date-time ,
Required: False ,
}
string ,
decommissioned:
{
Description: Indicates if the model is decommissioned. Decommissioned models cannot be referenced by newly created digital twins. ,
Required: False ,
}
boolean ,
model:
{
Description: The model definition. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwinModels_List (removed)
Description :  Retrieves model metadata and, optionally, model definitions. Status codes: * 200 OK * 400 Bad Request * InvalidArgument - The model id is invalid. * LimitExceeded - The maximum number of model ids allowed in 'dependenciesFor' has been reached. * 404 Not Found * ModelNotFound - The model was not found.
Reference :  Link ¶

⚼ Request

GET:  /models
{
dependenciesFor:
{
Description: The set of the models which will have their dependencies retrieved. If omitted, all models are retrieved. ,
Required: False ,
}
array ,
includeModelDefinition:
{
Description: When true the model definition will be returned as part of the result. ,
Required: False ,
}
boolean ,
max-items-per-page:
{
Description: The maximum number of items to retrieve per request. The server may choose to return less than the requested number. ,
Required: False ,
}
integer ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DigitalTwinsModelData objects. ,
Required: False ,
}
[
{
displayName:
{
Description: A language map that contains the localized display names as specified in the model definition. ,
Required: False ,
}
object ,
description:
{
Description: A language map that contains the localized descriptions as specified in the model definition. ,
Required: False ,
}
object ,
id:
{
Description: The id of the model as specified in the model definition. ,
Required: True ,
}
string ,
uploadTime:
{
Description: The time the model was uploaded to the service. ,
Format: date-time ,
Required: False ,
}
string ,
decommissioned:
{
Description: Indicates if the model is decommissioned. Decommissioned models cannot be referenced by newly created digital twins. ,
Required: False ,
}
boolean ,
model:
{
Description: The model definition. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: A URI to retrieve the next page of objects. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwinModels_GetById (removed)
Description :  Retrieves model metadata and optionally the model definition. Status codes: * 200 OK * 400 Bad Request * InvalidArgument - The model id is invalid. * MissingArgument - The model id was not provided. * 404 Not Found * ModelNotFound - The model was not found.
Reference :  Link ¶

⚼ Request

GET:  /models/{id}
{
id:
{
Description: The id for the model. The id is globally unique and case sensitive. ,
Required: True ,
}
string ,
includeModelDefinition:
{
Description: When true the model definition will be returned as part of the result. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
displayName:
{
Description: A language map that contains the localized display names as specified in the model definition. ,
Required: False ,
}
object ,
description:
{
Description: A language map that contains the localized descriptions as specified in the model definition. ,
Required: False ,
}
object ,
id:
{
Description: The id of the model as specified in the model definition. ,
Required: True ,
}
string ,
uploadTime:
{
Description: The time the model was uploaded to the service. ,
Format: date-time ,
Required: False ,
}
string ,
decommissioned:
{
Description: Indicates if the model is decommissioned. Decommissioned models cannot be referenced by newly created digital twins. ,
Required: False ,
}
boolean ,
model:
{
Description: The model definition. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwinModels_Update (removed)
Description :  Updates the metadata for a model. Status codes: * 204 No Content * 400 Bad Request * InvalidArgument - The model id is invalid. * JsonPatchInvalid - The JSON Patch provided is invalid. * MissingArgument - The model id was not provided. * 404 Not Found * ModelNotFound - The model was not found. * 409 Conflict * ModelReferencesNotDecommissioned - The model refers to models that are not decommissioned.
Reference :  Link ¶

⚼ Request

PATCH:  /models/{id}
{
id:
{
Description: The id for the model. The id is globally unique and case sensitive. ,
Required: True ,
}
string ,
updateModel:
{
Description: An update specification described by JSON Patch. Only the decommissioned property can be replaced. ,
Required: True ,
}
object ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwinModels_Delete (removed)
Description :  Deletes a model. A model can only be deleted if no other models reference it. Status codes: * 204 No Content * 400 Bad Request * InvalidArgument - The model id is invalid. * MissingArgument - The model id was not provided. * 404 Not Found * ModelNotFound - The model was not found. * 409 Conflict * ModelReferencesNotDeleted - The model refers to models that are not deleted.
Reference :  Link ¶

⚼ Request

DELETE:  /models/{id}
{
id:
{
Description: The id for the model. The id is globally unique and case sensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
Query_QueryTwins (removed)
Description :  Executes a query that allows traversing relationships and filtering by property values. Status codes: * 200 OK * 400 Bad Request * BadRequest - The continuation token is invalid. * SqlQueryError - The query contains some errors. * TimeoutError - The query execution timed out after 60 seconds. Try simplifying the query or adding conditions to reduce the result size. * 429 Too Many Requests * QuotaReachedError - The maximum query rate limit has been reached.
Reference :  Link ¶

⚼ Request

POST:  /query
{
querySpecification:
{
Description: The query specification to execute. ,
Required: True ,
}
{
query:
{
Description: The query to execute. This value is ignored if a continuation token is provided. ,
Required: False ,
}
string ,
continuationToken:
{
Description: A token which is used to retrieve the next set of results from a previous query. ,
Required: False ,
}
string ,
}
,
max-items-per-page:
{
Description: The maximum number of items to retrieve per request. The server may choose to return less than the requested number. ,
Required: False ,
}
integer ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
query-charge:
{
Description: The query charge. ,
}
number ,
}
,
$schema:
{
Description: The results of a query operation and an optional continuation token. ,
}
{
value:
{
Description: The query results. ,
Required: False ,
}
[
object ,
]
,
continuationToken:
{
Description: A token which can be used to construct a new QuerySpecification to retrieve the next set of results. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_GetById (removed)
Description :  Retrieves a digital twin. Status codes: * 200 OK * 400 Bad Request * InvalidArgument - The digital twin id is invalid. * 404 Not Found * DigitalTwinNotFound - The digital twin was not found.
Reference :  Link ¶

⚼ Request

GET:  /digitaltwins/{id}
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Weak Etag. ,
}
string ,
}
,
$schema: object ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_Add (removed)
Description :  Adds or replaces a digital twin. Status codes: * 200 OK * 400 Bad Request * InvalidArgument - The digital twin id or payload is invalid. * ModelDecommissioned - The model for the digital twin is decommissioned. * TwinLimitReached - The maximum number of digital twins allowed has been reached. * ValidationFailed - The digital twin payload is not valid. * 412 Precondition Failed * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.
Reference :  Link ¶

⚼ Request

PUT:  /digitaltwins/{id}
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
twin:
{
Description: The digital twin instance being added. If provided, the $dtId property is ignored. ,
Required: True ,
}
object ,
If-None-Match:
{
Description: Only perform the operation if the entity does not already exist. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Weak Etag. ,
}
string ,
}
,
$schema: object ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_Delete (removed)
Description :  Delete a DigitalTwinsInstance.
Reference :  Link ¶

⚼ Request

DELETE:  /digitaltwins/{id}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DigitalTwins instance properties. ,
Required: False ,
}
{
createdTime:
{
Description: Time when DigitalTwinsInstance was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Time when DigitalTwinsInstance was updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Api endpoint to work with DigitalTwinsInstance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: DigitalTwins instance properties. ,
Required: False ,
}
{
createdTime:
{
Description: Time when DigitalTwinsInstance was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Time when DigitalTwinsInstance was updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Api endpoint to work with DigitalTwinsInstance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DigitalTwins_Update (removed)
Description :  Update metadata of DigitalTwinsInstance.
Reference :  Link ¶

⚼ Request

PATCH:  /digitaltwins/{id}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
digitalTwinsPatchDescription:
{
Description: The DigitalTwinsInstance and security metadata. ,
Required: True ,
}
{
tags:
{
Description: Instance patch properties ,
Required: False ,
}
object ,
identity:
{
Description: The managed identity for the DigitalTwinsInstance. ,
Required: False ,
}
{
type:
{
Description: The type of Managed Identity used by the DigitalTwinsInstance. Only SystemAssigned is supported. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties for the DigitalTwinsInstance. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: DigitalTwins instance properties. ,
Required: False ,
}
{
createdTime:
{
Description: Time when DigitalTwinsInstance was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Time when DigitalTwinsInstance was updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Api endpoint to work with DigitalTwinsInstance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: DigitalTwins instance properties. ,
Required: False ,
}
{
createdTime:
{
Description: Time when DigitalTwinsInstance was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Time when DigitalTwinsInstance was updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Api endpoint to work with DigitalTwinsInstance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DigitalTwins_GetRelationshipById (removed)
Description :  Retrieves a relationship between two digital twins. Status codes: * 200 OK * 400 Bad Request * InvalidArgument - The digital twin id or relationship id is invalid. * 404 Not Found * DigitalTwinNotFound - The digital twin was not found. * RelationshipNotFound - The relationship was not found.
Reference :  Link ¶

⚼ Request

GET:  /digitaltwins/{id}/relationships/{relationshipId}
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
relationshipId:
{
Description: The id of the relationship. The id is unique within the digital twin and case sensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Weak Etag. ,
}
string ,
}
,
$schema: object ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_AddRelationship (removed)
Description :  Adds a relationship between two digital twins. Status codes: * 200 OK * 400 Bad Request * InvalidArgument - The digital twin id, relationship id, or payload is invalid. * InvalidRelationship - The relationship is invalid. * OperationNotAllowed - The relationship cannot connect to the same digital twin. * ValidationFailed - The relationship content is invalid. * 404 Not Found * DigitalTwinNotFound - The digital twin was not found. * TargetTwinNotFound - The digital twin target of the relationship was not found. * 412 Precondition Failed * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.
Reference :  Link ¶

⚼ Request

PUT:  /digitaltwins/{id}/relationships/{relationshipId}
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
relationshipId:
{
Description: The id of the relationship. The id is unique within the digital twin and case sensitive. ,
Required: True ,
}
string ,
relationship:
{
Description: The data for the relationship. ,
Required: True ,
}
object ,
If-None-Match:
{
Description: Only perform the operation if the entity does not already exist. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Weak Etag. ,
}
string ,
}
,
$schema: object ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_DeleteRelationship (removed)
Description :  Deletes a relationship between two digital twins. Status codes: * 204 No Content * 400 Bad Request * InvalidArgument - The digital twin id or relationship id is invalid. * 404 Not Found * DigitalTwinNotFound - The digital twin was not found. * RelationshipNotFound - The relationship was not found. * 412 Precondition Failed * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.
Reference :  Link ¶

⚼ Request

DELETE:  /digitaltwins/{id}/relationships/{relationshipId}
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
relationshipId:
{
Description: The id of the relationship. The id is unique within the digital twin and case sensitive. ,
Required: True ,
}
string ,
If-Match:
{
Description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_UpdateRelationship (removed)
Description :  Updates the properties on a relationship between two digital twins. Status codes: * 204 No Content * 400 Bad Request * InvalidArgument - The digital twin id or relationship id is invalid. * InvalidRelationship - The relationship is invalid. * JsonPatchInvalid - The JSON Patch provided is invalid. * ValidationFailed - The relationship content is invalid. * 404 Not Found * DigitalTwinNotFound - The digital twin was not found. * RelationshipNotFound - The relationship was not found. * 409 Conflict * RelationshipAlreadyExists - The relationship already exists. * 412 Precondition Failed * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.
Reference :  Link ¶

⚼ Request

PATCH:  /digitaltwins/{id}/relationships/{relationshipId}
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
relationshipId:
{
Description: The id of the relationship. The id is unique within the digital twin and case sensitive. ,
Required: True ,
}
string ,
patchDocument:
{
Description: JSON Patch description of the update to the relationship properties. ,
Required: True ,
}
object ,
If-Match:
{
Description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{
etag:
{
Description: Weak Etag. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_ListRelationships (removed)
Description :  Retrieves the relationships from a digital twin. Status codes: * 200 OK * 400 Bad Request * InvalidArgument - The digital twin id is invalid. * 404 Not Found * DigitalTwinNotFound - The digital twin was not found.
Reference :  Link ¶

⚼ Request

GET:  /digitaltwins/{id}/relationships
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
relationshipName:
{
Description: The name of the relationship. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The relationship objects. ,
Required: False ,
}
[
object ,
]
,
nextLink:
{
Description: A URI to retrieve the next page of objects. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_ListIncomingRelationships (removed)
Description :  Retrieves all incoming relationship for a digital twin. Status codes: * 200 OK * 400 Bad Request * InvalidArgument - The digital twin id is invalid. * 404 Not Found * DigitalTwinNotFound - The digital twin was not found.
Reference :  Link ¶

⚼ Request

GET:  /digitaltwins/{id}/incomingrelationships
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
$relationshipId:
{
Description: A user-provided string representing the id of this relationship, unique in the context of the source digital twin, i.e. sourceId + relationshipId is unique in the context of the service. ,
Required: False ,
}
string ,
$sourceId:
{
Description: The id of the source digital twin. ,
Required: False ,
}
string ,
$relationshipName:
{
Description: The name of the relationship. ,
Required: False ,
}
string ,
$relationshipLink:
{
Description: Link to the relationship, to be used for deletion. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: A URI to retrieve the next page of objects. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_SendTelemetry (removed)
Description :  Sends telemetry on behalf of a digital twin. Status codes: * 204 No Content * 400 Bad Request * InvalidArgument - The digital twin id or message id is invalid. * ValidationFailed - The telemetry content is invalid. * 404 Not Found * DigitalTwinNotFound - The digital twin was not found.
Reference :  Link ¶

⚼ Request

POST:  /digitaltwins/{id}/telemetry
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
telemetry:
{
Description: The telemetry measurements to send from the digital twin. ,
Required: True ,
}
object ,
Message-Id:
{
Description: A unique message identifier (in the scope of the digital twin id) that is commonly used for de-duplicating messages. ,
Required: True ,
}
string ,
Telemetry-Source-Time:
{
Description: An RFC 3339 timestamp that identifies the time the telemetry was measured. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_SendComponentTelemetry (removed)
Description :  Sends telemetry on behalf of a component in a digital twin. Status codes: * 204 No Content * 400 Bad Request * InvalidArgument - The digital twin id, message id, or component path is invalid. * ValidationFailed - The telemetry content is invalid. * 404 Not Found * DigitalTwinNotFound - The digital twin was not found. * ComponentNotFound - The component path was not found.
Reference :  Link ¶

⚼ Request

POST:  /digitaltwins/{id}/components/{componentPath}/telemetry
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
componentPath:
{
Description: The name of the DTDL component. ,
Required: True ,
}
string ,
telemetry:
{
Description: The telemetry measurements to send from the digital twin's component. ,
Required: True ,
}
object ,
Message-Id:
{
Description: A unique message identifier (in the scope of the digital twin id) that is commonly used for de-duplicating messages. ,
Required: True ,
}
string ,
Telemetry-Source-Time:
{
Description: An RFC 3339 timestamp that identifies the time the telemetry was measured. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_GetComponent (removed)
Description :  Retrieves a component from a digital twin. Status codes: * 200 OK * 400 Bad Request * InvalidArgument - The digital twin id or component path is invalid. * 404 Not Found * DigitalTwinNotFound - The digital twin was not found. * ComponentNotFound - The component path was not found.
Reference :  Link ¶

⚼ Request

GET:  /digitaltwins/{id}/components/{componentPath}
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
componentPath:
{
Description: The name of the DTDL component. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Weak Etag. ,
}
string ,
}
,
$schema: object ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_UpdateComponent (removed)
Description :  Updates a component on a digital twin. Status codes: * 204 No Content * 400 Bad Request * InvalidArgument - The digital twin id, component path, or payload is invalid. * JsonPatchInvalid - The JSON Patch provided is invalid. * ValidationFailed - Applying the patch results in an invalid digital twin. * 404 Not Found * DigitalTwinNotFound - The digital twin was not found. * 412 Precondition Failed * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.
Reference :  Link ¶

⚼ Request

PATCH:  /digitaltwins/{id}/components/{componentPath}
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
componentPath:
{
Description: The name of the DTDL component. ,
Required: True ,
}
string ,
patchDocument:
{
Description: An update specification described by JSON Patch. Updates to property values and $model elements may happen in the same request. Operations are limited to add, replace and remove. ,
Required: True ,
}
object ,
If-Match:
{
Description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{
etag:
{
Description: Weak Etag. ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
EventRoutes_List (removed)
Description :  Retrieves all event routes. Status codes: * 200 OK
Reference :  Link ¶

⚼ Request

GET:  /eventroutes
{
max-items-per-page:
{
Description: The maximum number of items to retrieve per request. The server may choose to return less than the requested number. ,
Required: False ,
}
integer ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EventRoute objects. ,
Required: False ,
}
[
{
id:
{
Description: The id of the event route. ,
Required: False ,
}
string ,
endpointName:
{
Description: The name of the endpoint this event route is bound to. ,
Required: True ,
}
string ,
filter:
{
Description: An expression which describes the events which are routed to the endpoint. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: A URI to retrieve the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
EventRoutes_GetById (removed)
Description :  Retrieves an event route. Status codes: * 200 OK * 404 Not Found * EventRouteNotFound - The event route was not found.
Reference :  Link ¶

⚼ Request

GET:  /eventroutes/{id}
{
id:
{
Description: The id for an event route. The id is unique within event routes and case sensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the event route. ,
Required: False ,
}
string ,
endpointName:
{
Description: The name of the endpoint this event route is bound to. ,
Required: True ,
}
string ,
filter:
{
Description: An expression which describes the events which are routed to the endpoint. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
EventRoutes_Add (removed)
Description :  Adds or replaces an event route. Status codes: * 204 No Content * 400 Bad Request * EventRouteEndpointInvalid - The endpoint provided does not exist or is not active. * EventRouteFilterInvalid - The event route filter is invalid. * EventRouteIdInvalid - The event route id is invalid. * LimitExceeded - The maximum number of event routes allowed has been reached.
Reference :  Link ¶

⚼ Request

PUT:  /eventroutes/{id}
{
id:
{
Description: The id for an event route. The id is unique within event routes and case sensitive. ,
Required: True ,
}
string ,
eventRoute:
{
Description: The event route data ,
Required: False ,
}
{
id:
{
Description: The id of the event route. ,
Required: False ,
}
string ,
endpointName:
{
Description: The name of the endpoint this event route is bound to. ,
Required: True ,
}
string ,
filter:
{
Description: An expression which describes the events which are routed to the endpoint. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
EventRoutes_Delete (removed)
Description :  Deletes an event route. Status codes: * 204 No Content * 404 Not Found * EventRouteNotFound - The event route was not found.
Reference :  Link ¶

⚼ Request

DELETE:  /eventroutes/{id}
{
id:
{
Description: The id for an event route. The id is unique within event routes and case sensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_Get (removed)
Description :  Get DigitalTwinsInstances resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DigitalTwins instance properties. ,
Required: False ,
}
{
createdTime:
{
Description: Time when DigitalTwinsInstance was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Time when DigitalTwinsInstance was updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Api endpoint to work with DigitalTwinsInstance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DigitalTwins_CreateOrUpdate (removed)
Description :  Create or update the metadata of a DigitalTwinsInstance. The usual pattern to modify a property is to retrieve the DigitalTwinsInstance and security metadata, and then combine them with the modified values in a new body to update the DigitalTwinsInstance.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
digitalTwinsCreate:
{
Description: The DigitalTwinsInstance and security metadata. ,
Required: True ,
}
{
properties:
{
Description: DigitalTwins instance properties. ,
Required: False ,
}
{
createdTime:
{
Description: Time when DigitalTwinsInstance was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Time when DigitalTwinsInstance was updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Api endpoint to work with DigitalTwinsInstance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: DigitalTwins instance properties. ,
Required: False ,
}
{
createdTime:
{
Description: Time when DigitalTwinsInstance was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Time when DigitalTwinsInstance was updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Api endpoint to work with DigitalTwinsInstance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: DigitalTwins instance properties. ,
Required: False ,
}
{
createdTime:
{
Description: Time when DigitalTwinsInstance was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Time when DigitalTwinsInstance was updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Api endpoint to work with DigitalTwinsInstance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DigitalTwins_Update (removed)
Description :  Update metadata of DigitalTwinsInstance.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
digitalTwinsPatchDescription:
{
Description: The DigitalTwinsInstance and security metadata. ,
Required: True ,
}
{
tags:
{
Description: Instance patch properties ,
Required: False ,
}
object ,
identity:
{
Description: The managed identity for the DigitalTwinsInstance. ,
Required: False ,
}
{
type:
{
Description: The type of Managed Identity used by the DigitalTwinsInstance. Only SystemAssigned is supported. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties for the DigitalTwinsInstance. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: DigitalTwins instance properties. ,
Required: False ,
}
{
createdTime:
{
Description: Time when DigitalTwinsInstance was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Time when DigitalTwinsInstance was updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Api endpoint to work with DigitalTwinsInstance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: DigitalTwins instance properties. ,
Required: False ,
}
{
createdTime:
{
Description: Time when DigitalTwinsInstance was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Time when DigitalTwinsInstance was updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Api endpoint to work with DigitalTwinsInstance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DigitalTwins_Delete (removed)
Description :  Delete a DigitalTwinsInstance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DigitalTwins instance properties. ,
Required: False ,
}
{
createdTime:
{
Description: Time when DigitalTwinsInstance was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Time when DigitalTwinsInstance was updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Api endpoint to work with DigitalTwinsInstance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: DigitalTwins instance properties. ,
Required: False ,
}
{
createdTime:
{
Description: Time when DigitalTwinsInstance was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Time when DigitalTwinsInstance was updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Api endpoint to work with DigitalTwinsInstance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DigitalTwinsEndpoint_List (removed)
Description :  Get DigitalTwinsInstance Endpoints.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of DigitalTwinsInstance Endpoints. ,
Required: False ,
}
string ,
value:
{
Description: A list of DigitalTwinsInstance Endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: DigitalTwinsInstance endpoint resource properties. ,
Required: True ,
}
{
endpointType:
{
Description: The type of Digital Twins endpoint ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
ServiceBus: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Time when the Endpoint was added to DigitalTwinsInstance. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationType:
{
Description: Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. ,
Enum:
{
KeyBased: No description available. ,
IdentityBased: No description available. ,
}
,
Required: False ,
}
enum ,
deadLetterSecret:
{
Description: Dead letter storage secret for key-based authentication. Will be obfuscated during read. ,
Required: False ,
}
string ,
deadLetterUri:
{
Description: Dead letter storage URL for identity-based authentication. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DigitalTwinsEndpoint_Get (removed)
Description :  Get DigitalTwinsInstances Endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of Endpoint Resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DigitalTwinsInstance endpoint resource properties. ,
Required: True ,
}
{
endpointType:
{
Description: The type of Digital Twins endpoint ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
ServiceBus: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Time when the Endpoint was added to DigitalTwinsInstance. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationType:
{
Description: Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. ,
Enum:
{
KeyBased: No description available. ,
IdentityBased: No description available. ,
}
,
Required: False ,
}
enum ,
deadLetterSecret:
{
Description: Dead letter storage secret for key-based authentication. Will be obfuscated during read. ,
Required: False ,
}
string ,
deadLetterUri:
{
Description: Dead letter storage URL for identity-based authentication. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DigitalTwinsEndpoint_CreateOrUpdate (removed)
Description :  Create or update DigitalTwinsInstance endpoint.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of Endpoint Resource. ,
Required: True ,
}
string ,
endpointDescription:
{
Description: The DigitalTwinsInstance endpoint metadata and security metadata. ,
Required: True ,
}
{
properties:
{
Description: DigitalTwinsInstance endpoint resource properties. ,
Required: True ,
}
{
endpointType:
{
Description: The type of Digital Twins endpoint ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
ServiceBus: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Time when the Endpoint was added to DigitalTwinsInstance. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationType:
{
Description: Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. ,
Enum:
{
KeyBased: No description available. ,
IdentityBased: No description available. ,
}
,
Required: False ,
}
enum ,
deadLetterSecret:
{
Description: Dead letter storage secret for key-based authentication. Will be obfuscated during read. ,
Required: False ,
}
string ,
deadLetterUri:
{
Description: Dead letter storage URL for identity-based authentication. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: DigitalTwinsInstance endpoint resource properties. ,
Required: True ,
}
{
endpointType:
{
Description: The type of Digital Twins endpoint ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
ServiceBus: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Time when the Endpoint was added to DigitalTwinsInstance. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationType:
{
Description: Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. ,
Enum:
{
KeyBased: No description available. ,
IdentityBased: No description available. ,
}
,
Required: False ,
}
enum ,
deadLetterSecret:
{
Description: Dead letter storage secret for key-based authentication. Will be obfuscated during read. ,
Required: False ,
}
string ,
deadLetterUri:
{
Description: Dead letter storage URL for identity-based authentication. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: DigitalTwinsInstance endpoint resource properties. ,
Required: True ,
}
{
endpointType:
{
Description: The type of Digital Twins endpoint ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
ServiceBus: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Time when the Endpoint was added to DigitalTwinsInstance. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationType:
{
Description: Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. ,
Enum:
{
KeyBased: No description available. ,
IdentityBased: No description available. ,
}
,
Required: False ,
}
enum ,
deadLetterSecret:
{
Description: Dead letter storage secret for key-based authentication. Will be obfuscated during read. ,
Required: False ,
}
string ,
deadLetterUri:
{
Description: Dead letter storage URL for identity-based authentication. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DigitalTwinsEndpoint_Delete (removed)
Description :  Delete a DigitalTwinsInstance endpoint.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of Endpoint Resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DigitalTwinsInstance endpoint resource properties. ,
Required: True ,
}
{
endpointType:
{
Description: The type of Digital Twins endpoint ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
ServiceBus: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Time when the Endpoint was added to DigitalTwinsInstance. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationType:
{
Description: Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. ,
Enum:
{
KeyBased: No description available. ,
IdentityBased: No description available. ,
}
,
Required: False ,
}
enum ,
deadLetterSecret:
{
Description: Dead letter storage secret for key-based authentication. Will be obfuscated during read. ,
Required: False ,
}
string ,
deadLetterUri:
{
Description: Dead letter storage URL for identity-based authentication. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: DigitalTwinsInstance endpoint resource properties. ,
Required: True ,
}
{
endpointType:
{
Description: The type of Digital Twins endpoint ,
Enum:
{
EventHub: No description available. ,
EventGrid: No description available. ,
ServiceBus: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Time when the Endpoint was added to DigitalTwinsInstance. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationType:
{
Description: Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. ,
Enum:
{
KeyBased: No description available. ,
IdentityBased: No description available. ,
}
,
Required: False ,
}
enum ,
deadLetterSecret:
{
Description: Dead letter storage secret for key-based authentication. Will be obfuscated during read. ,
Required: False ,
}
string ,
deadLetterUri:
{
Description: Dead letter storage URL for identity-based authentication. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DigitalTwins_List (removed)
Description :  Get all the DigitalTwinsInstances in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/digitalTwinsInstances
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of DigitalTwins description objects. ,
Required: False ,
}
string ,
value:
{
Description: A list of DigitalTwins description objects. ,
Required: False ,
}
[
{
properties:
{
Description: DigitalTwins instance properties. ,
Required: False ,
}
{
createdTime:
{
Description: Time when DigitalTwinsInstance was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Time when DigitalTwinsInstance was updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Api endpoint to work with DigitalTwinsInstance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DigitalTwins_ListByResourceGroup (removed)
Description :  Get all the DigitalTwinsInstances in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of DigitalTwins description objects. ,
Required: False ,
}
string ,
value:
{
Description: A list of DigitalTwins description objects. ,
Required: False ,
}
[
{
properties:
{
Description: DigitalTwins instance properties. ,
Required: False ,
}
{
createdTime:
{
Description: Time when DigitalTwinsInstance was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Time when DigitalTwinsInstance was updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Api endpoint to work with DigitalTwinsInstance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public network access for the DigitalTwinsInstance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Operations_List (removed)
Description :  Lists all of the available DigitalTwins service REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DigitalTwins/operations
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of DigitalTwins description objects. ,
Required: False ,
}
string ,
value:
{
Description: A list of DigitalTwins operations supported by the Microsoft.DigitalTwins resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{read | write | action | delete} ,
Required: False ,
}
string ,
display:
{
Description: Operation properties display ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft DigitalTwins. ,
Required: False ,
}
string ,
resource:
{
Description: Resource Type: DigitalTwinsInstances. ,
Required: False ,
}
string ,
operation:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
description:
{
Description: Friendly description for the operation. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation. ,
Required: False ,
}
string ,
isDataAction:
{
Description: If the operation is a data action (for data plane rbac). ,
Required: False ,
}
boolean ,
properties:
{
Description: Operation properties. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DigitalTwins_CheckNameAvailability (removed)
Description :  Check if a DigitalTwinsInstance name is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/locations/{location}/checkNameAvailability
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
location:
{
Description: Location of DigitalTwinsInstance. ,
Required: True ,
}
string ,
digitalTwinsInstanceCheckName:
{
Description: Set the name parameter in the DigitalTwinsInstanceCheckName structure to the name of the DigitalTwinsInstance to check. ,
Required: True ,
}
{
name:
{
Description: Resource name. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource, for instance Microsoft.DigitalTwins/digitalTwinsInstances. ,
Enum:
{
Microsoft.DigitalTwins/digitalTwinsInstances: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Specifies a Boolean value that indicates if the name is available. ,
Required: False ,
}
boolean ,
message:
{
Description: Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated. ,
Required: False ,
}
string ,
reason:
{
Description: Message providing the reason why the given name is invalid. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateLinkResources_List (removed)
Description :  List private link resources for given Digital Twin.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/privateLinkResources
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of available private link resources for a Digital Twin. ,
Required: False ,
}
[
{
properties:
{
Description: The group information properties. ,
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 ,
]
,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateLinkResources_Get (removed)
Description :  Get the specified private link resource for the given Digital Twin.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/privateLinkResources/{resourceId}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceId:
{
Description: The name of the private link resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The group information properties. ,
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 ,
]
,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateEndpointConnections_List (removed)
Description :  List private endpoint connection properties.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/privateEndpointConnections
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of available private link connections for a Digital Twin. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateEndpointConnections_Get (removed)
Description :  Get private endpoint connection properties for the given private endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateEndpointConnections_Delete (removed)
Description :  Delete private endpoint connection with the specified name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (removed)
Description :  Update the status of a private endpoint connection with the given name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 (202)

{
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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 connection properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The list of group ids for the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the private endpoint connection. ,
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)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
TimeSeriesDatabaseConnections_List (removed)
Description :  Get all existing time series database connections for this DigitalTwins instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/timeSeriesDatabaseConnections
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: A list of time series database connection resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a specific time series database connection. ,
Required: False ,
}
{
connectionType:
{
Description: The type of time series connection resource. ,
Enum:
{
AzureDataExplorer: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
TimeSeriesDatabaseConnections_Get (removed)
Description :  Get the description of an existing time series database connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/timeSeriesDatabaseConnections/{timeSeriesDatabaseConnectionName}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
timeSeriesDatabaseConnectionName:
{
Description: Name of time series database connection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a specific time series database connection. ,
Required: False ,
}
{
connectionType:
{
Description: The type of time series connection resource. ,
Enum:
{
AzureDataExplorer: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
TimeSeriesDatabaseConnections_CreateOrUpdate (removed)
Description :  Create or update a time series database connection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/timeSeriesDatabaseConnections/{timeSeriesDatabaseConnectionName}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
timeSeriesDatabaseConnectionName:
{
Description: Name of time series database connection. ,
Required: True ,
}
string ,
timeSeriesDatabaseConnectionDescription:
{
Description: The time series database connection description. ,
Required: True ,
}
{
properties:
{
Description: Properties of a specific time series database connection. ,
Required: False ,
}
{
connectionType:
{
Description: The type of time series connection resource. ,
Enum:
{
AzureDataExplorer: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a specific time series database connection. ,
Required: False ,
}
{
connectionType:
{
Description: The type of time series connection resource. ,
Enum:
{
AzureDataExplorer: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of a specific time series database connection. ,
Required: False ,
}
{
connectionType:
{
Description: The type of time series connection resource. ,
Enum:
{
AzureDataExplorer: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
TimeSeriesDatabaseConnections_Delete (removed)
Description :  Delete a time series database connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/timeSeriesDatabaseConnections/{timeSeriesDatabaseConnectionName}
{
api-version:
{
Description: Version of the DigitalTwinsInstance Management API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the DigitalTwinsInstance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the DigitalTwinsInstance. ,
Required: True ,
}
string ,
timeSeriesDatabaseConnectionName:
{
Description: Name of time series database connection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a specific time series database connection. ,
Required: False ,
}
{
connectionType:
{
Description: The type of time series connection resource. ,
Enum:
{
AzureDataExplorer: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Properties of a specific time series database connection. ,
Required: False ,
}
{
connectionType:
{
Description: The type of time series connection resource. ,
Enum:
{
AzureDataExplorer: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
Suspending: No description available. ,
Restoring: No description available. ,
Moving: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error description ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}