Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. avs
  5. getPlacementPolicy
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.avs.getPlacementPolicy

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

A vSphere Distributed Resource Scheduler (DRS) placement policy Azure REST API version: 2022-05-01.

Other available API versions: 2023-03-01, 2023-09-01.

Using getPlacementPolicy

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 getPlacementPolicy(args: GetPlacementPolicyArgs, opts?: InvokeOptions): Promise<GetPlacementPolicyResult>
function getPlacementPolicyOutput(args: GetPlacementPolicyOutputArgs, opts?: InvokeOptions): Output<GetPlacementPolicyResult>
Copy
def get_placement_policy(cluster_name: Optional[str] = None,
                         placement_policy_name: Optional[str] = None,
                         private_cloud_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetPlacementPolicyResult
def get_placement_policy_output(cluster_name: Optional[pulumi.Input[str]] = None,
                         placement_policy_name: Optional[pulumi.Input[str]] = None,
                         private_cloud_name: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetPlacementPolicyResult]
Copy
func LookupPlacementPolicy(ctx *Context, args *LookupPlacementPolicyArgs, opts ...InvokeOption) (*LookupPlacementPolicyResult, error)
func LookupPlacementPolicyOutput(ctx *Context, args *LookupPlacementPolicyOutputArgs, opts ...InvokeOption) LookupPlacementPolicyResultOutput
Copy

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

public static class GetPlacementPolicy 
{
    public static Task<GetPlacementPolicyResult> InvokeAsync(GetPlacementPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetPlacementPolicyResult> Invoke(GetPlacementPolicyInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPlacementPolicyResult> getPlacementPolicy(GetPlacementPolicyArgs args, InvokeOptions options)
public static Output<GetPlacementPolicyResult> getPlacementPolicy(GetPlacementPolicyArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:avs:getPlacementPolicy
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterName
This property is required.
Changes to this property will trigger replacement.
string
Name of the cluster in the private cloud
PlacementPolicyName
This property is required.
Changes to this property will trigger replacement.
string
Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy
PrivateCloudName
This property is required.
Changes to this property will trigger replacement.
string
Name of the private cloud
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
Name of the cluster in the private cloud
PlacementPolicyName
This property is required.
Changes to this property will trigger replacement.
string
Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy
PrivateCloudName
This property is required.
Changes to this property will trigger replacement.
string
Name of the private cloud
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
Name of the cluster in the private cloud
placementPolicyName
This property is required.
Changes to this property will trigger replacement.
String
Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy
privateCloudName
This property is required.
Changes to this property will trigger replacement.
String
Name of the private cloud
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
clusterName
This property is required.
Changes to this property will trigger replacement.
string
Name of the cluster in the private cloud
placementPolicyName
This property is required.
Changes to this property will trigger replacement.
string
Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy
privateCloudName
This property is required.
Changes to this property will trigger replacement.
string
Name of the private cloud
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
cluster_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the cluster in the private cloud
placement_policy_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy
private_cloud_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the private cloud
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
Name of the cluster in the private cloud
placementPolicyName
This property is required.
Changes to this property will trigger replacement.
String
Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy
privateCloudName
This property is required.
Changes to this property will trigger replacement.
String
Name of the private cloud
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getPlacementPolicy Result

The following output properties are available:

Id string
Resource ID.
Name string
Resource name.
Properties VmHostPlacementPolicyPropertiesResponse | VmVmPlacementPolicyPropertiesResponse
placement policy properties
Type string
Resource type.
id String
Resource ID.
name String
Resource name.
properties VmHostPlacementPolicyPropertiesResponse | VmVmPlacementPolicyPropertiesResponse
placement policy properties
type String
Resource type.
id string
Resource ID.
name string
Resource name.
properties VmHostPlacementPolicyPropertiesResponse | VmVmPlacementPolicyPropertiesResponse
placement policy properties
type string
Resource type.
id str
Resource ID.
name str
Resource name.
properties VmHostPlacementPolicyPropertiesResponse | VmVmPlacementPolicyPropertiesResponse
placement policy properties
type str
Resource type.
id String
Resource ID.
name String
Resource name.
properties Property Map | Property Map
placement policy properties
type String
Resource type.

Supporting Types

VmHostPlacementPolicyPropertiesResponse

AffinityType This property is required. string
placement policy affinity type
HostMembers This property is required. List<string>
Host members list
ProvisioningState This property is required. string
The provisioning state
VmMembers This property is required. List<string>
Virtual machine members list
AffinityStrength string
vm-host placement policy affinity strength (should/must)
AzureHybridBenefitType string
placement policy azure hybrid benefit opt-in type
DisplayName string
Display name of the placement policy
State string
Whether the placement policy is enabled or disabled
AffinityType This property is required. string
placement policy affinity type
HostMembers This property is required. []string
Host members list
ProvisioningState This property is required. string
The provisioning state
VmMembers This property is required. []string
Virtual machine members list
AffinityStrength string
vm-host placement policy affinity strength (should/must)
AzureHybridBenefitType string
placement policy azure hybrid benefit opt-in type
DisplayName string
Display name of the placement policy
State string
Whether the placement policy is enabled or disabled
affinityType This property is required. String
placement policy affinity type
hostMembers This property is required. List<String>
Host members list
provisioningState This property is required. String
The provisioning state
vmMembers This property is required. List<String>
Virtual machine members list
affinityStrength String
vm-host placement policy affinity strength (should/must)
azureHybridBenefitType String
placement policy azure hybrid benefit opt-in type
displayName String
Display name of the placement policy
state String
Whether the placement policy is enabled or disabled
affinityType This property is required. string
placement policy affinity type
hostMembers This property is required. string[]
Host members list
provisioningState This property is required. string
The provisioning state
vmMembers This property is required. string[]
Virtual machine members list
affinityStrength string
vm-host placement policy affinity strength (should/must)
azureHybridBenefitType string
placement policy azure hybrid benefit opt-in type
displayName string
Display name of the placement policy
state string
Whether the placement policy is enabled or disabled
affinity_type This property is required. str
placement policy affinity type
host_members This property is required. Sequence[str]
Host members list
provisioning_state This property is required. str
The provisioning state
vm_members This property is required. Sequence[str]
Virtual machine members list
affinity_strength str
vm-host placement policy affinity strength (should/must)
azure_hybrid_benefit_type str
placement policy azure hybrid benefit opt-in type
display_name str
Display name of the placement policy
state str
Whether the placement policy is enabled or disabled
affinityType This property is required. String
placement policy affinity type
hostMembers This property is required. List<String>
Host members list
provisioningState This property is required. String
The provisioning state
vmMembers This property is required. List<String>
Virtual machine members list
affinityStrength String
vm-host placement policy affinity strength (should/must)
azureHybridBenefitType String
placement policy azure hybrid benefit opt-in type
displayName String
Display name of the placement policy
state String
Whether the placement policy is enabled or disabled

VmVmPlacementPolicyPropertiesResponse

AffinityType This property is required. string
placement policy affinity type
ProvisioningState This property is required. string
The provisioning state
VmMembers This property is required. List<string>
Virtual machine members list
DisplayName string
Display name of the placement policy
State string
Whether the placement policy is enabled or disabled
AffinityType This property is required. string
placement policy affinity type
ProvisioningState This property is required. string
The provisioning state
VmMembers This property is required. []string
Virtual machine members list
DisplayName string
Display name of the placement policy
State string
Whether the placement policy is enabled or disabled
affinityType This property is required. String
placement policy affinity type
provisioningState This property is required. String
The provisioning state
vmMembers This property is required. List<String>
Virtual machine members list
displayName String
Display name of the placement policy
state String
Whether the placement policy is enabled or disabled
affinityType This property is required. string
placement policy affinity type
provisioningState This property is required. string
The provisioning state
vmMembers This property is required. string[]
Virtual machine members list
displayName string
Display name of the placement policy
state string
Whether the placement policy is enabled or disabled
affinity_type This property is required. str
placement policy affinity type
provisioning_state This property is required. str
The provisioning state
vm_members This property is required. Sequence[str]
Virtual machine members list
display_name str
Display name of the placement policy
state str
Whether the placement policy is enabled or disabled
affinityType This property is required. String
placement policy affinity type
provisioningState This property is required. String
The provisioning state
vmMembers This property is required. List<String>
Virtual machine members list
displayName String
Display name of the placement policy
state String
Whether the placement policy is enabled or disabled

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native