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

nutanix.getImagesV2

Explore with Pulumi AI

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

List images owned by Prism Central along with the image details like name, description, type, etc. This operation supports filtering, sorting, selection & pagination.

Using getImagesV2

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 getImagesV2(args: GetImagesV2Args, opts?: InvokeOptions): Promise<GetImagesV2Result>
function getImagesV2Output(args: GetImagesV2OutputArgs, opts?: InvokeOptions): Output<GetImagesV2Result>
Copy
def get_images_v2(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) -> GetImagesV2Result
def get_images_v2_output(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[GetImagesV2Result]
Copy
func LookupImagesV2(ctx *Context, args *LookupImagesV2Args, opts ...InvokeOption) (*LookupImagesV2Result, error)
func LookupImagesV2Output(ctx *Context, args *LookupImagesV2OutputArgs, opts ...InvokeOption) LookupImagesV2ResultOutput
Copy

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

public static class GetImagesV2 
{
    public static Task<GetImagesV2Result> InvokeAsync(GetImagesV2Args args, InvokeOptions? opts = null)
    public static Output<GetImagesV2Result> Invoke(GetImagesV2InvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetImagesV2Result> getImagesV2(GetImagesV2Args args, InvokeOptions options)
public static Output<GetImagesV2Result> getImagesV2(GetImagesV2Args args, InvokeOptions options)
Copy
fn::invoke:
  function: nutanix:index/getImagesV2:getImagesV2
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Filter string
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
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. Expression specified with the $select must conform to the OData V4.01 URL conventions.
Filter string
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
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. Expression specified with the $select must conform to the OData V4.01 URL conventions.
filter String
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
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. Expression specified with the $select must conform to the OData V4.01 URL conventions.
filter string
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
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. Expression specified with the $select must conform to the OData V4.01 URL conventions.
filter str
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
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. Expression specified with the $select must conform to the OData V4.01 URL conventions.
filter String
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
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. Expression specified with the $select must conform to the OData V4.01 URL conventions.

getImagesV2 Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Images List<PiersKarsenbarg.Nutanix.Outputs.GetImagesV2Image>
List of all images
Filter string
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
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. Expression specified with the $select must conform to the OData V4.01 URL conventions.
Id string
The provider-assigned unique ID for this managed resource.
Images []GetImagesV2Image
List of all images
Filter string
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
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. Expression specified with the $select must conform to the OData V4.01 URL conventions.
id String
The provider-assigned unique ID for this managed resource.
images List<GetImagesV2Image>
List of all images
filter String
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
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. Expression specified with the $select must conform to the OData V4.01 URL conventions.
id string
The provider-assigned unique ID for this managed resource.
images GetImagesV2Image[]
List of all images
filter string
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
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. Expression specified with the $select must conform to the OData V4.01 URL conventions.
id str
The provider-assigned unique ID for this managed resource.
images Sequence[GetImagesV2Image]
List of all images
filter str
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
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. Expression specified with the $select must conform to the OData V4.01 URL conventions.
id String
The provider-assigned unique ID for this managed resource.
images List<Property Map>
List of all images
filter String
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
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. Expression specified with the $select must conform to the OData V4.01 URL conventions.

Supporting Types

GetImagesV2Image

CategoryExtIds This property is required. List<string>
Checksums This property is required. List<PiersKarsenbarg.Nutanix.Inputs.GetImagesV2ImageChecksum>
ClusterLocationExtIds This property is required. List<string>
CreateTime This property is required. string
Description This property is required. string
ExtId This property is required. string
LastUpdateTime This property is required. string
Name This property is required. string
OwnerExtId This property is required. string
PlacementPolicyStatuses This property is required. List<PiersKarsenbarg.Nutanix.Inputs.GetImagesV2ImagePlacementPolicyStatus>
SizeBytes This property is required. int
Sources This property is required. List<PiersKarsenbarg.Nutanix.Inputs.GetImagesV2ImageSource>
Type This property is required. string
CategoryExtIds This property is required. []string
Checksums This property is required. []GetImagesV2ImageChecksum
ClusterLocationExtIds This property is required. []string
CreateTime This property is required. string
Description This property is required. string
ExtId This property is required. string
LastUpdateTime This property is required. string
Name This property is required. string
OwnerExtId This property is required. string
PlacementPolicyStatuses This property is required. []GetImagesV2ImagePlacementPolicyStatus
SizeBytes This property is required. int
Sources This property is required. []GetImagesV2ImageSource
Type This property is required. string
categoryExtIds This property is required. List<String>
checksums This property is required. List<GetImagesV2ImageChecksum>
clusterLocationExtIds This property is required. List<String>
createTime This property is required. String
description This property is required. String
extId This property is required. String
lastUpdateTime This property is required. String
name This property is required. String
ownerExtId This property is required. String
placementPolicyStatuses This property is required. List<GetImagesV2ImagePlacementPolicyStatus>
sizeBytes This property is required. Integer
sources This property is required. List<GetImagesV2ImageSource>
type This property is required. String
categoryExtIds This property is required. string[]
checksums This property is required. GetImagesV2ImageChecksum[]
clusterLocationExtIds This property is required. string[]
createTime This property is required. string
description This property is required. string
extId This property is required. string
lastUpdateTime This property is required. string
name This property is required. string
ownerExtId This property is required. string
placementPolicyStatuses This property is required. GetImagesV2ImagePlacementPolicyStatus[]
sizeBytes This property is required. number
sources This property is required. GetImagesV2ImageSource[]
type This property is required. string
category_ext_ids This property is required. Sequence[str]
checksums This property is required. Sequence[GetImagesV2ImageChecksum]
cluster_location_ext_ids This property is required. Sequence[str]
create_time This property is required. str
description This property is required. str
ext_id This property is required. str
last_update_time This property is required. str
name This property is required. str
owner_ext_id This property is required. str
placement_policy_statuses This property is required. Sequence[GetImagesV2ImagePlacementPolicyStatus]
size_bytes This property is required. int
sources This property is required. Sequence[GetImagesV2ImageSource]
type This property is required. str
categoryExtIds This property is required. List<String>
checksums This property is required. List<Property Map>
clusterLocationExtIds This property is required. List<String>
createTime This property is required. String
description This property is required. String
extId This property is required. String
lastUpdateTime This property is required. String
name This property is required. String
ownerExtId This property is required. String
placementPolicyStatuses This property is required. List<Property Map>
sizeBytes This property is required. Number
sources This property is required. List<Property Map>
type This property is required. String

GetImagesV2ImageChecksum

HexDigest This property is required. string
HexDigest This property is required. string
hexDigest This property is required. String
hexDigest This property is required. string
hex_digest This property is required. str
hexDigest This property is required. String

GetImagesV2ImagePlacementPolicyStatus

ComplianceStatus This property is required. string
ConflictingPolicyExtIds This property is required. List<string>
EnforcedClusterExtIds This property is required. List<string>
EnforcementMode This property is required. string
PlacementPolicyExtId This property is required. string
PolicyClusterExtIds This property is required. List<string>
ComplianceStatus This property is required. string
ConflictingPolicyExtIds This property is required. []string
EnforcedClusterExtIds This property is required. []string
EnforcementMode This property is required. string
PlacementPolicyExtId This property is required. string
PolicyClusterExtIds This property is required. []string
complianceStatus This property is required. String
conflictingPolicyExtIds This property is required. List<String>
enforcedClusterExtIds This property is required. List<String>
enforcementMode This property is required. String
placementPolicyExtId This property is required. String
policyClusterExtIds This property is required. List<String>
complianceStatus This property is required. string
conflictingPolicyExtIds This property is required. string[]
enforcedClusterExtIds This property is required. string[]
enforcementMode This property is required. string
placementPolicyExtId This property is required. string
policyClusterExtIds This property is required. string[]
compliance_status This property is required. str
conflicting_policy_ext_ids This property is required. Sequence[str]
enforced_cluster_ext_ids This property is required. Sequence[str]
enforcement_mode This property is required. str
placement_policy_ext_id This property is required. str
policy_cluster_ext_ids This property is required. Sequence[str]
complianceStatus This property is required. String
conflictingPolicyExtIds This property is required. List<String>
enforcedClusterExtIds This property is required. List<String>
enforcementMode This property is required. String
placementPolicyExtId This property is required. String
policyClusterExtIds This property is required. List<String>

GetImagesV2ImageSource

objectLiteSources This property is required. List<Property Map>
urlSources This property is required. List<Property Map>
vmDiskSources This property is required. List<Property Map>

GetImagesV2ImageSourceObjectLiteSource

Key This property is required. string
Key This property is required. string
key This property is required. String
key This property is required. string
key This property is required. str
key This property is required. String

GetImagesV2ImageSourceUrlSource

BasicAuths This property is required. List<PiersKarsenbarg.Nutanix.Inputs.GetImagesV2ImageSourceUrlSourceBasicAuth>
ShouldAllowInsecureUrl This property is required. bool
Url This property is required. string
BasicAuths This property is required. []GetImagesV2ImageSourceUrlSourceBasicAuth
ShouldAllowInsecureUrl This property is required. bool
Url This property is required. string
basicAuths This property is required. List<GetImagesV2ImageSourceUrlSourceBasicAuth>
shouldAllowInsecureUrl This property is required. Boolean
url This property is required. String
basicAuths This property is required. GetImagesV2ImageSourceUrlSourceBasicAuth[]
shouldAllowInsecureUrl This property is required. boolean
url This property is required. string
basic_auths This property is required. Sequence[GetImagesV2ImageSourceUrlSourceBasicAuth]
should_allow_insecure_url This property is required. bool
url This property is required. str
basicAuths This property is required. List<Property Map>
shouldAllowInsecureUrl This property is required. Boolean
url This property is required. String

GetImagesV2ImageSourceUrlSourceBasicAuth

Password This property is required. string
Username This property is required. string
Password This property is required. string
Username This property is required. string
password This property is required. String
username This property is required. String
password This property is required. string
username This property is required. string
password This property is required. str
username This property is required. str
password This property is required. String
username This property is required. String

GetImagesV2ImageSourceVmDiskSource

ExtId This property is required. string
ExtId This property is required. string
extId This property is required. String
extId This property is required. string
ext_id This property is required. str
extId 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