Share via


ResourceQueryResult Class

Definition

Query result.

public class ResourceQueryResult
type ResourceQueryResult = class
Public Class ResourceQueryResult
Inheritance
ResourceQueryResult

Properties

Count

Number of records returned in the current response. In the case of paging, this is the number of records in the current page.

Data

Query output in JObject array or Table format.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

Facets

Query facets. Please note Facet is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include FacetError and FacetResult.

ResultTruncated

Indicates whether the query results are truncated.

SkipToken

When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.

TotalRecords

Number of total records matching the query.

Applies to