az ppg

Manage Proximity Placement Groups.

Commands

az ppg create Create a proximity placement group.
az ppg delete Delete a proximity placement group.
az ppg list List proximity placement groups.
az ppg show Get a proximity placement group.
az ppg update Update a proximity placement group.

az ppg create

Create a proximity placement group.

az ppg create --name
--resource-group
[--location]
[--subscription]
[--tags]
[--type]

Examples

Create a proximity placement group (autogenerated)

az ppg create --name MyProximityPlacementGroup --resource-group MyResourceGroup

Required Parameters

--name -n

The name of the proximity placement group.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Space-separated tags in 'key[=value]' format. Use "" to clear existing tags.

--type -t

The type of the proximity placement group. Allowed values: Standard.

az ppg delete

Delete a proximity placement group.

az ppg delete --name
--resource-group
[--subscription]

Required Parameters

--name -n

The name of the proximity placement group.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az ppg list

List proximity placement groups.

az ppg list [--resource-group]
[--subscription]

Examples

List proximity placement groups (autogenerated)

az ppg list --resource-group MyResourceGroup

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az ppg show

Get a proximity placement group.

az ppg show --name
--resource-group
[--subscription]

Examples

Get a proximity placement group (commonly used with --output). (autogenerated)

az ppg show --name MyProximityPlacementGroup --resource-group MyResourceGroup

Required Parameters

--name -n

The name of the proximity placement group.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az ppg update

Update a proximity placement group.

az ppg update --name
--resource-group
[--add]
[--force-string]
[--remove]
[--set]
[--subscription]

Required Parameters

--name -n

The name of the proximity placement group.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.