import * as pulumi from "@pulumi/pulumi"; import * as outputs from "./types/output"; /** * Lists all cluster entities registered to Prism Central. * * ## Example Usage * * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as nutanix from "@pierskarsenbarg/nutanix"; * * const cls = nutanix.getClustersV2({}); * const filtered_cls = nutanix.getClustersV2({ * filter: "name eq 'cluster-1'", * }); * const paged_cls = nutanix.getClustersV2({ * page: 1, * limit: 10, * }); * ``` * */ export declare function getClustersV2(args?: GetClustersV2Args, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getClustersV2. */ export interface GetClustersV2Args { /** * -(Optional) A URL query parameter that allows clients to specify a sequence of transformations to the entity set, such as groupby, filter, aggregate etc. As of now only support for groupby exists.For example '\$apply=groupby((templateName))' would get all templates grouped by templateName. * The apply can be applied on the following fields: * - config/buildInfo/version * - nodes/numberOfNodes */ apply?: string; /** * -(Optional) A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved. Each expanded item is evaluated relative to the entity containing the property being expanded. Other query options can be applied to an expanded property by appending a semicolon-separated list of query options, enclosed in parentheses, to the property name. Permissible system query options are \$filter, \$select and \$orderby. * The `expand` can be applied on the following fields: * - clusterProfile * - storageSummary */ expand?: string; /** * -(Optional) 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: * - backupEligibilityScore * - clusterProfileExtId * - config/buildInfo/version * - config/clusterFunction * - config/encryptionInTransitStatus * - config/encryptionOption * - config/encryptionScope * - config/hypervisorTypes * - config/isAvailable * - extId * - name * - network/keyManagementServerType * - upgradeStatus */ filter?: string; /** * -(Optional) 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; /** * -(Optional) 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: * - backupEligibilityScore * - config/buildInfo/version * - config/isAvailable * - extId * - inefficientVmCount * - name * - network/keyManagementServerType * - nodes/numberOfNodes * - upgradeStatus * - vmCount */ orderBy?: string; /** * -(Optional) 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; /** * -(Optional) 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. * The select can be applied to the following fields: * - backupEligibilityScore * - inefficientVmCount * - name * - upgradeStatus * - vmCount */ select?: string; } /** * A collection of values returned by getClustersV2. */ export interface GetClustersV2Result { readonly apply?: string; /** * - List of cluster entities. */ readonly clusterEntities: outputs.GetClustersV2ClusterEntity[]; readonly expand?: string; 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; } /** * Lists all cluster entities registered to Prism Central. * * ## Example Usage * * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as nutanix from "@pierskarsenbarg/nutanix"; * * const cls = nutanix.getClustersV2({}); * const filtered_cls = nutanix.getClustersV2({ * filter: "name eq 'cluster-1'", * }); * const paged_cls = nutanix.getClustersV2({ * page: 1, * limit: 10, * }); * ``` * */ export declare function getClustersV2Output(args?: GetClustersV2OutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output; /** * A collection of arguments for invoking getClustersV2. */ export interface GetClustersV2OutputArgs { /** * -(Optional) A URL query parameter that allows clients to specify a sequence of transformations to the entity set, such as groupby, filter, aggregate etc. As of now only support for groupby exists.For example '\$apply=groupby((templateName))' would get all templates grouped by templateName. * The apply can be applied on the following fields: * - config/buildInfo/version * - nodes/numberOfNodes */ apply?: pulumi.Input; /** * -(Optional) A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved. Each expanded item is evaluated relative to the entity containing the property being expanded. Other query options can be applied to an expanded property by appending a semicolon-separated list of query options, enclosed in parentheses, to the property name. Permissible system query options are \$filter, \$select and \$orderby. * The `expand` can be applied on the following fields: * - clusterProfile * - storageSummary */ expand?: pulumi.Input; /** * -(Optional) 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: * - backupEligibilityScore * - clusterProfileExtId * - config/buildInfo/version * - config/clusterFunction * - config/encryptionInTransitStatus * - config/encryptionOption * - config/encryptionScope * - config/hypervisorTypes * - config/isAvailable * - extId * - name * - network/keyManagementServerType * - upgradeStatus */ filter?: pulumi.Input; /** * -(Optional) 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; /** * -(Optional) 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: * - backupEligibilityScore * - config/buildInfo/version * - config/isAvailable * - extId * - inefficientVmCount * - name * - network/keyManagementServerType * - nodes/numberOfNodes * - upgradeStatus * - vmCount */ orderBy?: pulumi.Input; /** * -(Optional) 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; /** * -(Optional) 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. * The select can be applied to the following fields: * - backupEligibilityScore * - inefficientVmCount * - name * - upgradeStatus * - vmCount */ select?: pulumi.Input; } //# sourceMappingURL=getClustersV2.d.ts.map