az network manager connect-config
Note
This reference is part of the virtual-network-manager extension for the Azure CLI (version 2.57.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
--resource-group
[--applies-to-group]
[--connectivity-topology {HubAndSpoke, Mesh}]
[--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-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
The name of the network manager connectivity configuration.
The name of the network manager.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Groups for configuration Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --applies-to-group
.
Connectivity topology type.
Flag if need to remove current existing peerings.
A description of the connectivity configuration.
List of hubItems Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --hub
.
Flag if global mesh is supported.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
The name of the network manager connectivity configuration.
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.
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.
The name of the network manager.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
The name of the network manager.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
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.
An optional query parameter which specifies the maximum number of records to be returned by the server.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
The name of the network manager connectivity configuration.
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.
The name of the network manager.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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 [--add]
[--applies-to-group]
[--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]
[--ids]
[--is-global {False, True}]
[--name]
[--remove]
[--resource-group]
[--set]
[--subscription]
Optional Parameters
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>.
Groups for configuration Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --applies-to-group
.
The name of the network manager connectivity configuration.
Connectivity topology type.
Flag if need to remove current existing peerings.
A description of the connectivity configuration.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
List of hubItems Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --hub
.
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.
Flag if global mesh is supported.
The name of the network manager.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
The name of the network manager connectivity configuration.
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
The name of the network manager.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Azure CLI