ReceivedSharesClient.GetReceivedShares Method

Reference

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

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.

Get a list of received shares.

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

abstract member GetReceivedShares : string * string * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetReceivedShares : string * string * string * Azure.RequestContext -> Azure.Pageable<BinaryData>

Public Overridable Function GetReceivedShares (Optional skipToken As String = Nothing, Optional filter As String = Nothing, Optional orderby As String = Nothing, Optional context As RequestContext = Nothing) As Pageable(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

Pageable<BinaryData>

The Pageable<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 GetReceivedShares and parse the result.

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

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

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

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

foreach (var data in client.GetReceivedShares("<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.
            }

Applies to

Share via