ReceivedInvitationsClient.GetReceivedInvitationsAsync メソッド

定義

名前空間:

Azure.Analytics.Purview.Share

アセンブリ:

Azure.Analytics.Purview.Share.dll

パッケージ:

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

Source:

ReceivedInvitationsClient.cs

受信した招待を一覧表示します。

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

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

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

パラメーター

skipToken

String

次のページを一覧表示する継続トークン。

filter

String

OData 構文を使用して結果をフィルター処理します。

orderby

String

OData 構文を使用して結果を並べ替えます。

context

RequestContext

要求コンテキスト。これは、クライアント パイプラインの既定の動作を呼び出しごとにオーバーライドできます。

戻り値

AsyncPageable<BinaryData>

AsyncPageable<T>オブジェクトの一覧を含むサービスの BinaryData 。 コレクション内の各項目の本文スキーマの詳細については、以下の「解説」セクションを参照してください。

例外

RequestFailedException

サービスから成功以外の状態コードが返されました。

例

このサンプルでは、GetReceivedInvitationsAsync を呼び出して結果を解析する方法を示します。

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

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

このサンプルでは、すべてのパラメーターを使用して GetReceivedInvitationsAsync を呼び出す方法と、結果を解析する方法を示します。

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

await foreach (var data in client.GetReceivedInvitationsAsync("<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("invitationKind").ToString());
}

注釈

受信した招待を一覧表示する

ページング可能な応答の 1 つの項目の JSON スキーマを次に示します。

応答本文:

の ReceivedInvitationListValueスキーマ:

{
              id: string, # Optional. The resource id of the resource.
              name: string, # Optional. Name of the resource.
              type: string, # Optional. Type of the resource.
              invitationKind: "User" | "Application", # Required. The types of invitations.
            }