az stack-hci-vm network public-ip
Note
This reference is part of the stack-hci-vm extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az stack-hci-vm network public-ip command. Learn more about extensions.
Manage public IP addresses with stack-hci-vm.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az stack-hci-vm network public-ip create |
Create a public IP address. |
Extension | GA |
| az stack-hci-vm network public-ip delete |
Delete a public IP address. |
Extension | GA |
| az stack-hci-vm network public-ip list |
List all public IP addresses. |
Extension | GA |
| az stack-hci-vm network public-ip show |
Get the details of a public IP address. |
Extension | GA |
| az stack-hci-vm network public-ip update |
Update a public IP address. |
Extension | GA |
az stack-hci-vm network public-ip create
Create a public IP address.
az stack-hci-vm network public-ip create --custom-location
--name
--resource-group
[--allocation-scope]
[--ip-address]
[--location]
[--polling-interval]
[--tags]
[--version {IPv4, IPv6}]
Examples
CreatePublicIP
az stack-hci-vm network public-ip create --resource-group "test-rg" --name "test-pip" --location "eastus" --version IPv4 --allocation-scope /subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/MyHciRg/providers/Microsoft.AzureStackHCI/logicalNetworks/MyLnet --ip-address 20.30.40.50 --tags env=prod pip=yes --custom-location "/subscriptions/xxxx/resourceGroups/test-rg/providers/Microsoft.ExtendedLocation/customLocations/test-location"
Required Parameters
The ID of the custom location.
Name of the Public IP address.
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.
IP allocation scope (e.g., logical network or pool reference).
Static IP address to allocate. If omitted, one is allocated automatically.
If location is not specified, the location of the resource group is used.
ARM polling interval for long running operations.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
IP version. Defaults to IPv4.
| Property | Value |
|---|---|
| Accepted values: | IPv4, IPv6 |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az stack-hci-vm network public-ip delete
Delete a public IP address.
az stack-hci-vm network public-ip delete --name
--resource-group
[--polling-interval]
[--yes]
Examples
DeletePublicIP
az stack-hci-vm network public-ip delete --name "test-pip" --resource-group "test-rg" --yes
Required Parameters
Name of the Public IP address.
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.
ARM polling interval for long running operations.
Do not prompt for confirmation.
| Property | Value |
|---|---|
| Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az stack-hci-vm network public-ip list
List all public IP addresses.
az stack-hci-vm network public-ip list [--resource-group]
Examples
ListPublicIPs
az stack-hci-vm network public-ip list --resource-group "test-rg"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az stack-hci-vm network public-ip show
Get the details of a public IP address.
az stack-hci-vm network public-ip show --name
--resource-group
Examples
ShowPublicIP
az stack-hci-vm network public-ip show --name "test-pip" --resource-group "test-rg"
Required Parameters
Name of the Public IP address.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az stack-hci-vm network public-ip update
Update a public IP address.
az stack-hci-vm network public-ip update --name
--resource-group
[--tags]
Examples
UpdatePublicIP
az stack-hci-vm network public-ip update --resource-group "test-rg" --name "test-pip" --tags env=prod updated=yes
Required Parameters
Name of the Public IP address.
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.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |