az networkfabric fabric
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 fabric command. Learn more about extensions.
Manage Network Fabric Resource.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az networkfabric fabric commit-configuration |
Atomic update of the given Network Fabric instance. Sync update of NFA resources at Fabric level. |
Extension | GA |
| az networkfabric fabric create |
Create a Network Fabric resource. |
Extension | GA |
| az networkfabric fabric delete |
Delete the Network Fabric resource. |
Extension | GA |
| az networkfabric fabric deprovision |
Deprovisions the underlying resources in the given Network Fabric instance. |
Extension | GA |
| az networkfabric fabric list |
List all Network Fabrics in the provided resource group or subscription. |
Extension | GA |
| az networkfabric fabric provision |
Provisions the underlying resources in the given Network Fabric instance. |
Extension | GA |
| az networkfabric fabric show |
Show details of the provided Network Fabric resource. |
Extension | GA |
| az networkfabric fabric update |
Update the Network Fabric resource. |
Extension | GA |
| az networkfabric fabric upgrade |
Upgrades the version of the underlying resources in the given Network Fabric instance. |
Extension | GA |
| az networkfabric fabric validate-configuration |
Validates the configuration of the underlying resources in the given Network Fabric instance. |
Extension | GA |
| az networkfabric fabric wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az networkfabric fabric commit-configuration
Atomic update of the given Network Fabric instance. Sync update of NFA resources at Fabric level.
az networkfabric fabric commit-configuration [--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--resource-name]
[--subscription]Examples
Commit Configuration
az networkfabric fabric commit-configuration --resource-group "example-rg" --resource-name "example-fabric"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.
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 Network Fabric.
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 fabric create
Create a Network Fabric resource.
az networkfabric fabric create --fabric-asn
--ipv4-prefix
--managed-network-config
--nf-sku
--nfc-id
--resource-group
--resource-name
--server-count-per-rack
--ts-config
[--annotation]
[--fabric-version]
[--ipv6-prefix]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--rack-count]
[--tags]Examples
Create a Network Fabric with option B Properties
az networkfabric fabric create --resource-group "example-rg" --location "westus3" --resource-name "example-fabric" --nf-sku "fab1" --fabric-version "1.x.x" --nfc-id "/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-NFC" --fabric-asn 20 --ipv4-prefix 10.1.0.0/19 --rack-count 2 --server-count-per-rack 5 --ts-config "{primaryIpv4Prefix:'172.31.0.0/30',secondaryIpv4Prefix:'172.31.0.20/30',username:'****',password:'*****',serialNumber:'1234'}" --managed-network-config "{infrastructureVpnConfiguration:{networkToNetworkInterconnectId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni',peeringOption:OptionB,optionBProperties:{routeTargets:{exportIpv4RouteTargets:['65046:10039'],exportIpv6RouteTargets:['65046:10039'],importIpv4RouteTargets:['65046:10039'],importIpv6RouteTargets:['65046:10039']}}},workloadVpnConfiguration:{networkToNetworkInterconnectId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni',peeringOption:OptionB,optionBProperties:{routeTargets:{exportIpv4RouteTargets:['65046:10039'],exportIpv6RouteTargets:['65046:10039'],importIpv4RouteTargets:['65046:10039'],importIpv6RouteTargets:['65046:10039']}}}}"Create a Network Fabric with option A Properties
az networkfabric fabric create --resource-group "example-rg" --location "westus3" --resource-name "example-fabric" --nf-sku "fab1" --fabric-version "1.x.x" --nfc-id "/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-NFC" --fabric-asn 20 --ipv4-prefix "10.1.0.0/19" --rack-count 2 --server-count-per-rack 5 --ts-config "{primaryIpv4Prefix:'172.31.0.0/30',secondaryIpv4Prefix:'172.31.0.20/30',username:'****',password:'*****',serialNumber:1234}" --managed-network-config "{infrastructureVpnConfiguration:{networkToNetworkInterconnectId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni',peeringOption:OptionA,optionAProperties:{bfdConfiguration:{multiplier:5,intervalInMilliSeconds:300},mtu:1500,vlanId:520,peerASN:65133,primaryIpv4Prefix:'172.31.0.0/31',secondaryIpv4Prefix:'172.31.0.20/31'}},workloadVpnConfiguration:{networkToNetworkInterconnectId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni',peeringOption:OptionA,optionAProperties:{bfdConfiguration:{multiplier:5,intervalInMilliSeconds:300},mtu:1500,vlanId:520,peerASN:65133,primaryIpv4Prefix:'172.31.0.0/31',secondaryIpv4Prefix:'172.31.0.20/31',primaryIpv6Prefix:'3FFE:FFFF:0:CD30::a0/127',secondaryIpv6Prefix:'3FFE:FFFF:0:CD30::a0/127'}}}"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 fabric create --ts-config "??"
az networkfabric fabric create --managed-network-config "{infrastructureVpnConfiguration:??"
az networkfabric fabric create --managed-network-config "{infrastructureVpnConfiguration:{option-b-properties:??"Required Parameters
ASN of CE devices for CE/PE connectivity. The value should be between 1 to 4294967295. Example: 65123.
IPv4Prefix for Management Network. Example: 10.1.0.0/19.
Configuration to be used to setup the management network. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Supported Network Fabric SKU. The SKU determines whether it is a single / multi rack Network Fabric.
Azure resource ID for the NetworkFabricController the NetworkFabric belongs.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name of the Network Fabric.
Number of servers.Possible values are from 1-16.
Network and credentials configuration currently applied to terminal server. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Optional Parameters
Description for underlying resource.
The version of Network Fabric.
IPv6Prefix for Management Network. Example: 3FFE:FFFF:0:CD40::/59.
Location of Azure region When not specified, the location of the resource group will be used.
Do not wait for the long-running operation to finish.
Number of compute racks associated to Network Fabric. Possible values are from 1-8.
Resource tags. 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 fabric delete
Delete the Network Fabric resource.
az networkfabric fabric delete [--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--resource-name]
[--subscription]Examples
Delete the Network Fabric
az networkfabric fabric delete --resource-group "example-rg" --resource-name "example-fabric"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.
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 Network Fabric.
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 fabric deprovision
Deprovisions the underlying resources in the given Network Fabric instance.
az networkfabric fabric deprovision [--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--resource-name]
[--subscription]Examples
Deprovision the Network Fabric
az networkfabric fabric deprovision --resource-group "example-rg" --resource-name "example-fabric"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.
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 Network Fabric.
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 fabric list
List all Network Fabrics in the provided resource group or subscription.
az networkfabric fabric list [--max-items]
[--next-token]
[--resource-group]Examples
List the Network Fabrics for Resource Group
az networkfabric fabric list --resource-group "example-rg"List the Network Fabrics for Subscription
az networkfabric fabric list --subscription "<subscriptionId>"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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
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 fabric provision
Provisions the underlying resources in the given Network Fabric instance.
az networkfabric fabric provision [--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--resource-name]
[--subscription]Examples
Provision the Network Fabric
az networkfabric fabric provision --resource-group "example-rg" --resource-name "example-fabric"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.
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 Network Fabric.
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 fabric show
Show details of the provided Network Fabric resource.
az networkfabric fabric show [--ids]
[--resource-group]
[--resource-name]
[--subscription]Examples
Show the Network Fabric
az networkfabric fabric show --resource-group "example-rg" --resource-name "example-fabric"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 resource group. You can configure the default group using az configure --defaults group=<name>.
Name of the Network Fabric.
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 fabric update
Update the Network Fabric resource.
az networkfabric fabric update [--annotation]
[--fabric-asn]
[--ids]
[--ipv4-prefix]
[--ipv6-prefix]
[--managed-network-config]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--rack-count]
[--resource-group]
[--resource-name]
[--server-count-per-rack]
[--subscription]
[--tags]
[--ts-config]Examples
Update the Network Fabric option B Properties
az networkfabric fabric update --resource-group "example-rg" --resource-name "example-fabric" --fabric-asn 20 --ipv4-prefix 10.1.0.0/19 --rack-count 3 --server-count-per-rack 7 --ts-config "{primaryIpv4Prefix:'172.31.0.0/30',secondaryIpv4Prefix:'172.31.0.20/30',username:'****',password:'*****',serialNumber:'1234'}" --managed-network-config "{infrastructureVpnConfiguration:{networkToNetworkInterconnectId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni',peeringOption:OptionB,optionBProperties:{routeTargets:{exportIpv4RouteTargets:['65046:10039'],exportIpv6RouteTargets:['65046:10039'],importIpv4RouteTargets:['65046:10039'],importIpv6RouteTargets:['65046:10039']}}},workloadVpnConfiguration:{networkToNetworkInterconnectId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni',peeringOption:OptionB,optionBProperties:{routeTargets:{exportIpv4RouteTargets:['65046:10039'],exportIpv6RouteTargets:['65046:10039'],importIpv4RouteTargets:['65046:10039'],importIpv6RouteTargets:['65046:10039']}}}}"Update the Network Fabric option A Properties
az networkfabric fabric update --resource-group "example-rg" --resource-name "example-fabric" --fabric-asn 20 --ipv4-prefix "10.1.0.0/19" --rack-count 3 --server-count-per-rack 7 --ts-config "{primaryIpv4Prefix:'172.31.0.0/30',secondaryIpv4Prefix:'172.31.0.20/30',username:'****',password:'*****',serialNumber:1234}" --managed-network-config "{infrastructureVpnConfiguration:{networkToNetworkInterconnectId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni',peeringOption:OptionA,optionAProperties:{bfdConfiguration:{multiplier:5,intervalInMilliSeconds:300},mtu:1500,vlanId:520,peerASN:65133,primaryIpv4Prefix:'172.31.0.0/31',secondaryIpv4Prefix:'172.31.0.20/31'}},workloadVpnConfiguration:{networkToNetworkInterconnectId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni',peeringOption:OptionA,optionAProperties:{bfdConfiguration:{multiplier:5,intervalInMilliSeconds:300},mtu:1500,vlanId:520,peerASN:65133,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 fabric update --ts-config "??"
az networkfabric fabric update --managed-network-config "{infrastructureVpnConfiguration:??"
az networkfabric fabric update --managed-network-config "{infrastructureVpnConfiguration:{option-b-properties:??"Optional Parameters
Description for underlying resource.
ASN of CE devices for CE/PE connectivity. The value should be between 1 to 4294967295. Example: 65123.
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.
IPv4Prefix for Management Network. Example: 10.1.0.0/19.
IPv6Prefix for Management Network. Example: 3FFE:FFFF:0:CD40::/59.
Configuration to be used to setup the management network. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
Number of compute racks associated to Network Fabric. Possible values are from 1-8.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name of the Network Fabric.
Number of servers.Possible values are from 1-16.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Resource tags Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Network and credentials configuration currently applied to terminal server. 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 fabric upgrade
Upgrades the version of the underlying resources in the given Network Fabric instance.
az networkfabric fabric upgrade [--action {Complete, Start}]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--resource-name]
[--subscription]
[--version]Optional Parameters
Action to be performed while upgrading the fabric.
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.
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 Network Fabric.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Specify the version.
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 fabric validate-configuration
Validates the configuration of the underlying resources in the given Network Fabric instance.
az networkfabric fabric validate-configuration [--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--resource-name]
[--subscription]
[--validate-action {Cabling, Configuration, Connectivity}]Examples
Validate the configuration
az networkfabric fabric validate-configuration -g "example-rg" --resource-name "example-nf" --validate-action "Cabling"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.
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 Network Fabric.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Validate action that to be performed.
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 fabric wait
Place the CLI in a waiting state until a condition is met.
az networkfabric fabric wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--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 resource group. You can configure the default group using az configure --defaults group=<name>.
Name of the Network Fabric.
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.
