Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Get-AzProximityPlacementGroup

Get or list Proximity Placement Group resource(s).

Syntax

DefaultParameter (Default) 

Get-AzProximityPlacementGroup
 [[-ResourceGroupName] <String>]
 [[-Name] <String>]
 [-ColocationStatus]
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

ResourceIdParameter 

Get-AzProximityPlacementGroup
 [-ResourceId] <String>
 [-ColocationStatus]
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

Description

This cmdlet will get or list Proximity Placement Group resource(s).

Examples

Example 1

Get-AzProximityPlacementGroup -ResourceGroupName $resourceGroupName -Name $proximityPlacementGroupName

ResourceGroupName : rg0
ProximityPlacementGroupType : Standard
VirtualMachines : {}
VirtualMachineScaleSets : {}
AvailabilitySets : {}
Id : /subscriptions/5393f919-a68a-43d0-9063-4b2bda6bffdf/resourceGroups/rg0/providers/Microsoft.Compute/proximityPlacementGroups/ppg0
Name : ppg0
Type : Microsoft.Compute/proximityPlacementGroups
Location : westcentralus
Tags : {[key1, val1]}

This command gets the proximity placement group

Example 2

Get-AzProximityPlacementGroup -ResourceGroupName $resourceGroupName

ResourceGroupName Name Location Type
----------------- ---- -------- ----
rg0 ppg0 westcentralus Standard
rg0 ppg1 westcentralus Standard

This command list all proximity placement groups under the given resource group.

Example 3

Get-AzProximityPlacementGroup

ResourceGroupName Name Location Type
----------------- ---- -------- ----
rg0 ppg0 westcentralus Standard
rg0 ppg1 westcentralus Standard
rg1 ppg2 centralus Standard

This command list all proximity placement groups under the subscription.

Parameters

-ColocationStatus

Shows the colocation status of a resource in the proximity placement group.

Parameter properties

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

Parameter sets

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

-Name

The name of the proximity placement group.

Parameter properties

Type:String
Default value:None
Supports wildcards:True
DontShow:False
Aliases:ProximityPlacementGroupName

Parameter sets

-ResourceGroupName

The name of the resource group.

Parameter properties

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

Parameter sets

-ResourceId

The resource id for the proximity placement group.

Parameter properties

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

Parameter sets

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

String

Outputs

PSProximityPlacementGroup

Feedback

Was this page helpful?