Share via

az networkfabric interface

Note

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

Manage Network Interface Resource.

Commands

Name Description Type Status
az networkfabric interface list

List all Network Interfaces in the provided resource group.

 Extension GA
az networkfabric interface show

Show details of the provided Network Interface resource.

 Extension GA
az networkfabric interface update

Update certain properties of the Network Interface resource.

 Extension GA
az networkfabric interface update-admin-state

Update the admin state of the Network Interface.

 Extension GA
az networkfabric interface wait

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

 Extension GA

az networkfabric interface list

List all Network Interfaces in the provided resource group.

az networkfabric interface list --device --network-device-name
                                --resource-group
                                [--max-items]
                                [--next-token]

Examples

List the Network Interfaces for Resource Group

az networkfabric interface list -g "example-rg" --network-device-name "example-device"

Required Parameters

--device --network-device-name

Name of the Network Device.

--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 networkfabric interface show

Show details of the provided Network Interface resource.

az networkfabric interface show [--device --network-device-name]
                                [--ids]
                                [--resource-group]
                                [--resource-name]
                                [--subscription]

Examples

Show the Network Interface

az networkfabric interface show -g "example-rg" --network-device-name "example-device" --resource-name "example-interface"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--device --network-device-name

Name of the Network Device.

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

Name of the Network Interface.

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

az networkfabric interface update

Update certain properties of the Network Interface resource.

az networkfabric interface update [--additional-description]
                                  [--annotation]
                                  [--device --network-device-name]
                                  [--ids]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--resource-group]
                                  [--resource-name]
                                  [--subscription]

Examples

Update Network Interface

az networkfabric interface update -g "example-rg" --network-device-name "example-device" --resource-name "example-interface" --additional-description "additional description"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--additional-description

Additional description of the interface.

Property Value
Parameter group: Properties Arguments
--annotation

Switch configuration description.

Property Value
Parameter group: Properties Arguments
--device --network-device-name

Name of the Network Device.

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

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

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

Name of the Network Interface.

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

az networkfabric interface update-admin-state

Update the admin state of the Network Interface.

az networkfabric interface update-admin-state [--device --network-device-name]
                                              [--ids]
                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--resource-group]
                                              [--resource-ids]
                                              [--resource-name]
                                              [--state {Disable, Enable, UnderMaintenance}]
                                              [--subscription]

Examples

Update admin state of Network Interface

az networkfabric interface update-admin-state -g "example-rg" --network-device-name "example-device" --resource-name "example-interface" --state "Enable"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--device --network-device-name

Name of the Network Device.

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

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

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

Network Fabrics or Network Rack resource Id. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Body Arguments
--resource-name

Name of the Network Interface.

Property Value
Parameter group: Resource Id Arguments
--state

Administrative state.

Property Value
Parameter group: Body Arguments
Accepted values: Disable, Enable, UnderMaintenance
--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

az networkfabric interface wait

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

az networkfabric interface wait [--created]
                                [--custom]
                                [--deleted]
                                [--device --network-device-name]
                                [--exists]
                                [--ids]
                                [--interval]
                                [--resource-group]
                                [--resource-name]
                                [--subscription]
                                [--timeout]
                                [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--device --network-device-name

Name of the Network Device.

Property Value
Parameter group: Resource Id Arguments
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--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
--resource-name

Name of the Network Interface.

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

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
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