az network manager connection subscription

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

Manage subscription-group connection with network.

Commands

az network manager connection subscription create	Create a connection from this 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 connection subscription create

Create a connection from this subscription to a cross tenant network manager.

az network manager connection subscription create --connection-name
                                                  --network-manager
                                                  [--description]

Examples

Create network manager connection

az network manager connection subscription create --connection-name "testNetworkManagerConnection" --description "A sample policy" --network-manager-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testManagerName

Required Parameters

--connection-name --name -n

The name of the network manager connection.

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

The id of the network manager.

Optional Parameters

--description

A description of the scope 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.

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

Deletes a network manager connection.

az network manager connection subscription delete --connection-name
                                                  [--yes]

Examples

Delete network manager connection

az network manager connection subscription delete --connection-name "testNetworkManagerConnection"

Required Parameters

--connection-name --name -n

The name of the network manager connection.

Optional Parameters

--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 connection subscription list

List all network manager connections created by this subscription.

az network manager connection subscription list [--skip-token]
                                                [--top]

Examples

List network manager connections in a network manager

az network manager connection subscription list

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 connection subscription show

Get a specified connection created by this subscription.

az network manager connection subscription show --connection-name

Examples

Get network manager connection

az network manager connection subscription show --connection-name "testNetworkManagerConnection"

Required Parameters

--connection-name --name -n

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

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

Update a connection from this subscription to a cross tenant network manager.

az network manager connection subscription update --connection-name
                                                  [--add]
                                                  [--description]
                                                  [--force-string]
                                                  [--remove]
                                                  [--set]

Examples

Update network manager connection

az network manager connection subscription update --connection-name "testNetworkManagerConnection" --description "A sample policy"

Required Parameters

--connection-name --name -n

The name of the network manager connection.

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

--force-string

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

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