Get-AzProximityPlacementGroup

Module:

Az.Compute

Get or list Proximity Placement Group resource(s).

Syntax

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

Get-AzProximityPlacementGroup
   [-ColocationStatus]
   [-ResourceId] <String>
   [-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.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

The name of the proximity placement group.

Type:	String
Aliases:	ProximityPlacementGroupName
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	True

-ResourceGroupName

The name of the resource group.

Type:	String
Position:	0
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	True

-ResourceId

The resource id for the proximity placement group.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

String

Outputs

PSProximityPlacementGroup