Share via

az vmware workload-network gateway

  • Reference

Note

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

Commands to manage a Gateway workload network.

Commands

Name Description Type Status
az vmware workload-network gateway list

List of gateways in a private cloud workload network.

 Extension GA
az vmware workload-network gateway show

Get a gateway by id in a private cloud workload network.

 Extension GA

az vmware workload-network gateway list

List of gateways in a private cloud workload network.

az vmware workload-network gateway list --private-cloud
                                        --resource-group
                                        [--max-items]
                                        [--next-token]

Examples

List of Gateways in a workload network.

az vmware workload-network gateway list --resource-group group1 --private-cloud cloud1

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

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

--next-token

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

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 vmware workload-network gateway show

Get a gateway by id in a private cloud workload network.

az vmware workload-network gateway show [--gateway]
                                        [--ids]
                                        [--private-cloud]
                                        [--resource-group]
                                        [--subscription]

Examples

Get a Gateway by ID in a workload network.

az vmware workload-network gateway show --resource-group group1 --private-cloud cloud1 --gateway gateway1

Optional Parameters

--gateway --name -n

NSX Gateway identifier. Generally the same as the Gateway's display name.

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

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

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