az network manager connect-config

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

Manage connectivity configuration with network.

Commands

Name Description Type Status
az network manager connect-config create

Create a new network manager connectivity configuration.

 Extension GA
az network manager connect-config delete

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

 Extension GA
az network manager connect-config list

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

 Extension GA
az network manager connect-config show

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

 Extension GA
az network manager connect-config update

Update a new network manager connectivity configuration.

 Extension GA
az network manager connect-config wait

Place the CLI in a waiting state until a condition is met.

 Extension GA

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

Usage: --applies-to-groups network-group-id=XX use-hub-gateway=XX is-global=XX group-connectivity=XX

network-group-id: Network group Id. use-hub-gateway: Flag if need to use hub gateway. Only required if topology is Hub and Spoke. is-global: Flag if global is supported. Only required if topology is Hub and Spoke. group-connectivity: Group connectivity type. Only required if topology is Hub and Spoke. Allowed values: None, DirectlyConnected

Multiple actions can be specified by using more than one --applies-to-groups argument.

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

--hub

The hub vnets.

Usage: --hub resource-id=XX resource-type=XX

resource-id: Resource ID resource-type: Resource type, suggested value(s): 'Microsoft.Network/virtualNetworks'.

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

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

Delete 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]
                                         [--force {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--ids]
                                         [--name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--resource-group]
                                         [--subscription]
                                         [--yes]

Examples

Delete Azure Virtual Network Manager Connectivity Configuration

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

Optional Parameters

--configuration-name

The name of the network manager connectivity configuration.

--force

Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete.

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.

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

The name of the network manager.

--no-wait

Do not wait for the long-running operation to finish.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

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

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

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

Examples

List Azure Virtual Network Manager Connecitivity Configuration

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

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

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

az network manager connect-config show [--configuration-name]
                                       [--ids]
                                       [--name]
                                       [--resource-group]
                                       [--subscription]

Examples

Get Azure Virtual Network Manager Connectivity Configuration

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

Optional Parameters

--configuration-name

The name of the network manager connectivity configuration.

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

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

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

Update a new network manager connectivity configuration.

az network manager connect-config update [--applies-to-groups]
                                         [--configuration-name]
                                         [--delete-existing-peering {false, true}]
                                         [--description]
                                         [--hub]
                                         [--ids]
                                         [--is-global {false, true}]
                                         [--name]
                                         [--resource-group]
                                         [--subscription]

Optional Parameters

--applies-to-groups

Groups for configuration.

Usage: --applies-to-groups network-group-id=XX use-hub-gateway=XX is-global=XX group-connectivity=XX

network-group-id: Network group Id. use-hub-gateway: Flag if need to use hub gateway. Only required if topology is Hub and Spoke. is-global: Flag if global is supported. Only required if topology is Hub and Spoke. group-connectivity: Group connectivity type. Only required if topology is Hub and Spoke. Allowed values: None, DirectlyConnected

Multiple actions can be specified by using more than one --applies-to-groups argument.

--configuration-name

The name of the network manager connectivity configuration.

--delete-existing-peering

Flag if need to remove current existing peerings.

accepted values: false, true
--description

A description of the connectivity configuration.

--hub

The hub vnets.

Usage: --hub resource-id=XX resource-type=XX

resource-id: Resource ID resource-type: Resource type, suggested value(s): 'Microsoft.Network/virtualNetworks'.

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

--is-global

Flag if global mesh is supported.

accepted values: false, true
--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>.

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

Place the CLI in a waiting state until a condition is met.

az network manager connect-config wait [--configuration-name]
                                       [--created]
                                       [--custom]
                                       [--deleted]
                                       [--exists]
                                       [--ids]
                                       [--interval]
                                       [--name]
                                       [--resource-group]
                                       [--subscription]
                                       [--timeout]
                                       [--updated]

Optional Parameters

--configuration-name

The name of the network manager connectivity configuration.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

default value: False
--exists

Wait until the resource exists.

default value: False
--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.

--interval

Polling interval in seconds.

default value: 30
--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>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

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.