import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
* Retrieves a list of entity groups. Use this data source when you need to list or filter entity groups rather than fetch a single group by `extId` (use the `nutanix.EntityGroupV2` data source for that).
*
* ## Example Usage
*
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as nutanix from "@pierskarsenbarg/nutanix";
*
* // List all entity groups
* const list = nutanix.getEntityGroupsV2({});
* // List entity groups with filter
* const filtered = nutanix.getEntityGroupsV2({
* filter: "name eq 'my-entity-group'",
* });
* // List entity groups with limit
* const withLimit = nutanix.getEntityGroupsV2({
* limit: 10,
* });
* // List entity groups with filter and limit
* const filteredLimit = nutanix.getEntityGroupsV2({
* filter: "name eq 'my-entity-group'",
* limit: 1,
* });
* ```
*
*/
export declare function getEntityGroupsV2(args?: GetEntityGroupsV2Args, opts?: pulumi.InvokeOptions): Promise;
/**
* A collection of arguments for invoking getEntityGroupsV2.
*/
export interface GetEntityGroupsV2Args {
/**
* A URL query parameter that allows clients to filter a collection of resources. The expression must conform to OData V4.01 URL conventions. The filter can be applied to the following fields:
*/
filter?: string;
/**
* A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
*/
limit?: number;
/**
* A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. The orderby can be applied to the following fields:
*/
orderBy?: string;
/**
* A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
*/
page?: number;
/**
* A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions.
*/
select?: string;
}
/**
* A collection of values returned by getEntityGroupsV2.
*/
export interface GetEntityGroupsV2Result {
/**
* List of entity groups.
*/
readonly entityGroups: outputs.GetEntityGroupsV2EntityGroup[];
readonly filter?: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly limit?: number;
readonly orderBy?: string;
readonly page?: number;
readonly select?: string;
}
/**
* Retrieves a list of entity groups. Use this data source when you need to list or filter entity groups rather than fetch a single group by `extId` (use the `nutanix.EntityGroupV2` data source for that).
*
* ## Example Usage
*
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as nutanix from "@pierskarsenbarg/nutanix";
*
* // List all entity groups
* const list = nutanix.getEntityGroupsV2({});
* // List entity groups with filter
* const filtered = nutanix.getEntityGroupsV2({
* filter: "name eq 'my-entity-group'",
* });
* // List entity groups with limit
* const withLimit = nutanix.getEntityGroupsV2({
* limit: 10,
* });
* // List entity groups with filter and limit
* const filteredLimit = nutanix.getEntityGroupsV2({
* filter: "name eq 'my-entity-group'",
* limit: 1,
* });
* ```
*
*/
export declare function getEntityGroupsV2Output(args?: GetEntityGroupsV2OutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output;
/**
* A collection of arguments for invoking getEntityGroupsV2.
*/
export interface GetEntityGroupsV2OutputArgs {
/**
* A URL query parameter that allows clients to filter a collection of resources. The expression must conform to OData V4.01 URL conventions. The filter can be applied to the following fields:
*/
filter?: pulumi.Input;
/**
* A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
*/
limit?: pulumi.Input;
/**
* A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. The orderby can be applied to the following fields:
*/
orderBy?: pulumi.Input;
/**
* A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
*/
page?: pulumi.Input;
/**
* A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions.
*/
select?: pulumi.Input;
}
//# sourceMappingURL=getEntityGroupsV2.d.ts.map