AcceptedSentSharesClient.GetAcceptedSentShareAsync Method

Definition

Namespace:

Azure.Analytics.Purview.Share

Assembly:

Azure.Analytics.Purview.Share.dll

Package:

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

Source:

AcceptedSentSharesClient.cs

Get an accepted share with acceptedSentShareName to a particular sent share.

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

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

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

Parameters

sentShareName

String

The name of the sent share.

acceptedSentShareName

String

The name of the accepted 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 or acceptedSentShareName is null.

ArgumentException

sentShareName or acceptedSentShareName 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 GetAcceptedSentShareAsync with required parameters and parse the result.

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

Response response = await client.GetAcceptedSentShareAsync("<sentShareName>", "<acceptedSentShareName>");

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 an accepted sent share

Below is the JSON schema for the response payload.

Response Body:

InPlaceAcceptedSentShare

Schema for InPlaceAcceptedSentShare:

{
              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: {
                createdAt: string (ISO 8601 Format), # Optional. created at
                expirationDate: string (ISO 8601 Format), # Optional. Expiration date of the received share in UTC format
                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 and created the received share
                receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation and created the received share
                receiverTargetObjectId: string, # Optional. Receiver's target object id
                receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation and created the received share
                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
                sharedAt: string (ISO 8601 Format), # Optional. Shared at
              }, # Required. Properties of in place accepted sent share.
            }