az connectedvmware host

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 host command. Learn more about extensions.

Host resource.

Commands

Name	Description	Type	Status
az connectedvmware host create	Create a host resource.	Extension	GA
az connectedvmware host delete	Delete host resource.	Extension	GA
az connectedvmware host list	Retrieve a list of host of given resource group.	Extension	GA
az connectedvmware host show	Get details of a host by id, resource-group, host name, or subscription.	Extension	GA

az connectedvmware host create

Create a host resource.

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

Examples

Create host

az connectedvmware host create --custom-location "custom location name"                --location "location name" --inventory-item "name or id the inventory item"                --name "host 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

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

--no-wait

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

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

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 connectedvmware host delete

Delete host resource.

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

Examples

Delete host

az connectedvmware host delete --ids "resource id" --name "host name"                --resource-group "resource group name" --subscription "Name or ID of 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.

--force

Whether force delete or not.

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

--name -n

Name of the resource.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Default value:	False

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

--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 connectedvmware host list

Retrieve a list of host of given resource group.

az connectedvmware host list [--resource-group]

Examples

Retrieve a list of host

az connectedvmware host list --resource-group "resource 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.

--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 connectedvmware host show

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

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

Examples

Get details of a host

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

Name of the resource.

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