Share via

az vmware workload-network public-ip

  • 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 public-ip command. Learn more about extensions.

Commands to manage a Public-IP workload network.

Commands

Name Description Type Status
az vmware workload-network public-ip create

Create a Public IP Block by id in a private cloud workload network.

 Extension GA
az vmware workload-network public-ip delete

Delete a Public IP Block by id in a private cloud workload network.

 Extension GA
az vmware workload-network public-ip list

List of Public IP Blocks in a private cloud workload network.

 Extension GA
az vmware workload-network public-ip show

Get a Public IP Block by id in a private cloud workload network.

 Extension GA
az vmware workload-network public-ip wait

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

 Extension GA

az vmware workload-network public-ip create

Create a Public IP Block by id in a private cloud workload network.

az vmware workload-network public-ip create --name
                                            --private-cloud
                                            --resource-group
                                            [--display-name]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--number-of-public-ips]

Examples

Create a Public IP Block by ID in a workload network.

az vmware workload-network public-ip create --resource-group group1 --private-cloud cloud1 --public-ip publicIP1 --display-name publicIP1 --number-of-public-ips 32

Required Parameters

--name --public-ip -n

NSX Public IP Block identifier. Generally the same as the Public IP Block's display name.

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

--display-name

Display name of the Public IP Block.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--number-of-public-ips

Number of Public IPs requested.

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 public-ip delete

Delete a Public IP Block by id in a private cloud workload network.

az vmware workload-network public-ip delete [--ids]
                                            [--name]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--private-cloud]
                                            [--resource-group]
                                            [--subscription]
                                            [--yes]

Examples

Delete a Public IP Block by ID in a workload network.

az vmware workload-network public-ip delete --resource-group group1 --private-cloud cloud1 --public-ip publicIP1

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 --public-ip -n

NSX Public IP Block identifier. Generally the same as the Public IP Block's display name.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

--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 vmware workload-network public-ip list

List of Public IP Blocks in a private cloud workload network.

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

Examples

List of Public IP Blocks in a workload network.

az vmware workload-network public-ip 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 public-ip show

Get a Public IP Block by id in a private cloud workload network.

az vmware workload-network public-ip show [--ids]
                                          [--name]
                                          [--private-cloud]
                                          [--resource-group]
                                          [--subscription]

Examples

Get a Public IP Block by ID in a workload network.

az vmware workload-network public-ip show --resource-group group1 --private-cloud cloud1 --public-ip publicIP1

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 --public-ip -n

NSX Public IP Block identifier. Generally the same as the Public IP Block's display name.

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

az vmware workload-network public-ip wait

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

az vmware workload-network public-ip wait [--created]
                                          [--custom]
                                          [--deleted]
                                          [--exists]
                                          [--ids]
                                          [--interval]
                                          [--name]
                                          [--private-cloud]
                                          [--resource-group]
                                          [--subscription]
                                          [--timeout]
                                          [--updated]

Optional Parameters

--created

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

Default value: False
--custom

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

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

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.

--interval

Polling interval in seconds.

Default value: 30
--name --public-ip -n

NSX Public IP Block identifier. Generally the same as the Public IP Block's display name.

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

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

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.