TimeSeriesDatabaseConnectionResource.DeleteAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
DeleteAsync(WaitUntil, CancellationToken) |
Delete a time series database connection.
|
DeleteAsync(WaitUntil, Nullable<CleanupConnectionArtifact>, CancellationToken) |
Delete a time series database connection.
|
DeleteAsync(WaitUntil, CancellationToken)
Delete a time series database connection.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/timeSeriesDatabaseConnections/{timeSeriesDatabaseConnectionName}
- Operation Id: TimeSeriesDatabaseConnections_Delete
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.DigitalTwins.TimeSeriesDatabaseConnectionResource>> DeleteAsync (Azure.WaitUntil waitUntil, System.Threading.CancellationToken cancellationToken);
abstract member DeleteAsync : Azure.WaitUntil * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.DigitalTwins.TimeSeriesDatabaseConnectionResource>>
override this.DeleteAsync : Azure.WaitUntil * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.DigitalTwins.TimeSeriesDatabaseConnectionResource>>
Public Overridable Function DeleteAsync (waitUntil As WaitUntil, cancellationToken As CancellationToken) As Task(Of ArmOperation(Of TimeSeriesDatabaseConnectionResource))
Parameters
- waitUntil
- WaitUntil
Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Applies to
DeleteAsync(WaitUntil, Nullable<CleanupConnectionArtifact>, CancellationToken)
Delete a time series database connection.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/timeSeriesDatabaseConnections/{timeSeriesDatabaseConnectionName}
- Operation Id: TimeSeriesDatabaseConnections_Delete
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.DigitalTwins.TimeSeriesDatabaseConnectionResource>> DeleteAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.DigitalTwins.Models.CleanupConnectionArtifact? cleanupConnectionArtifacts = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteAsync : Azure.WaitUntil * Nullable<Azure.ResourceManager.DigitalTwins.Models.CleanupConnectionArtifact> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.DigitalTwins.TimeSeriesDatabaseConnectionResource>>
override this.DeleteAsync : Azure.WaitUntil * Nullable<Azure.ResourceManager.DigitalTwins.Models.CleanupConnectionArtifact> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.DigitalTwins.TimeSeriesDatabaseConnectionResource>>
Public Overridable Function DeleteAsync (waitUntil As WaitUntil, Optional cleanupConnectionArtifacts As Nullable(Of CleanupConnectionArtifact) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of TimeSeriesDatabaseConnectionResource))
Parameters
- waitUntil
- WaitUntil
Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.
- cleanupConnectionArtifacts
- Nullable<CleanupConnectionArtifact>
Specifies whether or not to attempt to clean up artifacts that were created in order to establish a connection to the time series database. This is a best-effort attempt that will fail if appropriate permissions are not in place. Setting this to 'true' does not delete any recorded data.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Applies to
Azure SDK for .NET