ReceivedSharesClient.DeleteAsync(WaitUntil, String, RequestContext) Method

Reference

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

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.

Deletes a received share.

public virtual System.Threading.Tasks.Task<Azure.Operation> DeleteAsync (Azure.WaitUntil waitUntil, string receivedShareName, Azure.RequestContext context = default);

abstract member DeleteAsync : Azure.WaitUntil * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>
override this.DeleteAsync : Azure.WaitUntil * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>

Public Overridable Function DeleteAsync (waitUntil As WaitUntil, receivedShareName As String, Optional context As RequestContext = Nothing) As Task(Of Operation)

Parameters

waitUntil: WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

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<Operation>

The Operation representing an asynchronous operation on the service.

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 DeleteAsync with required parameters.

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

var operation = await client.DeleteAsync(WaitUntil.Completed, "<receivedShareName>");

var response = await operation.WaitForCompletionResponseAsync();
Console.WriteLine(response.Status)

Remarks

Delete a received share.

Applies to

Share via