FabricClient.PropertyManagementClient.NameExistsAsync 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
| NameExistsAsync(Uri, TimeSpan, CancellationToken) |
Returns |
| NameExistsAsync(Uri) |
Returns |
NameExistsAsync(Uri, TimeSpan, CancellationToken)
Returns true if the specified Service Fabric name exists.
public System.Threading.Tasks.Task<bool> NameExistsAsync (Uri name, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);member this.NameExistsAsync : Uri * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>Public Function NameExistsAsync (name As Uri, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of Boolean)Parameters
- name
- Uri
The Service Fabric name.
- timeout
- TimeSpan
The maximum amount of time the system will allow this operation to continue before returning TimeoutException.
- cancellationToken
- CancellationToken
The 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 operation.
true if the specified Service Fabric name exists; otherwise, false.
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:
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.
Caused by one of the following:
InvalidNameUri is returned when name 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
NameExistsAsync(Uri)
Returns true if the specified Service Fabric name exists.
public System.Threading.Tasks.Task<bool> NameExistsAsync (Uri name);member this.NameExistsAsync : Uri -> System.Threading.Tasks.Task<bool>Public Function NameExistsAsync (name As Uri) As Task(Of Boolean)Parameters
- name
- Uri
The Service Fabric name.
Returns
A task that represents the asynchronous operation.
true if the specified Service Fabric name exists; otherwise, false.
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:
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 name 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).
GetClusterHealthAsync(ClusterHealthQueryDescription) is the one way of verifying the cluster is up and FabricClient can connect to the cluster.
Applies to
Azure SDK for .NET