SentShareInvitationsClient.GetSentShareInvitationAsync 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:

SentShareInvitationsClient.cs

Obtenez l’invitation pour un partage donné.

public virtual System.Threading.Tasks.Task<Azure.Response> GetSentShareInvitationAsync (string sentShareName, string sentShareInvitationName, Azure.RequestContext context = default);

abstract member GetSentShareInvitationAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetSentShareInvitationAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetSentShareInvitationAsync (sentShareName As String, sentShareInvitationName As String, Optional context As RequestContext = Nothing) As Task(Of Response)

Paramètres

sentShareName

String

Nom du partage envoyé.

sentShareInvitationName

String

Nom de l’invitation envoyée.

context

RequestContext

Contexte de requête, qui peut remplacer les comportements par défaut du pipeline client par appel.

Retours

Task<Response>

Réponse retournée par le service. Les détails du schéma du corps de la réponse se trouvent dans la section Remarques ci-dessous.

Exceptions

ArgumentNullException

sentShareName ou sentShareInvitationName est null.

ArgumentException

sentShareName ou sentShareInvitationName est une chaîne vide, et on s’attendait à ce qu’elle ne soit pas vide.

RequestFailedException

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

Exemples

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

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

Response response = await client.GetSentShareInvitationAsync("<sentShareName>", "<sentShareInvitationName>");

JsonElement result = JsonDocument.Parse(response.ContentStream).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

Obtenir une invitation de partage envoyée

Vous trouverez ci-dessous le schéma JSON pour la charge utile de réponse.

Corps de réponse :

Cette méthode prend l’un des objets JSON ci-dessous comme charge utile. Sélectionnez un objet JSON pour afficher le schéma correspondant.

ApplicationInvitation

Schéma pour ApplicationInvitation:

{
              invitationKind: Application, # Required. The types of invitations.
              id: string, # Optional. The resource id of the resource.
              name: string, # Optional. Name of the resource.
              type: string, # Optional. Type of the resource.
              properties: {
                expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the invitation
                invitationId: string, # Optional. Id of the invitation
                invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation.
                provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource
                respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation.
                senderEmail: string, # Optional. Email address of the sender.
                senderName: string, # Optional. Name of the sender
                senderTenantName: string, # Optional. Tenant name of the sender
                sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent.
                shareKind: "InPlace", # Optional. Defines the supported types for share.
                targetActiveDirectoryId: string, # Required. The target azure active directory id the invitation is sent to.
                targetObjectId: string, # Required. The target object id in the azure active directory the invitation is sent to.
              }, # Required. Properties of the application invitation type.
            }

~+ 1 autres objets

JSON

UserInvitation

Schéma pour UserInvitation:

{
              invitationKind: User, # Required. The types of invitations.
              id: string, # Optional. The resource id of the resource.
              name: string, # Optional. Name of the resource.
              type: string, # Optional. Type of the resource.
              properties: {
                expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the invitation
                invitationId: string, # Optional. Id of the invitation
                invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation.
                provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource
                respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation.
                senderEmail: string, # Optional. Email address of the sender.
                senderName: string, # Optional. Name of the sender
                senderTenantName: string, # Optional. Tenant name of the sender
                sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent.
                shareKind: "InPlace", # Optional. Defines the supported types for share.
                targetEmail: string, # Required. The receiver email for the invitation is being sent.
              }, # Required. Properties of the user invitation type.
            }