SentSharesClient.GetSentShareAsync(String, RequestContext) 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 un partage envoyé par GUID.

• 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 System.Threading.Tasks.Task<Azure.Response> GetSentShareAsync (string sentShareId, Azure.RequestContext context = default);

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

Public Overridable Function GetSentShareAsync (sentShareId As String, Optional context As RequestContext = Nothing) As Task(Of Response)

Paramètres

sentShareId

String

ID du partage envoyé.

context

RequestContext

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

Retours

Task<Response>

Réponse retournée par le service.

Exceptions

ArgumentNullException

sentShareId a la valeur null.

ArgumentException

sentShareId est une chaîne vide et devait être non vide.

RequestFailedException

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

Exemples

Cet exemple montre comment appeler GetSentShareAsync 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 = await client.GetSentShareAsync("<sentShareId>");

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

Remarques

Obtenir un partage envoyé

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

Corps de réponse :

InPlaceSentShare

Schéma pour InPlaceSentShare:

{
  properties: {
    artifact: {
      storeKind: "AdlsGen2Account" | "BlobAccount", # Required. The types of asset.
      storeReference: {
        referenceName: string, # Optional. Reference name for resource associated with the sink or artifact.
        type: "ArmResourceReference", # Optional. Defines the type of resource being shared
      }, # Required. A Store Reference for an artifact or sink.
    }, # Required. A class for sent share artifact.
    createdAt: string (ISO 8601 Format), # Optional. Time at which the sent share was created. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
    dependsOn: [Guid], # Optional. List of shares on which the sent share depends.
    description: string, # Optional. Sent share description.
    displayName: string, # Required. The name of the sent share
    senderEmail: string, # Optional. Email of the sender who created the sent share.
    senderName: string, # Optional. Name of the sender who created the sent share.
    senderTenantName: string, # Optional. Tenant name of the sender who created the sent share.
    state: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed", # Optional. State of the resource
  }, # Required. Properties for InPlace sent share.
  shareKind: InPlace, # Required. Defines the supported types for share.
  id: string, # Optional. The unique id of the resource.
  type: string, # Optional. Type of the resource.
}