Endpoints - DigitalTwinsEndpoint Delete

Référence

Service:: Azure Digital Twins

API Version:: 2023-01-31

Supprimez un point de terminaison DigitalTwinsInstance.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpointName	path	True	string	Nom de la ressource de point de terminaison. Regex pattern: `^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient digitalTwinsInstance.
resourceName	path	True	string	Nom du DigitalTwinsInstance. Regex pattern: `^(?!-)[A-Za-z0-9-]{3,63}(?<!-)$`
subscriptionId	path	True	string	Identificateur de l’abonnement.
api-version	query	True	string	Version de l’API gestion DigitalTwinsInstance.

Réponses

Nom	Type	Description
200 OK	DigitalTwinsEndpointResource	Retourné si l’opération a été annulée ou a échoué.
202 Accepted	DigitalTwinsEndpointResource	Accepté - Demande de suppression acceptée ; l’opération se termine de manière asynchrone.
204 No Content		Retourné lorsque l’opération de suppression de longue durée est terminée ou que le point de terminaison de sortie n’existe pas.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Delete a DigitalTwinsInstance endpoint

Delete a DigitalTwinsInstance endpoint with identity

Delete a DigitalTwinsInstance endpoint

Sample Request

HTTP

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

Response Body

{
  "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

HTTP

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

Response Body

{
  "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

Définitions

Nom	Description
AuthenticationType	Spécifie le type d’authentification utilisé pour la connexion au point de terminaison. La valeur par défaut est « KeyBased ». Si 'KeyBased' est sélectionné, une chaîne de connexion doit être spécifiée (au moins la chaîne de connexion principale). Si « IdentityBased » est sélectionné, les propriétés endpointUri et entityPath doivent être spécifiées.
createdByType	Type d’identité qui a créé la ressource.
DigitalTwinsEndpointResource	Ressource de point de terminaison DigitalTwinsInstance.
EndpointProvisioningState	État d’approvisionnement.
ErrorDefinition	Définition de l’erreur.
ErrorResponse	Réponse d’erreur.
EventGrid	Propriétés liées à EventGrid.
EventHub	Propriétés liées à EventHub.
IdentityType	Type d’identité managée utilisée.
ManagedIdentityReference	Propriétés de l’identité managée.
ServiceBus	Propriétés liées à ServiceBus.
SystemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

AuthenticationType

Spécifie le type d’authentification utilisé pour la connexion au point de terminaison. La valeur par défaut est « KeyBased ». Si 'KeyBased' est sélectionné, une chaîne de connexion doit être spécifiée (au moins la chaîne de connexion principale). Si « IdentityBased » est sélectionné, les propriétés endpointUri et entityPath doivent être spécifiées.

Nom	Type	Description
IdentityBased	string
KeyBased	string

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DigitalTwinsEndpointResource

Ressource de point de terminaison DigitalTwinsInstance.

Nom	Type	Description
id	string	Identificateur de ressource.
name	string	Nom de la ressource d’extension.
properties	DigitalTwinsEndpointResourceProperties: EventGrid EventHub ServiceBus	Propriétés de ressource de point de terminaison DigitalTwinsInstance.
systemData	SystemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
type	string	Type de ressource.

EndpointProvisioningState

État d’approvisionnement.

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

ErrorDefinition

Définition de l’erreur.

Nom	Type	Description
code	string	Code d’erreur spécifique au service qui sert de sous-état pour le code d’erreur HTTP.
details	ErrorDefinition[]	Détails de l’erreur interne.
message	string	Description de l'erreur.

ErrorResponse

Réponse d’erreur.

Nom	Type	Description
error	ErrorDefinition	Description de l'erreur

EventGrid

Propriétés liées à EventGrid.

Nom	Type	Description
TopicEndpoint	string	Point de terminaison de rubrique EventGrid.
accessKey1	string	Clé d’accès secondaire EventGrid. Sera masqué pendant la lecture.
accessKey2	string	Clé d’accès secondaire EventGrid. Sera masqué pendant la lecture.
authenticationType	AuthenticationType	Spécifie le type d’authentification utilisé pour la connexion au point de terminaison. La valeur par défaut est « KeyBased ». Si 'KeyBased' est sélectionné, une chaîne de connexion doit être spécifiée (au moins la chaîne de connexion principale). Si « IdentityBased » est sélectionné, les propriétés endpointUri et entityPath doivent être spécifiées.
createdTime	string	Heure à laquelle le point de terminaison a été ajouté à DigitalTwinsInstance.
deadLetterSecret	string	Secret de stockage de lettres mortes pour l’authentification basée sur la clé. Sera masqué pendant la lecture.
deadLetterUri	string	URL de stockage de lettres mortes pour l’authentification basée sur l’identité.
endpointType	string: EventGrid	Type de point de terminaison Digital Twins
identity	ManagedIdentityReference	Propriétés d’identité managée pour le point de terminaison.
provisioningState	EndpointProvisioningState	État d’approvisionnement.

EventHub

Propriétés liées à EventHub.

Nom	Type	Description
authenticationType	AuthenticationType	Spécifie le type d’authentification utilisé pour la connexion au point de terminaison. La valeur par défaut est « KeyBased ». Si 'KeyBased' est sélectionné, une chaîne de connexion doit être spécifiée (au moins la chaîne de connexion principale). Si « IdentityBased » est sélectionné, les propriétés endpointUri et entityPath doivent être spécifiées.
connectionStringPrimaryKey	string	PrimaryConnectionString du point de terminaison pour l’authentification basée sur les clés. Sera masqué pendant la lecture.
connectionStringSecondaryKey	string	SecondaryConnectionString du point de terminaison pour l’authentification basée sur les clés. Sera masqué pendant la lecture.
createdTime	string	Heure à laquelle le point de terminaison a été ajouté à DigitalTwinsInstance.
deadLetterSecret	string	Secret de stockage de lettres mortes pour l’authentification basée sur la clé. Sera masqué pendant la lecture.
deadLetterUri	string	URL de stockage de lettres mortes pour l’authentification basée sur l’identité.
endpointType	string: EventHub	Type de point de terminaison Digital Twins
endpointUri	string	URL de l’espace de noms EventHub pour l’authentification basée sur l’identité. Il doit inclure le protocole « sb:// ».
entityPath	string	Nom EventHub dans l’espace de noms EventHub pour l’authentification basée sur l’identité.
identity	ManagedIdentityReference	Propriétés d’identité managée pour le point de terminaison.
provisioningState	EndpointProvisioningState	État d’approvisionnement.

IdentityType

Type d’identité managée utilisée.

Nom	Type	Description
SystemAssigned	string
UserAssigned	string

ManagedIdentityReference

Propriétés de l’identité managée.

Nom	Type	Description
type	IdentityType	Type d’identité managée utilisée.
userAssignedIdentity	string	ID de ressource ARM d’identité utilisateur si le type d’identité managée est « UserAssigned ».

ServiceBus

Propriétés liées à ServiceBus.

Nom	Type	Description
authenticationType	AuthenticationType	Spécifie le type d’authentification utilisé pour la connexion au point de terminaison. La valeur par défaut est « KeyBased ». Si 'KeyBased' est sélectionné, une chaîne de connexion doit être spécifiée (au moins la chaîne de connexion principale). Si « IdentityBased » est sélectionné, les propriétés endpointUri et entityPath doivent être spécifiées.
createdTime	string	Heure à laquelle le point de terminaison a été ajouté à DigitalTwinsInstance.
deadLetterSecret	string	Secret de stockage de lettres mortes pour l’authentification basée sur la clé. Sera masqué pendant la lecture.
deadLetterUri	string	URL de stockage de lettres mortes pour l’authentification basée sur l’identité.
endpointType	string: ServiceBus	Type de point de terminaison Digital Twins
endpointUri	string	URL de l’espace de noms ServiceBus pour l’authentification basée sur l’identité. Il doit inclure le protocole « sb:// ».
entityPath	string	Nom de la rubrique ServiceBus pour l’authentification basée sur l’identité.
identity	ManagedIdentityReference	Propriétés d’identité managée pour le point de terminaison.
primaryConnectionString	string	PrimaryConnectionString du point de terminaison pour l’authentification basée sur les clés. Sera masqué pendant la lecture.
provisioningState	EndpointProvisioningState	État d’approvisionnement.
secondaryConnectionString	string	SecondaryConnectionString du point de terminaison pour l’authentification basée sur les clés. Sera masqué pendant la lecture.

SystemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la dernière ressource.
lastModifiedByType	createdByType	Type d’identité qui a modifié la dernière ressource.

Partager via

Endpoints - DigitalTwinsEndpoint Delete

Paramètres URI

Réponses

Sécurité

azure_auth

Scopes

Exemples

Delete a DigitalTwinsInstance endpoint

Sample Request

Sample Response

Delete a DigitalTwinsInstance endpoint with identity

Sample Request

Sample Response

Définitions

AuthenticationType

createdByType

DigitalTwinsEndpointResource

EndpointProvisioningState

ErrorDefinition

ErrorResponse

EventGrid

EventHub

IdentityType

ManagedIdentityReference

ServiceBus

SystemData

Commentaires

Commentaires

Ressources supplémentaires