az network manager

Reference

Note

This reference is part of the virtual-network-manager extension for the Azure CLI (version 2.43.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

az network manager connect-config	Manage connectivityconfiguration with network.
az network manager connect-config create	Create a new network manager connectivity configuration.
az network manager connect-config delete	Deletes a network manager connectivity configuration, specified by the resource group, network manager name, and connectivity configuration name.
az network manager connect-config list	Lists all the network manager connectivity configuration in a specified network manager.
az network manager connect-config show	Gets a Network Connectivity Configuration, specified by the resource group, network manager name, and connectivity Configuration name.
az network manager connect-config update	Update a new network manager connectivity configuration.
az network manager connection	Manage connection with network manager.
az network manager connection management-group	Manage management-group connection with network.
az network manager connection management-group create	Create a connection to a cross tenant network manager".
az network manager connection management-group delete	Delete specified pending connection created by this management group.
az network manager connection management-group list	List all network manager connections created by this management group.
az network manager connection management-group show	Get a specified connection created by this management group.
az network manager connection management-group update	Update a connection to a cross tenant network manager.
az network manager connection subscription	Manage subscription-group connection with network.
az network manager connection subscription create	Create a connection from a subscription to a cross-tenant network manager.
az network manager connection subscription delete	Deletes a network manager connection.
az network manager connection subscription list	List all network manager connections created by this subscription.
az network manager connection subscription show	Get a specified connection created by this subscription.
az network manager connection subscription update	Update a connection from this subscription to a cross tenant network manager.
az network manager create	Create a Network Manager.
az network manager delete	Deletes a network manager.
az network manager group	Manage networkgroup with network.
az network manager group create	Create a network group.
az network manager group delete	Deletes a network group.
az network manager group list	Lists the specified network group.
az network manager group show	Gets the specified network group.
az network manager group static-member	Manage static members with network manager group.
az network manager group static-member create	Creates a static member.
az network manager group static-member delete	Deletes a static member.
az network manager group static-member list	Lists the specified static member.
az network manager group static-member show	Gets the specified static member.
az network manager group update	Update a network group.
az network manager list	List network managers in a resource group.
az network manager list-active-connectivity-config	Lists active configurations in a network manager.
az network manager list-active-security-admin-rule	List all security admin rules that have been deployed by this network manager.
az network manager list-deploy-status	Post List of Network Manager Deployment Status.
az network manager list-effective-connectivity-config	Lists effective configuration in a network manager.
az network manager list-effective-security-admin-rule	Lists effective configuration in a network manager.
az network manager post-commit	Post a Network Manager Commit.
az network manager scope-connection	Manage scope connection with network.
az network manager scope-connection create	Creates scope connection from Network Manager.
az network manager scope-connection delete	Delete the pending scope connection created by this network manager.
az network manager scope-connection list	List all scope connections created by this network manager.
az network manager scope-connection show	Get specified scope connection created by this Network Manager.
az network manager scope-connection update	Update scope connection from Network Manager.
az network manager security-admin-config	Manage security admin configuration with network.
az network manager security-admin-config create	Create a network manager security admin configuration.
az network manager security-admin-config delete	Delete a network manager security admin configuration.
az network manager security-admin-config list	List all the network manager security admin configurations in a network manager, in a paginated format.
az network manager security-admin-config rule-collection	Manage admin rule collection with network.
az network manager security-admin-config rule-collection create	Create a network manager security configuration admin rule collection.
az network manager security-admin-config rule-collection delete	Delete an admin rule collection.
az network manager security-admin-config rule-collection list	List network manager security configuration admin rule collections.
az network manager security-admin-config rule-collection rule	Manage adminrule with network.
az network manager security-admin-config rule-collection rule create	Create a network manager security configuration admin rule.
az network manager security-admin-config rule-collection rule delete	Deletes an admin rule.
az network manager security-admin-config rule-collection rule list	Retrieves a network manager security configuration admin rule.
az network manager security-admin-config rule-collection rule show	Gets a network manager security configuration admin rule in a subscription.
az network manager security-admin-config rule-collection rule update	Update a network manager security configuration admin rule in a subscription.
az network manager security-admin-config rule-collection show	Gets a network manager security configuration admin rule collection in a subscription.
az network manager security-admin-config rule-collection update	Update a network manager security configuration admin rule collection in a subscription.
az network manager security-admin-config show	Get a network manager security admin configuration.
az network manager security-admin-config update	Update a network manager security admin configuration.
az network manager security-admin-config wait	Place the CLI in a waiting state until a condition is met.
az network manager show	Gets the specified Network Manager.
az network manager update	Update a Network Manager.

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 -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name --network-manager-name -n

The name of the network manager.

--network-manager-scopes

Scope of Network Manager.

--resource-group -g

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

--scope-accesses

Scope Access. Available value: SecurityAdmin, Connectivity.

Optional Parameters

--description

A description of the network manager.

--id

Resource ID.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--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.

az network manager delete

Deletes a network manager.

az network manager delete [--force {false, true}]
                          [--ids]
                          [--name]
                          [--resource-group]
                          [--subscription]
                          [--yes]

Examples

Delete Azure Virtual Network Manager

az network manager delete --name "testNetworkManager" --resource-group "rg1"

Optional Parameters

--force

Deletes the resource even if it is part of a deployed configuration.

accepted values: false, true

default value: False

--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.

--name --network-manager-name -n

The name of the network manager.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--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.

az network manager list

List network managers in a resource group.

az network manager list --resource-group
                        [--skip-token]
                        [--top]

Examples

List Azure Virtual Network Manager

az network manager list --resource-group "rg1"

Required Parameters

--resource-group -g

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

Optional Parameters

--skip-token

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.

--top

An optional query parameter which specifies the maximum number of records to be returned by the server.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--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.

az network manager list-active-connectivity-config

Lists active configurations in a network manager.

az network manager list-active-connectivity-config --name
                                                   --resource-group
                                                   [--regions]
                                                   [--skip-token]

Examples

Get Azure Virtual Network Manager Active Configuration

az network manager list-active-connectivity-config --network-manager-name "testNetworkManager" --resource-group "myResourceGroup"

Required Parameters

--name --network-manager-name -n

The name of the network manager.

--resource-group -g

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

Optional Parameters

--regions

Location names.

--skip-token

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--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.

az network manager list-active-security-admin-rule

List all security admin rules that have been deployed by this network manager.

az network manager list-active-security-admin-rule --name
                                                   --resource-group
                                                   [--regions]
                                                   [--skip-token]

Examples

Get 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"

Required Parameters

--name --network-manager-name -n

The name of the network manager.

--resource-group -g

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

Optional Parameters

--regions

List of locations.

--skip-token

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--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.

az network manager list-deploy-status

Post List of Network Manager Deployment Status.

az network manager list-deploy-status --name
                                      --resource-group
                                      [--deployment-types]
                                      [--regions]
                                      [--skip-token]

Examples

Post 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"

Required Parameters

--name --network-manager-name -n

The name of the network manager.

--resource-group -g

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

Optional Parameters

--deployment-types

List of configurations' deployment types.

--regions

List of locations.

--skip-token

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--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.

az network manager list-effective-connectivity-config

Lists effective configuration in a network manager.

az network manager list-effective-connectivity-config --resource-group
                                                      --virtual-network-name
                                                      [--skip-token]

Examples

Get Azure Virtual Network Manager Effective Configuration

az network manager list-effective-connectivity-config --virtual-network-name "myVirtualNetwork" --resource-group "myResourceGroup"

Required Parameters

--resource-group -g

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

--virtual-network-name --vnet-name

The name of the virtual network.

Optional Parameters

--skip-token

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--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.

az network manager list-effective-security-admin-rule

Lists effective configuration in a network manager.

az network manager list-effective-security-admin-rule --resource-group
                                                      --virtual-network-name
                                                      [--skip-token]

Examples

Get Azure Virtual Network Manager Effective Configuration

az network manager list-effective-security-admin-rule --virtual-network-name "myVirtualNetwork" --resource-group "myResourceGroup"

Required Parameters

--resource-group -g

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

--virtual-network-name --vnet-name

The name of the virtual network.

Optional Parameters

--skip-token

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--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.

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]
                               [--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

Commit Type.

accepted values: Connectivity, SecurityAdmin

--target-locations

List of target locations.

Optional Parameters

--configuration-ids

List of configuration ids.

--ids

--name --network-manager-name -n

The name of the network manager.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--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.

az network manager show

Gets 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

--ids

--name --network-manager-name -n

The name of the network manager.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--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.

az network manager update

Update a Network Manager.

az network manager update [--add]
                          [--description]
                          [--force-string]
                          [--id]
                          [--ids]
                          [--location]
                          [--name]
                          [--network-manager-scopes]
                          [--remove]
                          [--resource-group]
                          [--scope-accesses]
                          [--set]
                          [--subscription]
                          [--tags]

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

default value: []

--description

A description of the network manager.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

default value: False

--id

Resource ID.

--ids

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name --network-manager-name -n

The name of the network manager.

--network-manager-scopes

Scope of Network Manager.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

default value: []

--resource-group -g

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

--scope-accesses

Scope Access. Available value: SecurityAdmin, Connectivity.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

default value: []

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--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.

az network manager

Commands

az network manager create

Examples

Required Parameters

Optional Parameters

az network manager delete

Examples

Optional Parameters

az network manager list

Examples

Required Parameters

Optional Parameters

az network manager list-active-connectivity-config

Examples

Required Parameters

Optional Parameters

az network manager list-active-security-admin-rule

Examples

Required Parameters

Optional Parameters

az network manager list-deploy-status

Examples

Required Parameters

Optional Parameters

az network manager list-effective-connectivity-config

Examples

Required Parameters

Optional Parameters

az network manager list-effective-security-admin-rule

Examples

Required Parameters

Optional Parameters

az network manager post-commit

Examples

Required Parameters

Optional Parameters

az network manager show

Examples

Optional Parameters

az network manager update

Optional Parameters

Feedback

Additional resources