az networkfabric l3domain
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 l3domain command. Learn more about extensions.
Manage L3 Isolation Domain Resource.
Commands
Name | Description | Type | Status |
---|---|---|---|
az networkfabric l3domain create |
Create a L3 Isolation Domain resource. |
Extension | GA |
az networkfabric l3domain delete |
Delete the L3 Isolation Domain resource. |
Extension | GA |
az networkfabric l3domain list |
List all L3 Isolation Domains in the provided resource group or subscription. |
Extension | GA |
az networkfabric l3domain show |
Show details of the provided L3 Isolation Domain resource. |
Extension | GA |
az networkfabric l3domain update |
Update to update certain properties of the L3 Isolation Domain resource. |
Extension | GA |
az networkfabric l3domain update-admin-state |
Enables racks for this Isolation Domain. |
Extension | GA |
az networkfabric l3domain wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az networkfabric l3domain create
Create a L3 Isolation Domain resource.
az networkfabric l3domain create --network-fabric-id --nf-id
--resource-group
--resource-name
[--aggregate-route-configuration]
[--annotation]
[--connected-subnet-route-policy]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--redistribute-connected-subnets {False, True}]
[--redistribute-static-routes {False, True}]
[--route-prefix-limit]
[--static-route-route-policy]
[--tags]
Examples
Create a L3 Isolation Domain
az networkfabric l3domain create --resource-group "example-rg" --resource-name "example-l3domain" --location "westus3" --nf-id "/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabricName" --redistribute-connected-subnets "True" --redistribute-static-routes "True" --aggregate-route-configuration "{ipv4Routes:[{prefix:'10.0.0.1/28'},{prefix:'10.0.0.2/28'}],ipv6Routes:[{prefix:'2fff::/64'},{prefix:'2fff::/65'}]}" --connected-subnet-route-policy "{exportRoutePolicy:{exportIpv4RoutePolicyId:'/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 l3domain create --connected-subnet-route-policy "??"
Required Parameters
ARM Resource ID of the Network Fabric.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the L3 Isolation Domain.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Aggregate route configurations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Switch configuration description.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Connected Subnet RoutePolicy Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The geo-location where the resource lives When not specified, the location of the resource group will be used.
Property | Value |
---|---|
Parameter group: | Resource Arguments |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Advertise Connected Subnets. Ex: "True" | "False".
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Default value: | True |
Accepted values: | False, True |
Advertise Static Routes. Ex: "True" | "False".
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Default value: | False |
Accepted values: | False, True |
VRF Limit configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Static Route - route policy. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Resource Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az networkfabric l3domain delete
Delete the L3 Isolation Domain resource.
az networkfabric l3domain delete [--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--resource-name]
[--subscription]
Examples
Delete the L3 Isolation Domain
az networkfabric l3domain delete --resource-group "example-rg" --resource-name "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.
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 |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of the L3 Isolation Domain.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az networkfabric l3domain list
List all L3 Isolation Domains in the provided resource group or subscription.
az networkfabric l3domain list [--max-items]
[--next-token]
[--resource-group]
Examples
List the L3 Isolation Domains for Resource Group
az networkfabric l3domain list --resource-group "example-rg"
List the L3 Isolation Domains for Subscription
az networkfabric l3domain list --subscription "<subscriptionId>"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
Token to specify where to start paginating. This is the token value from a previously truncated response.
Property | Value |
---|---|
Parameter group: | Pagination Arguments |
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.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az networkfabric l3domain show
Show details of the provided L3 Isolation Domain resource.
az networkfabric l3domain show [--ids]
[--resource-group]
[--resource-name]
[--subscription]
Examples
Show the L3 Isolation Domain
az networkfabric l3domain show --resource-group "example-rg" --resource-name "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.
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 |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of the L3 Isolation Domain.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az networkfabric l3domain update
Update to update certain properties of the L3 Isolation Domain resource.
az networkfabric l3domain update [--aggregate-route-configuration]
[--annotation]
[--connected-subnet-route-policy]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--redistribute-connected-subnets {False, True}]
[--redistribute-static-routes {False, True}]
[--resource-group]
[--resource-name]
[--route-prefix-limit]
[--static-route-route-policy]
[--subscription]
[--tags]
Examples
Update the L3 Isolation Domain
az networkfabric l3domain update --resource-group "example-rg" --resource-name "example-l3domain" --redistribute-connected-subnets "True" --redistribute-static-routes "True" --aggregate-route-configuration "{ipv4Routes:[{prefix:'10.0.0.1/28'},{prefix:'10.0.0.2/28'}],ipv6Routes:[{prefix:'2fff::/64'},{prefix:'2fff::/65'}]}" --connected-subnet-route-policy "{exportRoutePolicy:{exportIpv4RoutePolicyId:'/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 l3domain update --connected-subnet-route-policy "??"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Aggregate route configurations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Switch configuration description.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Connected Subnet RoutePolicy Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
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 |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Advertise Connected Subnets. Ex: "True" | "False".
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | False, True |
Advertise Static Routes. Ex: "True" | "False".
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | False, True |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of the L3 Isolation Domain.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Virtual Routing and Forwarding (VRF) Limit configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Static Route - route policy. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
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 |
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az networkfabric l3domain update-admin-state
Enables racks for this Isolation Domain.
az networkfabric l3domain update-admin-state [--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--resource-ids]
[--resource-name]
[--state {Disable, Enable, UnderMaintenance}]
[--subscription]
Examples
Update admin state of L3 Isolation Domain
az networkfabric l3domain update-admin-state --resource-group "example-rg" --resource-name "example-l3domain" --state "Enable"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Network Fabrics or Network Rack resource Id. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Body Arguments |
Name of the L3 Isolation Domain.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Administrative state.
Property | Value |
---|---|
Parameter group: | Body Arguments |
Accepted values: | Disable, Enable, UnderMaintenance |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az networkfabric l3domain wait
Place the CLI in a waiting state until a condition is met.
az networkfabric l3domain wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--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.
Wait until created with 'provisioningState' at 'Succeeded'.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
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 |
Wait until deleted.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Wait until the resource exists.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
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 |
Polling interval in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 30 |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of the L3 Isolation Domain.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Maximum wait in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 3600 |
Wait until updated with provisioningState at 'Succeeded'.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |