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]
              [--ppg-type {Standard, Ultra}]
              [--tags]
              [--zone]

Examples

Create a proximity placement group.

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

Optional Parameters

--intent-vm-sizes

Specifies possible sizes of virtual machines that can be created in the proximity placement group. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--location -l

Resource location When not specified, the location of the resource group will be used.

--ppg-type --type -t

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

Accepted values: Standard, Ultra

--tags

Space-separated tags: key[=value] [key[=value] ...]. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--zone -z

Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 [--max-items]
            [--next-token]
            [--resource-group]

Examples

List proximity placement groups.

az ppg list --resource-group MyResourceGroup

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

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

--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 {0, 1, f, false, n, no, t, true, y, yes}]
              [--intent-vm-sizes]
              [--ppg-type {Standard, Ultra}]
              [--remove]
              [--set]

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

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.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--intent-vm-sizes

Specifies possible sizes of virtual machines that can be created in the proximity placement group. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--ppg-type --type -t

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

Accepted values: Standard, Ultra

--remove

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

--set

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

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.

Share via

az ppg

Commands

az ppg create

Examples

Required Parameters

Optional Parameters

az ppg delete

Optional Parameters

az ppg list

Examples

Optional Parameters

az ppg show

Examples

Optional Parameters

az ppg update

Examples

Required Parameters

Optional Parameters

Additional resources