az network manager connect-config

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 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 --configuration-name
                                         --name --network-manager-name
                                         --resource-group
                                         [--applies-to-group --applies-to-groups]
                                         [--connectivity-topology {HubAndSpoke, Mesh}]
                                         [--delete-existing-peering {False, True}]
                                         [--description]
                                         [--hub --hubs]
                                         [--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-group 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/Micr osoft.Network/virtualNetworks/myTestConnectivityConfig" resource- type="Microsoft.Network/virtualNetworks" --is-global true --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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--applies-to-group --applies-to-groups

Groups for configuration Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --applies-to-group.

Property	Value
Parameter group:	Properties Arguments

--connectivity-topology

Connectivity topology type.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	HubAndSpoke, Mesh

--delete-existing-peering

Flag if need to remove current existing peerings.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	False, True

--description

A description of the connectivity configuration.

Property	Value
Parameter group:	Properties Arguments

--hub --hubs

List of hubItems Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --hub.

Property	Value
Parameter group:	Properties Arguments

--is-global

Flag if global mesh is supported.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	False, True

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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 --network-manager-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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--configuration-name

The name of the network manager connectivity configuration.

Property	Value
Parameter group:	Resource Id Arguments

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

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

Property	Value
Parameter group:	Resource Id Arguments

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

The name of the network manager.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

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 --network-manager-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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Pagination Arguments

--next-token

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

Property	Value
Parameter group:	Pagination Arguments

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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 --network-manager-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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--configuration-name

The name of the network manager connectivity configuration.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

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

The name of the network manager.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az network manager connect-config update

Update a new network manager connectivity configuration.

az network manager connect-config update [--add]
                                         [--applies-to-group --applies-to-groups]
                                         [--configuration-name]
                                         [--connectivity-topology {HubAndSpoke, Mesh}]
                                         [--delete-existing-peering {False, True}]
                                         [--description]
                                         [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--hub --hubs]
                                         [--ids]
                                         [--is-global {False, True}]
                                         [--name --network-manager-name]
                                         [--remove]
                                         [--resource-group]
                                         [--set]
                                         [--subscription]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Generic Update Arguments

--applies-to-group --applies-to-groups

Groups for configuration Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --applies-to-group.

Property	Value
Parameter group:	Properties Arguments

--configuration-name

The name of the network manager connectivity configuration.

Property	Value
Parameter group:	Resource Id Arguments

--connectivity-topology

Connectivity topology type.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	HubAndSpoke, Mesh

--delete-existing-peering

Flag if need to remove current existing peerings.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	False, True

--description

A description of the connectivity configuration.

Property	Value
Parameter group:	Properties Arguments

--force-string

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

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--hub --hubs

List of hubItems Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --hub.

Property	Value
Parameter group:	Properties Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--is-global

Flag if global mesh is supported.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	False, True

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

The name of the network manager.

Property	Value
Parameter group:	Resource Id Arguments

--remove

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

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

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 --network-manager-name]
                                       [--resource-group]
                                       [--subscription]
                                       [--timeout]
                                       [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--configuration-name

The name of the network manager connectivity configuration.

Property	Value
Parameter group:	Resource Id Arguments

--created

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

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

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

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

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

The name of the network manager.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

Share via

az network manager connect-config

Commands

az network manager connect-config create

Examples

Required Parameters

Optional Parameters

az network manager connect-config delete

Examples

Optional Parameters

az network manager connect-config list

Examples

Required Parameters

Optional Parameters

az network manager connect-config show

Examples

Optional Parameters

az network manager connect-config update

Optional Parameters

az network manager connect-config wait

Optional Parameters

Feedback