az ppg

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 --proximity-placement-group-name
              --resource-group
              [--intent-vm-sizes]
              [--location]
              [--ppg-type --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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Parameters Arguments

--ppg-type --type -t

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

Property	Value
Accepted values:	Standard, Ultra

--tags

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

Property	Value
Parameter group:	Parameters Arguments

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

Property	Value
Parameter group:	Parameters Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az ppg delete

Delete a proximity placement group.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--name --proximity-placement-group-name -n

The name of the proximity placement group.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Pagination Arguments

--next-token

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

Property	Value
Parameter group:	Pagination Arguments

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az ppg show

Get a proximity placement group.

az ppg show [--ids]
            [--include-colocation-status {False, True}]
            [--name --proximity-placement-group-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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--include-colocation-status

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

Property	Value
Accepted values:	False, True

--name --proximity-placement-group-name -n

The name of the proximity placement group.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az ppg update

Update a proximity placement group.

az ppg update --name --proximity-placement-group-name
              --resource-group
              [--add]
              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
              [--intent-vm-sizes]
              [--ppg-type --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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Generic Update Arguments

--force-string

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

Property	Value
Parameter group:	Generic Update Arguments
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.

Property	Value
Accepted values:	Standard, Ultra

--remove

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

Property	Value
Parameter group:	Generic Update Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False