Share via

az connectedvmware resource-pool

  • Reference

Note

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

Resource pool resource.

Commands

Name Description Type Status
az connectedvmware resource-pool create

Create a resource pool resource.

 Extension GA
az connectedvmware resource-pool delete

Delete resource pool resource.

 Extension GA
az connectedvmware resource-pool list

Retrieve a list of resource pool of given resource group.

 Extension GA
az connectedvmware resource-pool show

Get details of a resource pool by id, resource-group, resource pool name, or subscription.

 Extension GA

az connectedvmware resource-pool create

Create a resource pool resource.

az connectedvmware resource-pool create --custom-location
                                        --inventory-item
                                        --location
                                        --name
                                        --resource-group
                                        --vcenter
                                        [--no-wait]
                                        [--tags]

Examples

Create resource pool

az connectedvmware resource-pool create --custom-location "custom location name"                --location "location name" --inventory-item "name or id the inventory item"                --name "resource pool name" --resource-group "resource group name"                --vcenter "name or id of the vcenter"

Required Parameters

--custom-location -c

Name or ID of the custom location that will manage this resource.

--inventory-item -i

Name or ID of the inventory item.

--location -l

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

--name -n

Name of the resource.

--resource-group -g

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

--vcenter -v

Name or ID of the vCenter that is managing this resource.

Optional Parameters

--no-wait

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

Default value: False
--tags

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

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 connectedvmware resource-pool delete

Delete resource pool resource.

az connectedvmware resource-pool delete [--force]
                                        [--ids]
                                        [--name]
                                        [--no-wait]
                                        [--resource-group]
                                        [--subscription]
                                        [--yes]

Examples

Delete resource pool

az connectedvmware resource-pool delete --ids "resource id" --name "resource pool name"                --resource-group "resource group name" --subscription "Name or ID of subscription"

Optional Parameters

--force

Whether force delete or not.

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.

--name -n

Name of the resource.

--no-wait

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

Default value: False
--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.

--yes -y

Do not prompt for confirmation.

Default value: False
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 connectedvmware resource-pool list

Retrieve a list of resource pool of given resource group.

az connectedvmware resource-pool list [--resource-group]

Examples

Retrieve a list of resource pool

az connectedvmware resource-pool list --resource-group "resource group name"

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 connectedvmware resource-pool show

Get details of a resource pool by id, resource-group, resource pool name, or subscription.

az connectedvmware resource-pool show [--ids]
                                      [--name]
                                      [--resource-group]
                                      [--subscription]

Examples

Get details of a resource pool

az connectedvmware resource-pool show --ids "resource id" --name "resource pool name"                --resource-group "resource group name" --subscription "Name or ID of 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 -n

Name of the resource.

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