Entity.GetByIdsAsync 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.
Overloads
| Name | Description |
|---|---|
| GetByIdsAsync(IEnumerable<String>, Nullable<Boolean>, Nullable<Boolean>, RequestContext) |
[Protocol Method] List entities in bulk identified by its GUIDs.
|
| GetByIdsAsync(IEnumerable<String>, Nullable<Boolean>, Nullable<Boolean>, CancellationToken) |
List entities in bulk identified by its GUIDs. |
GetByIdsAsync(IEnumerable<String>, Nullable<Boolean>, Nullable<Boolean>, RequestContext)
- Source:
- Entity.cs
[Protocol Method] List entities in bulk identified by its GUIDs.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
- Please try the simpler GetByIdsAsync(IEnumerable<String>, Nullable<Boolean>, Nullable<Boolean>, CancellationToken) convenience overload with strongly typed models first.
public virtual System.Threading.Tasks.Task<Azure.Response> GetByIdsAsync(System.Collections.Generic.IEnumerable<string> guid, bool? minExtInfo, bool? ignoreRelationships, Azure.RequestContext context);abstract member GetByIdsAsync : seq<string> * Nullable<bool> * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetByIdsAsync : seq<string> * Nullable<bool> * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function GetByIdsAsync (guid As IEnumerable(Of String), minExtInfo As Nullable(Of Boolean), ignoreRelationships As Nullable(Of Boolean), context As RequestContext) As Task(Of Response)Parameters
- guid
- IEnumerable<String>
An array of GUIDs of entities to list.
- 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
guid is null.
Service returned a non-success status code.
Examples
This sample shows how to call GetByIdsAsync and parse the result.
Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
Entity client = new DataMapClient(endpoint, credential).GetEntityClient();
Response response = await client.GetByIdsAsync(new string[] { "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", "b4ebc8be-cef4-860a-bee9-28cc34cb5caa" }, true, null, null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());
Applies to
GetByIdsAsync(IEnumerable<String>, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)
- Source:
- Entity.cs
List entities in bulk identified by its GUIDs.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo>> GetByIdsAsync(System.Collections.Generic.IEnumerable<string> guid, bool? minExtInfo = default, bool? ignoreRelationships = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetByIdsAsync : seq<string> * Nullable<bool> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo>>
override this.GetByIdsAsync : seq<string> * Nullable<bool> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo>>Public Overridable Function GetByIdsAsync (guid As IEnumerable(Of String), Optional minExtInfo As Nullable(Of Boolean) = Nothing, Optional ignoreRelationships As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AtlasEntitiesWithExtInfo))Parameters
- guid
- IEnumerable<String>
An array of GUIDs of entities to list.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
guid is null.
Examples
This sample shows how to call GetByIdsAsync.
Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
Entity client = new DataMapClient(endpoint, credential).GetEntityClient();
Response<AtlasEntitiesWithExtInfo> response = await client.GetByIdsAsync(new string[] { "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", "b4ebc8be-cef4-860a-bee9-28cc34cb5caa" });
