ReceivedInvitationsClient.GetReceivedInvitationsAsync Méthode

Définition

Espace de noms:

Azure.Analytics.Purview.Share

Assembly:

Azure.Analytics.Purview.Share.dll

Paquet:

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

Source:

ReceivedInvitationsClient.cs

Répertorie les invitations reçues.

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)

Paramètres

skipToken

String

Jeton de continuation pour répertorier la page suivante.

filter

String

Filtre les résultats à l’aide de la syntaxe OData.

orderby

String

Trie les résultats à l’aide de la syntaxe OData.

context

RequestContext

Contexte de la demande, qui peut remplacer les comportements par défaut du pipeline client par appel.

Retours

AsyncPageable<BinaryData>

du AsyncPageable<T> service contenant une liste d’objets BinaryData . Les détails du schéma de corps pour chaque élément de la collection sont décrits dans la section Remarques ci-dessous.

Exceptions

RequestFailedException

Le service a retourné un code de status non réussi.

Exemples

Cet exemple montre comment appeler GetReceivedInvitationsAsync et analyser le résultat.

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());
}

Cet exemple montre comment appeler GetReceivedInvitationsAsync avec tous les paramètres et comment analyser le résultat.

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());
}

Remarques

Répertorier les invitations reçues

Voici le schéma JSON d’un élément de la réponse paginable.

Corps de réponse :

Schéma pour 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.
            }