SentSharesClient.GetSentShareAsync(String, RequestContext) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
[Protocol Method] Get a sent share by guid.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
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)
Parameters
- sentShareId
- String
Id of the sent share.
- context
- RequestContext
The request context, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
sentShareId
is null.
sentShareId
is an empty string, and was expected to be non-empty.
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 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());
Remarks
Get a sent share
Below is the JSON schema for the response payload.
Response Body:
InPlaceSentShare
Schema forInPlaceSentShare
:
{
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.
}