Share via

az networkfabric nni

  • Reference

Note

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

Manage Network To Network Interconnect Resource.

Commands

Name Description Type Status
az networkfabric nni create

Create a Network To Network Interconnect resource.

 Extension GA
az networkfabric nni delete

Delete the Network To Network Interconnect resource.

 Extension GA
az networkfabric nni list

List all Network To Network Interconnects in the provided resource group.

 Extension GA
az networkfabric nni show

Show details of the provided Network To Network Interconnect resource.

 Extension GA
az networkfabric nni update

Update the Network to Network interconnect resource.

 Extension GA
az networkfabric nni wait

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

 Extension GA

az networkfabric nni create

Create a Network To Network Interconnect resource.

az networkfabric nni create --fabric
                            --resource-group
                            --resource-name
                            --use-option-b {False, True}
                            [--egress-acl-id]
                            [--export-route-policy]
                            [--import-route-policy]
                            [--ingress-acl-id]
                            [--is-management-type {False, True}]
                            [--layer2-configuration]
                            [--nni-type {CE, NPB}]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--npb-static-route-configuration]
                            [--option-b-layer3-configuration]

Examples

Create a Network To Network Interconnect

az networkfabric nni create --resource-group "example-rg" --fabric "example-fabric" --resource-name "example-nni" --nni-type "CE" --is-management-type "True" --use-option-b "True" --import-route-policy "{importIpv4RoutePolicyId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/microsoft.managednetworkfabric/routePolicies/example-routepolicy',importIpv6RoutePolicyId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/microsoft.managednetworkfabric/routePolicies/example-routepolicy'}" --export-route-policy "{exportIpv4RoutePolicyId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/microsoft.managednetworkfabric/routePolicies/example-routepolicy',exportIpv6RoutePolicyId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/microsoft.managednetworkfabric/routePolicies/example-routepolicy'}" --layer2-configuration "{interfaces:['resourceId'],mtu:1500}" --option-b-layer3-configuration "{peerASN:28,vlanId:501,primaryIpv4Prefix:'172.31.0.0/31',secondaryIpv4Prefix:'172.31.0.20/31'}"

Help text for sub parameters under the specific parent can be viewed by using the shorthand syntax '??'. See https://github.com/Azure/azure-cli/tree/dev/doc/shorthand_syntax.md for more about shorthand syntax.

az networkfabric nni create --layer2-configuration "??"

Required Parameters

--fabric --fabric-name

Name of the Network Fabric.

--resource-group -g

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

--resource-name

Name of the Network to Network Interconnect.

--use-option-b

Selection of option B for NNI. Example: True.

Accepted values: False, True

Optional Parameters

--egress-acl-id

Egress Acl ARM resource ID.

--export-route-policy

Export Route Policy configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--import-route-policy

Import Route Policy configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--ingress-acl-id

Ingress Acl ARM resource ID.

--is-management-type

Configuration to use NNI for Infrastructure Management. Default value is True. Example: True.

Accepted values: False, True
--layer2-configuration

Common properties for Layer2 Configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--nni-type

Usage type of NNI. Default value is CE. Example: CE.

Accepted values: CE, NPB
--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--npb-static-route-configuration

NPB Static Route Configuration properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--option-b-layer3-configuration

Common properties for Layer3Configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 networkfabric nni delete

Delete the Network To Network Interconnect resource.

az networkfabric nni delete [--fabric]
                            [--ids]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--resource-group]
                            [--resource-name]
                            [--subscription]

Examples

Delete the Network To Network Interconnect

az networkfabric nni delete --resource-group "example-rg" --fabric "example-fabric" --resource-name "example-nni"

Optional Parameters

--fabric --fabric-name

Name of the Network Fabric.

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

--no-wait

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

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

--resource-name

Name of the Network to Network Interconnect.

--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 networkfabric nni list

List all Network To Network Interconnects in the provided resource group.

az networkfabric nni list --fabric
                          --resource-group
                          [--max-items]
                          [--next-token]

Examples

List the Network To Network Interconnects for Resource Group

az networkfabric nni list --resource-group "example-rg" --fabric "example-fabric"

Required Parameters

--fabric --fabric-name

Name of the Network Fabric.

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

Show details of the provided Network To Network Interconnect resource.

az networkfabric nni show [--fabric]
                          [--ids]
                          [--resource-group]
                          [--resource-name]
                          [--subscription]

Examples

Show the Network To Network Interconnect

az networkfabric nni show --resource-group "example-rg" --fabric "example-fabric" --resource-name "example-nni"

Optional Parameters

--fabric --fabric-name

Name of the Network Fabric.

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

--resource-group -g

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

--resource-name

Name of the Network to Network Interconnect.

--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 networkfabric nni update

Update the Network to Network interconnect resource.

az networkfabric nni update [--egress-acl-id]
                            [--export-route-policy]
                            [--fabric]
                            [--ids]
                            [--import-route-policy]
                            [--ingress-acl-id]
                            [--layer2-configuration]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--npb-static-route-configuration]
                            [--option-b-layer3-configuration]
                            [--resource-group]
                            [--resource-name]
                            [--subscription]

Examples

Update the Network To Network Interconnect

az networkfabric nni update --resource-group "example-rg" --fabric "example-fabric" --resource-name "example-nni" --import-route-policy "{importIpv4RoutePolicyId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/microsoft.managednetworkfabric/routePolicies/example-routepolicy',importIpv6RoutePolicyId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/microsoft.managednetworkfabric/routePolicies/example-routepolicy'}" --export-route-policy "{exportIpv4RoutePolicyId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/microsoft.managednetworkfabric/routePolicies/example-routepolicy',exportIpv6RoutePolicyId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/microsoft.managednetworkfabric/routePolicies/example-routepolicy'}" --layer2-configuration "{interfaces:['resourceId'],mtu:1500}" --option-b-layer3-configuration "{peerASN:28,vlanId:501,primaryIpv4Prefix:'172.31.0.0/31',secondaryIpv4Prefix:'172.31.0.20/31'}"

Help text for sub parameters under the specific parent can be viewed by using the shorthand syntax '??'. See https://github.com/Azure/azure-cli/tree/dev/doc/shorthand_syntax.md for more about shorthand syntax.

az networkfabric nni update --layer2-configuration "??"

Optional Parameters

--egress-acl-id

Egress Acl ARM resource ID.

--export-route-policy

Export Route Policy information Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--fabric --fabric-name

Name of the Network Fabric.

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

--import-route-policy

Import Route Policy information. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--ingress-acl-id

Ingress Acl ARM resource ID.

--layer2-configuration

Common properties for Layer2Configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--npb-static-route-configuration

NPB Static Route Configuration properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--option-b-layer3-configuration

Common properties for Layer3Configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-group -g

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

--resource-name

Name of the Network to Network Interconnect.

--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 networkfabric nni wait

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

az networkfabric nni wait [--created]
                          [--custom]
                          [--deleted]
                          [--exists]
                          [--fabric]
                          [--ids]
                          [--interval]
                          [--resource-group]
                          [--resource-name]
                          [--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
--fabric --fabric-name

Name of the Network Fabric.

--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
--resource-group -g

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

--resource-name

Name of the Network to Network Interconnect.

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