FabricClient.PropertyManagementClient.GetPropertyMetadataAsync Method

Reference

Definition

Namespace:: System.Fabric

Assembly:: System.Fabric.dll

Package:: Microsoft.ServiceFabric v9.1.1833

Package:: Microsoft.ServiceFabric v8.2.1748

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

GetPropertyMetadataAsync(Uri, String)	Gets the specified NamedPropertyMetadata.
GetPropertyMetadataAsync(Uri, String, TimeSpan, CancellationToken)	Gets the specified NamedPropertyMetadata.

GetPropertyMetadataAsync(Uri, String)

Gets the specified NamedPropertyMetadata.

public System.Threading.Tasks.Task<System.Fabric.NamedPropertyMetadata> GetPropertyMetadataAsync (Uri parentName, string propertyName);

member this.GetPropertyMetadataAsync : Uri * string -> System.Threading.Tasks.Task<System.Fabric.NamedPropertyMetadata>

Public Function GetPropertyMetadataAsync (parentName As Uri, propertyName As String) As Task(Of NamedPropertyMetadata)

Parameters

parentName: Uri

The parent Service Fabric name of the property.

propertyName: String

The name of the Property.

Returns

Task<NamedPropertyMetadata>

A task that represents the asynchronous get operation.

See NamedPropertyMetadata.

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.

FabricElementNotFoundException

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.

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 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.

COMException

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

GetPropertyMetadataAsync(Uri, String, TimeSpan, CancellationToken)

Gets the specified NamedPropertyMetadata.

public System.Threading.Tasks.Task<System.Fabric.NamedPropertyMetadata> GetPropertyMetadataAsync (Uri parentName, string propertyName, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetPropertyMetadataAsync : Uri * string * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.NamedPropertyMetadata>

Public Function GetPropertyMetadataAsync (parentName As Uri, propertyName As String, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of NamedPropertyMetadata)