Share via

az networkfabric internalnetwork

  • Reference

Note

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

Manage Internal Network Resource.

Commands

Name Description Type Status
az networkfabric internalnetwork create

Create a Internal Network resource.

 Extension GA
az networkfabric internalnetwork delete

Delete the Internal Network resource.

 Extension GA
az networkfabric internalnetwork list

List all Internal Networks in the provided resource group.

 Extension GA
az networkfabric internalnetwork show

Show details of the provided Internal Network resource.

 Extension GA
az networkfabric internalnetwork update

Update the Internal Network resource.

 Extension GA
az networkfabric internalnetwork wait

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

 Extension GA

az networkfabric internalnetwork create

Create a Internal Network resource.

az networkfabric internalnetwork create --l3-isolation-domain-name
                                        --resource-group
                                        --resource-name
                                        --vlan-id
                                        [--annotation]
                                        [--bgp-configuration]
                                        [--connected-ipv4-subnets]
                                        [--connected-ipv6-subnets]
                                        [--egress-acl-id]
                                        [--export-route-policy]
                                        [--export-route-policy-id]
                                        [--extension {NPB, NoExtension}]
                                        [--import-route-policy]
                                        [--import-route-policy-id]
                                        [--ingress-acl-id]
                                        [--is-monitoring-enabled {False, True}]
                                        [--mtu]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--static-route-configuration]

Examples

Create a Internal Network

az networkfabric internalnetwork create --resource-group "example-rg" --l3-isolation-domain-name "example-l3domain" --resource-name "example-internalNetwork" --vlan-id 2600 --mtu 1500 --extension "NoExtension" --is-monitoring-enabled "True" --connected-ipv4-subnets "[{prefix:'10.0.0.1/21'},{prefix:'10.1.1.1/22'}]" --connected-ipv6-subnets "[{prefix:'2fff::/64'}]" --static-route-configuration "{extension:NPB,bfdConfiguration:{multiplier:5,intervalInMilliSeconds:300},ipv4Routes:[{prefix:'10.1.0.0/24',nextHop:['10.0.0.1','10.0.0.2']},{prefix:'10.1.0.0/24',nextHop:['10.0.0.1','10.0.0.2']}],ipv6Routes:[{prefix:'2fff::/64',nextHop:['3fff::1']}]}" --bgp-configuration  "{bfdConfiguration:{multiplier:5,intervalInMilliSeconds:300},defaultRouteOriginate:True,allowAS:2,allowASOverride:Enable,peerASN:65047,ipv4ListenRangePrefixes:['10.1.1.1/28','10.0.0.1/28'],ipv6ListenRangePrefixes:['2fff::/66'],ipv4NeighborAddress:[{address:'10.0.0.11'},{address:'10.0.0.12'}],ipv6NeighborAddress:[{address:'2fff::'}]}" --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'}"

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 internalnetwork create --static-route-configuration "??"
az networkfabric internalnetwork create --static-route-configuration "{ipv4-routes:??"

Required Parameters

--l3-isolation-domain-name --l3domain

Name of the L3 Isolation Domain.

--resource-group -g

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

--resource-name

Name of the Internal Network.

--vlan-id

Vlan identifier. The value should be between 100-4094. Example: 1001.

Optional Parameters

--annotation

Description for underlying resource.

--bgp-configuration

BGP configuration properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--connected-ipv4-subnets

List of Connected IPv4 Subnets. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--connected-ipv6-subnets

List of connected IPv6 Subnets. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--egress-acl-id

Egress Acl ARM resource ID.

--export-route-policy

Export Route Policy either IPv4 or IPv6. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--export-route-policy-id

ARM Resource ID of the RoutePolicy. This is used for the backward compatibility.

--extension

Internal Network Extension type. Default value is NoExtension. Example: NoExtension.

Accepted values: NPB, NoExtension
--import-route-policy

Import Route Policy either IPv4 or IPv6. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--import-route-policy-id

ARM Resource ID of the RoutePolicy. This is used for the backward compatibility.

--ingress-acl-id

Ingress Acl ARM resource ID.

--is-monitoring-enabled

To check whether monitoring of internal network is enabled or not. Default value is False. Example: False.

Accepted values: False, True
--mtu

Maximum transmission unit. The value should be between 64 to 9200. Default value is 1500. Example: 1500.

--no-wait

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

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

Static Route Configuration properties. 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 internalnetwork delete

Delete the Internal Network resource.

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

Examples

Delete the Internal Network

az networkfabric internalnetwork delete --resource-group "example-rg" --l3domain "example-l3domain" --resource-name "example-internalnetwork"

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.

--l3-isolation-domain-name --l3domain

Name of the L3 Isolation Domain.

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

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

List all Internal Networks in the provided resource group.

az networkfabric internalnetwork list --l3-isolation-domain-name
                                      --resource-group

Examples

List the Internal Networks for Resource Group

az networkfabric internalnetwork list --resource-group "example-rg" --l3domain "example-l3domain"

Required Parameters

--l3-isolation-domain-name --l3domain

Name of the L3 Isolation Domain.

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

Show details of the provided Internal Network resource.

az networkfabric internalnetwork show [--ids]
                                      [--l3-isolation-domain-name]
                                      [--resource-group]
                                      [--resource-name]
                                      [--subscription]

Examples

Show the Internal Network

az networkfabric internalnetwork show --resource-group "example-rg" --resource-name "example-internalnetwork" --l3domain "example-l3domain"

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.

--l3-isolation-domain-name --l3domain

Name of the L3 Isolation Domain.

--resource-group -g

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

--resource-name

Name of the Internal Network.

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

Update the Internal Network resource.

az networkfabric internalnetwork update [--annotation]
                                        [--bgp-configuration]
                                        [--connected-ipv4-subnets]
                                        [--connected-ipv6-subnets]
                                        [--egress-acl-id]
                                        [--export-route-policy]
                                        [--export-route-policy-id]
                                        [--ids]
                                        [--import-route-policy]
                                        [--import-route-policy-id]
                                        [--ingress-acl-id]
                                        [--is-monitoring-enabled {False, True}]
                                        [--l3-isolation-domain-name]
                                        [--mtu]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--resource-group]
                                        [--resource-name]
                                        [--static-route-configuration]
                                        [--subscription]

Examples

Update the Internal Network resource

az networkfabric internalnetwork update --resource-group "example-rg" --l3-isolation-domain-name "example-l3domain" --resource-name "example-internalNetwork" --mtu 1500 --is-monitoring-enabled "True" --connected-ipv4-subnets "[{prefix:'10.0.0.1/21'},{prefix:'10.0.0.1/22'}]" --static-route-configuration "{bfdConfiguration:{multiplier:5,intervalInMilliSeconds:300},ipv4Routes:[{prefix:'10.1.0.0/24',nextHop:['10.0.0.1','10.0.0.2']},{prefix:'10.1.0.0/24',nextHop:['10.0.0.1','10.0.0.2']}]}" --bgp-configuration  "{bfdConfiguration:{multiplier:5,intervalInMilliSeconds:300},defaultRouteOriginate:True,allowAS:2,allowASOverride:Enable,peerASN:65047,ipv4ListenRangePrefixes:['10.1.0.0/28','10.1.0.1/28'],ipv4NeighborAddress:[{address:'10.0.0.11'},{address:'10.0.0.12'}]}" --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'}"

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 internalnetwork update --static-route-configuration "??"
az networkfabric internalnetwork update --static-route-configuration "{ipv4-routes:??"

Optional Parameters

--annotation

Description for underlying resource.

--bgp-configuration

BGP configuration properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--connected-ipv4-subnets

List of Connected IPv4 Subnets. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--connected-ipv6-subnets

List of connected IPv6 Subnets. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--egress-acl-id

Egress Acl ARM resource ID.

--export-route-policy

Export Route Policy either IPv4 or IPv6. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--export-route-policy-id

ARM Resource ID of the RoutePolicy. This is used for the backward compatibility.

--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 either IPv4 or IPv6. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--import-route-policy-id

ARM Resource ID of the RoutePolicy. This is used for the backward compatibility.

--ingress-acl-id

Ingress Acl ARM resource ID.

--is-monitoring-enabled

To check whether monitoring of internal network is enabled or not. Default value is False. Example: False.

Accepted values: False, True
--l3-isolation-domain-name --l3domain

Name of the L3 Isolation Domain.

--mtu

Maximum transmission unit. The value should be between 64 to 9200. Default value is 1500. Example: 1500.

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

--static-route-configuration

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

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

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

az networkfabric internalnetwork wait [--created]
                                      [--custom]
                                      [--deleted]
                                      [--exists]
                                      [--ids]
                                      [--interval]
                                      [--l3-isolation-domain-name]
                                      [--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
--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
--l3-isolation-domain-name --l3domain

Name of the L3 Isolation Domain.

--resource-group -g

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

--resource-name

Name of the Internal Network.

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