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

nutanix.getCategoryV2

Explore with Pulumi AI

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

Fetch a category

Using getCategoryV2

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 getCategoryV2(args: GetCategoryV2Args, opts?: InvokeOptions): Promise<GetCategoryV2Result>
function getCategoryV2Output(args: GetCategoryV2OutputArgs, opts?: InvokeOptions): Output<GetCategoryV2Result>
Copy
def get_category_v2(expand: Optional[str] = None,
                    ext_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetCategoryV2Result
def get_category_v2_output(expand: Optional[pulumi.Input[str]] = None,
                    ext_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetCategoryV2Result]
Copy
func LookupCategoryV2(ctx *Context, args *LookupCategoryV2Args, opts ...InvokeOption) (*LookupCategoryV2Result, error)
func LookupCategoryV2Output(ctx *Context, args *LookupCategoryV2OutputArgs, opts ...InvokeOption) LookupCategoryV2ResultOutput
Copy

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

public static class GetCategoryV2 
{
    public static Task<GetCategoryV2Result> InvokeAsync(GetCategoryV2Args args, InvokeOptions? opts = null)
    public static Output<GetCategoryV2Result> Invoke(GetCategoryV2InvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCategoryV2Result> getCategoryV2(GetCategoryV2Args args, InvokeOptions options)
public static Output<GetCategoryV2Result> getCategoryV2(GetCategoryV2Args args, InvokeOptions options)
Copy
fn::invoke:
  function: nutanix:index/getCategoryV2:getCategoryV2
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ExtId This property is required. string
The extID for the category.
Expand string
A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved.
ExtId This property is required. string
The extID for the category.
Expand string
A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved.
extId This property is required. String
The extID for the category.
expand String
A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved.
extId This property is required. string
The extID for the category.
expand string
A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved.
ext_id This property is required. str
The extID for the category.
expand str
A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved.
extId This property is required. String
The extID for the category.
expand String
A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved.

getCategoryV2 Result

The following output properties are available:

Associations List<PiersKarsenbarg.Nutanix.Outputs.GetCategoryV2Association>
This field gives basic information about resources that are associated to the category.
Description string
A string consisting of the description of the category as defined by the user.
DetailedAssociations List<PiersKarsenbarg.Nutanix.Outputs.GetCategoryV2DetailedAssociation>
This field gives detailed information about resources that are associated to the category.
ExtId string
Id string
The provider-assigned unique ID for this managed resource.
Key string
The key of a category when it is represented in key:value format.
Links List<PiersKarsenbarg.Nutanix.Outputs.GetCategoryV2Link>
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 string
This field contains the UUID of a user who owns the category.
TenantId string
A globally unique identifier that represents the tenant that owns this entity.
Type string
Denotes the type of a category. There are three types of categories: SYSTEM, INTERNAL, and USER.
Value string
The value of a category when it is represented in key:value format
Expand string
Associations []GetCategoryV2Association
This field gives basic information about resources that are associated to the category.
Description string
A string consisting of the description of the category as defined by the user.
DetailedAssociations []GetCategoryV2DetailedAssociation
This field gives detailed information about resources that are associated to the category.
ExtId string
Id string
The provider-assigned unique ID for this managed resource.
Key string
The key of a category when it is represented in key:value format.
Links []GetCategoryV2Link
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 string
This field contains the UUID of a user who owns the category.
TenantId string
A globally unique identifier that represents the tenant that owns this entity.
Type string
Denotes the type of a category. There are three types of categories: SYSTEM, INTERNAL, and USER.
Value string
The value of a category when it is represented in key:value format
Expand string
associations List<GetCategoryV2Association>
This field gives basic information about resources that are associated to the category.
description String
A string consisting of the description of the category as defined by the user.
detailedAssociations List<GetCategoryV2DetailedAssociation>
This field gives detailed information about resources that are associated to the category.
extId String
id String
The provider-assigned unique ID for this managed resource.
key String
The key of a category when it is represented in key:value format.
links List<GetCategoryV2Link>
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 String
This field contains the UUID of a user who owns the category.
tenantId String
A globally unique identifier that represents the tenant that owns this entity.
type String
Denotes the type of a category. There are three types of categories: SYSTEM, INTERNAL, and USER.
value String
The value of a category when it is represented in key:value format
expand String
associations GetCategoryV2Association[]
This field gives basic information about resources that are associated to the category.
description string
A string consisting of the description of the category as defined by the user.
detailedAssociations GetCategoryV2DetailedAssociation[]
This field gives detailed information about resources that are associated to the category.
extId string
id string
The provider-assigned unique ID for this managed resource.
key string
The key of a category when it is represented in key:value format.
links GetCategoryV2Link[]
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 string
This field contains the UUID of a user who owns the category.
tenantId string
A globally unique identifier that represents the tenant that owns this entity.
type string
Denotes the type of a category. There are three types of categories: SYSTEM, INTERNAL, and USER.
value string
The value of a category when it is represented in key:value format
expand string
associations Sequence[GetCategoryV2Association]
This field gives basic information about resources that are associated to the category.
description str
A string consisting of the description of the category as defined by the user.
detailed_associations Sequence[GetCategoryV2DetailedAssociation]
This field gives detailed information about resources that are associated to the category.
ext_id str
id str
The provider-assigned unique ID for this managed resource.
key str
The key of a category when it is represented in key:value format.
links Sequence[GetCategoryV2Link]
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 str
This field contains the UUID of a user who owns the category.
tenant_id str
A globally unique identifier that represents the tenant that owns this entity.
type str
Denotes the type of a category. There are three types of categories: SYSTEM, INTERNAL, and USER.
value str
The value of a category when it is represented in key:value format
expand str
associations List<Property Map>
This field gives basic information about resources that are associated to the category.
description String
A string consisting of the description of the category as defined by the user.
detailedAssociations List<Property Map>
This field gives detailed information about resources that are associated to the category.
extId String
id String
The provider-assigned unique ID for this managed resource.
key String
The key of a category when it is represented in key:value format.
links 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 String
This field contains the UUID of a user who owns the category.
tenantId String
A globally unique identifier that represents the tenant that owns this entity.
type String
Denotes the type of a category. There are three types of categories: SYSTEM, INTERNAL, and USER.
value String
The value of a category when it is represented in key:value format
expand String

Supporting Types

GetCategoryV2Association

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.

GetCategoryV2DetailedAssociation

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.
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.
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.
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.
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.
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.
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