SentSharesClient.GetAllSentShareInvitationsAsync Method

Reference

Definition

Namespace:: Azure.Analytics.Purview.Sharing

Assembly:: Azure.Analytics.Purview.Sharing.dll

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

Source:: SentSharesClient.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.

[Protocol Method] List all sent share invitations in a sent share

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

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

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

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

Parameters

sentShareId: String

Id of the sent share.

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

sentShareId is null.

ArgumentException

sentShareId 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 GetAllSentShareInvitationsAsync with required parameters and parse the result.

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

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

This sample shows how to call GetAllSentShareInvitationsAsync 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 SentSharesClient(endpoint, credential);

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

Applies to

Share via