TableClient.GetEntityIfExistsAsync<T> Method

Definition

Namespace:

Azure.Data.Tables

Assembly:

Azure.Data.Tables.dll

Package:

Azure.Data.Tables v12.9.1

Source:

TableClient.cs

Gets the specified table entity of type T.

public virtual System.Threading.Tasks.Task<Azure.NullableResponse<T>> GetEntityIfExistsAsync<T> (string partitionKey, string rowKey, System.Collections.Generic.IEnumerable<string> select = default, System.Threading.CancellationToken cancellationToken = default) where T : class, Azure.Data.Tables.ITableEntity;

abstract member GetEntityIfExistsAsync : string * string * seq<string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<'T>> (requires 'T : null and 'T :> Azure.Data.Tables.ITableEntity)
override this.GetEntityIfExistsAsync : string * string * seq<string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<'T>> (requires 'T : null and 'T :> Azure.Data.Tables.ITableEntity)

Public Overridable Function GetEntityIfExistsAsync(Of T As {Class, ITableEntity}) (partitionKey As String, rowKey As String, Optional select As IEnumerable(Of String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(Of T))

Type Parameters

T

A custom model type that implements ITableEntity or an instance of TableEntity.

Parameters

partitionKey

String

The partitionKey that identifies the table entity.

rowKey

String

The rowKey that identifies the table entity.

select

IEnumerable<String>

Selects which set of entity properties to return in the result set. Pass null to retreive all properties.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Task<NullableResponse<T>>

The NullableResponse<T> whose HasValue property will return true if the entity existed, otherwise false.

Exceptions

RequestFailedException

Exception thrown if an unexpected error occurs.

ArgumentNullException

partitionKey or rowKey is null.