az network vpn-connection shared-key
Manage VPN shared keys.
Commands
az network vpn-connection shared-key reset |
Reset a VPN connection shared key. |
az network vpn-connection shared-key show |
Retrieve a VPN connection shared key. |
az network vpn-connection shared-key update |
Update a VPN connection shared key. |
az network vpn-connection shared-key reset
Reset a VPN connection shared key.
az network vpn-connection shared-key reset --key-length
[--connection-name]
[--ids]
[--resource-group]
[--subscription]
Examples
Reset the shared key on a connection.
az network vpn-connection shared-key reset -g MyResourceGroup --connection-name MyConnection --key-length 128
Required Parameters
The virtual network connection reset shared key length, should between 1 and 128.
Optional Parameters
Connection name.
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 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
.
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.
Increase logging verbosity. Use --debug for full debug logs.
az network vpn-connection shared-key show
Retrieve a VPN connection shared key.
az network vpn-connection shared-key show [--connection-name]
[--ids]
[--query-examples]
[--resource-group]
[--subscription]
Examples
View the shared key of a connection.
az network vpn-connection shared-key show -g MyResourceGroup --connection-name MyConnection
Retrieve a VPN connection shared key. (autogenerated)
az network vpn-connection shared-key show --connection-name MyConnection --resource-group MyResourceGroup --subscription MySubscription
Optional Parameters
Connection name.
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.
Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.
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
.
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.
Increase logging verbosity. Use --debug for full debug logs.
az network vpn-connection shared-key update
Update a VPN connection shared key.
az network vpn-connection shared-key update --value
[--add]
[--connection-name]
[--force-string]
[--id]
[--ids]
[--remove]
[--resource-group]
[--set]
[--subscription]
Examples
Change the shared key for the connection to "Abc123".
az network vpn-connection shared-key update -g MyResourceGroup --connection-name MyConnection --value Abc123
Update a VPN connection shared key. (autogenerated)
az network vpn-connection shared-key update --connection-name MyConnection --resource-group MyResourceGroup --subscription MySubscription --value Abc123
Required Parameters
The virtual network connection shared key value.
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>.
Connection name.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Resource ID.
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 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
.
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.
Increase logging verbosity. Use --debug for full debug logs.