ReceivedSharesClient.GetAllAttachedReceivedSharesAsync Method

Definition

Namespace:

Azure.Analytics.Purview.Sharing

Assembly:

Azure.Analytics.Purview.Sharing.dll

Package:

Azure.Analytics.Purview.Sharing v1.0.0-beta.3

Source:

ReceivedSharesClient.cs

[Protocol Method] Get a list of attached received shares.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

public virtual Azure.AsyncPageable<BinaryData> GetAllAttachedReceivedSharesAsync (string referenceName, string filter = default, string orderby = default, Azure.RequestContext context = default);

abstract member GetAllAttachedReceivedSharesAsync : string * string * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetAllAttachedReceivedSharesAsync : string * string * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>

Public Overridable Function GetAllAttachedReceivedSharesAsync (referenceName As String, Optional filter As String = Nothing, Optional orderby As String = Nothing, Optional context As RequestContext = Nothing) As AsyncPageable(Of BinaryData)

Parameters

referenceName

String

A name that references a data store.

filter

String

Filters the results using OData syntax.

orderby

String

Sorts the results using OData syntax.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

AsyncPageable<BinaryData>

The AsyncPageable<T> from the service containing a list of BinaryData objects. Details of the body schema for each item in the collection are in the Remarks section below.

Exceptions

ArgumentNullException

referenceName is null.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetAllAttachedReceivedSharesAsync with required parameters and parse the result.

var credential = new DefaultAzureCredential();
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new ReceivedSharesClient(endpoint, credential);

await foreach (var item in client.GetAllAttachedReceivedSharesAsync("<referenceName>"))
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("shareKind").ToString());
    Console.WriteLine(result.ToString());
}

This sample shows how to call GetAllAttachedReceivedSharesAsync with all parameters, and how to parse the result.

var credential = new DefaultAzureCredential();
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new ReceivedSharesClient(endpoint, credential);

await foreach (var item in client.GetAllAttachedReceivedSharesAsync("<referenceName>", "<filter>", "<orderby>"))
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("shareKind").ToString());
    Console.WriteLine(result.GetProperty("id").ToString());
    Console.WriteLine(result.GetProperty("type").ToString());
}