SentSharesClient.GetSentShareAsync(String, RequestContext) Method

Definition

Namespace:

Azure.Analytics.Purview.Share

Assembly:

Azure.Analytics.Purview.Share.dll

Package:

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

Source:

SentSharesClient.cs

Get a sent share in the given Purview account.

public virtual System.Threading.Tasks.Task<Azure.Response> GetSentShareAsync (string sentShareName, 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 (sentShareName As String, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

sentShareName

String

The name of the sent share.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service. Details of the response body schema are in the Remarks section below.

Exceptions

ArgumentNullException

sentShareName is null.

ArgumentException

sentShareName is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetSentShareAsync with required parameters and parse the result.

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

Response response = await client.GetSentShareAsync("<sentShareName>");

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("shareKind").ToString());

Remarks

Get a sent share

Below is the JSON schema for the response payload.

Response Body:

InPlaceSentShare

Schema for InPlaceSentShare:

{
              shareKind: InPlace, # Required. Defines the supported types for share.
              id: string, # Optional. The resource id of the resource.
              name: string, # Optional. Name of the resource.
              type: string, # Optional. Type of the resource.
              properties: {
                collection: {
                  referenceName: string, # Required. Gets or sets the reference name.
                  type: string, # Required. Gets or sets the reference type property.
                }, # Required. Reference to a Collection.
                createdAt: string (ISO 8601 Format), # Optional. Time at which the share was created.
                description: string, # Optional. Share description.
                provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource
                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.
              }, # Required. Properties of in place sent share.
            }