az networkfabric internalnetwork
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 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
Name of the L3 Isolation Domain.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the Internal Network.
Vlan identifier. The value should be between 100-4094. Example: 1001.
Optional Parameters
Description for underlying resource.
BGP configuration properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
List of Connected IPv4 Subnets. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
List of connected IPv6 Subnets. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Egress Acl ARM resource ID.
Export Route Policy either IPv4 or IPv6. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
ARM Resource ID of the RoutePolicy. This is used for the backward compatibility.
Internal Network Extension type. Default value is NoExtension. Example: NoExtension.
Import Route Policy either IPv4 or IPv6. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
ARM Resource ID of the RoutePolicy. This is used for the backward compatibility.
Ingress Acl ARM resource ID.
To check whether monitoring of internal network is enabled or not. Default value is False. Example: False.
Maximum transmission unit. The value should be between 64 to 9200. Default value is 1500. Example: 1500.
Do not wait for the long-running operation to finish.
Static Route Configuration properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
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 of the L3 Isolation Domain.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the Internal Network.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
[--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
Name of the L3 Isolation Domain.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
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 of the L3 Isolation Domain.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the Internal Network.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
Description for underlying resource.
BGP configuration properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
List of Connected IPv4 Subnets. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
List of connected IPv6 Subnets. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Egress Acl ARM resource ID.
Export Route Policy either IPv4 or IPv6. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
ARM Resource ID of the RoutePolicy. This is used for the backward compatibility.
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 either IPv4 or IPv6. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
ARM Resource ID of the RoutePolicy. This is used for the backward compatibility.
Ingress Acl ARM resource ID.
To check whether monitoring of internal network is enabled or not. Default value is False. Example: False.
Name of the L3 Isolation Domain.
Maximum transmission unit. The value should be between 64 to 9200. Default value is 1500. Example: 1500.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the Internal Network.
Static Route Configuration properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
Name of the L3 Isolation Domain.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the Internal Network.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.