DocumentClient.ReadMediaAsync(String, CancellationToken) Method

Reference

Definition

Namespace:: Microsoft.Azure.Documents.Client

Assemblies:: Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Packages:: Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

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.

Retrieves the specified attachment content (aka media) from the Azure Cosmos DB service.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.MediaResponse> ReadMediaAsync (string mediaLink, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadMediaAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.MediaResponse>
override this.ReadMediaAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.MediaResponse>

Public Function ReadMediaAsync (mediaLink As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of MediaResponse)

Parameters

mediaLink: String

The link for the media to read. E.g. /media/media_rid

cancellationToken: CancellationToken

(Optional) A CancellationToken that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<MediaResponse>

The task object representing the service response for the asynchronous operation.

Implements

ReadMediaAsync(String, CancellationToken)

Exceptions

ArgumentNullException

If mediaLink is not set.

ArgumentException

If mediaLink is not in the form of /media/{mediaId}.

Applies to