Edit

Share via

Get-AzVMwarePlacementPolicy

Module:
Az.VMware Module

Get a PlacementPolicy

Syntax

List (Default) 

Get-AzVMwarePlacementPolicy
    -ClusterName <String>
    -PrivateCloudName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityPrivateCloud 

Get-AzVMwarePlacementPolicy
    -ClusterName <String>
    -Name <String>
    -PrivateCloudInputObject <IVMwareIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get 

Get-AzVMwarePlacementPolicy
    -ClusterName <String>
    -Name <String>
    -PrivateCloudName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityCluster 

Get-AzVMwarePlacementPolicy
    -Name <String>
    -ClusterInputObject <IVMwareIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity 

Get-AzVMwarePlacementPolicy
    -InputObject <IVMwareIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Get a PlacementPolicy

Examples

Example 1: List placement policy by private cloud cluster

Get-AzVMwarePlacementPolicy -ClusterName cluster1 -PrivateCloudName cloud1 -ResourceGroupName group1

Name    ResourceGroupName
----    -----------------
policy1 group1
policy2 group1

List placement policy by private cloud cluster

Example 2: Get a placement policy by name in a private cloud cluster

Get-AzVMwarePlacementPolicy -ClusterName cluster1 -Name policy1 -PrivateCloudName cloud1 -ResourceGroupName group1

Name    ResourceGroupName
----    -----------------
policy1 group1

Get a placement policy by name in a private cloud cluster

Parameters

-ClusterInputObject

Identity Parameter

Parameter properties

Type:IVMwareIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentityCluster
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-ClusterName

Name of the cluster

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
GetViaIdentityPrivateCloud
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter

Parameter properties

Type:IVMwareIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Name of the placement policy.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:PlacementPolicyName

Parameter sets

GetViaIdentityPrivateCloud
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
GetViaIdentityCluster
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PrivateCloudInputObject

Identity Parameter

Parameter properties

Type:IVMwareIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentityPrivateCloud
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-PrivateCloudName

Name of the private cloud

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Parameter properties

Type:

String[]

Default value:(Get-AzContext).Subscription.Id
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

IVMwareIdentity

Outputs

IPlacementPolicy