Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
nutanix.getImagesV2
Explore with Pulumi AI
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>
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]
func LookupImagesV2(ctx *Context, args *LookupImagesV2Args, opts ...InvokeOption) (*LookupImagesV2Result, error)
func LookupImagesV2Output(ctx *Context, args *LookupImagesV2OutputArgs, opts ...InvokeOption) LookupImagesV2ResultOutput
> 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)
}
public static CompletableFuture<GetImagesV2Result> getImagesV2(GetImagesV2Args args, InvokeOptions options)
public static Output<GetImagesV2Result> getImagesV2(GetImagesV2Args args, InvokeOptions options)
fn::invoke:
function: nutanix:index/getImagesV2:getImagesV2
arguments:
# arguments dictionary
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.
- Order
By 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.
- Order
By 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.
- order
By 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.
- order
By 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.
- order
By 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<Piers
Karsenbarg. Nutanix. Outputs. Get Images V2Image> - 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.
- Order
By 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
[]Get
Images V2Image - 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.
- Order
By 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<Get
Images V2Image> - 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.
- order
By 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
Get
Images V2Image[] - 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.
- order
By 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[Get
Images V2Image] - 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.
- order
By 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
- Category
Ext Ids This property is required. List<string> - Checksums
This property is required. List<PiersKarsenbarg. Nutanix. Inputs. Get Images V2Image Checksum> - Cluster
Location Ext Ids This property is required. List<string> - Create
Time This property is required. string - Description
This property is required. string - Ext
Id This property is required. string - Last
Update Time This property is required. string - Name
This property is required. string - Owner
Ext Id This property is required. string - Placement
Policy Statuses This property is required. List<PiersKarsenbarg. Nutanix. Inputs. Get Images V2Image Placement Policy Status> - Size
Bytes This property is required. int - Sources
This property is required. List<PiersKarsenbarg. Nutanix. Inputs. Get Images V2Image Source> - Type
This property is required. string
- Category
Ext Ids This property is required. []string - Checksums
This property is required. []GetImages V2Image Checksum - Cluster
Location Ext Ids This property is required. []string - Create
Time This property is required. string - Description
This property is required. string - Ext
Id This property is required. string - Last
Update Time This property is required. string - Name
This property is required. string - Owner
Ext Id This property is required. string - Placement
Policy Statuses This property is required. []GetImages V2Image Placement Policy Status - Size
Bytes This property is required. int - Sources
This property is required. []GetImages V2Image Source - Type
This property is required. string
- category
Ext Ids This property is required. List<String> - checksums
This property is required. List<GetImages V2Image Checksum> - cluster
Location Ext Ids This property is required. List<String> - create
Time This property is required. String - description
This property is required. String - ext
Id This property is required. String - last
Update Time This property is required. String - name
This property is required. String - owner
Ext Id This property is required. String - placement
Policy Statuses This property is required. List<GetImages V2Image Placement Policy Status> - size
Bytes This property is required. Integer - sources
This property is required. List<GetImages V2Image Source> - type
This property is required. String
- category
Ext Ids This property is required. string[] - checksums
This property is required. GetImages V2Image Checksum[] - cluster
Location Ext Ids This property is required. string[] - create
Time This property is required. string - description
This property is required. string - ext
Id This property is required. string - last
Update Time This property is required. string - name
This property is required. string - owner
Ext Id This property is required. string - placement
Policy Statuses This property is required. GetImages V2Image Placement Policy Status[] - size
Bytes This property is required. number - sources
This property is required. GetImages V2Image Source[] - type
This property is required. string
- category_
ext_ ids This property is required. Sequence[str] - checksums
This property is required. Sequence[GetImages V2Image Checksum] - 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[GetImages V2Image Placement Policy Status] - size_
bytes This property is required. int - sources
This property is required. Sequence[GetImages V2Image Source] - type
This property is required. str
- category
Ext Ids This property is required. List<String> - checksums
This property is required. List<Property Map> - cluster
Location Ext Ids This property is required. List<String> - create
Time This property is required. String - description
This property is required. String - ext
Id This property is required. String - last
Update Time This property is required. String - name
This property is required. String - owner
Ext Id This property is required. String - placement
Policy Statuses This property is required. List<Property Map> - size
Bytes This property is required. Number - sources
This property is required. List<Property Map> - type
This property is required. String
GetImagesV2ImageChecksum
- Hex
Digest This property is required. string
- Hex
Digest This property is required. string
- hex
Digest This property is required. String
- hex
Digest This property is required. string
- hex_
digest This property is required. str
- hex
Digest This property is required. String
GetImagesV2ImagePlacementPolicyStatus
- Compliance
Status This property is required. string - Conflicting
Policy Ext Ids This property is required. List<string> - Enforced
Cluster Ext Ids This property is required. List<string> - Enforcement
Mode This property is required. string - Placement
Policy Ext Id This property is required. string - Policy
Cluster Ext Ids This property is required. List<string>
- Compliance
Status This property is required. string - Conflicting
Policy Ext Ids This property is required. []string - Enforced
Cluster Ext Ids This property is required. []string - Enforcement
Mode This property is required. string - Placement
Policy Ext Id This property is required. string - Policy
Cluster Ext Ids This property is required. []string
- compliance
Status This property is required. String - conflicting
Policy Ext Ids This property is required. List<String> - enforced
Cluster Ext Ids This property is required. List<String> - enforcement
Mode This property is required. String - placement
Policy Ext Id This property is required. String - policy
Cluster Ext Ids This property is required. List<String>
- compliance
Status This property is required. string - conflicting
Policy Ext Ids This property is required. string[] - enforced
Cluster Ext Ids This property is required. string[] - enforcement
Mode This property is required. string - placement
Policy Ext Id This property is required. string - policy
Cluster Ext Ids 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]
- compliance
Status This property is required. String - conflicting
Policy Ext Ids This property is required. List<String> - enforced
Cluster Ext Ids This property is required. List<String> - enforcement
Mode This property is required. String - placement
Policy Ext Id This property is required. String - policy
Cluster Ext Ids This property is required. List<String>
GetImagesV2ImageSource
- Object
Lite Sources This property is required. List<PiersKarsenbarg. Nutanix. Inputs. Get Images V2Image Source Object Lite Source> - Url
Sources This property is required. List<PiersKarsenbarg. Nutanix. Inputs. Get Images V2Image Source Url Source> - Vm
Disk Sources This property is required. List<PiersKarsenbarg. Nutanix. Inputs. Get Images V2Image Source Vm Disk Source>
- Object
Lite Sources This property is required. []GetImages V2Image Source Object Lite Source - Url
Sources This property is required. []GetImages V2Image Source Url Source - Vm
Disk Sources This property is required. []GetImages V2Image Source Vm Disk Source
- object
Lite Sources This property is required. List<GetImages V2Image Source Object Lite Source> - url
Sources This property is required. List<GetImages V2Image Source Url Source> - vm
Disk Sources This property is required. List<GetImages V2Image Source Vm Disk Source>
- object
Lite Sources This property is required. GetImages V2Image Source Object Lite Source[] - url
Sources This property is required. GetImages V2Image Source Url Source[] - vm
Disk Sources This property is required. GetImages V2Image Source Vm Disk Source[]
- object_
lite_ sources This property is required. Sequence[GetImages V2Image Source Object Lite Source] - url_
sources This property is required. Sequence[GetImages V2Image Source Url Source] - vm_
disk_ sources This property is required. Sequence[GetImages V2Image Source Vm Disk Source]
- object
Lite Sources This property is required. List<Property Map> - url
Sources This property is required. List<Property Map> - vm
Disk Sources 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
- Basic
Auths This property is required. List<PiersKarsenbarg. Nutanix. Inputs. Get Images V2Image Source Url Source Basic Auth> - Should
Allow Insecure Url This property is required. bool - Url
This property is required. string
- Basic
Auths This property is required. []GetImages V2Image Source Url Source Basic Auth - Should
Allow Insecure Url This property is required. bool - Url
This property is required. string
- basic
Auths This property is required. List<GetImages V2Image Source Url Source Basic Auth> - should
Allow Insecure Url This property is required. Boolean - url
This property is required. String
- basic
Auths This property is required. GetImages V2Image Source Url Source Basic Auth[] - should
Allow Insecure Url This property is required. boolean - url
This property is required. string
- basic_
auths This property is required. Sequence[GetImages V2Image Source Url Source Basic Auth] - should_
allow_ insecure_ url This property is required. bool - url
This property is required. str
- basic
Auths This property is required. List<Property Map> - should
Allow Insecure Url This property is required. Boolean - url
This property is required. String
GetImagesV2ImageSourceUrlSourceBasicAuth
GetImagesV2ImageSourceVmDiskSource
- Ext
Id This property is required. string
- Ext
Id This property is required. string
- ext
Id This property is required. String
- ext
Id This property is required. string
- ext_
id This property is required. str
- ext
Id 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.