Share via

az network manager connection management-group

  • Reference

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 connection management-group command. Learn more about extensions.

Manage management-group connection with network.

Commands

Name Description Type Status
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 management-group create

Create a network manager connection on this management group.

az network manager connection management-group create --connection-name
                                                      --management-group-id
                                                      --network-manager
                                                      [--description]

Examples

Create network manager connection management-group

az network manager connection management-group create --management-group-id "testManagementGroupId" --connection-name "testNetworkManagerConnection" --network-manager "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testGroup/providers/Microsoft.Network/networkManagers/testNm" --description "A sample connection."

Required Parameters

--connection-name --name -n

Name for the network manager connection.

--management-group-id

The management group Id which uniquely identify the Microsoft Azure management group.

--network-manager --network-manager-id

Network Manager Id.

Optional Parameters

--description

A description of the network manager connection.

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 connection management-group delete

Delete specified pending connection created by this management group.

az network manager connection management-group delete --connection-name
                                                      --management-group-id
                                                      [--yes]

Examples

Delete network manager connection management-group

az network manager connection management-group delete --management-group-id "testManagementGroupId" --connection-name "testNetworkManagerConnection"

Required Parameters

--connection-name --name -n

Name for the network manager connection.

--management-group-id

The management group Id which uniquely identify the Microsoft Azure management group.

Optional Parameters

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

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 connection management-group list

List all network manager connections created by this management group.

az network manager connection management-group list --management-group-id
                                                    [--max-items]
                                                    [--next-token]
                                                    [--skip-token]
                                                    [--top]

Examples

List management-group connections in a network manager

az network manager connection management-group list --management-group-id "testManagementGroupId"

Required Parameters

--management-group-id

The management group Id which uniquely identify the Microsoft Azure management group.

Optional Parameters

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

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

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

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 connection management-group show

Get a specified connection created by this management group.

az network manager connection management-group show --connection-name
                                                    --management-group-id

Examples

Get network manager connection management-group

az network manager connection management-group show --management-group-id "testManagementGroupId" --connection-name "testNetworkManagerConnection"

Required Parameters

--connection-name --name -n

Name for the network manager connection.

--management-group-id

The management group Id which uniquely identify the Microsoft Azure management group.

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 connection management-group update

Update a network manager connection on this management group.

az network manager connection management-group update --connection-name
                                                      --management-group-id
                                                      [--add]
                                                      [--description]
                                                      [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--remove]
                                                      [--set]

Examples

Update network manager connection management-group

az network manager connection management-group update --management-group-id "testManagementGroupId" --connection-name "testNetworkManagerConnection" --description "My Test Network Manager Connection"

Required Parameters

--connection-name --name -n

Name for the network manager connection.

--management-group-id

The management group Id which uniquely identify the Microsoft Azure management group.

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

--force-string

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--remove

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

--set

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

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.