Share via

az azurestackhci networkinterface

  • Experimental
  • Reference

Note

This reference is part of the azurestackhci extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az azurestackhci networkinterface command. Learn more about extensions.

Command group 'azurestackhci' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage networkinterface with azurestackhci.

Commands

Name Description Type Status
az azurestackhci networkinterface create

Create a network interface.

 Extension Experimental
az azurestackhci networkinterface delete

Delete a network interface.

 Extension Experimental
az azurestackhci networkinterface list

List all network interfaces.

 Extension Experimental
az azurestackhci networkinterface show

Get the details of a network interface.

 Extension Experimental
az azurestackhci networkinterface update

Update a network interface.

 Extension Experimental

az azurestackhci networkinterface create

Experimental

Command group 'azurestackhci' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a network interface.

az azurestackhci networkinterface create --name
                                         --resource-group
                                         [--dns-servers]
                                         [--extended-location]
                                         [--gateway]
                                         [--ip-address]
                                         [--ip-allocation-method]
                                         [--ip-configurations]
                                         [--location]
                                         [--mac-address]
                                         [--prefix-length]
                                         [--subnet-id]
                                         [--tags]

Examples

Without ip configurations provided

az azurestackhci networkinterface create --resource-group "test-rg" --extended-location name="/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location" type="CustomLocation" --location "West US2" --subnet-id "test-vnet" --gateway "sample_gateway" --prefix-length 16 --ip-address "10.0.0.0" --ip-allocation-method "Static" --name "test-nic"

Required Parameters

--name

Name of the network interface.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--dns-servers

Space-separated list of DNS server IP addresses.

Usage: --dns-servers 10.220.32.16 10.220.32.17.

--extended-location

Usage: --extended-location type=XX name=XX

type: The extended location type. name: The extended location name.

--gateway

Gateway for network interface.

Usage: --gateway "1.2.3.4".

--ip-address

Ip_address - Private IP address of the IP configuration.

Usage: --ip-address "1.2.3.4".

--ip-allocation-method

Ip_allocation_method - The private IP address allocation method. Possible values include: Static, Dynamic.

Usage: --ip-allocation-method "Static/Dynamic".

--ip-configurations

IPConfigurations - A list of IPConfigurations of the network interface. Expected value: json-string/@json-file.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--mac-address

MacAddress - The MAC address of the network interface.

--prefix-length

Prefix_length for network interface.

Usage: --prefix-length 16.

--subnet-id

ID of the subnet or network to create the network interface on.

Usage: --subnet-id "test-vnet" The subnet-id provided will be ignored if ip-configurations parameter is also provided.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 azurestackhci networkinterface delete

Experimental

Command group 'azurestackhci' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a network interface.

az azurestackhci networkinterface delete [--ids]
                                         [--name]
                                         [--resource-group]
                                         [--subscription]
                                         [--yes]

Examples

DeleteNetworkInterface

az azurestackhci networkinterface delete --name "test-nic" --resource-group "test-rg"

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

Name of the network interface.

--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 azurestackhci networkinterface list

Experimental

Command group 'azurestackhci' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all network interfaces.

az azurestackhci networkinterface list [--resource-group]

Examples

ListNetworkInterfaceByResourceGroup

az azurestackhci networkinterface list --resource-group "test-rg"

ListNetworkInterfaceBySubscription

az azurestackhci networkinterface list

Optional Parameters

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

--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 azurestackhci networkinterface show

Experimental

Command group 'azurestackhci' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the details of a network interface.

az azurestackhci networkinterface show [--ids]
                                       [--name]
                                       [--resource-group]
                                       [--subscription]

Examples

GetNetworkInterface

az azurestackhci networkinterface show --name "test-nic" --resource-group "test-rg"

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

Name of the network interface.

--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 azurestackhci networkinterface update

Experimental

Command group 'azurestackhci' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a network interface.

az azurestackhci networkinterface update [--ids]
                                         [--name]
                                         [--resource-group]
                                         [--subscription]
                                         [--tags]

Examples

UpdateNetworkInterface

az azurestackhci networkinterface update --tags additionalProperties="sample" --name "test-nic" --resource-group "test-rg"

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

Name of the network interface.

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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.