Note

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

Access to this page requires authorization. You can try .

New-AzProximityPlacementGroup

Create Proximity Placement Group resource.

Syntax

Default (Default)

New-AzProximityPlacementGroup
 [-ResourceGroupName] <String>
 [-Name] <String>
 [-Location] <String>
 [-ProximityPlacementGroupType <String>]
 [-Tag <Hashtable>]
 [-AsJob]
 [-Zone <String[]>]
 [-IntentVMSizeList <String[]>]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

This cmdlet will create Proximity Placement Group resource.

Examples

Example 1

New-AzProximityPlacementGroup -ResourceGroupName $resourceGroupName -Name $proximityPlacementGroupName -Location $location -Tag @{key1 = "val1"}
ResourceGroupName : rg0
ProximityPlacementGroupType : Standard
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 creates a proximity place group in the given location.

Example 2

Create Proximity Placement Group resource. (autogenerated)

New-AzProximityPlacementGroup -Location westus -Name 'AgentPool01' -ProximityPlacementGroupType <String> -ResourceGroupName myresourcegroup

Example 3

$ResourceGroupName = <Resource Group Name>
$PPGName = <PPG Name>
$Location = <Azure Region>
# Use the VM Sizes and Zone that you want to use for the Zone and IntentVMSizeList parameters.
New-AzProximityPlacementGroup -ResourceGroupName $ResourceGroupName -Name $PPGName -Location $Location -Zone '1' -IntentVMSizeList 'Standard_D4d_v4', 'Standard_D4d_v5';
$ppg = Get-AzProximityPlacementGroup -ResourceGroupName $ResourceGroupName -Name $PPGName;

# View the new values at $ppg.Intent.VmSizes[0], $ppg.Intent.VmSizes[1], and $ppg.Zones[0].

Parameters

-AsJob

Run cmdlet in the background

Parameter properties

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

Parameter sets

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

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

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

-IntentVMSizeList

Specifies possible sizes of virtual machines that can be created in the proximity placement group.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-Location

Resource location

Parameter properties

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

Parameter sets

-Name

The name of the proximity placement group.

Parameter properties

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

Parameter sets

-ProximityPlacementGroupType

Specifies the type of the proximity placement group. Possible values are: Standard or Ultra

Parameter properties

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

Parameter sets

-ResourceGroupName

The name of the resource group.

Parameter properties

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

Parameter sets

-Tag

Resource tags

Parameter properties

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

Parameter sets

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

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

Parameter sets

-Zone

Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created.

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?