az networkfabric tap
Note
This reference is part of the managednetworkfabric extension for the Azure CLI (version 2.49.0 or higher). The extension will automatically install the first time you run an az networkfabric tap command. Learn more about extensions.
Manage Network Tap Resource.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az networkfabric tap create |
Create a Network Tap resource. |
Extension | GA |
| az networkfabric tap delete |
Delete the Network Tap resource. |
Extension | GA |
| az networkfabric tap list |
List all Network Taps in the provided resource group or subscription. |
Extension | GA |
| az networkfabric tap resync |
Implements the operation to the underlying resources. |
Extension | GA |
| az networkfabric tap show |
Show details of the provided Network Tap resource. |
Extension | GA |
| az networkfabric tap update |
Update the Network Tap resource. |
Extension | GA |
| az networkfabric tap update-admin-state |
Enable/Disable a network tap. |
Extension | GA |
| az networkfabric tap wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az networkfabric tap create
Create a Network Tap resource.
az networkfabric tap create --destinations
--network-packet-broker-id
--resource-group
--resource-name
[--annotation]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--polling-type {Pull, Push}]
[--tags]Examples
Create a Network Tap
az networkfabric tap create --resource-group "example-rg" --location "westus3" --resource-name "example-networktap" --network-packet-broker-id "/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker" --polling-type "Pull" --destinations "[{name:'example-destinaionName',destinationType:IsolationDomain,destinationId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork',isolationDomainProperties:{encapsulation:None,neighborGroupIds:['/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup']},destinationTapRuleId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule'}]"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 tap create --destinations "??"Required Parameters
List of destinations to send the filter traffic. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
ARM resource ID of the Network Packet Broker.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name of the Network Tap.
Optional Parameters
Description for underlying resource.
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.
Network tap rule file polling type. Default value is Pull. Example: Pull.
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 tap delete
Delete the Network Tap resource.
az networkfabric tap delete [--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--resource-name]
[--subscription]Examples
Delete the Network Tap
az networkfabric tap delete --resource-group "example-rg" --resource-name "example-networktap"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 Tap.
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 tap list
List all Network Taps in the provided resource group or subscription.
az networkfabric tap list [--resource-group]Examples
List the Network Tap for Resource group
az networkfabric tap list --resource-group "example-rg"List the Network Tap for Subscription
az networkfabric tap list --subscription "<subscriptionId>"Optional Parameters
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 tap resync
Implements the operation to the underlying resources.
az networkfabric tap resync [--ids]
[--network-tap-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]Examples
Resync Operation
az networkfabric tap resync --resource-group "example-rg" --network-tap-name "example-networktap"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 Network Tap.
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 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 tap show
Show details of the provided Network Tap resource.
az networkfabric tap show [--ids]
[--resource-group]
[--resource-name]
[--subscription]Examples
Show the Network Tap
az networkfabric tap show --resource-group "example-rg" --resource-name "example-networktap"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 Tap.
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 tap update
Update the Network Tap resource.
az networkfabric tap update [--annotation]
[--destinations]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--polling-type {Pull, Push}]
[--resource-group]
[--resource-name]
[--subscription]
[--tags]Examples
Update the Network Tap
az networkfabric tap update --resource-group "example-rg" --resource-name "example-networktap" --polling-type "Pull" --destinations "[{name:'example-destinaionName',destinationType:IsolationDomain,destinationId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork',isolationDomainProperties:{encapsulation:None,neighborGroupIds:['/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup']},destinationTapRuleId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule'}]"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 tap update --destinations "??"Optional Parameters
Description for underlying resource.
List of destination properties to send the filter traffic. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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.
Network tap rule file polling type. Default value is Pull. Example: Pull.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name of the Network Tap.
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.
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 tap update-admin-state
Enable/Disable a network tap.
az networkfabric tap 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}]
[--subscription]Examples
Update admin state of Network Tap
az networkfabric tap update-admin-state --resource-group "example-rg" --resource-name "example-tap" --state "Enable"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>.
Network Fabrics or Network Rack resource Id. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name of the Network Tap.
Administrative state.
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 tap wait
Place the CLI in a waiting state until a condition is met.
az networkfabric tap 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 Tap.
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.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for