1. Packages
  2. Azure Native
  3. API Docs
  4. avs
  5. PlacementPolicy
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi

azure-native.avs.PlacementPolicy

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi

    A vSphere Distributed Resource Scheduler (DRS) placement policy

    Uses Azure REST API version 2023-09-01. In version 2.x of the Azure Native provider, it used API version 2022-05-01.

    Other available API versions: 2022-05-01, 2023-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native avs [ApiVersion]. See the version guide for details.

    Example Usage

    PlacementPolicies_CreateOrUpdate

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var placementPolicy = new AzureNative.AVS.PlacementPolicy("placementPolicy", new()
        {
            ClusterName = "cluster1",
            PlacementPolicyName = "policy1",
            PrivateCloudName = "cloud1",
            ResourceGroupName = "group1",
            Type = AzureNative.AVS.PlacementPolicyType.VmHost,
        });
    
    });
    
    package main
    
    import (
    	avs "github.com/pulumi/pulumi-azure-native-sdk/avs/v3"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := avs.NewPlacementPolicy(ctx, "placementPolicy", &avs.PlacementPolicyArgs{
    			ClusterName:         pulumi.String("cluster1"),
    			PlacementPolicyName: pulumi.String("policy1"),
    			PrivateCloudName:    pulumi.String("cloud1"),
    			ResourceGroupName:   pulumi.String("group1"),
    			Type:                pulumi.String(avs.PlacementPolicyTypeVmHost),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.avs.PlacementPolicy;
    import com.pulumi.azurenative.avs.PlacementPolicyArgs;
    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) {
            var placementPolicy = new PlacementPolicy("placementPolicy", PlacementPolicyArgs.builder()
                .clusterName("cluster1")
                .placementPolicyName("policy1")
                .privateCloudName("cloud1")
                .resourceGroupName("group1")
                .type("VmHost")
                .build());
    
        }
    }
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const placementPolicy = new azure_native.avs.PlacementPolicy("placementPolicy", {
        clusterName: "cluster1",
        placementPolicyName: "policy1",
        privateCloudName: "cloud1",
        resourceGroupName: "group1",
        type: azure_native.avs.PlacementPolicyType.VmHost,
    });
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    placement_policy = azure_native.avs.PlacementPolicy("placementPolicy",
        cluster_name="cluster1",
        placement_policy_name="policy1",
        private_cloud_name="cloud1",
        resource_group_name="group1",
        type=azure_native.avs.PlacementPolicyType.VM_HOST)
    
    resources:
      placementPolicy:
        type: azure-native:avs:PlacementPolicy
        properties:
          clusterName: cluster1
          placementPolicyName: policy1
          privateCloudName: cloud1
          resourceGroupName: group1
          type: VmHost
    

    Create PlacementPolicy Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PlacementPolicy(name: string, args: PlacementPolicyArgs, opts?: CustomResourceOptions);
    @overload
    def PlacementPolicy(resource_name: str,
                        args: PlacementPolicyArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def PlacementPolicy(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        cluster_name: Optional[str] = None,
                        private_cloud_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        type: Optional[Union[str, PlacementPolicyType]] = None,
                        display_name: Optional[str] = None,
                        placement_policy_name: Optional[str] = None,
                        state: Optional[Union[str, PlacementPolicyState]] = None)
    func NewPlacementPolicy(ctx *Context, name string, args PlacementPolicyArgs, opts ...ResourceOption) (*PlacementPolicy, error)
    public PlacementPolicy(string name, PlacementPolicyArgs args, CustomResourceOptions? opts = null)
    public PlacementPolicy(String name, PlacementPolicyArgs args)
    public PlacementPolicy(String name, PlacementPolicyArgs args, CustomResourceOptions options)
    
    type: azure-native:avs:PlacementPolicy
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args PlacementPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PlacementPolicyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PlacementPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PlacementPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PlacementPolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var placementPolicyResource = new AzureNative.AVS.PlacementPolicy("placementPolicyResource", new()
    {
        ClusterName = "string",
        PrivateCloudName = "string",
        ResourceGroupName = "string",
        Type = "string",
        DisplayName = "string",
        PlacementPolicyName = "string",
        State = "string",
    });
    
    example, err := avs.NewPlacementPolicy(ctx, "placementPolicyResource", &avs.PlacementPolicyArgs{
    	ClusterName:         pulumi.String("string"),
    	PrivateCloudName:    pulumi.String("string"),
    	ResourceGroupName:   pulumi.String("string"),
    	Type:                pulumi.String("string"),
    	DisplayName:         pulumi.String("string"),
    	PlacementPolicyName: pulumi.String("string"),
    	State:               pulumi.String("string"),
    })
    
    var placementPolicyResource = new PlacementPolicy("placementPolicyResource", PlacementPolicyArgs.builder()
        .clusterName("string")
        .privateCloudName("string")
        .resourceGroupName("string")
        .type("string")
        .displayName("string")
        .placementPolicyName("string")
        .state("string")
        .build());
    
    placement_policy_resource = azure_native.avs.PlacementPolicy("placementPolicyResource",
        cluster_name="string",
        private_cloud_name="string",
        resource_group_name="string",
        type="string",
        display_name="string",
        placement_policy_name="string",
        state="string")
    
    const placementPolicyResource = new azure_native.avs.PlacementPolicy("placementPolicyResource", {
        clusterName: "string",
        privateCloudName: "string",
        resourceGroupName: "string",
        type: "string",
        displayName: "string",
        placementPolicyName: "string",
        state: "string",
    });
    
    type: azure-native:avs:PlacementPolicy
    properties:
        clusterName: string
        displayName: string
        placementPolicyName: string
        privateCloudName: string
        resourceGroupName: string
        state: string
        type: string
    

    PlacementPolicy Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PlacementPolicy resource accepts the following input properties:

    ClusterName string
    Name of the cluster
    PrivateCloudName string
    Name of the private cloud
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    Type string | Pulumi.AzureNative.AVS.PlacementPolicyType
    Placement Policy type
    DisplayName string
    Display name of the placement policy
    PlacementPolicyName string
    Name of the placement policy.
    State string | Pulumi.AzureNative.AVS.PlacementPolicyState
    Whether the placement policy is enabled or disabled
    ClusterName string
    Name of the cluster
    PrivateCloudName string
    Name of the private cloud
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    Type string | PlacementPolicyType
    Placement Policy type
    DisplayName string
    Display name of the placement policy
    PlacementPolicyName string
    Name of the placement policy.
    State string | PlacementPolicyStateEnum
    Whether the placement policy is enabled or disabled
    clusterName String
    Name of the cluster
    privateCloudName String
    Name of the private cloud
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    type String | PlacementPolicyType
    Placement Policy type
    displayName String
    Display name of the placement policy
    placementPolicyName String
    Name of the placement policy.
    state String | PlacementPolicyState
    Whether the placement policy is enabled or disabled
    clusterName string
    Name of the cluster
    privateCloudName string
    Name of the private cloud
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    type string | PlacementPolicyType
    Placement Policy type
    displayName string
    Display name of the placement policy
    placementPolicyName string
    Name of the placement policy.
    state string | PlacementPolicyState
    Whether the placement policy is enabled or disabled
    cluster_name str
    Name of the cluster
    private_cloud_name str
    Name of the private cloud
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    type str | PlacementPolicyType
    Placement Policy type
    display_name str
    Display name of the placement policy
    placement_policy_name str
    Name of the placement policy.
    state str | PlacementPolicyState
    Whether the placement policy is enabled or disabled
    clusterName String
    Name of the cluster
    privateCloudName String
    Name of the private cloud
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    type String | "VmVm" | "VmHost"
    Placement Policy type
    displayName String
    Display name of the placement policy
    placementPolicyName String
    Name of the placement policy.
    state String | "Enabled" | "Disabled"
    Whether the placement policy is enabled or disabled

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PlacementPolicy resource produces the following output properties:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    The provisioning state
    SystemData Pulumi.AzureNative.AVS.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    The provisioning state
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    The provisioning state
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    provisioningState string
    The provisioning state
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    azure_api_version str
    The Azure API version of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    provisioning_state str
    The provisioning state
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    The provisioning state
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    Supporting Types

    PlacementPolicyState, PlacementPolicyStateArgs

    Enabled
    Enabledis enabled
    Disabled
    Disabledis disabled
    PlacementPolicyStateEnabled
    Enabledis enabled
    PlacementPolicyStateDisabled
    Disabledis disabled
    Enabled
    Enabledis enabled
    Disabled
    Disabledis disabled
    Enabled
    Enabledis enabled
    Disabled
    Disabledis disabled
    ENABLED
    Enabledis enabled
    DISABLED
    Disabledis disabled
    "Enabled"
    Enabledis enabled
    "Disabled"
    Disabledis disabled

    PlacementPolicyType, PlacementPolicyTypeArgs

    VmVm
    VmVm
    VmHost
    VmHost
    PlacementPolicyTypeVmVm
    VmVm
    PlacementPolicyTypeVmHost
    VmHost
    VmVm
    VmVm
    VmHost
    VmHost
    VmVm
    VmVm
    VmHost
    VmHost
    VM_VM
    VmVm
    VM_HOST
    VmHost
    "VmVm"
    VmVm
    "VmHost"
    VmHost

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:avs:PlacementPolicy policy1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/placementPolicies/{placementPolicyName} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi