通过

Endpoints - DigitalTwinsEndpoint Delete

Service:
Reference
API Version:
2023-01-31

Delete a DigitalTwinsInstance endpoint.

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

URI Parameters

Name In Required Type Description
endpointName
 path True

string

Name of Endpoint Resource.
resourceGroupName
 path True

string

The name of the resource group that contains the DigitalTwinsInstance.
resourceName
 path True

string

The name of the DigitalTwinsInstance.
subscriptionId
 path True

string

The subscription identifier.
api-version
 query True

string

Version of the DigitalTwinsInstance Management API.

Responses

Name Type Description
200 OK

DigitalTwinsEndpointResource

Returned if the operation was canceled or failed.
202 Accepted

DigitalTwinsEndpointResource

Accepted - Delete request accepted; the operation will complete asynchronously.
204 No Content

Returned when the long running delete operation has finished, or the egress endpoint 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 endpoint
Delete a DigitalTwinsInstance endpoint with identity

Delete a DigitalTwinsInstance endpoint

Sample request

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

Sample response

Status code:
200 
{
  "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/endpoints/myServiceBus",
  "type": "Microsoft.DigitalTwins/digitalTwinsInstances/endpoints",
  "name": "myendpoint",
  "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": {
    "authenticationType": "KeyBased",
    "endpointType": "ServiceBus",
    "provisioningState": "Failed",
    "primaryConnectionString": "Endpoint=sb://***/;SharedAccessKeyName=***;SharedAccessKey=***;EntityPath=***",
    "secondaryConnectionString": "Endpoint=sb://***/;SharedAccessKeyName=***;SharedAccessKey=***;EntityPath=***",
    "createdTime": "2019-11-19T01:10:34.350Z"
  }
}
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/endpoints/myServiceBus",
  "type": "Microsoft.DigitalTwins/digitalTwinsInstances/endpoints",
  "name": "myendpoint",
  "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": {
    "authenticationType": "KeyBased",
    "endpointType": "ServiceBus",
    "provisioningState": "Deleting",
    "primaryConnectionString": "Endpoint=sb://***/;SharedAccessKeyName=***;SharedAccessKey=***;EntityPath=***",
    "secondaryConnectionString": "Endpoint=sb://***/;SharedAccessKeyName=***;SharedAccessKey=***;EntityPath=***",
    "createdTime": "2019-11-19T01:10:34.350Z"
  }
}
Status code:
204

Delete a DigitalTwinsInstance endpoint with identity

Sample request

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

Sample response

Status code:
200 
{
  "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/endpoints/myServiceBus",
  "type": "Microsoft.DigitalTwins/digitalTwinsInstances/endpoints",
  "name": "myendpoint",
  "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": {
    "endpointType": "ServiceBus",
    "authenticationType": "KeyBased",
    "provisioningState": "Failed",
    "endpointUri": "sb://mysb.servicebus.windows.net/",
    "entityPath": "mysbtopic",
    "createdTime": "2019-11-19T01:10:34.350Z"
  }
}
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/endpoints/myServiceBus",
  "type": "Microsoft.DigitalTwins/digitalTwinsInstances/endpoints",
  "name": "myendpoint",
  "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": {
    "endpointType": "ServiceBus",
    "authenticationType": "IdentityBased",
    "provisioningState": "Deleting",
    "endpointUri": "sb://mysb.servicebus.windows.net/",
    "entityPath": "mysbtopic",
    "createdTime": "2019-11-19T01:10:34.350Z"
  }
}
Status code:
204

Definitions

Name Description
AuthenticationType

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.
createdByType

The type of identity that created the resource.
DigitalTwinsEndpointResource

DigitalTwinsInstance endpoint resource.
EndpointProvisioningState

The provisioning state.
ErrorDefinition

Error definition.
ErrorResponse

Error response.
EventGrid

Properties related to EventGrid.
EventHub

Properties related to EventHub.
IdentityType

The type of managed identity used.
ManagedIdentityReference

The properties of the Managed Identity.
ServiceBus

Properties related to ServiceBus.
SystemData

Metadata pertaining to creation and last modification of the resource.

AuthenticationType

Enumeration

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.

Value Description
IdentityBased
KeyBased

createdByType

Enumeration

The type of identity that created the resource.

Value Description
Application
Key
ManagedIdentity
User

DigitalTwinsEndpointResource

Object

DigitalTwinsInstance endpoint resource.

Name Type Description
id

string

The resource identifier.
name

string

Extension resource name.
properties DigitalTwinsEndpointResourceProperties:

DigitalTwinsInstance endpoint resource properties.
systemData

SystemData

Metadata pertaining to creation and last modification of the resource.
type

string

The resource type.

EndpointProvisioningState

Enumeration

The provisioning state.

Value Description
Canceled
Deleted
Deleting
Disabled
Failed
Moving
Provisioning
Restoring
Succeeded
Suspending
Updating
Warning

ErrorDefinition

Object

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

Object

Error response.

Name Type Description
error

ErrorDefinition

Error description

EventGrid

Object

Properties related to EventGrid.

Name Type Description
TopicEndpoint

string

EventGrid Topic Endpoint.
accessKey1

string

EventGrid secondary accesskey. Will be obfuscated during read.
accessKey2

string

EventGrid secondary accesskey. Will be obfuscated during read.
authenticationType

AuthenticationType

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.
createdTime

string

Time when the Endpoint was added to DigitalTwinsInstance.
deadLetterSecret

string

Dead letter storage secret for key-based authentication. Will be obfuscated during read.
deadLetterUri

string

Dead letter storage URL for identity-based authentication.
endpointType string:

EventGrid

The type of Digital Twins endpoint
identity

ManagedIdentityReference

Managed identity properties for the endpoint.
provisioningState

EndpointProvisioningState

The provisioning state.

EventHub

Object

Properties related to EventHub.

Name Type Description
authenticationType

AuthenticationType

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.
connectionStringPrimaryKey

string

PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
connectionStringSecondaryKey

string

SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
createdTime

string

Time when the Endpoint was added to DigitalTwinsInstance.
deadLetterSecret

string

Dead letter storage secret for key-based authentication. Will be obfuscated during read.
deadLetterUri

string

Dead letter storage URL for identity-based authentication.
endpointType string:

EventHub

The type of Digital Twins endpoint
endpointUri

string

The URL of the EventHub namespace for identity-based authentication. It must include the protocol 'sb://'.
entityPath

string

The EventHub name in the EventHub namespace for identity-based authentication.
identity

ManagedIdentityReference

Managed identity properties for the endpoint.
provisioningState

EndpointProvisioningState

The provisioning state.

IdentityType

Enumeration

The type of managed identity used.

Value Description
SystemAssigned
UserAssigned

ManagedIdentityReference

Object

The properties of the Managed Identity.

Name Type Description
type

IdentityType

The type of managed identity used.
userAssignedIdentity

string

The user identity ARM resource id if the managed identity type is 'UserAssigned'.

ServiceBus

Object

Properties related to ServiceBus.

Name Type Description
authenticationType

AuthenticationType

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.
createdTime

string

Time when the Endpoint was added to DigitalTwinsInstance.
deadLetterSecret

string

Dead letter storage secret for key-based authentication. Will be obfuscated during read.
deadLetterUri

string

Dead letter storage URL for identity-based authentication.
endpointType string:

ServiceBus

The type of Digital Twins endpoint
endpointUri

string

The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol 'sb://'.
entityPath

string

The ServiceBus Topic name for identity-based authentication.
identity

ManagedIdentityReference

Managed identity properties for the endpoint.
primaryConnectionString

string

PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
provisioningState

EndpointProvisioningState

The provisioning state.
secondaryConnectionString

string

SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.

SystemData

Object

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.