AssetMappingsClient.GetAssetMappingsAsync 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:: AssetMappingsClient.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.

List AssetMappings in a received share.

public virtual Azure.AsyncPageable<BinaryData> GetAssetMappingsAsync (string receivedShareName, string skipToken = default, string filter = default, string orderby = default, Azure.RequestContext context = default);

abstract member GetAssetMappingsAsync : string * string * string * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetAssetMappingsAsync : string * string * string * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>

Public Overridable Function GetAssetMappingsAsync (receivedShareName As String, Optional skipToken As String = Nothing, Optional filter As String = Nothing, Optional orderby As String = Nothing, Optional context As RequestContext = Nothing) As AsyncPageable(Of BinaryData)

Parameters

receivedShareName: String

The name of the received share.

skipToken: String

The continuation token to list the next page.

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

AsyncPageable<BinaryData>

The AsyncPageable<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

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

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

await foreach (var data in client.GetAssetMappingsAsync("<receivedShareName>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.ToString());
}

This sample shows how to call GetAssetMappingsAsync with all parameters, and how to parse the result.

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

await foreach (var data in client.GetAssetMappingsAsync("<receivedShareName>", "<skipToken>", "<filter>", "<orderby>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("id").ToString());
    Console.WriteLine(result.GetProperty("name").ToString());
    Console.WriteLine(result.GetProperty("type").ToString());
    Console.WriteLine(result.GetProperty("kind").ToString());
}

Remarks

List asset mappings for a received share

Below is the JSON schema for one item in the pageable response.

Response Body:

Schema for AssetMappingListValue:

{
              id: string, # Optional. The resource id of the resource.
              name: string, # Optional. Name of the resource.
              type: string, # Optional. Type of the resource.
              kind: "AdlsGen2Account" | "BlobAccount", # Required. Types of asset mapping.
            }

Applies to

Share via