ReceivedSharesClient.GetReceivedSharesAsync Method

Definition

Namespace:

Azure.Analytics.Purview.Share

Assembly:

Azure.Analytics.Purview.Share.dll

Package:

Azure.Analytics.Purview.Share v1.0.3-beta.20

Source:

ReceivedSharesClient.cs

Get a list of received shares.

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

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

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

Parameters

skipToken

String

The continuation token to list the next page.

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

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetReceivedSharesAsync and parse the result.

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

await foreach (var data in client.GetReceivedSharesAsync())
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.ToString());
}

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

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

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

Remarks

List received shares

Below is the JSON schema for one item in the pageable response.

Response Body:

Schema for ReceivedShareListValue:

{
              id: string, # Optional. The resource id of the resource.
              name: string, # Optional. Name of the resource.
              type: string, # Optional. Type of the resource.
              shareKind: "InPlace", # Required. Defines the supported types for share.
            }