SentSharesClient.GetSentShareInvitation Méthode

Définition

Espace de noms:

Azure.Analytics.Purview.Sharing

Assembly:

Azure.Analytics.Purview.Sharing.dll

Paquet:

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

Source:

SentSharesClient.cs

[Méthode de protocole] Obtenir l’invitation de partage envoyé pour un partage envoyé donné

• Cette méthode de protocole permet la création explicite de la demande et le traitement de la réponse pour les scénarios avancés.

public virtual Azure.Response GetSentShareInvitation (string sentShareId, string sentShareInvitationId, Azure.RequestContext context = default);

abstract member GetSentShareInvitation : string * string * Azure.RequestContext -> Azure.Response
override this.GetSentShareInvitation : string * string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetSentShareInvitation (sentShareId As String, sentShareInvitationId As String, Optional context As RequestContext = Nothing) As Response

Paramètres

sentShareId

String

ID du partage envoyé.

sentShareInvitationId

String

ID de l’invitation de partage envoyée.

context

RequestContext

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

Retours

Response

Réponse retournée par le service.

Exceptions

ArgumentNullException

sentShareId ou sentShareInvitationId est null.

ArgumentException

sentShareId ou sentShareInvitationId est une chaîne vide, et était censé être non vide.

RequestFailedException

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

Exemples

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

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

Response response = client.GetSentShareInvitation("<sentShareId>", "<sentShareInvitationId>");

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("invitationKind").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("type").ToString());

Remarques

Obtenir le destinataire d’un partage envoyé donné

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 en tant que charge utile. Sélectionnez un objet JSON pour afficher le schéma correspondant.

ServiceInvitation

Schéma pour ServiceInvitation:

{
  properties: {
    expirationDate: string (ISO 8601 Format), # Optional. The time at which the invitation will expire. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
    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. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
    shareStatus: "Detached" | "Attached", # Optional. Share status.
    state: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed", # Optional. State of the resource
    targetActiveDirectoryId: Guid, # Required. The target azure active directory id the invitation is sent to.
    targetObjectId: Guid, # Required. The target object id in the azure active directory the invitation is sent to.
  }, # Required. Properties of the service invitation type.
  invitationKind: Service, # Required. The types of invitations.
  id: string, # Optional. The unique id of the resource.
  type: string, # Optional. Type of the resource.
}

~+ 1 autres objets

JSON

UserInvitation

Schéma pour UserInvitation:

{
  properties: {
    expirationDate: string (ISO 8601 Format), # Optional. The time at which the invitation will expire. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
    notify: boolean, # Optional. Whether or not the recipient was notified via email.
    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. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
    shareStatus: "Detached" | "Attached", # Optional. Share status.
    state: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed", # Optional. State of the resource
    targetEmail: string, # Required. The receiver email for the invitation is being sent.
  }, # Required. Properties of the user invitation type.
  invitationKind: User, # Required. The types of invitations.
  id: string, # Optional. The unique id of the resource.
  type: string, # Optional. Type of the resource.
}