Delen via


Time Series Database Connections - Delete

Een verbinding met een tijdreeksdatabase verwijderen.

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

URI-parameters

Name In Vereist Type Description
resourceGroupName
path True

string

De naam van de resourcegroep die de DigitalTwinsInstance bevat.

resourceName
path True

string

De naam van de DigitalTwinsInstance.

Regex pattern: ^(?!-)[A-Za-z0-9-]{3,63}(?<!-)$

subscriptionId
path True

string

De abonnements-id.

timeSeriesDatabaseConnectionName
path True

string

Naam van tijdreeksdatabaseverbinding.

Regex pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$

api-version
query True

string

Versie van de DigitalTwinsInstance Management-API.

cleanupConnectionArtifacts
query

cleanupConnectionArtifacts

Hiermee geeft u op of moet worden geprobeerd om artefacten op te schonen die zijn gemaakt om een verbinding met de tijdreeksdatabase tot stand te brengen. Dit is een poging tot best effort die mislukt als de juiste machtigingen niet aanwezig zijn. Als u dit instelt op 'true', worden er geen opgenomen gegevens verwijderd.

Antwoorden

Name Type Description
200 OK

TimeSeriesDatabaseConnection

Wordt geretourneerd als de bewerking is geannuleerd of mislukt.

202 Accepted

TimeSeriesDatabaseConnection

Geaccepteerd - Aanvraag voor verwijderen geaccepteerd; de bewerking wordt asynchroon voltooid.

204 No Content

Wordt geretourneerd wanneer de langdurige verwijderbewerking is voltooid of wanneer de tijdreeksdatabaseverbinding niet bestaat.

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Scopes

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

Delete a time series database connection for a DigitalTwins instance.

Sample Request

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

Sample Response

{
  "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/timeSeriesDatabaseConnections/myConnection",
  "type": "Microsoft.DigitalTwins/digitalTwinsInstances/timeSeriesDatabaseConnections",
  "name": "myConnection",
  "properties": {
    "connectionType": "AzureDataExplorer",
    "provisioningState": "Failed",
    "adxEndpointUri": "https://mycluster.kusto.windows.net",
    "adxResourceId": "/subscriptions/c493073e-2460-45ba-a403-f3e0df1e9feg/resourceGroups/testrg/providers/Microsoft.Kusto/clusters/mycluster",
    "adxDatabaseName": "myDatabase",
    "eventHubEndpointUri": "sb://myeh.servicebus.windows.net/",
    "eventHubEntityPath": "myeh",
    "eventHubConsumerGroup": "$Default",
    "eventHubNamespaceResourceId": "/subscriptions/c493073e-2460-45ba-a403-f3e0df1e9feg/resourceGroups/testrg/providers/Microsoft.EventHub/namespaces/myeh"
  }
}
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/timeSeriesDatabaseConnections/myConnection",
  "type": "Microsoft.DigitalTwins/digitalTwinsInstances/timeSeriesDatabaseConnections",
  "name": "myConnection",
  "properties": {
    "connectionType": "AzureDataExplorer",
    "provisioningState": "Deleting",
    "adxEndpointUri": "https://mycluster.kusto.windows.net",
    "adxResourceId": "/subscriptions/c493073e-2460-45ba-a403-f3e0df1e9feg/resourceGroups/testrg/providers/Microsoft.Kusto/clusters/mycluster",
    "adxDatabaseName": "myDatabase",
    "adxTableName": "myTable",
    "eventHubEndpointUri": "sb://myeh.servicebus.windows.net/",
    "eventHubEntityPath": "myeh",
    "eventHubConsumerGroup": "$Default",
    "eventHubNamespaceResourceId": "/subscriptions/c493073e-2460-45ba-a403-f3e0df1e9feg/resourceGroups/testrg/providers/Microsoft.EventHub/namespaces/myeh"
  }
}

Definities

Name Description
AzureDataExplorerConnectionProperties

Eigenschappen van een tijdreeksdatabaseverbinding met Azure Data Explorer waarbij gegevens worden verzonden via een EventHub.

cleanupConnectionArtifacts

Hiermee geeft u op of moet worden geprobeerd om artefacten op te schonen die zijn gemaakt om een verbinding met de tijdreeksdatabase tot stand te brengen. Dit is een poging tot best effort die mislukt als de juiste machtigingen niet aanwezig zijn. Als u dit instelt op 'true', worden er geen opgenomen gegevens verwijderd.

createdByType

Het type identiteit waarmee de resource is gemaakt.

ErrorDefinition

Foutdefinitie.

ErrorResponse

Foutreactie.

IdentityType

Het type beheerde identiteit dat wordt gebruikt.

ManagedIdentityReference

De eigenschappen van de beheerde identiteit.

recordPropertyAndItemRemovals

Hiermee geeft u op of het verwijderen van eigenschappen en items van dubbels/relaties moet worden vastgelegd, inclusief verwijderingen van geïndexeerde of sleutelwaarden (zoals toewijzingsvermeldingen, matrixelementen, enzovoort). Deze functie wordt gedeactiveerd, tenzij deze expliciet is ingesteld op 'true'. Als u deze eigenschap instelt op 'true', wordt er een extra kolom gegenereerd in de tabel met eigenschapsgebeurtenissen in ADX.

SystemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

TimeSeriesDatabaseConnection

Beschrijft een verbindingsresource voor een tijdreeksdatabase.

TimeSeriesDatabaseConnectionState

De inrichtingsstatus.

AzureDataExplorerConnectionProperties

Eigenschappen van een tijdreeksdatabaseverbinding met Azure Data Explorer waarbij gegevens worden verzonden via een EventHub.

Name Type Standaardwaarde Description
adxDatabaseName

string

De naam van de Azure Data Explorer-database.

adxEndpointUri

string

De URI van het Azure Data Explorer-eindpunt.

adxRelationshipLifecycleEventsTableName

string

De naam van de Azure Data Explorer tabel die wordt gebruikt voor het vastleggen van levenscyclus-gebeurtenissen voor relaties. De tabel wordt niet gemaakt als deze eigenschap niet is opgegeven.

adxResourceId

string

De resource-id van het Azure Data Explorer-cluster.

adxTableName

string

AdtPropertyEvents

De naam van de Azure Data Explorer tabel die wordt gebruikt voor het opslaan van updates voor eigenschappen van tweelingen en relaties. De standaardinstelling is AdtPropertyEvents.

adxTwinLifecycleEventsTableName

string

De naam van de Azure Data Explorer tabel die wordt gebruikt voor het vastleggen van levenscyclus-gebeurtenissen van dubbels. De tabel wordt niet gemaakt als deze eigenschap niet is opgegeven.

connectionType string:

AzureDataExplorer

Het type tijdreeksverbindingsresource.

eventHubConsumerGroup

string

$Default

De EventHub-consumentengroep die moet worden gebruikt wanneer ADX leest uit EventHub. De standaardinstelling is $Default.

eventHubEndpointUri

string

De URL van de EventHub-naamruimte voor verificatie op basis van identiteit. Deze moet het protocol bevatten sb://

eventHubEntityPath

string

De EventHub-naam in de EventHub-naamruimte voor verificatie op basis van identiteit.

eventHubNamespaceResourceId

string

De resource-id van de EventHub-naamruimte.

identity

ManagedIdentityReference

Eigenschappen van beheerde identiteit voor de verbindingsresource van de tijdreeksdatabase.

provisioningState

TimeSeriesDatabaseConnectionState

De inrichtingsstatus.

recordPropertyAndItemRemovals

recordPropertyAndItemRemovals

false

Hiermee geeft u op of het verwijderen van eigenschappen en items van dubbels/relaties moet worden vastgelegd, inclusief verwijderingen van geïndexeerde of sleutelwaarden (zoals toewijzingsvermeldingen, matrixelementen, enzovoort). Deze functie wordt gedeactiveerd, tenzij deze expliciet is ingesteld op 'true'. Als u deze eigenschap instelt op 'true', wordt er een extra kolom gegenereerd in de tabel met eigenschapsgebeurtenissen in ADX.

cleanupConnectionArtifacts

Hiermee geeft u op of moet worden geprobeerd om artefacten op te schonen die zijn gemaakt om een verbinding met de tijdreeksdatabase tot stand te brengen. Dit is een poging tot best effort die mislukt als de juiste machtigingen niet aanwezig zijn. Als u dit instelt op 'true', worden er geen opgenomen gegevens verwijderd.

Name Type Description
false

string

true

string

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDefinition

Foutdefinitie.

Name Type Description
code

string

Servicespecifieke foutcode die fungeert als de substatus voor de HTTP-foutcode.

details

ErrorDefinition[]

Interne foutdetails.

message

string

Beschrijving van de fout.

ErrorResponse

Foutreactie.

Name Type Description
error

ErrorDefinition

Foutbeschrijving

IdentityType

Het type beheerde identiteit dat wordt gebruikt.

Name Type Description
SystemAssigned

string

UserAssigned

string

ManagedIdentityReference

De eigenschappen van de beheerde identiteit.

Name Type Description
type

IdentityType

Het type beheerde identiteit dat wordt gebruikt.

userAssignedIdentity

string

De ARM-resource-id van de gebruikersidentiteit als het type beheerde identiteit 'UserAssigned' is.

recordPropertyAndItemRemovals

Hiermee geeft u op of het verwijderen van eigenschappen en items van dubbels/relaties moet worden vastgelegd, inclusief verwijderingen van geïndexeerde of sleutelwaarden (zoals toewijzingsvermeldingen, matrixelementen, enzovoort). Deze functie wordt gedeactiveerd, tenzij deze expliciet is ingesteld op 'true'. Als u deze eigenschap instelt op 'true', wordt er een extra kolom gegenereerd in de tabel met eigenschapsgebeurtenissen in ADX.

Name Type Description
false

string

true

string

SystemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name Type Description
createdAt

string

De tijdstempel van het maken van resources (UTC).

createdBy

string

De identiteit die de resource heeft gemaakt.

createdByType

createdByType

Het type identiteit waarmee de resource is gemaakt.

lastModifiedAt

string

Het tijdstempel van de laatste wijziging van de resource (UTC)

lastModifiedBy

string

De identiteit die de resource het laatst heeft gewijzigd.

lastModifiedByType

createdByType

Het type identiteit dat de resource het laatst heeft gewijzigd.

TimeSeriesDatabaseConnection

Beschrijft een verbindingsresource voor een tijdreeksdatabase.

Name Type Description
id

string

De resource-id.

name

string

Naam van extensieresource.

properties TimeSeriesDatabaseConnectionProperties:

AzureDataExplorerConnectionProperties

Eigenschappen van een specifieke tijdreeksdatabaseverbinding.

systemData

SystemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

type

string

Het resourcetype.

TimeSeriesDatabaseConnectionState

De inrichtingsstatus.

Name 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