Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nutanix
  3. API Docs
  4. getImagePlacementPoliciesV2
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

nutanix.getImagePlacementPoliciesV2

Explore with Pulumi AI

nutanix logo
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

    List image placement policies details.

    Example

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

const ipp = nutanix.getImagePlacementPoliciesV2({
    filter: "startswith(name,'<name-prefix>')",
    limit: 10,
    page: 0,
});

    import pulumi
import pulumi_nutanix as nutanix

ipp = nutanix.get_image_placement_policies_v2(filter="startswith(name,'<name-prefix>')",
    limit=10,
    page=0)

    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.GetImagePlacementPoliciesV2(ctx, &nutanix.GetImagePlacementPoliciesV2Args{
			Filter: pulumi.StringRef("startswith(name,'<name-prefix>')"),
			Limit:  pulumi.IntRef(10),
			Page:   pulumi.IntRef(0),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nutanix = Pulumi.Nutanix;

return await Deployment.RunAsync(() => 
{
    var ipp = Nutanix.GetImagePlacementPoliciesV2.Invoke(new()
    {
        Filter = "startswith(name,'<name-prefix>')",
        Limit = 10,
        Page = 0,
    });

});

    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.GetImagePlacementPoliciesV2Args;
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 ipp = NutanixFunctions.getImagePlacementPoliciesV2(GetImagePlacementPoliciesV2Args.builder()
            .filter("startswith(name,'<name-prefix>')")
            .limit(10)
            .page(0)
            .build());

    }
}

    variables:
  ipp:
    fn::invoke:
      function: nutanix:getImagePlacementPoliciesV2
      arguments:
        filter: startswith(name,'<name-prefix>')
        limit: 10
        page: 0

    Using getImagePlacementPoliciesV2

    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 getImagePlacementPoliciesV2(args: GetImagePlacementPoliciesV2Args, opts?: InvokeOptions): Promise<GetImagePlacementPoliciesV2Result>
function getImagePlacementPoliciesV2Output(args: GetImagePlacementPoliciesV2OutputArgs, opts?: InvokeOptions): Output<GetImagePlacementPoliciesV2Result>
    def get_image_placement_policies_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) -> GetImagePlacementPoliciesV2Result
def get_image_placement_policies_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[GetImagePlacementPoliciesV2Result]
    func GetImagePlacementPoliciesV2(ctx *Context, args *GetImagePlacementPoliciesV2Args, opts ...InvokeOption) (*GetImagePlacementPoliciesV2Result, error)
func GetImagePlacementPoliciesV2Output(ctx *Context, args *GetImagePlacementPoliciesV2OutputArgs, opts ...InvokeOption) GetImagePlacementPoliciesV2ResultOutput

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

    public static class GetImagePlacementPoliciesV2 
{
    public static Task<GetImagePlacementPoliciesV2Result> InvokeAsync(GetImagePlacementPoliciesV2Args args, InvokeOptions? opts = null)
    public static Output<GetImagePlacementPoliciesV2Result> Invoke(GetImagePlacementPoliciesV2InvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetImagePlacementPoliciesV2Result> getImagePlacementPoliciesV2(GetImagePlacementPoliciesV2Args args, InvokeOptions options)
public static Output<GetImagePlacementPoliciesV2Result> getImagePlacementPoliciesV2(GetImagePlacementPoliciesV2Args args, InvokeOptions options)

    fn::invoke:
  function: nutanix:index/getImagePlacementPoliciesV2:getImagePlacementPoliciesV2
  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.
    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.

    getImagePlacementPoliciesV2 Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    PlacementPolicies List<PiersKarsenbarg.Nutanix.Outputs.GetImagePlacementPoliciesV2PlacementPolicy>
    List of all image placement policies
    Filter string
    Limit int
    OrderBy string
    Page int
    Select string
    Id string
    The provider-assigned unique ID for this managed resource.
    PlacementPolicies []GetImagePlacementPoliciesV2PlacementPolicy
    List of all image placement policies
    Filter string
    Limit int
    OrderBy string
    Page int
    Select string
    id String
    The provider-assigned unique ID for this managed resource.
    placementPolicies List<GetImagePlacementPoliciesV2PlacementPolicy>
    List of all image placement policies
    filter String
    limit Integer
    orderBy String
    page Integer
    select String
    id string
    The provider-assigned unique ID for this managed resource.
    placementPolicies GetImagePlacementPoliciesV2PlacementPolicy[]
    List of all image placement policies
    filter string
    limit number
    orderBy string
    page number
    select string
    id str
    The provider-assigned unique ID for this managed resource.
    placement_policies Sequence[GetImagePlacementPoliciesV2PlacementPolicy]
    List of all image placement policies
    filter str
    limit int
    order_by str
    page int
    select str
    id String
    The provider-assigned unique ID for this managed resource.
    placementPolicies List<Property Map>
    List of all image placement policies
    filter String
    limit Number
    orderBy String
    page Number
    select String

    Supporting Types

    GetImagePlacementPoliciesV2PlacementPolicy

    ClusterEntityFilters List<PiersKarsenbarg.Nutanix.Inputs.GetImagePlacementPoliciesV2PlacementPolicyClusterEntityFilter>
    (Required) Category-based entity filter.
    CreateTime string
    Description string
    (Optional) Description of the image placement policy.
    EnforcementState string
    (Optional) Enforcement status of the image placement policy. Valid values "ACTIVE", "SUSPENDED"
    ExtId string
    The external identifier of an image placement policy.
    ImageEntityFilters List<PiersKarsenbarg.Nutanix.Inputs.GetImagePlacementPoliciesV2PlacementPolicyImageEntityFilter>
    (Required) Category-based entity filter.
    LastUpdateTime string
    Name string
    (Required) Name of the image placement policy.
    OwnerExtId string
    PlacementType string
    (Required) Type of the image placement policy. Valid values "HARD", "SOFT"
    ClusterEntityFilters []GetImagePlacementPoliciesV2PlacementPolicyClusterEntityFilter
    (Required) Category-based entity filter.
    CreateTime string
    Description string
    (Optional) Description of the image placement policy.
    EnforcementState string
    (Optional) Enforcement status of the image placement policy. Valid values "ACTIVE", "SUSPENDED"
    ExtId string
    The external identifier of an image placement policy.
    ImageEntityFilters []GetImagePlacementPoliciesV2PlacementPolicyImageEntityFilter
    (Required) Category-based entity filter.
    LastUpdateTime string
    Name string
    (Required) Name of the image placement policy.
    OwnerExtId string
    PlacementType string
    (Required) Type of the image placement policy. Valid values "HARD", "SOFT"
    clusterEntityFilters List<GetImagePlacementPoliciesV2PlacementPolicyClusterEntityFilter>
    (Required) Category-based entity filter.
    createTime String
    description String
    (Optional) Description of the image placement policy.
    enforcementState String
    (Optional) Enforcement status of the image placement policy. Valid values "ACTIVE", "SUSPENDED"
    extId String
    The external identifier of an image placement policy.
    imageEntityFilters List<GetImagePlacementPoliciesV2PlacementPolicyImageEntityFilter>
    (Required) Category-based entity filter.
    lastUpdateTime String
    name String
    (Required) Name of the image placement policy.
    ownerExtId String
    placementType String
    (Required) Type of the image placement policy. Valid values "HARD", "SOFT"
    clusterEntityFilters GetImagePlacementPoliciesV2PlacementPolicyClusterEntityFilter[]
    (Required) Category-based entity filter.
    createTime string
    description string
    (Optional) Description of the image placement policy.
    enforcementState string
    (Optional) Enforcement status of the image placement policy. Valid values "ACTIVE", "SUSPENDED"
    extId string
    The external identifier of an image placement policy.
    imageEntityFilters GetImagePlacementPoliciesV2PlacementPolicyImageEntityFilter[]
    (Required) Category-based entity filter.
    lastUpdateTime string
    name string
    (Required) Name of the image placement policy.
    ownerExtId string
    placementType string
    (Required) Type of the image placement policy. Valid values "HARD", "SOFT"
    cluster_entity_filters Sequence[GetImagePlacementPoliciesV2PlacementPolicyClusterEntityFilter]
    (Required) Category-based entity filter.
    create_time str
    description str
    (Optional) Description of the image placement policy.
    enforcement_state str
    (Optional) Enforcement status of the image placement policy. Valid values "ACTIVE", "SUSPENDED"
    ext_id str
    The external identifier of an image placement policy.
    image_entity_filters Sequence[GetImagePlacementPoliciesV2PlacementPolicyImageEntityFilter]
    (Required) Category-based entity filter.
    last_update_time str
    name str
    (Required) Name of the image placement policy.
    owner_ext_id str
    placement_type str
    (Required) Type of the image placement policy. Valid values "HARD", "SOFT"
    clusterEntityFilters List<Property Map>
    (Required) Category-based entity filter.
    createTime String
    description String
    (Optional) Description of the image placement policy.
    enforcementState String
    (Optional) Enforcement status of the image placement policy. Valid values "ACTIVE", "SUSPENDED"
    extId String
    The external identifier of an image placement policy.
    imageEntityFilters List<Property Map>
    (Required) Category-based entity filter.
    lastUpdateTime String
    name String
    (Required) Name of the image placement policy.
    ownerExtId String
    placementType String
    (Required) Type of the image placement policy. Valid values "HARD", "SOFT"

    GetImagePlacementPoliciesV2PlacementPolicyClusterEntityFilter

    CategoryExtIds List<string>
    Array of strings
    Type string
    (Required) Filter matching type. Valid values "CATEGORIES_MATCH_ALL", "CATEGORIES_MATCH_ANY"
    CategoryExtIds []string
    Array of strings
    Type string
    (Required) Filter matching type. Valid values "CATEGORIES_MATCH_ALL", "CATEGORIES_MATCH_ANY"
    categoryExtIds List<String>
    Array of strings
    type String
    (Required) Filter matching type. Valid values "CATEGORIES_MATCH_ALL", "CATEGORIES_MATCH_ANY"
    categoryExtIds string[]
    Array of strings
    type string
    (Required) Filter matching type. Valid values "CATEGORIES_MATCH_ALL", "CATEGORIES_MATCH_ANY"
    category_ext_ids Sequence[str]
    Array of strings
    type str
    (Required) Filter matching type. Valid values "CATEGORIES_MATCH_ALL", "CATEGORIES_MATCH_ANY"
    categoryExtIds List<String>
    Array of strings
    type String
    (Required) Filter matching type. Valid values "CATEGORIES_MATCH_ALL", "CATEGORIES_MATCH_ANY"

    GetImagePlacementPoliciesV2PlacementPolicyImageEntityFilter

    CategoryExtIds List<string>
    Array of strings
    Type string
    (Required) Filter matching type. Valid values "CATEGORIES_MATCH_ALL", "CATEGORIES_MATCH_ANY"
    CategoryExtIds []string
    Array of strings
    Type string
    (Required) Filter matching type. Valid values "CATEGORIES_MATCH_ALL", "CATEGORIES_MATCH_ANY"
    categoryExtIds List<String>
    Array of strings
    type String
    (Required) Filter matching type. Valid values "CATEGORIES_MATCH_ALL", "CATEGORIES_MATCH_ANY"
    categoryExtIds string[]
    Array of strings
    type string
    (Required) Filter matching type. Valid values "CATEGORIES_MATCH_ALL", "CATEGORIES_MATCH_ANY"
    category_ext_ids Sequence[str]
    Array of strings
    type str
    (Required) Filter matching type. Valid values "CATEGORIES_MATCH_ALL", "CATEGORIES_MATCH_ANY"
    categoryExtIds List<String>
    Array of strings
    type String
    (Required) Filter matching type. Valid values "CATEGORIES_MATCH_ALL", "CATEGORIES_MATCH_ANY"

    Package Details

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