1. Packages
  2. Nutanix
  3. API Docs
  4. getCategoriesV2
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg

nutanix.getCategoriesV2

Explore with Pulumi AI

Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg

List categories

Example

import * as pulumi from "@pulumi/pulumi";
import * as nutanix from "@pulumi/nutanix";

const categories = nutanix.getCategoriesV2({});
const categories_filtered = nutanix.getCategoriesV2({
    filter: "key eq '{<key value>}'",
});
Copy
import pulumi
import pulumi_nutanix as nutanix

categories = nutanix.get_categories_v2()
categories_filtered = nutanix.get_categories_v2(filter="key eq '{<key value>}'")
Copy
package main

import (
	"github.com/pierskarsenbarg/pulumi-nutanix/sdk/go/nutanix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nutanix.GetCategoriesV2(ctx, &nutanix.GetCategoriesV2Args{}, nil)
		if err != nil {
			return err
		}
		_, err = nutanix.GetCategoriesV2(ctx, &nutanix.GetCategoriesV2Args{
			Filter: pulumi.StringRef("key eq '{<key value>}'"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nutanix = Pulumi.Nutanix;

return await Deployment.RunAsync(() => 
{
    var categories = Nutanix.GetCategoriesV2.Invoke();

    var categories_filtered = Nutanix.GetCategoriesV2.Invoke(new()
    {
        Filter = "key eq '{<key value>}'",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nutanix.NutanixFunctions;
import com.pulumi.nutanix.inputs.GetCategoriesV2Args;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var categories = NutanixFunctions.getCategoriesV2();

        final var categories-filtered = NutanixFunctions.getCategoriesV2(GetCategoriesV2Args.builder()
            .filter("key eq '{<key value>}'")
            .build());

    }
}
Copy
variables:
  categories:
    fn::invoke:
      function: nutanix:getCategoriesV2
      arguments: {}
  categories-filtered:
    fn::invoke:
      function: nutanix:getCategoriesV2
      arguments:
        filter: key eq '{<key value>}'
Copy

Using getCategoriesV2

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 getCategoriesV2(args: GetCategoriesV2Args, opts?: InvokeOptions): Promise<GetCategoriesV2Result>
function getCategoriesV2Output(args: GetCategoriesV2OutputArgs, opts?: InvokeOptions): Output<GetCategoriesV2Result>
Copy
def get_categories_v2(expand: Optional[str] = None,
                      filter: Optional[str] = None,
                      limit: Optional[int] = None,
                      order_by: Optional[str] = None,
                      page: Optional[int] = None,
                      select: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetCategoriesV2Result
def get_categories_v2_output(expand: Optional[pulumi.Input[str]] = None,
                      filter: Optional[pulumi.Input[str]] = None,
                      limit: Optional[pulumi.Input[int]] = None,
                      order_by: Optional[pulumi.Input[str]] = None,
                      page: Optional[pulumi.Input[int]] = None,
                      select: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetCategoriesV2Result]
Copy
func GetCategoriesV2(ctx *Context, args *GetCategoriesV2Args, opts ...InvokeOption) (*GetCategoriesV2Result, error)
func GetCategoriesV2Output(ctx *Context, args *GetCategoriesV2OutputArgs, opts ...InvokeOption) GetCategoriesV2ResultOutput
Copy

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

public static class GetCategoriesV2 
{
    public static Task<GetCategoriesV2Result> InvokeAsync(GetCategoriesV2Args args, InvokeOptions? opts = null)
    public static Output<GetCategoriesV2Result> Invoke(GetCategoriesV2InvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCategoriesV2Result> getCategoriesV2(GetCategoriesV2Args args, InvokeOptions options)
public static Output<GetCategoriesV2Result> getCategoriesV2(GetCategoriesV2Args args, InvokeOptions options)
Copy
fn::invoke:
  function: nutanix:index/getCategoriesV2:getCategoriesV2
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Expand string
A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved.
Filter string
A URL query parameter that allows clients to filter a collection of resources.
Limit int
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.
OrderBy string
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
Page int
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.
Select string
A URL query parameter that allows clients to request a specific set of properties for each entity or complex type.
Expand string
A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved.
Filter string
A URL query parameter that allows clients to filter a collection of resources.
Limit int
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.
OrderBy string
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
Page int
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.
Select string
A URL query parameter that allows clients to request a specific set of properties for each entity or complex type.
expand String
A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved.
filter String
A URL query parameter that allows clients to filter a collection of resources.
limit Integer
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.
orderBy String
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
page Integer
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.
select String
A URL query parameter that allows clients to request a specific set of properties for each entity or complex type.
expand string
A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved.
filter string
A URL query parameter that allows clients to filter a collection of resources.
limit number
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.
orderBy string
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
page number
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.
select string
A URL query parameter that allows clients to request a specific set of properties for each entity or complex type.
expand str
A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved.
filter str
A URL query parameter that allows clients to filter a collection of resources.
limit int
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.
order_by str
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
page int
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.
select str
A URL query parameter that allows clients to request a specific set of properties for each entity or complex type.
expand String
A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved.
filter String
A URL query parameter that allows clients to filter a collection of resources.
limit Number
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.
orderBy String
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
page Number
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.
select String
A URL query parameter that allows clients to request a specific set of properties for each entity or complex type.

getCategoriesV2 Result

The following output properties are available:

Categories List<PiersKarsenbarg.Nutanix.Outputs.GetCategoriesV2Category>
Id string
The provider-assigned unique ID for this managed resource.
Expand string
Filter string
Limit int
OrderBy string
Page int
Select string
Categories []GetCategoriesV2Category
Id string
The provider-assigned unique ID for this managed resource.
Expand string
Filter string
Limit int
OrderBy string
Page int
Select string
categories List<GetCategoriesV2Category>
id String
The provider-assigned unique ID for this managed resource.
expand String
filter String
limit Integer
orderBy String
page Integer
select String
categories GetCategoriesV2Category[]
id string
The provider-assigned unique ID for this managed resource.
expand string
filter string
limit number
orderBy string
page number
select string
categories Sequence[GetCategoriesV2Category]
id str
The provider-assigned unique ID for this managed resource.
expand str
filter str
limit int
order_by str
page int
select str
categories List<Property Map>
id String
The provider-assigned unique ID for this managed resource.
expand String
filter String
limit Number
orderBy String
page Number
select String

Supporting Types

GetCategoriesV2Category

Associations This property is required. List<PiersKarsenbarg.Nutanix.Inputs.GetCategoriesV2CategoryAssociation>
This field gives basic information about resources that are associated to the category.
Description This property is required. string
A string consisting of the description of the category as defined by the user.
DetailedAssociations This property is required. List<PiersKarsenbarg.Nutanix.Inputs.GetCategoriesV2CategoryDetailedAssociation>
This field gives detailed information about resources that are associated to the category.
ExtId This property is required. string
The extID for the category.
Key This property is required. string
The key of a category when it is represented in key:value format.
Links This property is required. List<PiersKarsenbarg.Nutanix.Inputs.GetCategoriesV2CategoryLink>
A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
OwnerUuid This property is required. string
This field contains the UUID of a user who owns the category.
TenantId This property is required. string
A globally unique identifier that represents the tenant that owns this entity.
Type This property is required. string
Denotes the type of a category. There are three types of categories: SYSTEM, INTERNAL, and USER.
Value This property is required. string
The value of a category when it is represented in key:value format
Associations This property is required. []GetCategoriesV2CategoryAssociation
This field gives basic information about resources that are associated to the category.
Description This property is required. string
A string consisting of the description of the category as defined by the user.
DetailedAssociations This property is required. []GetCategoriesV2CategoryDetailedAssociation
This field gives detailed information about resources that are associated to the category.
ExtId This property is required. string
The extID for the category.
Key This property is required. string
The key of a category when it is represented in key:value format.
Links This property is required. []GetCategoriesV2CategoryLink
A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
OwnerUuid This property is required. string
This field contains the UUID of a user who owns the category.
TenantId This property is required. string
A globally unique identifier that represents the tenant that owns this entity.
Type This property is required. string
Denotes the type of a category. There are three types of categories: SYSTEM, INTERNAL, and USER.
Value This property is required. string
The value of a category when it is represented in key:value format
associations This property is required. List<GetCategoriesV2CategoryAssociation>
This field gives basic information about resources that are associated to the category.
description This property is required. String
A string consisting of the description of the category as defined by the user.
detailedAssociations This property is required. List<GetCategoriesV2CategoryDetailedAssociation>
This field gives detailed information about resources that are associated to the category.
extId This property is required. String
The extID for the category.
key This property is required. String
The key of a category when it is represented in key:value format.
links This property is required. List<GetCategoriesV2CategoryLink>
A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
ownerUuid This property is required. String
This field contains the UUID of a user who owns the category.
tenantId This property is required. String
A globally unique identifier that represents the tenant that owns this entity.
type This property is required. String
Denotes the type of a category. There are three types of categories: SYSTEM, INTERNAL, and USER.
value This property is required. String
The value of a category when it is represented in key:value format
associations This property is required. GetCategoriesV2CategoryAssociation[]
This field gives basic information about resources that are associated to the category.
description This property is required. string
A string consisting of the description of the category as defined by the user.
detailedAssociations This property is required. GetCategoriesV2CategoryDetailedAssociation[]
This field gives detailed information about resources that are associated to the category.
extId This property is required. string
The extID for the category.
key This property is required. string
The key of a category when it is represented in key:value format.
links This property is required. GetCategoriesV2CategoryLink[]
A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
ownerUuid This property is required. string
This field contains the UUID of a user who owns the category.
tenantId This property is required. string
A globally unique identifier that represents the tenant that owns this entity.
type This property is required. string
Denotes the type of a category. There are three types of categories: SYSTEM, INTERNAL, and USER.
value This property is required. string
The value of a category when it is represented in key:value format
associations This property is required. Sequence[GetCategoriesV2CategoryAssociation]
This field gives basic information about resources that are associated to the category.
description This property is required. str
A string consisting of the description of the category as defined by the user.
detailed_associations This property is required. Sequence[GetCategoriesV2CategoryDetailedAssociation]
This field gives detailed information about resources that are associated to the category.
ext_id This property is required. str
The extID for the category.
key This property is required. str
The key of a category when it is represented in key:value format.
links This property is required. Sequence[GetCategoriesV2CategoryLink]
A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
owner_uuid This property is required. str
This field contains the UUID of a user who owns the category.
tenant_id This property is required. str
A globally unique identifier that represents the tenant that owns this entity.
type This property is required. str
Denotes the type of a category. There are three types of categories: SYSTEM, INTERNAL, and USER.
value This property is required. str
The value of a category when it is represented in key:value format
associations This property is required. List<Property Map>
This field gives basic information about resources that are associated to the category.
description This property is required. String
A string consisting of the description of the category as defined by the user.
detailedAssociations This property is required. List<Property Map>
This field gives detailed information about resources that are associated to the category.
extId This property is required. String
The extID for the category.
key This property is required. String
The key of a category when it is represented in key:value format.
links This property is required. List<Property Map>
A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
ownerUuid This property is required. String
This field contains the UUID of a user who owns the category.
tenantId This property is required. String
A globally unique identifier that represents the tenant that owns this entity.
type This property is required. String
Denotes the type of a category. There are three types of categories: SYSTEM, INTERNAL, and USER.
value This property is required. String
The value of a category when it is represented in key:value format

GetCategoriesV2CategoryAssociation

CategoryId This property is required. string
External identifier for the given category, used across all v4 apis/entities/resources where categories are referenced.
Count This property is required. string
Count of associations of a particular type of entity or policy
ResourceGroup This property is required. string
An enum denoting the resource group. Resources can be organized into either an entity or a policy.
ResourceType This property is required. string
An enum denoting the associated resource types. Resource types are further grouped into 2 types - entity or a policy.
CategoryId This property is required. string
External identifier for the given category, used across all v4 apis/entities/resources where categories are referenced.
Count This property is required. string
Count of associations of a particular type of entity or policy
ResourceGroup This property is required. string
An enum denoting the resource group. Resources can be organized into either an entity or a policy.
ResourceType This property is required. string
An enum denoting the associated resource types. Resource types are further grouped into 2 types - entity or a policy.
categoryId This property is required. String
External identifier for the given category, used across all v4 apis/entities/resources where categories are referenced.
count This property is required. String
Count of associations of a particular type of entity or policy
resourceGroup This property is required. String
An enum denoting the resource group. Resources can be organized into either an entity or a policy.
resourceType This property is required. String
An enum denoting the associated resource types. Resource types are further grouped into 2 types - entity or a policy.
categoryId This property is required. string
External identifier for the given category, used across all v4 apis/entities/resources where categories are referenced.
count This property is required. string
Count of associations of a particular type of entity or policy
resourceGroup This property is required. string
An enum denoting the resource group. Resources can be organized into either an entity or a policy.
resourceType This property is required. string
An enum denoting the associated resource types. Resource types are further grouped into 2 types - entity or a policy.
category_id This property is required. str
External identifier for the given category, used across all v4 apis/entities/resources where categories are referenced.
count This property is required. str
Count of associations of a particular type of entity or policy
resource_group This property is required. str
An enum denoting the resource group. Resources can be organized into either an entity or a policy.
resource_type This property is required. str
An enum denoting the associated resource types. Resource types are further grouped into 2 types - entity or a policy.
categoryId This property is required. String
External identifier for the given category, used across all v4 apis/entities/resources where categories are referenced.
count This property is required. String
Count of associations of a particular type of entity or policy
resourceGroup This property is required. String
An enum denoting the resource group. Resources can be organized into either an entity or a policy.
resourceType This property is required. String
An enum denoting the associated resource types. Resource types are further grouped into 2 types - entity or a policy.

GetCategoriesV2CategoryDetailedAssociation

CategoryId This property is required. string
External identifier for the given category, used across all v4 apis/entities/resources where categories are referenced.
ResourceGroup This property is required. string
An enum denoting the resource group. Resources can be organized into either an entity or a policy.
ResourceId This property is required. string

The UUID of the entity or policy associated with the particular category.

See detailed information in Nutanix Categories v4.

ResourceType This property is required. string
An enum denoting the associated resource types. Resource types are further grouped into 2 types - entity or a policy.
CategoryId This property is required. string
External identifier for the given category, used across all v4 apis/entities/resources where categories are referenced.
ResourceGroup This property is required. string
An enum denoting the resource group. Resources can be organized into either an entity or a policy.
ResourceId This property is required. string

The UUID of the entity or policy associated with the particular category.

See detailed information in Nutanix Categories v4.

ResourceType This property is required. string
An enum denoting the associated resource types. Resource types are further grouped into 2 types - entity or a policy.
categoryId This property is required. String
External identifier for the given category, used across all v4 apis/entities/resources where categories are referenced.
resourceGroup This property is required. String
An enum denoting the resource group. Resources can be organized into either an entity or a policy.
resourceId This property is required. String

The UUID of the entity or policy associated with the particular category.

See detailed information in Nutanix Categories v4.

resourceType This property is required. String
An enum denoting the associated resource types. Resource types are further grouped into 2 types - entity or a policy.
categoryId This property is required. string
External identifier for the given category, used across all v4 apis/entities/resources where categories are referenced.
resourceGroup This property is required. string
An enum denoting the resource group. Resources can be organized into either an entity or a policy.
resourceId This property is required. string

The UUID of the entity or policy associated with the particular category.

See detailed information in Nutanix Categories v4.

resourceType This property is required. string
An enum denoting the associated resource types. Resource types are further grouped into 2 types - entity or a policy.
category_id This property is required. str
External identifier for the given category, used across all v4 apis/entities/resources where categories are referenced.
resource_group This property is required. str
An enum denoting the resource group. Resources can be organized into either an entity or a policy.
resource_id This property is required. str

The UUID of the entity or policy associated with the particular category.

See detailed information in Nutanix Categories v4.

resource_type This property is required. str
An enum denoting the associated resource types. Resource types are further grouped into 2 types - entity or a policy.
categoryId This property is required. String
External identifier for the given category, used across all v4 apis/entities/resources where categories are referenced.
resourceGroup This property is required. String
An enum denoting the resource group. Resources can be organized into either an entity or a policy.
resourceId This property is required. String

The UUID of the entity or policy associated with the particular category.

See detailed information in Nutanix Categories v4.

resourceType This property is required. String
An enum denoting the associated resource types. Resource types are further grouped into 2 types - entity or a policy.
Href This property is required. string
Rel This property is required. string
Href This property is required. string
Rel This property is required. string
href This property is required. String
rel This property is required. String
href This property is required. string
rel This property is required. string
href This property is required. str
rel This property is required. str
href This property is required. String
rel This property is required. String

Package Details

Repository
nutanix pierskarsenbarg/pulumi-nutanix
License
Apache-2.0
Notes
This Pulumi package is based on the nutanix Terraform Provider.
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg