Microsoft.DigitalTwins (stable:2022-10-31)

2025/10/23 • 22 new, 22 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. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: 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 ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. . ,
Required: False ,
}
object ,
}
,
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. ,
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. ,
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 ,
identity:
{
Description: Managed identity properties for the endpoint. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
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. ,
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. ,
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 ,
identity:
{
Description: Managed identity properties for the endpoint. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
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. ,
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. ,
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 ,
identity:
{
Description: Managed identity properties for the endpoint. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
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. ,
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. ,
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 ,
identity:
{
Description: Managed identity properties for the endpoint. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
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. ,
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. ,
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 ,
identity:
{
Description: Managed identity properties for the endpoint. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
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. ,
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. ,
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 ,
identity:
{
Description: Managed identity properties for the endpoint. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
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. ,
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. ,
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 ,
identity:
{
Description: Managed identity properties for the endpoint. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
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. ,
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. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Managed identity properties for the time series database connection resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
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_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. ,
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. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Managed identity properties for the time series database connection resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
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_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. ,
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. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Managed identity properties for the time series database connection resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
Required: False ,
}
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. ,
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. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Managed identity properties for the time series database connection resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ 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. ,
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. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Managed identity properties for the time series database connection resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
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_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. ,
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. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Managed identity properties for the time series database connection resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ 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. ,
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. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Managed identity properties for the time series database connection resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
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_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. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: 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 ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. . ,
Required: False ,
}
object ,
}
,
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. ,
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. ,
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 ,
identity:
{
Description: Managed identity properties for the endpoint. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
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. ,
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. ,
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 ,
identity:
{
Description: Managed identity properties for the endpoint. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
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. ,
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. ,
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 ,
identity:
{
Description: Managed identity properties for the endpoint. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
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. ,
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. ,
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 ,
identity:
{
Description: Managed identity properties for the endpoint. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
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. ,
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. ,
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 ,
identity:
{
Description: Managed identity properties for the endpoint. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
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. ,
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. ,
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 ,
identity:
{
Description: Managed identity properties for the endpoint. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
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. ,
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. ,
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 ,
identity:
{
Description: Managed identity properties for the endpoint. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
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. ,
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. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Managed identity properties for the time series database connection resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
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_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. ,
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. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Managed identity properties for the time series database connection resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
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_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. ,
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. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Managed identity properties for the time series database connection resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
Required: False ,
}
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. ,
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. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Managed identity properties for the time series database connection resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ 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. ,
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. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Managed identity properties for the time series database connection resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
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_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. ,
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. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Managed identity properties for the time series database connection resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ 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. ,
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. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Managed identity properties for the time series database connection resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity ARM resource id if the managed identity type is 'UserAssigned'. ,
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 ,
]
,
}
,
}