FabricClient.PropertyManagementClient.DeletePropertyAsync 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
| DeletePropertyAsync(Uri, String) |
Deletes the specified Service Fabric property. |
| DeletePropertyAsync(Uri, String, TimeSpan, CancellationToken) |
Deletes the specified Service Fabric property. |
DeletePropertyAsync(Uri, String)
Deletes the specified Service Fabric property.
public System.Threading.Tasks.Task DeletePropertyAsync (Uri parentName, string propertyName);member this.DeletePropertyAsync : Uri * string -> System.Threading.Tasks.TaskPublic Function DeletePropertyAsync (parentName As Uri, propertyName As String) As TaskParameters
- parentName
- Uri
The parent Service Fabric name of the property.
- propertyName
- String
The name of the Service Fabric property.
Returns
A task that represents the asynchronous delete operation.
Exceptions
Caused by one of the following:
E_INVALIDARG is returned when one or more arguments are not valid.
Caused by one of the following:
E_POINTER is returned when a null reference is passed to a method that does not accept it as a valid argument.
Caused by one of the following:
NameNotFound is returned when the user provided parentName does not exist.
PropertyNotFound is returned when the specified Property does not exist.
Caused by one of the following:
WriteConflict is returned when this write operation conflicts with another write operation.
Caused by one of the following:
E_ABORT is returned when operation was aborted.
See https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.
See https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.
Caused by one of the following:
InvalidNameUri is returned when parentName is not a valid Service Fabric name.
See also https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.
This exception is thrown when an internal error has occurred.
Remarks
Timeout for the operation will be set to default timeout (1 minute).
Applies to
DeletePropertyAsync(Uri, String, TimeSpan, CancellationToken)
Deletes the specified Service Fabric property.
public System.Threading.Tasks.Task DeletePropertyAsync (Uri parentName, string propertyName, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);member this.DeletePropertyAsync : Uri * string * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Function DeletePropertyAsync (parentName As Uri, propertyName As String, timeout As TimeSpan, cancellationToken As CancellationToken) As TaskParameters
- parentName
- Uri
URI defines the parent Service Fabric name of the property.
- propertyName
- String
String defines the name of the Service Fabric property.
- timeout
- TimeSpan
TimeSpan defines the maximum amount of time the system will allow this operation to continue before returning TimeoutException.
- cancellationToken
- CancellationToken
CancellationToken that the operation is observing. It can be used to propagate notification that the operation should be canceled.
Returns
A task that represents the asynchronous delete operation.
Exceptions
Caused by one of the following:
E_INVALIDARG is returned when one or more arguments are not valid.
Caused by one of the following:
E_POINTER is returned when a null reference is passed to a method that does not accept it as a valid argument.
Caused by one of the following:
NameNotFound is returned when the user provided parentName does not exist.
PropertyNotFound is returned when the specified Property does not exist.
Caused by one of the following:
WriteConflict is returned when this write operation conflicts with another write operation.
Caused by one of the following:
E_ABORT is returned when operation was aborted.
See https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.
See https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.
Caused by one of the following:
InvalidNameUri is returned when parentName is not a valid Service Fabric name.
See also https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.
This exception is thrown when an internal error has occurred.
Remarks
Timeout for the operation will be set to default timeout (1 minute).
Applies to
Azure SDK for .NET