az network manager group

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Note

This reference is part of the virtual-network-manager extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az network manager group command. Learn more about extensions.

Manage networkgroup with network.

Commands

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 list-effect-vnet	Lists all effective virtual networks by 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 group create

Create a network group.

az network manager group create --member-type {Microsoft.Network/virtualNetworks}
                                --name
                                --network-manager-name
                                --resource-group
                                [--description]
                                [--display-name]
                                [--if-match]

Examples

Create/Update Azure Virtual Network Manager Network Group

az network manager group create --name "TestNetworkGroup" --network-manager-name "testNetworkManager" --description "A sample group" --display-name "My Network Group" --member-type "Microsoft.Network/virtualNetworks" --resource-group "rg1"

Required Parameters

--member-type

Group member type.

accepted values: Microsoft.Network/virtualNetworks

--name --network-group-name -n

The name of the network group to get.

--network-manager-name

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

--description

A description of the network group.

--display-name

A friendly name for the network group.

--if-match

The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

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

Deletes a network group.

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

Examples

Delete Azure Virtual Network Manager Group

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

Required Parameters

--name --network-group-name -n

The name of the network group to get.

--network-manager-name

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

--force

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

accepted values: false, true

--yes -y

Do not prompt for confirmation.

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

Lists the specified network group.

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

Examples

List Azure Virtual Network Manager Network Groups

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

Required Parameters

--network-manager-name

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

--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 group list-effect-vnet

Lists all effective virtual networks by specified network group.

az network manager group list-effect-vnet --name
                                          --network-group-name
                                          --resource-group
                                          [--skip-token]

Examples

List Effective Virtual Networks List By Network Groups

az network manager group list-effect-vnet --network-group-name "TestNetworkGroup" --network-manager-name "testNetworkManager" --resource-group "rg1"

Required Parameters

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

The name of the network manager.

--network-group-name

The name of the network group to get.

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

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

Gets the specified network group.

az network manager group show --name
                              --network-manager-name
                              --resource-group

Examples

Get Azure Virtual Network Manager Network Group

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

Required Parameters

--name --network-group-name -n

The name of the network group to get.

--network-manager-name

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

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

Update a network group.

az network manager group update --name
                                --network-manager-name
                                --resource-group
                                [--add]
                                [--description]
                                [--display-name]
                                [--force-string]
                                [--if-match]
                                [--member-type {Subnet, VirtualNetwork}]
                                [--remove]
                                [--set]

Required Parameters

--name --network-group-name -n

The name of the network group to get.

--network-manager-name

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

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

--description

A description of the network group.

--display-name

A friendly name for the network group.

--force-string

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

--if-match

The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

--member-type

Group member type.

accepted values: Subnet, VirtualNetwork

--remove

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

--set

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

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.