az network manager

Note

This reference is part of the virtual-network-manager extension for the Azure CLI (version 2.61.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 ipam-pool	Manage IPAM pool with network.	Extension	GA
az network manager ipam-pool create	Create the Pool resource.	Extension	GA
az network manager ipam-pool delete	Delete the Pool resource.	Extension	GA
az network manager ipam-pool get-pool-usage	Get the Pool Usage.	Extension	GA
az network manager ipam-pool list	List list of Pool resources at Network Manager level.	Extension	GA
az network manager ipam-pool list-associated-resource	List Associated Resource in the Pool.	Extension	GA
az network manager ipam-pool show	Get the specific Pool resource.	Extension	GA
az network manager ipam-pool static-cidr	Manage static cidr with network.	Extension	GA
az network manager ipam-pool static-cidr create	Create the Static CIDR resource.	Extension	GA
az network manager ipam-pool static-cidr delete	Delete the Static CIDR resource.	Extension	GA
az network manager ipam-pool static-cidr list	List list of Static CIDR resources at Network Manager level.	Extension	GA
az network manager ipam-pool static-cidr show	Get the specific Static CIDR resource.	Extension	GA
az network manager ipam-pool static-cidr wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az network manager ipam-pool update	Update the Pool resource.	Extension	GA
az network manager ipam-pool 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 routing-config	Manage network-manager routing-config with network.	Extension	Preview
az network manager routing-config create	Create a network manager routing configuration.	Extension	Preview
az network manager routing-config delete	Delete a network manager routing configuration.	Extension	Preview
az network manager routing-config list	List all the network manager routing configurations in a network manager, in a paginated format.	Extension	Preview
az network manager routing-config rule-collection	Manage network-manager routing-config rule-collection.	Extension	Preview
az network manager routing-config rule-collection create	Create a routing rule collection.	Extension	Preview
az network manager routing-config rule-collection delete	Delete an routing rule collection.	Extension	Preview
az network manager routing-config rule-collection list	List all the rule collections in a routing configuration, in a paginated format.	Extension	Preview
az network manager routing-config rule-collection rule	Manage network-manager routing-config rule-collection rule.	Extension	Preview
az network manager routing-config rule-collection rule create	Create an routing rule.	Extension	Preview
az network manager routing-config rule-collection rule delete	Delete a routing rule.	Extension	Preview
az network manager routing-config rule-collection rule list	List all network manager routing configuration routing rules.	Extension	Preview
az network manager routing-config rule-collection rule show	Get a network manager routing configuration routing rule.	Extension	Preview
az network manager routing-config rule-collection rule update	Update an routing rule.	Extension	Preview
az network manager routing-config rule-collection rule wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview
az network manager routing-config rule-collection show	Get a network manager routing configuration rule collection.	Extension	Preview
az network manager routing-config rule-collection update	Update a routing rule collection.	Extension	Preview
az network manager routing-config rule-collection wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview
az network manager routing-config show	Get a network manager routing configuration.	Extension	Preview
az network manager routing-config update	Update a network manager routing configuration.	Extension	Preview
az network manager routing-config wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview
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 verifier-workspace	Manage verifier workspace with network.	Extension	GA
az network manager verifier-workspace create	Create Verifier Workspace.	Extension	GA
az network manager verifier-workspace delete	Delete Verifier Workspace.	Extension	GA
az network manager verifier-workspace list	List list of Verifier Workspaces.	Extension	GA
az network manager verifier-workspace reachability-analysis-intent	Manage reachability analysis intent with network.	Extension	GA
az network manager verifier-workspace reachability-analysis-intent create	Create Reachability Analysis Intent.	Extension	GA
az network manager verifier-workspace reachability-analysis-intent delete	Delete Reachability Analysis Intent.	Extension	GA
az network manager verifier-workspace reachability-analysis-intent list	List list of Reachability Analysis Intents .	Extension	GA
az network manager verifier-workspace reachability-analysis-intent show	Get the Reachability Analysis Intent.	Extension	GA
az network manager verifier-workspace reachability-analysis-run	Manage reachability analysis run with network.	Extension	GA
az network manager verifier-workspace reachability-analysis-run create	Create Reachability Analysis Runs.	Extension	GA
az network manager verifier-workspace reachability-analysis-run delete	Delete Reachability Analysis Run.	Extension	GA
az network manager verifier-workspace reachability-analysis-run list	List list of Reachability Analysis Runs.	Extension	GA
az network manager verifier-workspace reachability-analysis-run show	Get Reachability Analysis Run.	Extension	GA
az network manager verifier-workspace reachability-analysis-run wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az network manager verifier-workspace show	Get Verifier Workspace.	Extension	GA
az network manager verifier-workspace update	Update Verifier Workspace.	Extension	GA
az network manager verifier-workspace wait	Place the CLI in a waiting state until a condition is met.	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-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.

Usage: --network-manager-scopes management-groups=XX subscriptions=XX

management-groups: List of management groups. subscriptions: List of subscriptions.

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

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

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

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 network manager delete

Delete a network manager.

az network manager delete [--force {0, 1, f, false, n, no, t, true, y, yes}]
                          [--ids]
                          [--name --network-manager-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

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

--force

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.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

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

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

The name of the network manager.

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

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

--yes -y

Do not prompt for confirmation.

Property	Value
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

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

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

--resource-group -g

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

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

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 network manager list-active-connectivity-config

Lists active connectivity configurations in a network manager.

az network manager list-active-connectivity-config [--ids]
                                                   [--name --network-manager-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

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

--ids

Property	Value
Parameter group:	Resource Id Arguments

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

The name of the network manager.

Property	Value
Parameter group:	Resource Id Arguments

--regions

List of regions. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Parameters 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

--skip-token

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.

Property	Value
Parameter group:	Parameters 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 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 --network-manager-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

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

--ids

Property	Value
Parameter group:	Resource Id Arguments

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

The name of the network manager.

Property	Value
Parameter group:	Resource Id Arguments

--regions

List of regions. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Parameters 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

--skip-token

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.

Property	Value
Parameter group:	Parameters 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 network manager list-deploy-status

Post List of Network Manager Deployment Status.

az network manager list-deploy-status [--deployment-types]
                                      [--ids]
                                      [--name --network-manager-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

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

--deployment-types

List of deployment types. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Parameters Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

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

The name of the network manager.

Property	Value
Parameter group:	Resource Id Arguments

--regions

List of locations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Parameters 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

--skip-token

Continuation token for pagination, capturing the next page size and offset, as well as the context of the query.

Property	Value
Parameter group:	Parameters 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 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 --vnet-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

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

--ids

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

--skip-token

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.

Property	Value
Parameter group:	Parameters 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

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

The name of the virtual network.

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

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

--ids

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

--skip-token

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.

Property	Value
Parameter group:	Parameters 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

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

The name of the virtual network.

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 network manager post-commit

Post a Network Manager Commit.

az network manager post-commit --commit-type {Connectivity, Routing, SecurityAdmin, SecurityUser}
                               --target-locations
                               [--configuration-ids]
                               [--ids]
                               [--name --network-manager-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

Commit Type.

Property	Value
Parameter group:	Parameters Arguments
Accepted values:	Connectivity, Routing, SecurityAdmin, SecurityUser

--target-locations

List of target locations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Parameters Arguments

Optional Parameters

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

--configuration-ids

List of configuration ids. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Parameters Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

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

The name of the network manager.

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

--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 network manager show

Get the specified Network Manager.

az network manager show [--ids]
                        [--name --network-manager-name]
                        [--resource-group]
                        [--subscription]

Examples

Get Azure Virtual Network Manager

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

Optional Parameters

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

--ids

Property	Value
Parameter group:	Resource Id Arguments

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

The name of the network manager.

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

--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 network manager update

Update a Network Manager.

az network manager update [--description]
                          [--id]
                          [--ids]
                          [--location]
                          [--name --network-manager-name]
                          [--network-manager-scopes]
                          [--resource-group]
                          [--scope-accesses]
                          [--subscription]
                          [--tags]

Optional Parameters

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

--description

A description of the network manager.

--id

Resource ID.

--ids

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--network-manager-scopes

Scope of Network Manager.

Usage: --network-manager-scopes management-groups=XX subscriptions=XX

management-groups: List of management groups. subscriptions: List of subscriptions.

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

--scope-accesses

Scope Access. Available value: SecurityAdmin, Connectivity.

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

--tags

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

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 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 --network-manager-name]
                        [--resource-group]
                        [--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

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

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

The name of the network manager.

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

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

Share via

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

Optional Parameters

az network manager list-active-connectivity-config

Examples

Optional Parameters

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

Examples

Optional Parameters

az network manager list-deploy-status

Examples

Optional Parameters

az network manager list-effective-connectivity-config

Examples

Optional Parameters

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

Examples

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

az network manager wait

Optional Parameters

Feedback