Share via

az ppg

  • Reference

Manage Proximity Placement Groups.

Commands

Name Description Type Status
az ppg create

Create a proximity placement group.

 Core GA
az ppg delete

Delete a proximity placement group.

 Core GA
az ppg list

List proximity placement groups.

 Core GA
az ppg show

Get a proximity placement group.

 Core GA
az ppg update

Update a proximity placement group.

 Core GA

az ppg create

Create a proximity placement group.

az ppg create --name
              --resource-group
              [--intent-vm-sizes]
              [--location]
              [--tags]
              [--type {Standard, Ultra}]
              [--zone]

Examples

Create a proximity placement group (autogenerated)

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

Create a proximity placement group with specifying VM sizes that can be created.

az ppg create --name MyProximityPlacementGroup --resource-group MyResourceGroup \
    --intent-vm-sizes Standard_E64s_v4 Standard_M416ms_v2

Create a proximity placement group with specifying VM sizes that can be created and availability zone.

az ppg create --name MyProximityPlacementGroup --resource-group MyResourceGroup \
    --intent-vm-sizes Standard_E64s_v4 Standard_M416ms_v2 --zone 1

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

--intent-vm-sizes

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

--location -l

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--type -t

The type of the proximity placement group.

Accepted values: Standard, Ultra
--zone -z

Availability zone into which to provision the resource.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ppg delete

Delete a proximity placement group.

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

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --proximity-placement-group-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>.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ppg list

List proximity placement groups.

az ppg list [--resource-group]

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>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ppg show

Get a proximity placement group.

az ppg show [--ids]
            [--include-colocation-status {False, True}]
            [--name]
            [--resource-group]
            [--subscription]

Examples

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

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

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--include-colocation-status

Enable fetching the colocation status of all the resources in the proximity placement group.

Accepted values: False, True
--name --proximity-placement-group-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>.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ppg update

Update a proximity placement group.

az ppg update --name
              --resource-group
              [--add]
              [--force-string]
              [--include-colocation-status]
              [--intent-vm-sizes]
              [--remove]
              [--set]
              [--type {Standard, Ultra}]

Examples

Update a proximity placement group with specifying VM sizes that can be created.

az ppg update --name MyProximityPlacementGroup --resource-group MyResourceGroup \
    --intent-vm-sizes Standard_E64s_v4 Standard_M416ms_v2

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>.

Default value: []
--force-string

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

Default value: False
--include-colocation-status

IncludeColocationStatus=true enables fetching the colocation status of all the resources in the proximity placement group. Default value is None.

--intent-vm-sizes

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

--remove

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

Default value: []
--set

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

Default value: []
--type -t

The type of the proximity placement group.

Accepted values: Standard, Ultra
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.