az network manager
Note
This reference is part of the virtual-network-manager extension for the Azure CLI (version 2.51.0 or higher). The extension will automatically install the first time you run an az network manager command. Learn more about extensions.
Manage network-manager with network.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az network manager connect-config |
Manage connectivity configuration with network. |
Extension | GA |
| az network manager connect-config create |
Create a new network manager connectivity configuration. |
Extension | GA |
| az network manager connect-config delete |
Delete a network manager connectivity configuration, specified by the resource group, network manager name, and connectivity configuration name. |
Extension | GA |
| az network manager connect-config list |
List all the network manager connectivity configuration in a specified network manager. |
Extension | GA |
| az network manager connect-config show |
Get a Network Connectivity Configuration, specified by the resource group, network manager name, and connectivity Configuration name. |
Extension | GA |
| az network manager connect-config update |
Update a new network manager connectivity configuration. |
Extension | GA |
| az network manager connect-config wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
| az network manager connection |
Manage connection with network manager. |
Extension | GA |
| az network manager connection management-group |
Manage management-group connection with network. |
Extension | GA |
| az network manager connection management-group create |
Create a network manager connection on this management group. |
Extension | GA |
| az network manager connection management-group delete |
Delete specified pending connection created by this management group. |
Extension | GA |
| az network manager connection management-group list |
List all network manager connections created by this management group. |
Extension | GA |
| az network manager connection management-group show |
Get a specified connection created by this management group. |
Extension | GA |
| az network manager connection management-group update |
Update a network manager connection on this management group. |
Extension | GA |
| az network manager connection subscription |
Manage subscription-group connection with network. |
Extension | GA |
| az network manager connection subscription create |
Create a network manager connection on this subscription. |
Extension | GA |
| az network manager connection subscription delete |
Delete specified connection created by this subscription. |
Extension | GA |
| az network manager connection subscription list |
List all network manager connections created by this subscription. |
Extension | GA |
| az network manager connection subscription show |
Get a specified connection created by this subscription. |
Extension | GA |
| az network manager connection subscription update |
Update a network manager connection on this subscription. |
Extension | GA |
| az network manager create |
Create a Network Manager. |
Extension | GA |
| az network manager delete |
Delete a network manager. |
Extension | GA |
| az network manager group |
Manage networkgroup with network. |
Extension | GA |
| az network manager group create |
Create a network group. |
Extension | GA |
| az network manager group delete |
Delete a network group. |
Extension | GA |
| az network manager group list |
List the specified network group. |
Extension | GA |
| az network manager group show |
Get the specified network group. |
Extension | GA |
| az network manager group static-member |
Manage static members with network manager group. |
Extension | GA |
| az network manager group static-member create |
Create a static member. |
Extension | GA |
| az network manager group static-member delete |
Delete a static member. |
Extension | GA |
| az network manager group static-member list |
List the static members within a specific network group. |
Extension | GA |
| az network manager group static-member show |
Get the specified static member. |
Extension | GA |
| az network manager group update |
Update a network group. |
Extension | GA |
| az network manager group wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
| az network manager list |
List all network managers in a subscription. |
Extension | GA |
| az network manager list-active-connectivity-config |
Lists active connectivity configurations in a network manager. |
Extension | GA |
| az network manager list-active-security-admin-rule |
Lists active security admin rules in a network manager. |
Extension | GA |
| az network manager list-deploy-status |
Post List of Network Manager Deployment Status. |
Extension | GA |
| az network manager list-effective-connectivity-config |
List all effective connectivity configurations applied on a virtual network. |
Extension | GA |
| az network manager list-effective-security-admin-rule |
List all effective security admin rules applied on a virtual network. |
Extension | GA |
| az network manager post-commit |
Post a Network Manager Commit. |
Extension | GA |
| az network manager scope-connection |
Manage scope connection with network. |
Extension | GA |
| az network manager scope-connection create |
Create scope connection from Network Manager. |
Extension | GA |
| az network manager scope-connection delete |
Delete the pending scope connection created by this network manager. |
Extension | GA |
| az network manager scope-connection list |
List all scope connections created by this network manager. |
Extension | GA |
| az network manager scope-connection show |
Get specified scope connection created by this Network Manager. |
Extension | GA |
| az network manager scope-connection update |
Update scope connection from Network Manager. |
Extension | GA |
| az network manager security-admin-config |
Manage security admin configuration with network. |
Extension | GA |
| az network manager security-admin-config create |
Create a network manager security admin configuration. |
Extension | GA |
| az network manager security-admin-config delete |
Delete a network manager security admin configuration. |
Extension | GA |
| az network manager security-admin-config list |
List all the network manager security admin configurations in a network manager, in a paginated format. |
Extension | GA |
| az network manager security-admin-config rule-collection |
Manage admin rule collection with network. |
Extension | GA |
| az network manager security-admin-config rule-collection create |
Create a network manager security configuration admin rule collection. |
Extension | GA |
| az network manager security-admin-config rule-collection delete |
Delete an admin rule collection. |
Extension | GA |
| az network manager security-admin-config rule-collection list |
List all the rule collections in a security admin configuration, in a paginated format. |
Extension | GA |
| az network manager security-admin-config rule-collection rule |
Manage admin rule with network. |
Extension | GA |
| az network manager security-admin-config rule-collection rule create |
Create a network manager security configuration admin rule. |
Extension | GA |
| az network manager security-admin-config rule-collection rule delete |
Delete an admin rule. |
Extension | GA |
| az network manager security-admin-config rule-collection rule list |
List all network manager security configuration admin rules. |
Extension | GA |
| az network manager security-admin-config rule-collection rule show |
Get a network manager security configuration admin rule. |
Extension | GA |
| az network manager security-admin-config rule-collection rule update |
Update a network manager security configuration admin rule in a subscription. |
Extension | GA |
| az network manager security-admin-config rule-collection show |
Get a network manager security admin configuration rule collection. |
Extension | GA |
| az network manager security-admin-config rule-collection update |
Update a network manager security configuration admin rule collection in a subscription. |
Extension | GA |
| az network manager security-admin-config rule-collection wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
| az network manager security-admin-config show |
Get a network manager security admin configuration. |
Extension | GA |
| az network manager security-admin-config update |
Update a network manager security admin configuration. |
Extension | GA |
| az network manager security-admin-config wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
| az network manager show |
Get the specified Network Manager. |
Extension | GA |
| az network manager update |
Update a Network Manager. |
Extension | GA |
| az network manager wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az network manager create
Create a Network Manager.
az network manager create --location
--name
--network-manager-scopes
--resource-group
--scope-accesses
[--description]
[--id]
[--tags]Examples
Create/Update Azure Virtual Network Manager
az network manager create --name "TestNetworkManager" -l eastus2euap --description "My Test Network Manager" --scope-accesses "SecurityAdmin" "Connectivity" --network-manager-scopes management-groups="/providers/Microsoft.Management/testmg" subscriptions="/subscriptions/00000000-0000-0000-0000-000000000000" --resource-group "rg1"Required Parameters
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
The name of the network manager.
Scope of Network Manager.
Usage: --network-manager-scopes management-groups=XX subscriptions=XX
management-groups: List of management groups. subscriptions: List of subscriptions.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Scope Access. Available value: SecurityAdmin, Connectivity.
Optional Parameters
A description of the network manager.
Resource ID.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
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 network manager delete
Delete a network manager.
az network manager delete [--force {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]Examples
Delete Azure Virtual Network Manager
az network manager delete --name "testNetworkManager" --resource-group "rg1"Optional Parameters
Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete.
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.
The name of the network manager.
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.
Do not prompt for confirmation.
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 network manager list
List all network managers in a subscription.
az network manager list [--max-items]
[--next-token]
[--resource-group]
[--skip-token]
[--top]Examples
List Azure Virtual Network Manager
az network manager list --resource-group "rg1"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>.
SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.
An optional query parameter which specifies the maximum number of records to be returned by the server.
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 network manager list-active-connectivity-config
Lists active connectivity configurations in a network manager.
az network manager list-active-connectivity-config [--ids]
[--name]
[--regions]
[--resource-group]
[--skip-token]
[--subscription]Examples
List Azure Virtual Network Manager Active Configuration
az network manager list-active-connectivity-config --network-manager-name "testNetworkManager" --resource-group "myResourceGroup"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.
The name of the network manager.
List of regions. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.
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 network manager list-active-security-admin-rule
Lists active security admin rules in a network manager.
az network manager list-active-security-admin-rule [--ids]
[--name]
[--regions]
[--resource-group]
[--skip-token]
[--subscription]Examples
List Azure Virtual Network Manager Active Security Admin Rule
az network manager list-active-security-admin-rule --network-manager-name "testNetworkManager" --resource-group "myResourceGroup" --region "eastus2euap"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.
The name of the network manager.
List of regions. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.
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 network manager list-deploy-status
Post List of Network Manager Deployment Status.
az network manager list-deploy-status [--deployment-types]
[--ids]
[--name]
[--regions]
[--resource-group]
[--skip-token]
[--subscription]Examples
List Azure Virtual Network Manager Deployment Status
az network manager list-deploy-status --network-manager-name "testNetworkManager" --deployment-types "Connectivity" "SecurityAdmin" --regions "eastus" "westus" --resource-group "resoureGroupSample"Optional Parameters
List of deployment types. 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.
The name of the network manager.
List of locations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Continuation token for pagination, capturing the next page size and offset, as well as the context of the query.
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 network manager list-effective-connectivity-config
List all effective connectivity configurations applied on a virtual network.
az network manager list-effective-connectivity-config [--ids]
[--resource-group]
[--skip-token]
[--subscription]
[--virtual-network-name]Examples
List Azure Virtual Network Manager Effective Configuration
az network manager list-effective-connectivity-config --virtual-network-name "myVirtualNetwork" --resource-group "myResourceGroup"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>.
When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
The name of the virtual network.
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 network manager list-effective-security-admin-rule
List all effective security admin rules applied on a virtual network.
az network manager list-effective-security-admin-rule [--ids]
[--resource-group]
[--skip-token]
[--subscription]
[--virtual-network-name]Examples
List Azure Virtual Network Manager Effective Security Admin Rule
az network manager list-effective-security-admin-rule --virtual-network-name "myVirtualNetwork" --resource-group "myResourceGroup"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>.
When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
The name of the virtual network.
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 network manager post-commit
Post a Network Manager Commit.
az network manager post-commit --commit-type {Connectivity, SecurityAdmin}
--target-locations
[--configuration-ids]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]Examples
Post Azure Virtual Network Manager Commit
az network manager post-commit --network-manager-name "testNetworkManager" --commit-type "SecurityAdmin" --configuration-ids "/subscriptions/subscriptionC/resourceGroups/resoureGroupSample/providers/Microsoft.Network/networkManagers/testNetworkManager/securityConfigurations/SampleSecurityConfig" --target-locations "eastus" --resource-group "resoureGroupSample"Required Parameters
Commit Type.
List of target locations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Optional Parameters
List of configuration ids. 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.
The name of the network manager.
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 network manager show
Get the specified Network Manager.
az network manager show [--ids]
[--name]
[--resource-group]
[--subscription]Examples
Get Azure Virtual Network Manager
az network manager show --name "testNetworkManager" --resource-group "rg1"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.
The name of the network manager.
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 network manager update
Update a Network Manager.
az network manager update [--description]
[--id]
[--ids]
[--location]
[--name]
[--network-manager-scopes]
[--resource-group]
[--scope-accesses]
[--subscription]
[--tags]Optional Parameters
A description of the network manager.
Resource ID.
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.
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
The name of the network manager.
Scope of Network Manager.
Usage: --network-manager-scopes management-groups=XX subscriptions=XX
management-groups: List of management groups. subscriptions: List of subscriptions.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Scope Access. Available value: SecurityAdmin, Connectivity.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
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 network manager wait
Place the CLI in a waiting state until a condition is met.
az network manager wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--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.
The name of the network manager.
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.
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