az network manager connection subscription

  • Reference

Note

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

Name Description Type Status
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 connection subscription create

Create a network manager connection on this subscription.

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

Name for the network manager connection.

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

Delete specified connection created by this subscription.

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

Examples

Delete network manager connection

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

Optional Parameters

--connection-name --name -n

Name for the network manager connection.

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

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

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

List all network manager connections created by this subscription.

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

Examples

List network manager connections in a network manager

az network manager connection subscription list

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

Get a specified connection created by this subscription.

az network manager connection subscription show [--connection-name]
                                                [--ids]
                                                [--subscription]

Examples

Get network manager connection

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

Optional Parameters

--connection-name --name -n

Name for the network manager connection.

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

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

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

Update a network manager connection on this subscription.

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

Examples

Update network manager connection

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

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

--connection-name --name -n

Name for the network manager connection.

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

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

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

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.