az networkfabric internalnetwork

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 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 --l3domain
                                        --resource-group
                                        --resource-name
                                        --vlan-id
                                        [--annotation]
                                        [--bgp-configuration]
                                        [--connected-ipv4-subnets]
                                        [--connected-ipv6-subnets]
                                        [--egress-acl-id]
                                        [--export-route-policy]
                                        [--extension {NPB, NoExtension}]
                                        [--import-route-policy]
                                        [--ingress-acl-id]
                                        [--is-monitoring-enabled {False, True}]
                                        [--mtu]
                                        [--native-ipv4-prefix-limit]
                                        [--native-ipv6-prefix-limit]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--static-route-configuration]

Examples

Create an 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::'}],v4OverV6BgpSession:'Enabled',v6OverV4BgpSession:'Enabled'}" --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'}" --native-ipv4-prefix-limit "{prefixLimits:[{idleTimeExpiry:60,maximumRoutes:5,threshold:50},{idleTimeExpiry:80,maximumRoutes:10,threshold:60}]}" --native-ipv6-prefix-limit "{prefixLimits:[{idleTimeExpiry:60,maximumRoutes:5,threshold:50},{idleTimeExpiry:80,maximumRoutes:10,threshold:60}]}"

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. Example: 1001.

Property	Value
Parameter group:	Properties Arguments

Optional Parameters

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

--annotation

Switch configuration description.

Property	Value
Parameter group:	Properties Arguments

--bgp-configuration

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

Property	Value
Parameter group:	Properties Arguments

--connected-ipv4-subnets

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

Property	Value
Parameter group:	Properties Arguments

--connected-ipv6-subnets

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

Property	Value
Parameter group:	Properties Arguments

--egress-acl-id

Egress Acl. ARM resource ID of Access Control Lists.

Property	Value
Parameter group:	Properties Arguments

--export-route-policy

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

Property	Value
Parameter group:	Properties Arguments

--extension

Extension. Example: NoExtension | NPB.

Property	Value
Parameter group:	Properties Arguments
Default value:	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.

Property	Value
Parameter group:	Properties Arguments

--ingress-acl-id

Ingress Acl. ARM resource ID of Access Control Lists.

Property	Value
Parameter group:	Properties Arguments

--is-monitoring-enabled

To check whether monitoring of internal network is enabled or not.

Property	Value
Parameter group:	Properties Arguments
Default value:	False
Accepted values:	False, True

--mtu

Maximum transmission unit. Default value is 1500.

Property	Value
Parameter group:	Properties Arguments
Default value:	1500

--native-ipv4-prefix-limit

Native IPv4 Prefix Limit Configuration properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--native-ipv6-prefix-limit

Native IPv6 Prefix Limit Configuration properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties 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

--static-route-configuration

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

Property	Value
Parameter group:	Properties 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 internalnetwork delete

Delete the Internal Network resource.

az networkfabric internalnetwork delete [--ids]
                                        [--l3-isolation-domain-name --l3domain]
                                        [--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

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

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

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

Name of the L3 Isolation Domain.

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

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

List all Internal Networks in the provided resource group.

az networkfabric internalnetwork list --l3-isolation-domain-name --l3domain
                                      --resource-group
                                      [--max-items]
                                      [--next-token]

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

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

Show details of the provided Internal Network resource.

az networkfabric internalnetwork show [--ids]
                                      [--l3-isolation-domain-name --l3domain]
                                      [--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

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

--ids

Property	Value
Parameter group:	Resource Id Arguments

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

Name of the L3 Isolation Domain.

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

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 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]
                                        [--ids]
                                        [--import-route-policy]
                                        [--ingress-acl-id]
                                        [--is-monitoring-enabled {False, True}]
                                        [--l3-isolation-domain-name --l3domain]
                                        [--mtu]
                                        [--native-ipv4-prefix-limit]
                                        [--native-ipv6-prefix-limit]
                                        [--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'}],v4OverV6BgpSession:'Enabled',v6OverV4BgpSession:'Enabled'}" --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'}" --native-ipv4-prefix-limit "{prefixLimits:[{idleTimeExpiry:60,maximumRoutes:5,threshold:50},{idleTimeExpiry:80,maximumRoutes:10,threshold:60}]}" --native-ipv6-prefix-limit "{prefixLimits:[{idleTimeExpiry:60,maximumRoutes:5,threshold:50},{idleTimeExpiry:80,maximumRoutes:10,threshold:60}]}"

az networkfabric internalnetwork update --static-route-configuration "??"
az networkfabric internalnetwork update --static-route-configuration "{ipv4-routes:??"

Optional Parameters

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

--annotation

Switch configuration description.

Property	Value
Parameter group:	Properties Arguments

--bgp-configuration

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

Property	Value
Parameter group:	Properties Arguments

--connected-ipv4-subnets

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

Property	Value
Parameter group:	Properties Arguments

--connected-ipv6-subnets

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

Property	Value
Parameter group:	Properties Arguments

--egress-acl-id

Egress Acl. ARM resource ID of Access Control Lists.

Property	Value
Parameter group:	Properties Arguments

--export-route-policy

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

Property	Value
Parameter group:	Properties Arguments

--ids

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

Property	Value
Parameter group:	Properties Arguments

--ingress-acl-id

Ingress Acl. ARM resource ID of Access Control Lists.

Property	Value
Parameter group:	Properties Arguments

--is-monitoring-enabled

To check whether monitoring of internal network is enabled or not.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	False, True

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

Name of the L3 Isolation Domain.

Property	Value
Parameter group:	Resource Id Arguments

--mtu

Maximum transmission unit. Default value is 1500.

Property	Value
Parameter group:	Properties Arguments

--native-ipv4-prefix-limit

Native IPv4 Prefix Limit Configuration properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--native-ipv6-prefix-limit

Native IPv6 Prefix Limit Configuration properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties 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 Internal Network.

Property	Value
Parameter group:	Resource Id Arguments

--static-route-configuration

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

Property	Value
Parameter group:	Properties 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 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 --l3domain]
                                      [--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

--exists

Wait until the resource exists.

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

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

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

Name of the L3 Isolation Domain.

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

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

Share via

az networkfabric internalnetwork

Commands

az networkfabric internalnetwork create

Examples

Required Parameters

Optional Parameters

az networkfabric internalnetwork delete

Examples

Optional Parameters

az networkfabric internalnetwork list

Examples

Required Parameters

Optional Parameters

az networkfabric internalnetwork show

Examples

Optional Parameters

az networkfabric internalnetwork update

Examples

Optional Parameters

az networkfabric internalnetwork wait

Optional Parameters

Feedback