AcceptedSentSharesClient.GetAcceptedSentSharesAsync 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:: AcceptedSentSharesClient.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.

List of accepted shares for the current sent share.

public virtual Azure.AsyncPageable<BinaryData> GetAcceptedSentSharesAsync (string sentShareName, string skipToken = default, Azure.RequestContext context = default);

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

Public Overridable Function GetAcceptedSentSharesAsync (sentShareName As String, Optional skipToken As String = Nothing, Optional context As RequestContext = Nothing) As AsyncPageable(Of BinaryData)

Parameters

sentShareName: String

The name of the sent share.

skipToken: String

The continuation token to list the next page.

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

sentShareName is null.

ArgumentException

sentShareName is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

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

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

await foreach (var data in client.GetAcceptedSentSharesAsync("<sentShareName>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.ToString());
}

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

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

await foreach (var data in client.GetAcceptedSentSharesAsync("<sentShareName>", "<skipToken>"))
{
    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

Get list of accepted sent shares

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

Response Body:

Schema for AcceptedSentShareListValue:

{
              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