import * as pulumi from "@pulumi/pulumi"; import * as outputs from "./types/output"; /** * Describes a List all the Role(s). * * ## Example Usage * * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as nutanix from "@pierskarsenbarg/nutanix"; * * // List all Roles * const roles = nutanix.getRolesV2({}); * // List Roles with filter * const filtered_roles = nutanix.getRolesV2({ * filter: "displayName eq 'example_role'", * }); * // List Roles with filter and orderby * const filtered_ordered_roles = nutanix.getRolesV2({ * filter: "displayName eq 'example_role'", * orderBy: "createdTime desc", * }); * ``` * * * ## Argument Reference * * The following arguments are supported: * * * `page`: - 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. * * `limit` : 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. * * `filter` :A URL query parameter that allows clients to filter a collection of resources. The expression specified with \$filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the \$filter must conform to the OData V4.01 URL conventions. For example, filter '\$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '\$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'. The filter can be applied to the following fields: * - clientName * - createdBy * - extId * - createdTime * - displayName * - extId * - isSystemDefined * - lastUpdatedTime * * `orderby` : 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. For example, '\$orderby=templateName desc' would get all templates sorted by templateName in descending order. The orderby can be applied to the following fields: * - createdTime * - distinguishedName * - displayName * - extId- * - lastUpdatedTime * * `select` : 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. If a \$select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. following fields: * - accessibleClients * - accessibleEntityTypes * - assignedUserGroupsCount * - assignedUsersCount * - clientName * - createdBy * - createdTime * - description * - displayName * - extId * - isSystemDefined * - lastUpdatedTime * - links * - operations * - tenantId */ export declare function getRolesV2(args?: GetRolesV2Args, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getRolesV2. */ export interface GetRolesV2Args { filter?: string; limit?: number; orderBy?: string; page?: number; select?: string; } /** * A collection of values returned by getRolesV2. */ export interface GetRolesV2Result { readonly filter?: string; /** * The provider-assigned unique ID for this managed resource. */ readonly id: string; readonly limit?: number; readonly orderBy?: string; readonly page?: number; /** * - List of Roles. */ readonly roles: outputs.GetRolesV2Role[]; readonly select?: string; } /** * Describes a List all the Role(s). * * ## Example Usage * * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as nutanix from "@pierskarsenbarg/nutanix"; * * // List all Roles * const roles = nutanix.getRolesV2({}); * // List Roles with filter * const filtered_roles = nutanix.getRolesV2({ * filter: "displayName eq 'example_role'", * }); * // List Roles with filter and orderby * const filtered_ordered_roles = nutanix.getRolesV2({ * filter: "displayName eq 'example_role'", * orderBy: "createdTime desc", * }); * ``` * * * ## Argument Reference * * The following arguments are supported: * * * `page`: - 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. * * `limit` : 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. * * `filter` :A URL query parameter that allows clients to filter a collection of resources. The expression specified with \$filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the \$filter must conform to the OData V4.01 URL conventions. For example, filter '\$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '\$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'. The filter can be applied to the following fields: * - clientName * - createdBy * - extId * - createdTime * - displayName * - extId * - isSystemDefined * - lastUpdatedTime * * `orderby` : 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. For example, '\$orderby=templateName desc' would get all templates sorted by templateName in descending order. The orderby can be applied to the following fields: * - createdTime * - distinguishedName * - displayName * - extId- * - lastUpdatedTime * * `select` : 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. If a \$select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. following fields: * - accessibleClients * - accessibleEntityTypes * - assignedUserGroupsCount * - assignedUsersCount * - clientName * - createdBy * - createdTime * - description * - displayName * - extId * - isSystemDefined * - lastUpdatedTime * - links * - operations * - tenantId */ export declare function getRolesV2Output(args?: GetRolesV2OutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output; /** * A collection of arguments for invoking getRolesV2. */ export interface GetRolesV2OutputArgs { filter?: pulumi.Input; limit?: pulumi.Input; orderBy?: pulumi.Input; page?: pulumi.Input; select?: pulumi.Input; } //# sourceMappingURL=getRolesV2.d.ts.map