FabricClient.PropertyManagementClient.NameExistsAsync Method

Definition

Namespace:

System.Fabric

Assembly:

System.Fabric.dll

Package:

Microsoft.ServiceFabric v9.1.1833

Overloads

NameExistsAsync(Uri, TimeSpan, CancellationToken)	Returns true if the specified Service Fabric name exists.
NameExistsAsync(Uri)	Returns true if the specified Service Fabric name exists.

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

Task<Boolean>

A task that represents the asynchronous operation.

true if the specified Service Fabric name exists; otherwise, false.

Exceptions

ArgumentException

Caused by one of the following:

E_INVALIDARG is returned when one or more arguments are not valid.

ArgumentNullException

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.

OperationCanceledException

Caused by one of the following:

E_ABORT is returned when operation was aborted.

TimeoutException

See https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

FabricException

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.

COMException

This exception is thrown when an internal error has occurred.

Remarks

Timeout for the operation will be set to default timeout (1 minute).

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

Task<Boolean>

A task that represents the asynchronous operation.

true if the specified Service Fabric name exists; otherwise, false.

Exceptions

ArgumentException

Caused by one of the following:

E_INVALIDARG is returned when one or more arguments are not valid.

ArgumentNullException

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.

OperationCanceledException

Caused by one of the following:

E_ABORT is returned when operation was aborted.

FabricObjectClosedException

See https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

TimeoutException

See https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

FabricException

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.

COMException

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.