Share via

az vmware hcx-enterprise-site

Note

This reference is part of the vmware extension for the Azure CLI (version 2.70.0 or higher). The extension will automatically install the first time you run an az vmware hcx-enterprise-site command. Learn more about extensions.

Commands to manage HCX Enterprise Sites in a private cloud.

Commands

Name Description Type Status
az vmware hcx-enterprise-site create

Create an HCX Enterprise Site in a private cloud.

 Extension GA
az vmware hcx-enterprise-site delete

Delete an HCX Enterprise Site in a private cloud.

 Extension GA
az vmware hcx-enterprise-site list

List HCX Enterprise Sites in a private cloud.

 Extension GA
az vmware hcx-enterprise-site show

Get an HCX Enterprise Site by name in a private cloud.

 Extension GA

az vmware hcx-enterprise-site create

Create an HCX Enterprise Site in a private cloud.

az vmware hcx-enterprise-site create --hcx-enterprise-site-name --name
                                     --private-cloud
                                     --resource-group

Required Parameters

--hcx-enterprise-site-name --name -n

Name of the HCX Enterprise Site in the private cloud.

--private-cloud -c

Name of the private cloud.

--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 vmware hcx-enterprise-site delete

Delete an HCX Enterprise Site in a private cloud.

az vmware hcx-enterprise-site delete [--hcx-enterprise-site-name --name]
                                     [--ids]
                                     [--private-cloud]
                                     [--resource-group]
                                     [--subscription]
                                     [--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.

--hcx-enterprise-site-name --name -n

Name of the HCX Enterprise Site in the private cloud.

Property Value
Parameter group: Resource Id 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
--private-cloud -c

Name of the private cloud.

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
--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 vmware hcx-enterprise-site list

List HCX Enterprise Sites in a private cloud.

az vmware hcx-enterprise-site list --private-cloud
                                   --resource-group
                                   [--max-items]
                                   [--next-token]

Required Parameters

--private-cloud -c

Name of the private cloud.

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

--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 vmware hcx-enterprise-site show

Get an HCX Enterprise Site by name in a private cloud.

az vmware hcx-enterprise-site show [--hcx-enterprise-site-name --name]
                                   [--ids]
                                   [--private-cloud]
                                   [--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.

--hcx-enterprise-site-name --name -n

Name of the HCX Enterprise Site in the private cloud.

Property Value
Parameter group: Resource Id 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
--private-cloud -c

Name of the private cloud.

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