ReceivedSharesClient.GetAllDetachedReceivedShares 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 list of detached received shares.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual Azure.Pageable<BinaryData> GetAllDetachedReceivedShares (string filter = default, string orderby = default, Azure.RequestContext context = default);
abstract member GetAllDetachedReceivedShares : string * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetAllDetachedReceivedShares : string * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
Public Overridable Function GetAllDetachedReceivedShares (Optional filter As String = Nothing, Optional orderby As String = Nothing, Optional context As RequestContext = Nothing) As Pageable(Of BinaryData)
Parameters
- filter
- String
Filters the results using OData syntax.
- orderby
- String
Sorts the results using OData syntax.
- context
- RequestContext
The request context, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The Pageable<T> from the service containing a list of BinaryData objects. Details of the body schema for each item in the collection are in the Remarks section below.
Exceptions
Service returned a non-success status code.
Examples
This sample shows how to call GetAllDetachedReceivedShares and parse the result.
var credential = new DefaultAzureCredential();
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new ReceivedSharesClient(endpoint, credential);
foreach (var item in client.GetAllDetachedReceivedShares())
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("shareKind").ToString());
Console.WriteLine(result.ToString());
}
This sample shows how to call GetAllDetachedReceivedShares with all parameters, and how to parse the result.
var credential = new DefaultAzureCredential();
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new ReceivedSharesClient(endpoint, credential);
foreach (var item in client.GetAllDetachedReceivedShares("<filter>", "<orderby>"))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("shareKind").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("type").ToString());
}
Applies to
Azure SDK for .NET