az discovery supercomputer node-pool

Note

This reference is part of the discovery extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az discovery supercomputer node-pool command. Learn more about extensions.

Manage Node Pool.

Commands

Name	Description	Type	Status
az discovery supercomputer node-pool create	Create a NodePool.	Extension	GA
az discovery supercomputer node-pool delete	Delete a NodePool.	Extension	GA
az discovery supercomputer node-pool list	List NodePool resources by Supercomputer.	Extension	GA
az discovery supercomputer node-pool show	Get a NodePool.	Extension	GA
az discovery supercomputer node-pool update	Update a NodePool.	Extension	GA
az discovery supercomputer node-pool wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az discovery supercomputer node-pool create

Create a NodePool.

az discovery supercomputer node-pool create --name --node-pool-name
                                            --resource-group
                                            --supercomputer-name
                                            [--acquire-policy-token]
                                            [--change-reference]
                                            [--ic-lower-threshold --image-cache-lower-threshold]
                                            [--ic-upper-threshold --image-cache-upper-threshold]
                                            [--location]
                                            [--max-node-count]
                                            [--min-node-count]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--os-disk-size-gb]
                                            [--scale-set-priority {Regular, Spot}]
                                            [--subnet-id]
                                            [--tags]
                                            [--vm-size {Standard_NC16as_T4_v3, Standard_NC24ads_A100_v4, Standard_NC48ads_A100_v4, Standard_NC4as_T4_v3, Standard_NC64as_T4_v3, Standard_NC8as_T4_v3, Standard_NC96ads_A100_v4, Standard_ND40rs_v2, Standard_NV12ads_A10_v5, Standard_NV24ads_A10_v5, Standard_NV36adms_A10_v5, Standard_NV36ads_A10_v5, Standard_NV6ads_A10_v5, Standard_NV72ads_A10_v5}]

Examples

Create a GPU node pool for a supercomputer.

az discovery supercomputer node-pool create --resource-group MyResourceGroup --supercomputer-name MySupercomputer --name MyNodePool --location eastus --subnet-id /subscriptions/<subscription-id>/resourceGroups/MyNetworkRG/providers/Microsoft.Network/virtualNetworks/MyVnet/subnets/MyNodePoolSubnet --vm-size Standard_NC4as_T4_v3 --min-node-count 1 --max-node-count 4

Required Parameters

--name --node-pool-name -n

The name of the NodePool.

--resource-group -g

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

--supercomputer-name

The name of the Supercomputer.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--ic-lower-threshold --image-cache-lower-threshold

The percent of disk usage before which image garbage collection is never run. This cannot be set higher than imageCacheUpperThreshold. The default is 40%.

Property	Value
Parameter group:	Properties Arguments
Default value:	40

--ic-upper-threshold --image-cache-upper-threshold

The percent of disk usage after which image garbage collection is guaranteed to run. The default is 60%.

Property	Value
Parameter group:	Properties Arguments
Default value:	60

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property	Value
Parameter group:	Resource Arguments

--max-node-count

The maximum number of nodes.

Property	Value
Parameter group:	Properties Arguments

--min-node-count

The minimum number of nodes.

Property	Value
Parameter group:	Properties Arguments
Default value:	0

--no-wait

Do not wait for the long-running operation to finish.

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

--os-disk-size-gb

The size of the OS disk in GB. If not specified, the default is 120 GB.

Property	Value
Parameter group:	Properties Arguments
Default value:	120

--scale-set-priority

The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.

Property	Value
Parameter group:	Properties Arguments
Default value:	Regular
Accepted values:	Regular, Spot

--subnet-id

The node pool subnet.

Property	Value
Parameter group:	Properties Arguments

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Resource Arguments

--vm-size

The size of the underlying Azure VM.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Standard_NC16as_T4_v3, Standard_NC24ads_A100_v4, Standard_NC48ads_A100_v4, Standard_NC4as_T4_v3, Standard_NC64as_T4_v3, Standard_NC8as_T4_v3, Standard_NC96ads_A100_v4, Standard_ND40rs_v2, Standard_NV12ads_A10_v5, Standard_NV24ads_A10_v5, Standard_NV36adms_A10_v5, Standard_NV36ads_A10_v5, Standard_NV6ads_A10_v5, Standard_NV72ads_A10_v5

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 discovery supercomputer node-pool delete

Delete a NodePool.

az discovery supercomputer node-pool delete [--acquire-policy-token]
                                            [--change-reference]
                                            [--ids]
                                            [--name --node-pool-name]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--subscription]
                                            [--supercomputer-name]
                                            [--yes]

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--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 --node-pool-name -n

The name of the NodePool.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

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

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

--supercomputer-name

The name of the Supercomputer.

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

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 discovery supercomputer node-pool list

List NodePool resources by Supercomputer.

az discovery supercomputer node-pool list --resource-group
                                          --supercomputer-name
                                          [--max-items]
                                          [--next-token]

Required Parameters

--resource-group -g

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

--supercomputer-name

The name of the Supercomputer.

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

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 discovery supercomputer node-pool show

Get a NodePool.

az discovery supercomputer node-pool show [--ids]
                                          [--name --node-pool-name]
                                          [--resource-group]
                                          [--subscription]
                                          [--supercomputer-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.

--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 --node-pool-name -n

The name of the NodePool.

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

--supercomputer-name

The name of the Supercomputer.

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 discovery supercomputer node-pool update

Update a NodePool.

az discovery supercomputer node-pool update [--acquire-policy-token]
                                            [--add]
                                            [--change-reference]
                                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--ids]
                                            [--max-node-count]
                                            [--min-node-count]
                                            [--name --node-pool-name]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--remove]
                                            [--resource-group]
                                            [--set]
                                            [--subscription]
                                            [--supercomputer-name]
                                            [--tags]

Examples

Scale a node pool by updating its minimum and maximum node counts.

az discovery supercomputer node-pool update --resource-group MyResourceGroup --supercomputer-name MySupercomputer --name MyNodePool --min-node-count 2 --max-node-count 8

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy 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

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

--max-node-count

The maximum number of nodes.

Property	Value
Parameter group:	Properties Arguments

--min-node-count

The minimum number of nodes.

Property	Value
Parameter group:	Properties Arguments

--name --node-pool-name -n

The name of the NodePool.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

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

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

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

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

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

--supercomputer-name

The name of the Supercomputer.

Property	Value
Parameter group:	Resource Id Arguments

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Resource 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 discovery supercomputer node-pool wait

Place the CLI in a waiting state until a condition is met.

az discovery supercomputer node-pool wait [--acquire-policy-token]
                                          [--change-reference]
                                          [--created]
                                          [--custom]
                                          [--deleted]
                                          [--exists]
                                          [--ids]
                                          [--interval]
                                          [--name --node-pool-name]
                                          [--resource-group]
                                          [--subscription]
                                          [--supercomputer-name]
                                          [--timeout]
                                          [--updated]

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

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

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name --node-pool-name -n

The name of the NodePool.

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

--supercomputer-name

The name of the Supercomputer.

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

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