az network manager connect-config

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 connect-config command. Learn more about extensions.

Manage connectivityconfiguration with network.

Commands

az network manager connect-config create	Create a new network manager connectivity configuration.
az network manager connect-config delete	Deletes a network manager connectivity configuration, specified by the resource group, network manager name, and connectivity configuration name.
az network manager connect-config list	Lists all the network manager connectivity configuration in a specified network manager.
az network manager connect-config show	Gets a Network Connectivity Configuration, specified by the resource group, network manager name, and connectivity Configuration name.
az network manager connect-config update	Update a new network manager connectivity configuration.

az network manager connect-config create

Create a new network manager connectivity configuration.

az network manager connect-config create --applies-to-groups
                                         --configuration-name
                                         --connectivity-topology {HubAndSpoke, Mesh}
                                         --name
                                         --resource-group
                                         [--delete-existing-peering {false, true}]
                                         [--description]
                                         [--display-name]
                                         [--hub]
                                         [--is-global {false, true}]

Examples

Create/Update Azure Virtual Network Manager Connectivity Configuration

az network manager connect-config create --configuration-name "myTestConnectivityConfig" --description "Sample Configuration" --applies-to-groups group-connectivity="None" is-global=false network-group-id="subscriptions/subscriptionA/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkManagerGroups/group1" use-hub-gateway=true --connectivity-topology "HubAndSpoke" --delete-existing-peering true --display-name "myTestConnectivityConfig" --hub resource-id="subscriptions/subscriptionA/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myTestConnectivityConfig" resource-type="Microsoft.Network/virtualNetworks" --is-global true --network-manager-name "testNetworkManager" --resource-group "myResourceGroup"

Required Parameters

--applies-to-groups

Groups for configuration.

--configuration-name

The name of the network manager connectivity configuration.

--connectivity-topology

Connectivity topology type.

accepted values: HubAndSpoke, Mesh

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

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

--delete-existing-peering

Flag if need to remove current existing peerings.

accepted values: false, true

--description

A description of the connectivity configuration.

--display-name

A friendly name for the resource.

--hub

The hub vnets.

--is-global

Flag if global mesh is supported.

accepted values: false, true

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 connect-config delete

Deletes a network manager connectivity configuration, specified by the resource group, network manager name, and connectivity configuration name.

az network manager connect-config delete --configuration-name
                                         --name
                                         --resource-group
                                         [--yes]

Examples

Get Azure Virtual Network Manager Connectivity Configuration

az network manager connect-config delete --configuration-name "myTestConnectivityConfig" --network-manager-name "testNetworkManager" --resource-group "myResourceGroup"

Required Parameters

--configuration-name

The name of the network manager connectivity configuration.

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

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

--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 connect-config list

Lists all the network manager connectivity configuration in a specified network manager.

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

Examples

Get Azure Virtual Network Manager Connecitivity Configuration List

az network manager connect-config list --network-manager-name "testNetworkManager" --resource-group "myResourceGroup"

Required Parameters

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

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 connect-config show

Gets a Network Connectivity Configuration, specified by the resource group, network manager name, and connectivity Configuration name.

az network manager connect-config show --configuration-name
                                       --name
                                       --resource-group

Examples

Get Azure Virtual Network Manager Connectivity Configuration

az network manager connect-config show --configuration-name "myTestConnectivityConfig" --network-manager-name "testNetworkManager" --resource-group "myResourceGroup"

Required Parameters

--configuration-name

The name of the network manager connectivity configuration.

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

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 connect-config update

Update a new network manager connectivity configuration.

az network manager connect-config update --configuration-name
                                         --name
                                         --resource-group
                                         [--add]
                                         [--applies-to-groups]
                                         [--delete-existing-peering {false, true}]
                                         [--description]
                                         [--display-name]
                                         [--force-string]
                                         [--hub]
                                         [--is-global {false, true}]
                                         [--remove]
                                         [--set]

Required Parameters

--configuration-name

The name of the network manager connectivity configuration.

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

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

--applies-to-groups

Groups for configuration.

--delete-existing-peering

Flag if need to remove current existing peerings.

accepted values: false, true

--description

A description of the connectivity configuration.

--display-name

A friendly name for the resource.

--force-string

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

--hub

The hub vnets.

--is-global

Flag if global mesh is supported.

accepted values: false, true

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