ReceivedSharesClient.GetReceivedShareAsync(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:

ReceivedSharesClient.cs

Get a received share by name.

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

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

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

Parameters

receivedShareName

String

The name of the received 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

receivedShareName is null.

ArgumentException

receivedShareName 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 GetReceivedShareAsync with required parameters and parse the result.

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

Response response = await client.GetReceivedShareAsync("<receivedShareName>");

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 received share

Below is the JSON schema for the response payload.

Response Body:

InPlaceReceivedShare

Schema for InPlaceReceivedShare:

{
              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 received share was created.
                expirationDate: string (ISO 8601 Format), # Optional. The expiration date of the received share.
                invitationId: string, # Required. The invitation id.
                provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource
                receivedShareStatus: "Active" | "Reinstating" | "Revoked" | "Revoking" | "RevokeFailed" | "ReinstateFailed" | "SourceDeleted", # Optional. received share status
                receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation
                receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation
                receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation
                senderEmail: string, # Optional. Email of the sender who created the sent share invitation
                senderName: string, # Optional. Name of the sender who created the sent share invitation
                senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation
                sentShareDescription: string, # Optional. Share description.
                sentShareLocation: string, # Required. Sent share location.
                sharedAt: string (ISO 8601 Format), # Optional. Time at which the sent share was shared.
                shareName: string, # Optional. Name of the share
              }, # Required. Properties of in place received share.
            }