Κοινή χρήση μέσω

az networkfabric nni

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 nni command. Learn more about extensions.

Manage Network To Network Interconnect Resource.

Commands

Name Description Type Status
az networkfabric nni create

Create a Network To Network Interconnect resource.

 Extension GA
az networkfabric nni delete

Delete the Network To Network Interconnect resource.

 Extension GA
az networkfabric nni list

List all Network To Network Interconnects in the provided resource group.

 Extension GA
az networkfabric nni show

Show details of the provided Network To Network Interconnect resource.

 Extension GA
az networkfabric nni update

Update the Network to Network interconnect resource.

 Extension GA
az networkfabric nni update-bfd-administrative-state

Updates the Admin State.

 Extension GA
az networkfabric nni wait

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

 Extension GA

az networkfabric nni create

Create a Network To Network Interconnect resource.

az networkfabric nni create --fabric --fabric-name
                            --resource-group
                            --resource-name
                            --use-option-b {False, True}
                            [--conditional-default-route-configuration]
                            [--egress-acl-id]
                            [--export-route-policy]
                            [--import-route-policy]
                            [--ingress-acl-id]
                            [--is-management-type {False, True}]
                            [--layer2-configuration]
                            [--micro-bfd-state {Disabled, Enabled}]
                            [--nni-type {CE, NPB}]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--npb-static-route-configuration]
                            [--option-b-layer3-configuration]
                            [--static-route-configuration]

Examples

Create a Network To Network Interconnect

az networkfabric nni create --resource-group "example-rg" --fabric "example-fabric" --resource-name "example-nni" --nni-type "CE" --is-management-type "True" --use-option-b "True" --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'}" --layer2-configuration "{interfaces:['resourceId'],mtu:1500}" --option-b-layer3-configuration "{peerASN:28,vlanId:501,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 nni create --layer2-configuration "??"

Required Parameters

--fabric --fabric-name

Name of the Network Fabric.

--resource-group -g

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

--resource-name

Name of the Network to Network Interconnect.

--use-option-b

Based on this option layer3 parameters are mandatory. Example: True/False.

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

Optional Parameters

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

--conditional-default-route-configuration

Conditional Default Route Configuration properties. 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 information Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--import-route-policy

Import Route Policy information. 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-management-type

Configuration to use NNI for Infrastructure Management. Example: True/False.

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

Common properties for Layer2 Configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--micro-bfd-state

Micro Bidirectional Forwarding Detection (BFD) enabled/disabled state.

Property Value
Parameter group: Properties Arguments
Accepted values: Disabled, Enabled
--nni-type

Type of NNI used. Example: CE | NPB.

Property Value
Parameter group: Properties Arguments
Default value: CE
Accepted values: CE, NPB
--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
--npb-static-route-configuration

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

Property Value
Parameter group: Properties Arguments
--option-b-layer3-configuration

Common properties for Layer3Configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--static-route-configuration

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

Delete the Network To Network Interconnect resource.

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

Examples

Delete the Network To Network Interconnect

az networkfabric nni delete --resource-group "example-rg" --fabric "example-fabric" --resource-name "example-nni"

Optional Parameters

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

--fabric --fabric-name

Name of the Network Fabric.

Property Value
Parameter group: Resource Id Arguments
--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
--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 Network to Network Interconnect.

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

List all Network To Network Interconnects in the provided resource group.

az networkfabric nni list --fabric --fabric-name
                          --resource-group
                          [--max-items]
                          [--next-token]

Examples

List the Network To Network Interconnects for Resource Group

az networkfabric nni list --resource-group "example-rg" --fabric "example-fabric"

Required Parameters

--fabric --fabric-name

Name of the Network Fabric.

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

Show details of the provided Network To Network Interconnect resource.

az networkfabric nni show [--fabric --fabric-name]
                          [--ids]
                          [--resource-group]
                          [--resource-name]
                          [--subscription]

Examples

Show the Network To Network Interconnect

az networkfabric nni show --resource-group "example-rg" --fabric "example-fabric" --resource-name "example-nni"

Optional Parameters

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

--fabric --fabric-name

Name of the Network Fabric.

Property Value
Parameter group: Resource Id Arguments
--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
--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 Network to Network Interconnect.

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

Update the Network to Network interconnect resource.

az networkfabric nni update [--egress-acl-id]
                            [--export-route-policy]
                            [--fabric --fabric-name]
                            [--ids]
                            [--import-route-policy]
                            [--ingress-acl-id]
                            [--layer2-configuration]
                            [--micro-bfd-state {Disabled, Enabled}]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--npb-static-route-configuration]
                            [--option-b-layer3-configuration]
                            [--resource-group]
                            [--resource-name]
                            [--static-route-configuration]
                            [--subscription]

Examples

Update the Network To Network Interconnect

az networkfabric nni update --resource-group "example-rg" --fabric "example-fabric" --resource-name "example-nni" --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'}" --layer2-configuration "{interfaces:['resourceId'],mtu:1500}" --option-b-layer3-configuration "{peerASN:28,vlanId:501,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 nni update --layer2-configuration "??"

Optional Parameters

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

--egress-acl-id

Egress Acl. ARM resource ID of Access Control Lists.

Property Value
Parameter group: Properties Arguments
--export-route-policy

Export Route Policy information Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--fabric --fabric-name

Name of the Network Fabric.

Property Value
Parameter group: Resource Id Arguments
--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
--import-route-policy

Import Route Policy information. 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
--layer2-configuration

Common properties for Layer2Configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--micro-bfd-state

Micro BFD enabled/disabled state.

Property Value
Parameter group: Properties Arguments
Accepted values: Disabled, Enabled
--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
--npb-static-route-configuration

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

Property Value
Parameter group: Properties Arguments
--option-b-layer3-configuration

Common properties for Layer3Configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

Property Value
Parameter group: Resource Id Arguments
--static-route-configuration

Static Route Configuration. 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 nni update-bfd-administrative-state

Updates the Admin State.

az networkfabric nni update-bfd-administrative-state [--administrative-state {Disabled, Enabled, MAT, RMA}]
                                                     [--ids]
                                                     [--network-fabric-name]
                                                     [--network-to-network-interconnect-name --nni-name]
                                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                     [--resource-group]
                                                     [--route-type {OptionA, Static}]
                                                     [--subscription]

Optional Parameters

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

--administrative-state

State. Select either enable or disable.

Property Value
Parameter group: Body Arguments
Accepted values: Disabled, Enabled, MAT, RMA
--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
--network-fabric-name

Name of the Network Fabric.

Property Value
Parameter group: Resource Id Arguments
--network-to-network-interconnect-name --nni-name

Name of the Network to Network Interconnect.

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

Route Type. Choose either Static or OptionA.

Property Value
Parameter group: Body Arguments
Accepted values: OptionA, Static
--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 nni wait

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

az networkfabric nni wait [--created]
                          [--custom]
                          [--deleted]
                          [--exists]
                          [--fabric --fabric-name]
                          [--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.

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

Name of the Network Fabric.

Property Value
Parameter group: Resource Id Arguments
--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
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--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 Network to Network Interconnect.

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