powerplatform.getDataRecords

Power Platform v0.3.3, May 18 26

Viewing docs for Power Platform v0.3.3
published on Monday, May 18, 2026 by rpothin

Schema (JSON)

rpothin/pulumi-powerplatform

Viewing docs for Power Platform v0.3.3
published on Monday, May 18, 2026 by rpothin

Schema (JSON)

rpothin/pulumi-powerplatform

Using getDataRecords

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDataRecords(args: GetDataRecordsArgs, opts?: InvokeOptions): Promise<GetDataRecordsResult>
function getDataRecordsOutput(args: GetDataRecordsOutputArgs, opts?: InvokeOptions): Output<GetDataRecordsResult>

def get_data_records(apply: Optional[str] = None,
                     entity_collection: Optional[str] = None,
                     environment_id: Optional[str] = None,
                     expand: Optional[Sequence[DataRecordsExpandParam]] = None,
                     filter: Optional[str] = None,
                     orderby: Optional[str] = None,
                     select: Optional[Sequence[str]] = None,
                     top: Optional[int] = None,
                     opts: Optional[InvokeOptions] = None) -> GetDataRecordsResult
def get_data_records_output(apply: pulumi.Input[Optional[str]] = None,
                     entity_collection: pulumi.Input[Optional[str]] = None,
                     environment_id: pulumi.Input[Optional[str]] = None,
                     expand: pulumi.Input[Optional[Sequence[pulumi.Input[DataRecordsExpandParamArgs]]]] = None,
                     filter: pulumi.Input[Optional[str]] = None,
                     orderby: pulumi.Input[Optional[str]] = None,
                     select: pulumi.Input[Optional[Sequence[pulumi.Input[str]]]] = None,
                     top: pulumi.Input[Optional[int]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetDataRecordsResult]

func GetDataRecords(ctx *Context, args *GetDataRecordsArgs, opts ...InvokeOption) (*GetDataRecordsResult, error)
func GetDataRecordsOutput(ctx *Context, args *GetDataRecordsOutputArgs, opts ...InvokeOption) GetDataRecordsResultOutput

> Note: This function is named GetDataRecords in the Go SDK.

public static class GetDataRecords 
{
    public static Task<GetDataRecordsResult> InvokeAsync(GetDataRecordsArgs args, InvokeOptions? opts = null)
    public static Output<GetDataRecordsResult> Invoke(GetDataRecordsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDataRecordsResult> getDataRecords(GetDataRecordsArgs args, InvokeOptions options)
public static Output<GetDataRecordsResult> getDataRecords(GetDataRecordsArgs args, InvokeOptions options)

fn::invoke:
  function: powerplatform:getDataRecords
  arguments:
    # arguments dictionary

data "powerplatform_getdatarecords" "name" {
    # arguments
}

The following arguments are supported:

EntityCollection string: The plural OData collection name for the Dataverse table to query (e.g. accounts, deploymentpipelines).
EnvironmentId string: The GUID of the Power Platform environment containing the Dataverse instance.
Apply string: OData $apply aggregation expression (e.g. "aggregate(revenue with sum as revenue_sum)").
Expand List<DataRecordsExpandParam>: List of navigation properties to expand in the response.
Filter string: OData $filter expression (e.g. "name eq 'My Pipeline'").
Orderby string: OData $orderby expression (e.g. "createdon desc").
Select List<string>: List of column logical names to include in the response.
Top int: Maximum number of records to return ($top). Use to limit large result sets.

EntityCollection string: The plural OData collection name for the Dataverse table to query (e.g. accounts, deploymentpipelines).
EnvironmentId string: The GUID of the Power Platform environment containing the Dataverse instance.
Apply string: OData $apply aggregation expression (e.g. "aggregate(revenue with sum as revenue_sum)").
Expand []DataRecordsExpandParam: List of navigation properties to expand in the response.
Filter string: OData $filter expression (e.g. "name eq 'My Pipeline'").
Orderby string: OData $orderby expression (e.g. "createdon desc").
Select []string: List of column logical names to include in the response.
Top int: Maximum number of records to return ($top). Use to limit large result sets.

entity_collection string: The plural OData collection name for the Dataverse table to query (e.g. accounts, deploymentpipelines).
environment_id string: The GUID of the Power Platform environment containing the Dataverse instance.
apply string: OData $apply aggregation expression (e.g. "aggregate(revenue with sum as revenue_sum)").
expand list(object): List of navigation properties to expand in the response.
filter string: OData $filter expression (e.g. "name eq 'My Pipeline'").
orderby string: OData $orderby expression (e.g. "createdon desc").
select list(string): List of column logical names to include in the response.
top number: Maximum number of records to return ($top). Use to limit large result sets.

entityCollection String: The plural OData collection name for the Dataverse table to query (e.g. accounts, deploymentpipelines).
environmentId String: The GUID of the Power Platform environment containing the Dataverse instance.
apply String: OData $apply aggregation expression (e.g. "aggregate(revenue with sum as revenue_sum)").
expand List<DataRecordsExpandParam>: List of navigation properties to expand in the response.
filter String: OData $filter expression (e.g. "name eq 'My Pipeline'").
orderby String: OData $orderby expression (e.g. "createdon desc").
select List<String>: List of column logical names to include in the response.
top Integer: Maximum number of records to return ($top). Use to limit large result sets.

entityCollection string: The plural OData collection name for the Dataverse table to query (e.g. accounts, deploymentpipelines).
environmentId string: The GUID of the Power Platform environment containing the Dataverse instance.
apply string: OData $apply aggregation expression (e.g. "aggregate(revenue with sum as revenue_sum)").
expand DataRecordsExpandParam[]: List of navigation properties to expand in the response.
filter string: OData $filter expression (e.g. "name eq 'My Pipeline'").
orderby string: OData $orderby expression (e.g. "createdon desc").
select string[]: List of column logical names to include in the response.
top number: Maximum number of records to return ($top). Use to limit large result sets.

entity_collection str: The plural OData collection name for the Dataverse table to query (e.g. accounts, deploymentpipelines).
environment_id str: The GUID of the Power Platform environment containing the Dataverse instance.
apply str: OData $apply aggregation expression (e.g. "aggregate(revenue with sum as revenue_sum)").
expand Sequence[DataRecordsExpandParam]: List of navigation properties to expand in the response.
filter str: OData $filter expression (e.g. "name eq 'My Pipeline'").
orderby str: OData $orderby expression (e.g. "createdon desc").
select Sequence[str]: List of column logical names to include in the response.
top int: Maximum number of records to return ($top). Use to limit large result sets.

entityCollection String: The plural OData collection name for the Dataverse table to query (e.g. accounts, deploymentpipelines).
environmentId String: The GUID of the Power Platform environment containing the Dataverse instance.
apply String: OData $apply aggregation expression (e.g. "aggregate(revenue with sum as revenue_sum)").
expand List<Property Map>: List of navigation properties to expand in the response.
filter String: OData $filter expression (e.g. "name eq 'My Pipeline'").
orderby String: OData $orderby expression (e.g. "createdon desc").
select List<String>: List of column logical names to include in the response.
top Number: Maximum number of records to return ($top). Use to limit large result sets.

getDataRecords Result

The following output properties are available:

Records List<object>: The list of matching Dataverse records. Each record is a map of column name to value.
TotalRowsCount int: Total number of records matching the query filter (from @odata.count). Always 0 when the count annotation is absent or when apply is used (the count is not available in aggregation mode).
TotalRowsCountLimitExceeded bool: True when the total row count exceeded the Dataverse limit (@Microsoft.Dynamics.CRM.totalrecordcountlimitexceeded).

Records []interface{}: The list of matching Dataverse records. Each record is a map of column name to value.
TotalRowsCount int: Total number of records matching the query filter (from @odata.count). Always 0 when the count annotation is absent or when apply is used (the count is not available in aggregation mode).
TotalRowsCountLimitExceeded bool: True when the total row count exceeded the Dataverse limit (@Microsoft.Dynamics.CRM.totalrecordcountlimitexceeded).

records list(any): The list of matching Dataverse records. Each record is a map of column name to value.
total_rows_count number: Total number of records matching the query filter (from @odata.count). Always 0 when the count annotation is absent or when apply is used (the count is not available in aggregation mode).
total_rows_count_limit_exceeded bool: True when the total row count exceeded the Dataverse limit (@Microsoft.Dynamics.CRM.totalrecordcountlimitexceeded).

records List<Object>: The list of matching Dataverse records. Each record is a map of column name to value.
totalRowsCount Integer: Total number of records matching the query filter (from @odata.count). Always 0 when the count annotation is absent or when apply is used (the count is not available in aggregation mode).
totalRowsCountLimitExceeded Boolean: True when the total row count exceeded the Dataverse limit (@Microsoft.Dynamics.CRM.totalrecordcountlimitexceeded).

records any[]: The list of matching Dataverse records. Each record is a map of column name to value.
totalRowsCount number: Total number of records matching the query filter (from @odata.count). Always 0 when the count annotation is absent or when apply is used (the count is not available in aggregation mode).
totalRowsCountLimitExceeded boolean: True when the total row count exceeded the Dataverse limit (@Microsoft.Dynamics.CRM.totalrecordcountlimitexceeded).

records Sequence[Any]: The list of matching Dataverse records. Each record is a map of column name to value.
total_rows_count int: Total number of records matching the query filter (from @odata.count). Always 0 when the count annotation is absent or when apply is used (the count is not available in aggregation mode).
total_rows_count_limit_exceeded bool: True when the total row count exceeded the Dataverse limit (@Microsoft.Dynamics.CRM.totalrecordcountlimitexceeded).

records List<Any>: The list of matching Dataverse records. Each record is a map of column name to value.
totalRowsCount Number: Total number of records matching the query filter (from @odata.count). Always 0 when the count annotation is absent or when apply is used (the count is not available in aggregation mode).
totalRowsCountLimitExceeded Boolean: True when the total row count exceeded the Dataverse limit (@Microsoft.Dynamics.CRM.totalrecordcountlimitexceeded).

Supporting Types

DataRecordsExpandParam

NavigationProperty string: The navigation property name to expand.
Filter string: OData filter expression for the expanded entity.
Select string: Comma-separated list of columns to include for the expanded entity.

NavigationProperty string: The navigation property name to expand.
Filter string: OData filter expression for the expanded entity.
Select string: Comma-separated list of columns to include for the expanded entity.

navigation_property string: The navigation property name to expand.
filter string: OData filter expression for the expanded entity.
select string: Comma-separated list of columns to include for the expanded entity.

navigationProperty String: The navigation property name to expand.
filter String: OData filter expression for the expanded entity.
select String: Comma-separated list of columns to include for the expanded entity.

navigationProperty string: The navigation property name to expand.
filter string: OData filter expression for the expanded entity.
select string: Comma-separated list of columns to include for the expanded entity.

navigation_property str: The navigation property name to expand.
filter str: OData filter expression for the expanded entity.
select str: Comma-separated list of columns to include for the expanded entity.

navigationProperty String: The navigation property name to expand.
filter String: OData filter expression for the expanded entity.
select String: Comma-separated list of columns to include for the expanded entity.

Package Details

Repository: powerplatform rpothin/pulumi-powerplatform
License: MIT

Viewing docs for Power Platform v0.3.3
published on Monday, May 18, 2026 by rpothin

Schema (JSON)

rpothin/pulumi-powerplatform

powerplatform.getDataRecords

On this page

On this page

Using getDataRecords

getDataRecords Result

Supporting Types

DataRecordsExpandParam

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

powerplatform.getDataRecords

On this page

On this page

Using getDataRecords

getDataRecords Result

Supporting Types

DataRecordsExpandParam

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.