Digital Twins Instance - DigitalTwins Delete

Reference

Service:: Reference

API Version:: 2023-01-31

Delete a DigitalTwinsInstance.

DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}?api-version=2023-01-31

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group that contains the DigitalTwinsInstance.
resourceName	path	True	string	The name of the DigitalTwinsInstance. Regex pattern: `^(?!-)[A-Za-z0-9-]{3,63}(?<!-)$`
subscriptionId	path	True	string	The subscription identifier.
api-version	query	True	string	Version of the DigitalTwinsInstance Management API.

Responses

Name	Type	Description
200 OK	DigitalTwinsDescription	Returned if the operation was canceled or failed.
202 Accepted	DigitalTwinsDescription	Accepted - Delete request accepted; the operation will complete asynchronously.
204 No Content		Returned when the long running delete operation has finished, or the Digital Twins instance does not exist.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Impersonate your user account

Examples

Delete a DigitalTwinsInstance resource

Delete a DigitalTwinsInstance resource with identity

Delete a DigitalTwinsInstance resource

Sample request

HTTP

DELETE https://management.azure.com/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService?api-version=2023-01-31

Sample response

Status code:: 200

{
  "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService",
  "location": "westus2",
  "type": "Microsoft.DigitalTwins/digitalTwinsInstances",
  "name": "myDigitalTwinsService",
  "systemData": {
    "createdBy": "user@example.com",
    "createdByType": "User",
    "createdAt": "2021-03-11T17:13:59.4037715Z",
    "lastModifiedBy": "user@example.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-03-11T17:14:02.5281409Z"
  },
  "properties": {
    "createdTime": "2019-11-19T12:55:05.229Z",
    "lastUpdatedTime": "2019-12-06T12:21:58.610Z",
    "provisioningState": "Failed",
    "hostName": "https://myDigitalTwinsService.api.wus2.ss.azuredigitaltwins-test.net"
  }
}

Status code:: 202

azure-asyncoperation: https://management.azure.com/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/providers/Microsoft.DigitalTwins/locations/westus2/operationStatuses/12345678-1234-1234-123456789012
location: https://management.azure.com/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/providers/Microsoft.DigitalTwins/locations/westus2/operationResults/12345678-1234-1234-123456789012
retry-after: 10

{
  "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService",
  "location": "westus2",
  "type": "Microsoft.DigitalTwins/digitalTwinsInstances",
  "name": "myDigitalTwinsService",
  "systemData": {
    "createdBy": "user@example.com",
    "createdByType": "User",
    "createdAt": "2021-03-11T17:13:59.4037715Z",
    "lastModifiedBy": "user@example.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-03-11T17:14:02.5281409Z"
  },
  "properties": {
    "createdTime": "2019-11-19T12:55:05.229Z",
    "lastUpdatedTime": "2019-12-06T12:21:58.610Z",
    "provisioningState": "Deleting",
    "hostName": "https://myDigitalTwinsService.api.wus2.ss.azuredigitaltwins-test.net"
  }
}

Status code:: 204

Delete a DigitalTwinsInstance resource with identity

Sample request

HTTP

DELETE https://management.azure.com/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService?api-version=2023-01-31

Sample response

Status code:: 200

{
  "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService",
  "location": "westus2",
  "type": "Microsoft.DigitalTwins/digitalTwinsInstances",
  "name": "myDigitalTwinsService",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "544215a9-21d8-4fb5-8094-8efbcc311dd0",
    "tenantId": "544215a9-21d8-4fb5-8094-8efbcc311dd0"
  },
  "systemData": {
    "createdBy": "user@example.com",
    "createdByType": "User",
    "createdAt": "2021-03-11T17:13:59.4037715Z",
    "lastModifiedBy": "user@example.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-03-11T17:14:02.5281409Z"
  },
  "properties": {
    "createdTime": "2019-11-19T12:55:05.229Z",
    "lastUpdatedTime": "2019-12-06T12:21:58.610Z",
    "provisioningState": "Failed",
    "hostName": "https://myDigitalTwinsService.api.wus2.ss.azuredigitaltwins-test.net"
  }
}

Status code:: 202

azure-asyncoperation: https://management.azure.com/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/providers/Microsoft.DigitalTwins/locations/westus2/operationStatuses/12345678-1234-1234-123456789012
location: https://management.azure.com/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/providers/Microsoft.DigitalTwins/locations/westus2/operationResults/12345678-1234-1234-123456789012
retry-after: 10

{
  "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService",
  "location": "westus2",
  "type": "Microsoft.DigitalTwins/digitalTwinsInstances",
  "name": "myDigitalTwinsService",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "544215a9-21d8-4fb5-8094-8efbcc311dd0",
    "tenantId": "544215a9-21d8-4fb5-8094-8efbcc311dd0"
  },
  "systemData": {
    "createdBy": "user@example.com",
    "createdByType": "User",
    "createdAt": "2021-03-11T17:13:59.4037715Z",
    "lastModifiedBy": "user@example.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-03-11T17:14:02.5281409Z"
  },
  "properties": {
    "createdTime": "2019-11-19T12:55:05.229Z",
    "lastUpdatedTime": "2019-12-06T12:21:58.610Z",
    "provisioningState": "Deleting",
    "hostName": "https://myDigitalTwinsService.api.wus2.ss.azuredigitaltwins-test.net"
  }
}

Status code:: 204

Definitions

Name	Description
ConnectionProperties	The properties of a private endpoint connection.
ConnectionPropertiesProvisioningState	The provisioning state.
createdByType	The type of identity that created the resource.
DigitalTwinsDescription	The description of the DigitalTwins service.
DigitalTwinsIdentity	The managed identity for the DigitalTwinsInstance.
DigitalTwinsIdentityType	The type of Managed Identity used by the DigitalTwinsInstance.
ErrorDefinition	Error definition.
ErrorResponse	Error response.
PrivateEndpoint	The private endpoint property of a private endpoint connection.
PrivateEndpointConnection	The private endpoint connection of a Digital Twin.
PrivateLinkServiceConnectionState	The connection state.
PrivateLinkServiceConnectionStatus	The status of a private endpoint connection.
provisioningState	The provisioning state.
publicNetworkAccess	Public network access for the DigitalTwinsInstance.
SystemData	Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentity	The information about the user assigned identity.

ConnectionProperties

The properties of a private endpoint connection.

Name	Type	Description
groupIds	string[]	The list of group ids for the private endpoint connection.
privateEndpoint	PrivateEndpoint	The private endpoint.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	The connection state.
provisioningState	ConnectionPropertiesProvisioningState	The provisioning state.

ConnectionPropertiesProvisioningState

The provisioning state.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DigitalTwinsDescription

The description of the DigitalTwins service.

Name	Type	Description
id	string	The resource identifier.
identity	DigitalTwinsIdentity	The managed identity for the DigitalTwinsInstance.
location	string	The resource location.
name	string	The resource name.
properties.createdTime	string	Time when DigitalTwinsInstance was created.
properties.hostName	string	Api endpoint to work with DigitalTwinsInstance.
properties.lastUpdatedTime	string	Time when DigitalTwinsInstance was updated.
properties.privateEndpointConnections	PrivateEndpointConnection[]	The private endpoint connections.
properties.provisioningState	provisioningState	The provisioning state.
properties.publicNetworkAccess	publicNetworkAccess	Public network access for the DigitalTwinsInstance.
systemData	SystemData	Metadata pertaining to creation and last modification of the DigitalTwinsInstance.
tags	object	The resource tags.
type	string	The resource type.

DigitalTwinsIdentity

The managed identity for the DigitalTwinsInstance.

Name	Type	Description
principalId	string	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
tenantId	string	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
type	DigitalTwinsIdentityType	The type of Managed Identity used by the DigitalTwinsInstance.
userAssignedIdentities	<string, UserAssignedIdentity>	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}'. .

DigitalTwinsIdentityType

The type of Managed Identity used by the DigitalTwinsInstance.

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

ErrorDefinition

Error definition.

Name	Type	Description
code	string	Service specific error code which serves as the substatus for the HTTP error code.
details	ErrorDefinition[]	Internal error details.
message	string	Description of the error.

ErrorResponse

Error response.

Name	Type	Description
error	ErrorDefinition	Error description

PrivateEndpoint

The private endpoint property of a private endpoint connection.

Name	Type	Description
id	string	The resource identifier.

PrivateEndpointConnection

The private endpoint connection of a Digital Twin.

Name	Type	Description
id	string	The resource identifier.
name	string	The resource name.
properties	ConnectionProperties	The connection properties.
systemData	SystemData	Metadata pertaining to creation and last modification of the private endpoint connection.
type	string	The resource type.

PrivateLinkServiceConnectionState

The connection state.

Name	Type	Description
actionsRequired	string	Actions required for a private endpoint connection.
description	string	The description for the current state of a private endpoint connection.
status	PrivateLinkServiceConnectionStatus	The status of a private endpoint connection.

PrivateLinkServiceConnectionStatus

The status of a private endpoint connection.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

provisioningState

The provisioning state.

Name	Type	Description
Canceled	string
Deleted	string
Deleting	string
Failed	string
Moving	string
Provisioning	string
Restoring	string
Succeeded	string
Suspending	string
Updating	string
Warning	string

publicNetworkAccess

Public network access for the DigitalTwinsInstance.

Name	Type	Description
Disabled	string
Enabled	string

SystemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UserAssignedIdentity

The information about the user assigned identity.

Name	Type	Description
clientId	string	The client id of the User Assigned Identity Resource.
principalId	string	The object id of the User Assigned Identity Resource.

Megosztás a következőn keresztül:

Digital Twins Instance - DigitalTwins Delete

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Delete a DigitalTwinsInstance resource

Sample request

Sample response

Delete a DigitalTwinsInstance resource with identity

Sample request

Sample response

Definitions

ConnectionProperties

ConnectionPropertiesProvisioningState

createdByType

DigitalTwinsDescription

DigitalTwinsIdentity

DigitalTwinsIdentityType

ErrorDefinition

ErrorResponse

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

provisioningState

publicNetworkAccess

SystemData

UserAssignedIdentity

Visszajelzés

További források